GXSTK class

class geosoft.gx.GXSTK
The STK class is used for plotting a single data profile in
an MVIEW. The MSTK class (see MSTK.GXH) is used to plot
multiple STK objects to a single map.

Use geosoft.gx.GXMSTK.add_stk() fuction to create a STK object before
using functions in this file

SEE MSTK FILE FOR DETAILED DESCRIPTIONS OF ALL FUNCTION PARAMETERS.
get_axis_format((int)arg1) → int:
Get axis number display format.
Parameters:arg1 (int) – STK_AXIS constants
Returns:The current format - DB_CHAN_FORMAT constants
Return type:int

New in version 5.1.5.

Note:

By default, DB_CHAN_FORMAT_NORMAL
get_axis_parms((int_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (str_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (int_ref)arg9, (int)arg10) → None:
Get parameters in STK object relating drawing X/Y axis
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
? mark in the note represent either X and Y
get_fid_parms((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (str_ref)arg4, (float_ref)arg5, (str_ref)arg6) → None:
Get parameters in STK object relating drawing fid ticks
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
get_flag((int)arg1) → int:
Get flag indicating part of STK object is to be drawn or not
Parameters:arg1 (int) – STK_FLAG constants
Returns:FALSE (0) if part of the object is not to be drawn TRUE (1) if part of the object is drawn
Return type:int

New in version 6.0.1.

get_gen_parms((str_ref)arg1, (str_ref)arg2, (str_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (float_ref)arg9, (float_ref)arg10, (float_ref)arg11) → None:
Get general parameters in STK object
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
get_grid_parms((int_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (float_ref)arg9, (str_ref)arg10, (int)arg11) → None:
Get background grid parameters in STK object
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
? mark in the note represent either X and Y
get_label_parms((int_ref)arg1, (float_ref)arg2, (int_ref)arg3, (float_ref)arg4, (int_ref)arg5, (float_ref)arg6, (str_ref)arg7, (float_ref)arg8, (str_ref)arg9, (int_ref)arg10, (int)arg11) → None:
Get parameters in STK object relating X/Y axis labels
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
? mark in the note represent either X and Y
Sets the label format to GSF_NORMAL. To override this,
use the geosoft.gx.GXSTK.set_axis_format() function AFTER calling this.
get_profile((int_ref)arg1, (float_ref)arg2, (float_ref)arg3, (str_ref)arg4, (int_ref)arg5, (int_ref)arg6, (int_ref)arg7, (GXVV)arg8, (str_ref)arg9, (int_ref)arg10, (str_ref)arg11, (float_ref)arg12, (str_ref)arg13, (int_ref)arg14) → None:
Get profile parameters in STK object
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
get_profile_ex((int_ref)arg1, (float_ref)arg2, (float_ref)arg3, (str_ref)arg4, (int_ref)arg5, (int_ref)arg6, (int_ref)arg7, (int_ref)arg8, (GXVV)arg9, (str_ref)arg10, (int_ref)arg11, (str_ref)arg12, (float_ref)arg13, (str_ref)arg14, (int_ref)arg15) → None:
Get profile parameters in STK object (added Break on dummy option)
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.3.

Note:

See MSTK for detailed description of all function parameters
get_symb_parms((str_ref)arg1, (float_ref)arg2, (str_ref)arg3, (str_ref)arg4, (int_ref)arg5, (int_ref)arg6, (float_ref)arg7, (int_ref)arg8, (GXVV)arg9, (GXVV)arg10, (int_ref)arg11, (str_ref)arg12, (float_ref)arg13, (str_ref)arg14) → None:
Get parameters in STK object relating drawing symbols
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
get_title_parms((str_ref)arg1, (str_ref)arg2, (int_ref)arg3, (float_ref)arg4, (float_ref)arg5, (int_ref)arg6, (float_ref)arg7, (float_ref)arg8, (str_ref)arg9, (float_ref)arg10, (str_ref)arg11, (int)arg12) → None:
Get parameters in STK object relating X/Y axis titles
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
? mark in the note represent either X and Y
get_trans_parms((int_ref)arg1, (float_ref)arg2, (GXVV)arg3, (GXVV)arg4, (int_ref)arg5, (float_ref)arg6, (GXVV)arg7, (GXVV)arg8) → None:
Get transformation parameters in STK object
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See above full description of each parameters
VV's for X channel transformation can be NULL if the
transformation is log or loglinear. The same for Y channel.

See MSTK for detailed description of all function parameters
is_null() → bool

Check if the instance of geosoft.gx.GXSTK is null (undefined)

Returns:True if this is a null instance of geosoft.gx.GXSTK, False otherwise.
Return type:bool`
static null() → GXSTK

A null (undefined) instance of geosoft.gx.GXSTK

Returns:A null geosoft.gx.GXSTK
Return type:geosoft.gx.GXSTK
set_array_colors((GXITR)arg1) → None:
Set colours for individual channels in a VA, via an ITR
Parameters:arg1 (geosoft.gx.GXITR) – ITR object for colours
Returns:Nothing
Return type:None

New in version 5.0.1.

Note:

The ITR is consulted by taking the channel index and dividing
by the number of channels; hence the ITR maximum values should
be in the range: 0 > values >= 1.0.
set_axis_format((int)arg1, (int)arg2) → None:
Set axis number display format.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.5.

Note:

By default, DB_CHAN_FORMAT_NORMAL is used to display the values,
or for values > 1.e7, DB_CHAN_FORMAT_EXP.
set_axis_parms((int)arg1, (float)arg2, (float)arg3, (float)arg4, (str)arg5, (float)arg6, (float)arg7, (float)arg8, (int)arg9, (int)arg10) → None:
Set parameters in STK object relating drawing X/Y axis
Parameters:
  • arg1 (int) – ?BARDRAW
  • arg2 (float) – Bottom Y/Left X location
  • arg3 (float) – Top Y/Right X location
  • arg4 (float) – ?BARLINETHICK - Line thickness in mm. Default is 0.05
  • arg5 (str) – ?BARCOLOR - Line color string in RGB model. Default is black
  • arg6 (float) – ?BARTICKINTEERVAL
  • arg7 (float) – Major tick size in mm for bottom/left axis bar.
  • arg8 (float) – Major tick size in mm for top/right axis bar.
  • arg9 (int) – ?BARMINORTICK - Number of minor ticks. (0) none, (-1) automatic
  • arg10 (int) – STK_AXIS constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
? mark in the note represent either X and Y
set_fid_parms((float)arg1, (float)arg2, (float)arg3, (str)arg4, (float)arg5, (str)arg6) → None:
Set parameters in STK object relating drawing fid ticks
Parameters:
  • arg1 (float) – Y location in data unit to draw Fid ticks. Default is the bottom of the stack
  • arg2 (float) – Fid tick size in mm. Default is 2.0mm
  • arg3 (float) – Fid interval to draw ticks. Nice number is calculated by default
  • arg4 (str) – Font to use to label fids. Default is use ‘default’ font set in Montaj
  • arg5 (float) – Text size in mm to label fids. Default is 5mm
  • arg6 (str) – Text color string in RGB model. Default is black
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
set_flag((int)arg1, (int)arg2) → None:
Set flag indicating part of STK object is to be drawn or not
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

set_gen_parms((str)arg1, (str)arg2, (str)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (float)arg11) → None:
Set general parameters in STK object
Parameters:
  • arg1 (str) – X channel name, REQUIRED
  • arg2 (str) – Y channel name, REQUIRED
  • arg3 (str) – Group name
  • arg4 (float) – X scale (map scale, units/metre), REQUIRED
  • arg5 (float) – Y scale (plot scale, units/mm), REQUIRED
  • arg6 (float) – Minimum X value (data unit) to draw
  • arg7 (float) – Maximum X value (data unit) to draw
  • arg8 (float) – Minimum Y value (data unit) to draw
  • arg9 (float) – Minimum horizontal location in mm of the stack on the map
  • arg10 (float) – Minimum vertical location in mm on the map
  • arg11 (float) – Profile height in mm on the map, must be > 0.0
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
set_grid_parms((int)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (str)arg10, (int)arg11) → None:
Set background grid parameters in STK object
Parameters:
  • arg1 (int) – Type of grid to draw:
  • arg2 (float) – Minimum X in ground unit to draw grid
  • arg3 (float) – Maximum X in ground unit to draw grid
  • arg4 (float) – Minimum Y in ground unit to draw grid
  • arg5 (float) – Maximum Y in ground unit to draw grid
  • arg6 (float) – Line thickness in mm. Default is 0.01mm
  • arg7 (float) – Cross size or separation between dots in mm.
  • arg8 (float) – Separation between vertical grid lines.
  • arg9 (float) – Separation between horizontal grid lines.
  • arg10 (str) – Grid line color string in RGB model. Default is black
  • arg11 (int) – STK_GRID constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
? mark in the note represent either X and Y
set_label_parms((int)arg1, (float)arg2, (int)arg3, (float)arg4, (int)arg5, (float)arg6, (str)arg7, (float)arg8, (str)arg9, (int)arg10, (int)arg11) → None:
Set parameters in STK object relating X/Y axis labels
Parameters:
  • arg1 (int) – Bottom/Top or Left/Right axes
  • arg2 (float) – Bottom or Left axis label location
  • arg3 (int) – Bottom or Left labels orientation.
  • arg4 (float) – Top or Right axis label location
  • arg5 (int) – Top or Right axis label orientation
  • arg6 (float) – Label interval. Default is to use related axis tick interval
  • arg7 (str) – Font to use to label. Default is use ‘default’ font set in Montaj
  • arg8 (float) – Text size in mm to draw profile labels. Default is 5mm
  • arg9 (str) – Text color string in RGB model. Default is black
  • arg10 (int) – ?LABELBOUND - Edge bound. 0 - No
  • arg11 (int) – STK_AXIS constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
? mark in the note represent either X and Y
Sets the label format to GSF_NORMAL. To override this,
use the geosoft.gx.GXSTK.set_axis_format() function AFTER calling this.
set_line_parm((int)arg1) → None:
Set line parameter (of Y Chan) in STK object
Parameters:arg1 (int) – Line symb
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
set_profile((int)arg1, (float)arg2, (float)arg3, (str)arg4, (int)arg5, (int)arg6, (int)arg7, (GXVV)arg8, (str)arg9, (int)arg10, (str)arg11, (float)arg12, (str)arg13, (int)arg14) → None:
Set profile parameters in STK object
Parameters:
  • arg1 (int) – Profile line type. 1 - solid (default)
  • arg2 (float) – Patterned line pitch in mm. Default is 10 mm
  • arg3 (float) – Line thickness in mm. Default is 0.05mm
  • arg4 (str) – Color string in RGB model. Default is black
  • arg5 (int) – Wrap option
  • arg6 (int) – Clip option
  • arg7 (int) – Plot smoothed polyline.
  • arg8 (geosoft.gx.GXVV) – Integers starting from 0 indicating windows in VA channel to draw VV type of INT (integer)
  • arg9 (str) – Characters string to label profiles
  • arg10 (int) – Reference location to draw label.
  • arg11 (str) – Font to use to draw profile labels. Default is use ‘default’ font set in Montaj
  • arg12 (float) – Text size in mm to draw profile labels. Default is 5mm
  • arg13 (str) – Text color string in RGB model. Default is black
  • arg14 (int) – Include VA column numbers as part of the profile label 0 - no, 1 - yes
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
set_profile_ex((int)arg1, (float)arg2, (float)arg3, (str)arg4, (int)arg5, (int)arg6, (int)arg7, (int)arg8, (GXVV)arg9, (str)arg10, (int)arg11, (str)arg12, (float)arg13, (str)arg14, (int)arg15) → None:
Set profile parameters in STK object (added Break on dummy option)
Parameters:
  • arg1 (int) – Profile line type. 1 - solid (default)
  • arg2 (float) – Patterned line pitch in mm. Default is 10 mm
  • arg3 (float) – Line thickness in mm. Default is 0.05mm
  • arg4 (str) – Color string in RGB model. Default is black
  • arg5 (int) – Break on dummy option
  • arg6 (int) – Wrap option
  • arg7 (int) – Clip option
  • arg8 (int) – Plot smoothed polyline.
  • arg9 (geosoft.gx.GXVV) – Integers starting from 0 indicating windows in VA channel to draw VV type of INT (integer)
  • arg10 (str) – Characters string to label profiles
  • arg11 (int) – Reference location to draw label.
  • arg12 (str) – Font to use to draw profile labels. Default is use ‘default’ font set in Montaj
  • arg13 (float) – Text size in mm to draw profile labels. Default is 5mm
  • arg14 (str) – Text color string in RGB model. Default is black
  • arg15 (int) – Include VA column numbers as part of the profile label 0 - no, 1 - yes
Returns:

Nothing
Return type:

None

New in version 5.0.3.

Note:

See MSTK for detailed description of all function parameters
set_symb_parms((str)arg1, (float)arg2, (str)arg3, (str)arg4, (int)arg5, (int)arg6, (float)arg7, (int)arg8, (GXVV)arg9, (GXVV)arg10, (int)arg11, (str)arg12, (float)arg13, (str)arg14) → None:
Set parameters in STK object relating drawing symbols
Parameters:
  • arg1 (str) – Font to use to draw symbols. Default is use ‘symbols.gfn’ font
  • arg2 (float) – Symbol size in mm. Default is 5mm
  • arg3 (str) – Edge color string in RGB model. Default is black
  • arg4 (str) – Fill color string in RGB model. Default is black
  • arg5 (int) – Wrap option
  • arg6 (int) – Clip option
  • arg7 (float) – Y location to draw symbols. Default is to use the data from Y channel
  • arg8 (int) – Number of symbols levels
  • arg9 (geosoft.gx.GXVV) – Y values to define data ranges for each symbol types Type of REAL
  • arg10 (geosoft.gx.GXVV) – Symbol numbers (given in the symbol font) to draw Type of INT
  • arg11 (int) – Draw symbols ID (1) or not (0)
  • arg12 (str) – Font to use to draw symbol ID (A,B,C...). Default is use ‘default’
  • arg13 (float) – Text size in mm to draw profile labels. Default is 5mm
  • arg14 (str) – Text color string in RGB model. Default is black
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
set_title_parms((str)arg1, (str)arg2, (int)arg3, (float)arg4, (float)arg5, (int)arg6, (float)arg7, (float)arg8, (str)arg9, (float)arg10, (str)arg11, (int)arg12) → None:
Set parameters in STK object relating X/Y axis titles
Parameters:
  • arg1 (str) – Title for bottom X axis/left Y axis. Default is no title.
  • arg2 (str) – Title for top X axis/right Y axis. Default is no title.
  • arg3 (int) – Bottom/Left axis title orientation.
  • arg4 (float) – X location to draw bottom/left axis title
  • arg5 (float) – Y location to draw bottom/left axis title
  • arg6 (int) – Top/Right axis title orientation.
  • arg7 (float) – X location to draw top/right axis title
  • arg8 (float) – Y location to draw top/right axis title
  • arg9 (str) – Font to draw titles. Default is use ‘default’ font set in Montaj
  • arg10 (float) – Text size in mm to draw titles. Default is 5mm
  • arg11 (str) – Text color string in RGB model. Default is black
  • arg12 (int) – STK_AXIS constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See MSTK for detailed description of all function parameters
? mark in the note represent either X and Y
set_trans_parms((int)arg1, (float)arg2, (int)arg3, (int)arg4, (int)arg5, (float)arg6, (int)arg7, (int)arg8) → None:
Set transformation parameters in STK object
Parameters:
  • arg1 (int) – Type of transformation for horizontal axis
  • arg2 (float) – Minimum value to apply logarithmic
  • arg3 (int) – future use
  • arg4 (int) – future use
  • arg5 (int) – Type of scaling for vertical axis
  • arg6 (float) – Minimum value to apply logarithmic
  • arg7 (int) – future use
  • arg8 (int) – future use
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See above full description of each parameters
VV's for X channel transformation can be NULL if the
transformation is log or loglinear. The same for Y channel.
See MSTK for detailed description of all function parameters
set_va_index_start((int)arg1) → None:
Start array profile index labels at 0 or 1.
Parameters:arg1 (int) – Starting index (0 or 1)
Returns:Nothing
Return type:None

New in version 6.0.1.

Note:

By default, the index labels for array channel profiles
begin at 0. Use this function to start them at either 0
or 1.

STK_AXIS constants

STK Axis defines
gx.STK_AXIS_X = 0
X Axis
gx.STK_AXIS_Y = 1
Y Axis

STK_FLAG constants

Stack flags
gx.STK_FLAG_PROFILE = 0
gx.STK_FLAG_FID = 1
gx.STK_FLAG_SYMBOL = 2
gx.STK_FLAG_XBAR = 3
gx.STK_FLAG_XLABEL = 4
gx.STK_FLAG_XTITLE = 5
gx.STK_FLAG_YBAR = 6
gx.STK_FLAG_YLABEL = 7
gx.STK_FLAG_YTITLE = 8
gx.STK_FLAG_GRID1 = 9
gx.STK_FLAG_GRID2 = 10

STK_GRID constants

Stack Grid define
gx.STK_GRID_PRIMARY = 0
Primary Grid
gx.STK_GRID_SECONDARY = 1
Secondary Grid