GXIPGUI class¶

class GXIPGUI(handle=0)[source]¶

GXIPGUI class.

This class is used in the GXIP System for GXGUI functions such as defining parameters for pseudo-section plots.

__init__(handle=0)[source]¶: Initialize self. See help(type(self)) for accurate signature.

classmethod ipqc_tool_exists()[source]¶

See if there is an IPQC Tool (Offset or Inline) already open.

Returns: 0 if not open, 1 if open
Return type: int

New in version 8.1.

License: Geosoft Extended End-User License

Note: See if there is an IPQC Tool already open.

is_null()[source]¶

Check if this is a null (undefined) instance

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

classmethod launch_ipqc_tool(db, line, chan)[source]¶

Launch the In-Line GXIP QC tool on a database.

Parameters

db (str) – Database name
line (str) – Current Line (can be blank)
chan (str) – Channel to open with (can be blank)

New in version 8.1.

License: Geosoft Extended End-User License

Note: The database should be a currently open database.

classmethod launch_offset_ipqc_tool(db, line, chan)[source]¶

Launch the Offset GXIP QC tool on a database.

Parameters

db (str) – Database name
line (str) – Current Line (can be blank)
chan (str) – Channel to open with (can be blank)

New in version 9.1.

License: Geosoft Extended End-User License

Note: The database should be a currently open database.

classmethod launch_remove_contributing_electrodes_ext_tool(db, map)[source]¶

Launch the Remove Contributing Electrodes dialog.

Parameters

db (str) – Database name
map (str) – Current Map

New in version 9.4.

License: Geosoft Extended End-User License

Note: This tool removes the GXEXT object that allows the database-map linking between an IP data base and IP plan map for plotting contributing electrodes for a given database row of data.

classmethod modify_job(ip, db, ini, plot_type, page)[source]¶

Modify parameters for an GXIP plot.

Parameters

ip (GXIP) – GXDH Handle
db (GXDB) – GXDB Handle
ini (str) – Job Name (*.inp)
plot_type (int) – Job type IP_PLOT constants
page (int_ref) – Page to open GXGUI on

Returns

0 - Ok -1 - User Cancelled

Return type

int

New in version 6.1.

License: Geosoft Extended End-User License

classmethod null()[source]¶

A null (undefined) instance of GXIPGUI

Returns: A null GXIPGUI
Return type: GXIPGUI