GXDAT class

class geosoft.gx.GXDAT

The DAT object is used to access data from an variety of data sources
using the same access functions. The DAT interface supports data access
on a point-by-point, of line-by-line basis.  For example,
the geosoft.gx.GXBIGRID.run() function uses 2 DAT objects - one DAT associated with the
input data source, which is read line-by-line, and a second associated with
the output grid file output grid file.

Use a specific DAT creation method for an associated
information source in order to make a DAT as required
by a specific processing function.  The gridding methods all use DATs.

static create_db((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4) → GXDAT:

Create a handle to a database DAT object

Parameters:

• ctx (geosoft.gx.GXContext) – The GX execution context
• arg1 (geosoft.gx.GXDB) – Handle to database which DAT is connected with
• arg2 (str) – Name of X channel in database
• arg3 (str) – Name of Y channel in database
• arg4 (str) – Name of Z channel in database

Returns:

DAT Object

Return type:

geosoft.gx.GXDAT

New in version 5.0.0.

static create_xgd((GXContext)ctx, (str)arg1, (int)arg2) → GXDAT:

Create a handle to a grid file DAT object

Parameters:

• ctx (geosoft.gx.GXContext) – The GX execution context
• arg1 (str) – Name of grid file to associate DAT with
• arg2 (int) – DAT_XGD constants

Returns:

DAT Object

Return type:

geosoft.gx.GXDAT

New in version 5.0.0.

static get_lst((GXContext)ctx, (GXLST)arg1, (str)arg2, (int)arg3, (int)arg4) → None:

Put available DAT filters and qualifiers in a LST

Parameters:

• ctx (geosoft.gx.GXContext) – The GX execution context
• arg1 (geosoft.gx.GXLST) – LST object to populate
• arg2 (str) – DAT interface name (“XGD” only support option currently)
• arg3 (int) – DAT_FILE constants
• arg4 (int) – DAT_FILE_FORM constants

Returns:

Nothing

Return type:

None

New in version 5.1.8.

Note:

The filters displayed in the Grid/Image file browse dialog are put
in the "Name" of the LST, while the file qualifiers are stored in
the "Value".

is_null() → bool

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

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

static null() → GXDAT

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

Returns:A null geosoft.gx.GXDAT Return type:geosoft.gx.GXDAT

range_xyz((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (int_ref)arg7) → None:

Determine the range in X, Y and Z in the DAT source

Parameters:

• arg1 (geosoft.gx.float_ref) – Minimum X (rMAX if none)
• arg2 (geosoft.gx.float_ref) – Minimum Y (rMAX if none)
• arg3 (geosoft.gx.float_ref) – Minimum Z (rMAX if none)
• arg4 (geosoft.gx.float_ref) – Maximum X (rMIN if none)
• arg5 (geosoft.gx.float_ref) – Maximum Y (rMIN if none)
• arg6 (geosoft.gx.float_ref) – Maximum Z (rMIN if none)
• arg7 (geosoft.gx.int_ref) – Number of non-dummy XYZ.

Returns:

Nothing

Return type:

None

New in version 7.3.0.

Note:

Terminates if unable to open an RPT DAT interface.

DAT_FILE constants

Type of grid

gx.DAT_FILE_GRID = 1

gx.DAT_FILE_IMAGE = 2

DAT_FILE_FORM constants

Type of form

gx.DAT_FILE_FORM_OPEN = 0

gx.DAT_FILE_FORM_SAVE = 1

DAT_XGD constants

DAT Open modes

gx.DAT_XGD_READ = 0

gx.DAT_XGD_NEW = 1

gx.DAT_XGD_WRITE = 2