GXSEMPLOT class¶
-
class
geosoft.gx.
GXSEMPLOT
¶ Oasis montaj implementation of RTE SEMPLOT
-
static
apply_filter_to_mask
((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5, (int)arg6) → None:¶ Apply the filter to the mask channel
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Filter name
- arg3 (str) – Mask channel name
- arg4 (str) – Mineral channel name
- arg5 (str) – Mineral to use (“All” or “” for all)
- arg6 (int) – Mask mode (0: Append, 1: New)
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The mask channel is updated for the current data to reflect the actions of the filter. Those values passing get 1, those failing get 0.
- ctx (
-
static
convert_dummies
((GXContext)ctx, (GXDB)arg1, (int)arg2) → None:¶ Convert dummies to zero values for assay channels.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – database handle - arg2 (int) – Input line to convert
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The is operation is controlled by the Preferences "Use dummies to indicate no data?" By default, this option is "yes" so this function will return with no changes. However, if "no", then all ASSAY class channels will have dummy values converted to 0.0.
- ctx (
-
static
create_ascii_template
((GXContext)ctx, (str)arg1, (str)arg2) → int:¶ : Generate ASCII import template automatically
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (str) – data file name
- arg2 (str) – template to make
Returns: 1 if it succeeds in creating a Template. 0 if it fails.
Return type: int
New in version 6.2.0.
- ctx (
-
static
create_database_template
((GXContext)ctx, (str)arg1, (str)arg2) → int:¶ Generate database import template automatically
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (str) – data file name
- arg2 (str) – template to make
Returns: 1 if it succeeds in creating a Template. 0 if it fails.
Return type: int
New in version 6.2.0.
- ctx (
-
static
create_groups
((GXContext)ctx, (GXDB)arg1, (str)arg2) → None:¶ Group data by anomaly or string channel - Interactive.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Mask channel
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
default_groups
((GXContext)ctx, (GXDB)arg1) → None:¶ Group data by selected anomalies.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
edit_filter
((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5) → int:¶ Edit and create filter on channel values
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Name of filter
- arg3 (str) – Mask channel name
- arg4 (str) – Mineral channel name
- arg5 (str) – Mineral to restrict filter to.
Returns: -1 - Cancel - Edits to filter discarded.
0 - Normal Return. Edits saved to filter file.
1 - Apply filter to current data only
- 2 - Remove filter - If removing filtered data, just
restore the data to the Min/Pos data otherwise set the mask channel to 1.
Re-entry code. If not iDUMMY, what to do inside the filter after going back in. Returned on exit, used on next input.
0 - Nothing. Don’t need to go back into this function again. 1 - Edit the filter.
- Notes New and edited filters are stored in useretc in files with
the file extension ”.semfilter” If a file for the specified filter does not exist, then a new filter by that name will be created.
Return type: int
New in version 6.2.0.
- ctx (
-
static
edit_map_plot_parameters
((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (GXMAP)arg4, (str)arg5) → None:¶ Alter parameters in an XYplot Triplot map.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Mask channel (can be “”)
- arg3 (str) – Mineral channel (can be “” for raw data)
- arg4 (
geosoft.gx.GXMAP
) – Map handle - arg5 (str) – Map View
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The Parameters GUI is loaded based on settings stored in the map. The map is then re-plotted, overwriting the old one, based on the new settings. Note that the selection of data in the current DB is used to replot the map.
- ctx (
-
static
edit_plot_components
((GXContext)ctx, (GXDB)arg1, (str)arg2) → None:¶ Set group names and channels to plot in a template.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Template name
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The "Components" group in the INI file is edited. Looks first in useretc, then in etc. Looks first for file prefix "semtemplate" then "xyt" or "tri" The altered template will be output to the useretc directory with the file extension "semtemplate".
- ctx (
-
static
edit_plot_parameters
((GXContext)ctx, (GXDB)arg1, (str)arg2) → None:¶ Set TriPlot parameters in a template.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Template name
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The "Parameters" group in the INI file is edited. Looks first in useretc, then in etc. Looks first for file prefix "semtemplate" then "xyt" or "tri" The altered template will be output to the useretc directory with the file extension "semtemplate".
- ctx (
-
static
export_overlay
((GXContext)ctx, (str)arg1, (str)arg2, (GXMVIEW)arg3, (str)arg4, (int)arg5, (str)arg6, (str)arg7, (str)arg8, (str)arg9, (str)arg10, (str)arg11, (int)arg12) → None:¶ Create overlay map and file from a group.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (str) – overlay file name
- arg2 (str) – associated map
- arg3 (
geosoft.gx.GXMVIEW
) – View with group - arg4 (str) – group name
- arg5 (int) – SEMPLOT_PLOT constants
- arg6 (str) – XStage
- arg7 (str) – XOxide
- arg8 (str) – YStage
- arg9 (str) – YOxide
- arg10 (str) – ZStage
- arg11 (str) – ZOxide
- arg12 (int) – SEMPLOT_EXT constants
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The group is written to a new map, and an overlay file is created which points to this map.
- ctx (
-
static
export_view
((GXContext)ctx, (GXDB)arg1, (GXLST)arg2, (GXDB)arg3, (int)arg4, (str)arg5, (str)arg6, (str)arg7) → None:¶ Create a "View" database
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Original raw data database - arg2 (
geosoft.gx.GXLST
) – List of lines (anomlies) to export - arg3 (
geosoft.gx.GXDB
) – Destination database - arg4 (int) – View to export - One of SEMPLOT_XXX_STAGE
- arg5 (str) – Mask channel (“” for None)
- arg6 (str) – Mineral channel
- arg7 (str) – Mineral to export (“” for all)
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
export_view2
((GXContext)ctx, (GXDB)arg1, (GXLST)arg2, (GXDB)arg3, (int)arg4, (str)arg5, (str)arg6, (str)arg7, (int)arg8) → None:¶ Create a "View" database, with channel selection
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Original raw data database - arg2 (
geosoft.gx.GXLST
) – List of lines (anomlies) to export - arg3 (
geosoft.gx.GXDB
) – Destination database - arg4 (int) – View to export - One of SEMPLOT_XXX_STAGE
- arg5 (str) – Mask channel (“” for None)
- arg6 (str) – Mineral channel
- arg7 (str) – Mineral to export (“” for all)
- arg8 (int) – SEMPLOT_EXPORT constants Channel selection
Returns: Nothing
Return type: None
New in version 7.1.0.
- ctx (
-
static
filter_lst
((GXContext)ctx, (GXLST)arg1) → None:¶ Fill a LST with existing SEMPLOT filters
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXLST
) – LST to fill.
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
"Supplied" filters are stored in etc, while user-edited and new filters are stored in useretc. This function finds all files with the extension ".semfilter", first in useretc, then in etc, and adds the file names (without the extension) to the LST. The name with the extension is stored as the value. The LST is cleared first.
- ctx (
-
static
filter_mineral_pos_data
((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4, (int)arg5) → None:¶ Filter raw data by position and mineral values
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Mask channel
- arg3 (str) – Mineral channel
- arg4 (str) – mineral (string) - “C”, “I” etc.
- arg5 (int) – Grain position
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The Mask channel will be updated so that those data values which "pass" get "1" and those that "fail" get dummy "*" NO DATA IS REMOVED. Works on all selected lines of data.
- ctx (
-
static
get_associated_lst
((GXContext)ctx, (GXDB)arg1, (int)arg2, (GXLST)arg3) → None:¶ Get the associated channels for this group in a LST
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (int) – Data Group handle
- arg3 (
geosoft.gx.GXLST
) – LST to copy channels into
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
get_current_mineral_lst
((GXContext)ctx, (GXDB)arg1, (str)arg2, (GXLST)arg3) → None:¶ Retrieve LST of minerals in selected lines.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Mineral channel name
- arg3 (
geosoft.gx.GXLST
) – LST object
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
If the mineral channel name is not specified, it returns just the "X" (Unknown) item.
- ctx (
-
static
get_current_position_lst
((GXContext)ctx, (GXDB)arg1, (GXLST)arg2) → None:¶ Retrieve LST of positions in selected lines.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (
geosoft.gx.GXLST
) – LST object
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
get_full_mineral_lst
((GXContext)ctx, (GXLST)arg1) → None:¶ Retrieve LST of all minerals in Semplot_Minerals.csv
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXLST
) – LST object
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
get_full_position_lst
((GXContext)ctx, (GXLST)arg1) → None:¶ Retrieve LST of all possible mineral positions.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXLST
) – LST object
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
get_grouping_lst
((GXContext)ctx, (GXDB)arg1, (GXLST)arg2) → None:¶ Get list of items to group symbols by.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – database handle - arg2 (
geosoft.gx.GXLST
) – list to hold items
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The first item is "Anomaly", which gives the line names, The second item (if the channel exists in the database) is the Sample Number. After this are included all string channels which are NOT oxides or elements. (The list can include the mineral). Channel symbol is the LST value (except for the first item - "Anomaly")
- ctx (
-
static
get_mineral_channel_name
((GXContext)ctx, (GXDB)arg1, (str_ref)arg2) → None:¶ Retrieve the mineral channel name.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (
geosoft.gx.str_ref
) – Mineral channel name
Returns: Nothing
Return type: None
New in version 6.3.0.
Note:
First looks at the SEMPLOT.MINERAL_CHANNEL value. If not found, returns the first MINERAL class channel found. If still not found, returns a blank string.
- ctx (
-
static
import_ascii_wizard
((GXContext)ctx, (str)arg1, (str)arg2, (str_ref)arg3) → None:¶ Generate a SEMPLOT ASCII import template.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (str) – data file name
- arg2 (str) – template to make
- arg3 (
geosoft.gx.str_ref
) – anomaly name (can be “”)
Returns: Nothing
Return type: None
New in version 6.3.0.
Note:
If the anomaly name is not included, then the input data must have an "Anom_Name" field.
- ctx (
-
static
import_bin
((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4, (int)arg5, (float)arg6) → None:¶ Import blocked binary or archive ASCII data
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database - arg2 (str) – import data file name
- arg3 (str) – import template name
- arg4 (str) – Optional Line name (see note 3.)
- arg5 (int) – Optional Flight number
- arg6 (float) – Optional date
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
This wrapper is for SEMPLOT, and does not require the import licence. 1. Binary import templates have extension .I2 by convention. See BINARY.I2 for a description of the template format. Archive import templates have extension .I3 by convention. See ARCHIVE.I3 for a description of the template format. 2. Both the import template and data file must exist. 3. If a line already exists in the database, a new version is created unless a line name is passed in. In this case, the specified name is used and the imported channels on the previous line will be destroyed.
See also
geosoft.gx.GXDU.lab_template()
in du.gxh- ctx (
-
static
import_database_ado
((GXContext)ctx, (str)arg1, (str)arg2) → None:¶ Generate a template file for importing semplot databases.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (str) – data file name
- arg2 (str) – template to make
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
import_database_odbc
((GXContext)ctx, (str_ref)arg1, (str_ref)arg2) → None:¶ Generate a template file for importing ODBC databases.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.str_ref
) – connection string (input and returned) - arg2 (
geosoft.gx.str_ref
) – template file (returned)
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
init_group_symbols_used
((GXContext)ctx, (GXDB)arg1) → None:¶ Initializes memory of symbols used in plotting.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – database handle
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
Maintains a list of the symbols used in plotting. Call before Plotting one or more legends - symbols are accumulated.
geosoft.gx.GXSEMPLOT.plot_symbol_legend()
uses this information to create a legend.- ctx (
-
static
mineral_id
((GXContext)ctx, (GXDB)arg1, (float)arg2, (int)arg3, (int)arg4) → None:¶ Identify minerals from the oxide channels.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database - arg2 (float) – Maximum residual value (in % of the total oxide)
- arg3 (int) – Mineral channel (Locked RW)
- arg4 (int) – Residual channel (Locked RW)
Returns: Nothing
Return type: None
New in version 6.3.0.
Note:
Finds the best mineral matching the composition for each row of oxide values. Works using linear programming and the simplex method to maximize the oxides used to create each of the possible output minerals. The mineral leaving the least leftover is selected, as long as the residual (measured as a percent of the total) is less than or equal to the input value.
- ctx (
-
static
new_filter
((GXContext)ctx, (str)arg1, (str)arg2) → None:¶ Create a new selection filter.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (str) – New filter name
- arg2 (str) – Filter to use as a model (can be “”)
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
Creates a new, empty filter file in the useretc directory
- ctx (
-
static
new_template
((GXContext)ctx, (str)arg1, (int)arg2, (str)arg3) → None:¶ Create a new XYPlot or TriPlot template.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (str) – New template name
- arg2 (int) – Unknown
- arg3 (str) – Template to use as a model (can be “”)
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The new template is written to the useretc directory, with the file extension "semfilter". The template contains a parameter identifying it as an XY or Triplot. Model Template: Looks first in useretc, then in etc. Looks first for file prefix "semtemplate" then "xyt" or "tri" Because there are so many shared parameters, it is possible to use an XYPlot template as a model for a TriPlot, and vica-verca, with few complications. (e.g. needing to define a "Z" component)
- ctx (
-
static
overlay_lst
((GXContext)ctx, (GXLST)arg1, (int)arg2, (int)arg3) → None:¶ Fill a list with the available plot overlay names
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXLST
) – Input LST. - arg2 (int) – SEMPLOT_EXT constants
- arg3 (int) – SEMPLOT_PLOT constants
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
Looks first in useretc, then in etc. See SEMPLOT_EXT definitions above for which files to look for.
- ctx (
-
static
plot
((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5, (int)arg6, (int)arg7) → None:¶ Plot an XYPlot or TriPlot based on the template.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Template file name
- arg3 (str) – Mask channel (can be “”)
- arg4 (str) – Mineral channel (can be “” for raw data)
- arg5 (str) – Map name
- arg6 (int) – Map open mode; one of MAP_WRITEXXX (see map.gxh)
- arg7 (int) – Plot symbols (O: No, 1:Yes) ?
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The "Components" and "Parameters" groups in the INI file are used. Only values with mask values of 1 are plotted, if the mask channel is specified. Call "
geosoft.gx.GXSEMPLOT.reset_used_channel()
" prior to this function in order to track the values actually plotted. Callgeosoft.gx.GXSEMPLOT.init_group_symbols_used()
prior to this function to reset recording of the symbols used in plotting (for legends etc).- ctx (
-
static
plot_symbol_legend
((GXContext)ctx, (GXDB)arg1, (GXMVIEW)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:¶ Plot a symbol legend in a view.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (
geosoft.gx.GXMVIEW
) – View to plot into - arg3 (float) – X Minimum
- arg4 (float) – Y Minimum
- arg5 (float) – Y Maximum
- arg6 (float) – Symbol size
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
This function depends on
geosoft.gx.GXSEMPLOT.init_group_symbols_used()
before the plot for which this legend is created is made. The symbols and groups to use in the legend are stored to a database blob after the plot is made. These values are recovered by this function to make the legend at the specified location.- ctx (
-
static
prop_symb
((GXContext)ctx, (GXDB)arg1, (GXMAP)arg2, (str)arg3, (str)arg4, (str)arg5, (str)arg6, (int)arg7, (int)arg8, (float)arg9, (float)arg10, (int)arg11, (int)arg12, (int)arg13, (int)arg14, (int)arg15) → None:¶ Plot a proportional symbol plot.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (
geosoft.gx.GXMAP
) – Map to plot to - arg3 (str) – View to replot
- arg4 (str) – channel name
- arg5 (str) – mask channel (can be “”)
- arg6 (str) – mineral channel (
- arg7 (int) – linear (0) or logarithmic (1) scaling
- arg8 (int) – scale by diameter (0) or area (1)
- arg9 (float) – scale base (log) data units
- arg10 (float) – scale factor (log) data units/mm
- arg11 (int) – symbol number
- arg12 (int) – symbol weight
- arg13 (int) – symbol line color
- arg14 (int) – symbol fill color
- arg15 (int) – plot legend?
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
Replots map using proportional symbols
- ctx (
-
static
re_plot_symbol_legend
((GXContext)ctx, (GXDB)arg1, (GXMVIEW)arg2) → None:¶ Replot a symbol legend in a view.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (
geosoft.gx.GXMVIEW
) – View to plot into
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
Searches the VIEW REG for information on a previously created legend, and if it finds that info, replots the Legend, using the current data, group key etc.
- ctx (
-
static
replot
((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (GXMAP)arg4, (str)arg5) → None:¶ Replot an existing SEMPLOT plot based on current data.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Mask channel (can be “”)
- arg3 (str) – Mineral channel (can be “” for raw data)
- arg4 (
geosoft.gx.GXMAP
) – Map handle - arg5 (str) – Map View containing the plot
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
Note that the selection of data in the current DB is used to replot the map. Call "
geosoft.gx.GXSEMPLOT.reset_used_channel()
" prior to this function in order to track the values actually plotted. Callgeosoft.gx.GXSEMPLOT.init_group_symbols_used()
prior to this function to reset recording of the symbols used in plotting (for legends etc).- ctx (
-
static
reset_groups
((GXContext)ctx, (GXDB)arg1, (str)arg2) → None:¶ Re-group data using current settings.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Mask channel
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
reset_used_channel
((GXContext)ctx, (GXDB)arg1) → None:¶ Set the "Plotted" channel to dummies
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – database handle
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
This function is called before one or a series of plots to initialize the "Plotted" channel in all the selected lines to dummy values. As the plots are created, those points used in the plot are set to 1, so that at the end the database records which values have been plotted. This information can then be used to make a symbol legend. If the "Plotted" channel does not exist, it is created, associated, loaded, and filled with dummies.
- ctx (
-
static
select_poly
((GXContext)ctx, (GXDB)arg1, (GXMVIEW)arg2, (str)arg3, (str)arg4, (GXPLY)arg5, (int)arg6) → None:¶ Select data from a polygonal area on a map.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (
geosoft.gx.GXMVIEW
) – View Handle - arg3 (str) – Mask channel to update
- arg4 (str) – Mineral channel
- arg5 (
geosoft.gx.GXPLY
) – Polygon to select from, in the view coordinates. - arg6 (int) – Mask mode (0: Append, 1: New)
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
set_channel_order
((GXContext)ctx, (GXDB)arg1, (GXLST)arg2) → None:¶ Sets preset channel order.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – database handle - arg2 (
geosoft.gx.GXLST
) – channel names, handles
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
Sets channel order as follows: Sample_No X and Y Locations Mineral Grain_No Position (e.g. center, edge etc.) Grain Morph Oxides (in the order they appear in Semplot_Oxides.csv) Trace Elements (Ordered as in the periodic table) Total Mask IsPlotted (flag set when a value is plotted) Other channels Channel order is set for all "RawData" groups.
- ctx (
-
static
set_channel_units
((GXContext)ctx, (GXDB)arg1) → None:¶ Set units for oxides (%) and elements (ppm)
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – database handle
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
If the channel units are already set, then they are not changed. Oxide channels are identified from the Semplot_Oxides.csv file. Trace elements are identified from the periodic table of the elements, except for "Y", if it is the current Y channel.
- ctx (
-
static
set_itr
((GXContext)ctx, (GXDB)arg1, (int)arg2, (GXITR)arg3) → None:¶ Put ITR into a channel.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (int) – Data channel handle
- arg3 (
geosoft.gx.GXITR
) – ITR
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
set_mask
((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4, (int)arg5, (int)arg6) → None:¶ Set the mask channel ON or OFF.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (str) – Mask channel
- arg3 (str) – Mineral channel
- arg4 (str) – Mineral to use (“All” or “” for all)
- arg5 (int) – 0 for all lines, 1 for selected lines
- arg6 (int) – 0 for off, 1 for on.
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
sort_data
((GXContext)ctx, (GXDB)arg1, (int)arg2, (int)arg3) → None:¶ Sort data by Sample No, Grain and Position
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – Database handle - arg2 (int) – Data Group handle
- arg3 (int) – Use Anomaly channel as primary sort?
Returns: Nothing
Return type: None
New in version 6.2.0.
- ctx (
-
static
template_lst
((GXContext)ctx, (GXLST)arg1, (int)arg2) → None:¶ Fill a list with the available plot template names
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXLST
) – Input LST. - arg2 (int) – SEMPLOT_PLOT constants
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
Looks first in useretc, then in etc. Looks first for file prefix "semtemplate" then "xyt" or "tri" (New-style templates with the "semtemplate" extentsion have the plot type "triplot" or "xyplot" inside them.)
- ctx (
-
static
template_type
((GXContext)ctx, (str)arg1) → int:¶ Create a new XYPlot or TriPlot template.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (str) – Template name
Returns: SEMPLOT_PLOT_XYPLOT or SEMPLOT_PLOT_TRIPLOT Terminates if error.
Return type: int
New in version 6.2.0.
- ctx (
-
static
tile_windows
((GXContext)ctx) → None:¶ Tile currently maximimized windows.
Parameters: ctx ( geosoft.gx.GXContext
) – The GX execution contextReturns: Nothing Return type: None New in version 6.2.0.
-
static
total_oxides
((GXContext)ctx, (GXDB)arg1, (str)arg2) → None:¶ Calculate the total oxides channel.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXDB
) – database handle - arg2 (str) – Mineral channel
Returns: Nothing
Return type: None
New in version 6.2.0.
Note:
The mineral channel is needed in order to adjust the total with the Fe Corrected Ferric and Ferrous values, and these require a mineral for their identification. If none is provided, mineral "X" (unknown) is assumed.
- ctx (
-
static
view_type
((GXContext)ctx, (GXMAP)arg1, (str)arg2) → int:¶ Test to see if a view is an XYPlot or Triplot view.
Parameters: - ctx (
geosoft.gx.GXContext
) – The GX execution context - arg1 (
geosoft.gx.GXMAP
) – Input map object - arg2 (str) – Input view name
Returns: Return type: int
New in version 6.4.2.
Note:
First checks the view name to see if it starts with "XYplt_" or "Triplt_". Failing that it looks in the view REG for a value for "Components.Type", which will be either "XYPlot" or "TriPlot". If the view does not appear to be an XYPlot or a TriPlot view, the function returns SEMPLOT_PLOT_UNKNOWN.
- ctx (
-
static
SEMPLOT_EXPORT constants¶
SEMPLOT export type selection.
-
gx.
SEMPLOT_EXPORT_NORMAL
= 0¶
Exports Sample info channels, oxides/ratios, totals, extra channels.
-
gx.
SEMPLOT_EXPORT_NOEXTRA
= 1¶
Exports Sample info, oxides/ratios, totals.
SEMPLOT_EXT constants¶
SEMPLOT file extension selection
-
gx.
SEMPLOT_EXT_ALL
= 0¶
Use for selection only. Selects both "Semplot" and "CHIMERA" type
files when creating LSTs etc.
-
gx.
SEMPLOT_EXT_SEMPLOT
= 1¶
Read/write templates with extensions ".xyt", ".tri" and ".semtemplate"
Read/write overlays with extensions ".oly" and ".semoverlay"
-
gx.
SEMPLOT_EXT_CHIMERA
= 2¶
Read/write templates with extensions ".geosoft_template"
Read/write overlays with extensions ".geosoft_overlay"
SEMPLOT_PLOT constants¶
SEMPLOT plot type selection.
-
gx.
SEMPLOT_PLOT_ALL
= 0¶
Use for selection only. Selects both "XYPlot" and "TriPlot"
plots when creating LSTs etc.
-
gx.
SEMPLOT_PLOT_XYPLOT
= 1¶
Select XY (Scatter) plot.
-
gx.
SEMPLOT_PLOT_TRIPLOT
= 2¶
Select Tri (Triangular) plot.
-
gx.
SEMPLOT_PLOT_UNKNOWN
= 3¶
Returned as an error status from some functions.