GXMSTK class

class GXMSTK(handle=0)

GXMSTK class.

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

See also: GXSTK class.

add_stk()

Create and add a GXSTK object to GXMSTK

Returns:GXSTK, fail if error Return type:GXSTK

New in version 5.0.

License: Geosoft End-User License

Note: Index to the added GXSTK object is the last one in GXMSTK container.

chan_list_vv(db, num_ch_vv, str_ch_vv, x_ch_vv, prof_ch_vv, prof_ch__un_used_vv)

Save channel names in VVs based on channel types

Parameters:

• db (GXDB) – Database handle
• num_ch_vv (GXVV) – List of names of numeric channels
• str_ch_vv (GXVV) – List of name of string channels
• x_ch_vv (GXVV) – List of channel names which can be used for X axis. Must be numeric channels but not GXVA channels
• prof_ch_vv (GXVV) – List of profiles with channel names in both GXMSTK and GXDB
• prof_ch__un_used_vv (GXVV) – List of profiles with channels in GXMSTK but not in database

New in version 5.0.

License: Geosoft End-User License

Note: Terms ‘used’ and ‘unused’ indicate that the a channel name in database also ‘in’ and ‘not in’ the GXMSTK object respectively

classmethod create()

Create GXMSTK.

Returns:GXMSTK, aborts if creation fails Return type:GXMSTK

New in version 5.0.

License: Geosoft End-User License

delete_stk(num)

Delete a GXSTK object

Parameters:num (int) – Index to GXSTK to delete (0 is first one)

New in version 5.0.

License: Geosoft End-User License

Note: 0 is the first one

draw_profile(db, line, map)

Draw multiple profiles in map

Parameters:

• db (GXDB) – Database handle
• line (int) – Database line
• map (GXMAP) – GXMAP handle

New in version 5.0.

License: Geosoft End-User License

find_stk(str_val, index, group, x_ch, y_ch)

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

Parameters:

• str_val (str) – Input string (see notes above). Will be modified on return
• index (int_ref) – Index to the GXSTK found, Must be greater than 0 if found, -1 if not found
• group (str_ref) – Output group name string
• x_ch (str_ref) – Output X channel name string
• y_ch (str_ref) – Output Y channel name string

New in version 5.0.

License: Geosoft End-User License

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_val, index, vv_rtd)

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

Parameters:

• str_val (str) – Input string (see notes above). Will be modified on return
• index (int_ref) – Index to the GXSTK found, Must be greater than 0 if found, -1 if not found
• vv_rtd (GXVV) – Returned GXVV with names of Group, X channel and Y channel GXVV type must be of STRING

New in version 5.0.

License: Geosoft End-User License

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()

Get the number of GXSTK objects in a GXMSTK object

Returns:The number of GXSTK objects in a GXMSTK object Return type:int

New in version 5.0.

License: Geosoft End-User License

get_stk(num)

Get a specific GXSTK object from a GXMSTK object (Index of 0 gets the first GXSTK in the GXMSTK)

Parameters:num (int) – Index to GXSTK to get Returns:x - GXSTK Object handle Return type:GXSTK

New in version 5.0.

License: Geosoft End-User License

is_null()

Check if this is a null (undefined) instance

Returns:True if this is a null (undefined) instance, False otherwise. Return type:bool

classmethod null()

A null (undefined) instance of GXMSTK

Returns:A null GXMSTK Return type:GXMSTK

read_ini(ra)

Read multiple profiles parameters from an INI file

Parameters:ra (GXRA) – GXRA handle to an INI file

New in version 5.0.

License: Geosoft End-User License

save_profile(wa)

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

Parameters:wa (GXWA) – GXWA handle to an INI file

New in version 5.0.

License: Geosoft End-User License

set_y_axis_direction(direction)

Set the Y-axis direction - normal or inverted

Parameters:direction (int) – Y-axis direction: 0 - normal, 1 - inverted

New in version 8.3.

License: Geosoft End-User License