GXMSTK class¶

class geosoft.gx.GXMSTK¶

Multi-profile stack
This class is used for storing data of multiple profiles and
plotting profiles in a map. It is a container of STK class objects.

See also:         STK class.

add_stk() → GXSTK:¶

Create and add a STK object to MSTK

Returns:	STK, fail if error
Return type:	`geosoft.gx.GXSTK`

New in version 5.0.0.

Note:

Index to the added STK object is the last one in MSTK container.

chan_list_vv((GXDB)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6) → None:¶

Save channel names in VVs based on channel types

Parameters:	arg1 (`geosoft.gx.GXDB`) – Database handle arg2 (`geosoft.gx.GXVV`) – List of names of numeric channels arg3 (`geosoft.gx.GXVV`) – List of name of string channels arg4 (`geosoft.gx.GXVV`) – List of channel names which can be used for X axis. Must be numeric channels but not VA channels arg5 (`geosoft.gx.GXVV`) – List of profiles with channel names in both MSTK and DB arg6 (`geosoft.gx.GXVV`) – List of profiles with channels in MSTK but not in database
Returns:	Nothing
Return type:	None

New in version 5.0.0.

Note:

Terms 'used' and 'unused' indicate that the a channel name
in database also 'in' and 'not in' the MSTK object respectively

static create((GXContext)ctx) → GXMSTK:¶

Create MSTK.

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context
Returns:	MSTK, aborts if creation fails
Return type:	`geosoft.gx.GXMSTK`

New in version 5.0.0.

delete_stk((int)arg1) → None:¶

Delete a STK object

Parameters:	arg1 (int) – Index to STK to delete (0 is first one)
Returns:	Nothing
Return type:	None

New in version 5.0.0.

Note:

0 is the first one

draw_profile((GXDB)arg1, (int)arg2, (GXMAP)arg3) → None:¶

Draw multiple profiles in map

Parameters:	arg1 (`geosoft.gx.GXDB`) – Database handle arg2 (int) – Database line arg3 (`geosoft.gx.GXMAP`) – MAP handle
Returns:	Nothing
Return type:	None

New in version 5.0.0.

find_stk((str)arg1, (int_ref)arg2, (str_ref)arg3, (str_ref)arg4, (str_ref)arg5) → None:¶

Find index of STK from a string of group names and X/Y channels

Parameters:	arg1 (str) – Input string (see notes above). Will be modified on return arg2 (`geosoft.gx.int_ref`) – Index to the STK found, Must be greater than 0 if found, -1 if not found arg3 (`geosoft.gx.str_ref`) – output group name string arg4 (`geosoft.gx.str_ref`) – output X channel name string arg5 (`geosoft.gx.str_ref`) – output Y channel name string
Returns:	Nothing
Return type:	None

New in version 5.0.0.

Note:

Format of the input string:

Map group name + " ( " + X channel name + " , " + Y channel name + " )"

for example, string "DATA ( DIST , MAG )"  indicates a map group name of DATA,
X channel name of DIST and Y channel name of MAG.

find_stk2((str)arg1, (int_ref)arg2, (GXVV)arg3) → None:¶

Find index of STK from a string of group names and X/Y channels

Parameters:	arg1 (str) – Input string (see notes above). Will be modified on return arg2 (`geosoft.gx.int_ref`) – Index to the STK found, Must be greater than 0 if found, -1 if not found arg3 (`geosoft.gx.GXVV`) – Returned VV with names of Group, X channel and Y channel VV type must be of STRING
Returns:	Nothing
Return type:	None

New in version 5.0.0.

Note:

Format of the input string:

Map group name + " ( " + X channel name + " , " + Y channel name + " )"

for example, string "DATA ( DIST , MAG )"  indicates a map group name of DATA,
X channel name of DIST and Y channel name of MAG.

get_num_stk() → int:¶

Get the number of STK objects in a MSTK object

Returns:	The number of STK objects in a MSTK object
Return type:	int

New in version 5.0.0.

get_stk((int)arg1) → GXSTK:¶

Get a specific STK object from a MSTK object
(Index of 0 gets the first STK in the MSTK)

Parameters:	arg1 (int) – Index to STK to get
Returns:	x - STK Object handle
Return type:	`geosoft.gx.GXSTK`

New in version 5.0.0.

is_null() → bool¶

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

Returns:	True if this is a null instance of `geosoft.gx.GXMSTK`, False otherwise.
Return type:	bool`

static null() → GXMSTK¶

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

Returns:	A null `geosoft.gx.GXMSTK`
Return type:	`geosoft.gx.GXMSTK`

read_ini((GXRA)arg1) → None:¶

Read multiple profiles parameters from an INI file

Parameters:	arg1 (`geosoft.gx.GXRA`) – RA handle to an INI file
Returns:	Nothing
Return type:	None

New in version 5.0.0.

save_profile((GXWA)arg1) → None:¶

Save multiple profile INI parameters in a WA file of INI format

Parameters:	arg1 (`geosoft.gx.GXWA`) – WA handle to an INI file
Returns:	Nothing
Return type:	None

New in version 5.0.0.

set_y_axis_direction((int)arg1) → None:¶

Set the Y-axis direction - normal or inverted

Parameters:	arg1 (int) – Y-axis direction: 0 - normal, 1 - inverted
Returns:	Nothing
Return type:	None

New in version 8.3.0.