GXBIGRID class¶

class geosoft.gx.GXBIGRID¶

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

clear() → None:¶

Clears all the parameters in a BIGRID object

Returns:	Nothing
Return type:	None

New in version 5.0.0.

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

Create a handle to a Brigrid object

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context
Returns:	BIGRID Object
Return type:	`geosoft.gx.GXBIGRID`

New in version 5.0.0.

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 BIGRID object.

is_null() → bool¶

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

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

load_parms((str)arg1) → int:¶

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

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

New in version 5.0.0.

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 BIGRID object.
Otherwise, the control file's settings are retrieved from
the file and loaded into the BIGRID object.

load_warp((str)arg1, (str)arg2, (str)arg3) → int:¶

Load a warp projection.

Parameters:	arg1 (str) – New grid title arg2 (str) – New grid cell size as a string, blank for default arg3 (str) – Warp projection file name
Returns:	0 - Ok 1 - Error
Return type:	int

New in version 5.0.0.

static null() → GXBIGRID¶

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

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

run((str)arg1, (GXDAT)arg2, (GXDAT)arg3) → None:¶

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

Parameters:	arg1 (str) – not used, pass as “” arg2 (`geosoft.gx.GXDAT`) – Handle to source DAT object (from database) arg3 (`geosoft.gx.GXDAT`) – Handle to output grid file DAT
Returns:	Nothing
Return type:	None

New in version 5.0.0.

run2((str)arg1, (GXDAT)arg2, (GXDAT)arg3, (GXIPJ)arg4) → None:¶

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

Parameters:	arg1 (str) – not used, pass as “” arg2 (`geosoft.gx.GXDAT`) – Handle to source DAT object (from database) arg3 (`geosoft.gx.GXDAT`) – Handle to output grid file DAT arg4 (`geosoft.gx.GXIPJ`) – IPJ handle of the projection system
Returns:	Nothing
Return type:	None

New in version 6.3.0.

save_parms((str)arg1) → None:¶

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

Parameters:	arg1 (str) – Name of file to put the parameter settings into
Returns:	Nothing
Return type:	None

New in version 5.0.0.

Note:

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