GXBIGRID class¶

class GXBIGRID(handle=0)[source]¶

GXBIGRID class.

The Bigrid class is used to grid data using a optimized algorithm that assumes data is collected in semi-straight lines.

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

clear()[source]¶

Clears all the parameters in a GXBIGRID object

New in version 5.0.

License: Geosoft Extended End-User License

classmethod create()[source]¶

Create a handle to a Bigrid object

Returns: GXBIGRID Object
Return type: GXBIGRID

New in version 5.0.

License: Geosoft Extended End-User License

Note: The Bigrid object is initially empty. It will store the control file parameters which the Bigrid program needs to execute. Use the LoadParms_BIGRID method to get the control file parameters into the GXBIGRID object.

classmethod get_defaults(db, x, y, z, cell, maxLineSeparation, maxPointSeparation, trendAngle, lowPassWavelength, highPass, noneLinear, preFilter)[source]¶

Get default values for max line separation, max point separation and trend angle.

Parameters

db (GXDB) – Handle to a database
x (str) – Y Channel
y (str) – X Channel
z (str) – Data channel
cell (float) – cell size
maxLineSeparation (float_ref) – max line separation
maxPointSeparation (float_ref) – max point separation
trendAngle (float_ref) – trend angle
lowPassWavelength (float_ref) – low-pass filter wavelength
highPass (float_ref) – high-pass filter wavelength
noneLinear (float_ref) – non-linear filter tolerance
preFilter (float_ref) – pre-filter sample increment

Returns

0 - Ok 1 - Error

Return type

int

New in version 2021.2.

License: Geosoft Extended End-User License

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

load_parms(file)[source]¶

Retrieves a Bigrid object’s control parameters from a file, or sets the parameters to default if the file doesn’t exist.

Parameters: file (str) – Name of file to get the parameter settings from
Returns: 0 - Ok 1 - Error
Return type: int

New in version 5.0.

License: Geosoft Extended End-User License

Note: If the control file name passed into this function is a file which does not exist, then the defaults for a Bigrid control file will be generated and put into the GXBIGRID object. Otherwise, the control file’s settings are retrieved from the file and loaded into the GXBIGRID object.

load_warp(title, cell, warp)[source]¶

Load a warp projection.

Parameters

title (str) – New grid title
cell (str) – New grid cell size as a string, blank for default
warp (str) – Warp projection file name

Returns

0 - Ok 1 - Error

Return type

int

New in version 5.0.

License: Geosoft Extended End-User License

classmethod null()[source]¶

A null (undefined) instance of GXBIGRID

Returns: A null GXBIGRID
Return type: GXBIGRID

run(zchan, in_dat, out_dat)[source]¶

Executes the Bigrid program, using the input channel and output file parameters.

Parameters

zchan (str) – Not used, pass as “”
in_dat (GXDAT) – Handle to source GXDAT object (from database)
out_dat (GXDAT) – Handle to output grid file GXDAT

New in version 5.0.

License: Geosoft Extended End-User License

run2(zchan, in_dat, out_dat, ipj)[source]¶

Executes the Bigrid program, using the input channel and output file parameters with a projection handle.

Parameters

zchan (str) – Not used, pass as “”
in_dat (GXDAT) – Handle to source GXDAT object (from database)
out_dat (GXDAT) – Handle to output grid file GXDAT
ipj (GXIPJ) – GXIPJ handle of the projection system

New in version 6.3.

License: Geosoft Extended End-User License

save_parms(name)[source]¶

Puts the Bigrid object’s control parameters back into its control file.

Parameters: name (str) – Name of file to put the parameter settings into

New in version 5.0.

License: Geosoft Extended End-User License

Note: If the control file did not previously exist, it will be created. Otherwise, the old file will be overwritten.