GXRGRD class

class geosoft.gx.GXRGRD
The RGRD object is used as a storage place for the control
parameters which the Rangrid (minimum curvature) program needs to execute. The
Run_RGRD function executes the Rangrid program using the RGRD object.
clear() → None:
Clears all the parameters in a RGRD object
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

DLL name geosoft.gx.GXRGRD.clear()
static create((GXContext)ctx) → GXRGRD:
Create a handle to a Rangrid object
Parameters:ctx (geosoft.gx.GXContext) – The GX execution context
Returns:RGRD Object
Return type:geosoft.gx.GXRGRD

New in version 5.0.0.

Note:

The Rangrid object is initially empty. It will store the
control file parameters which the Rangrid program needs
to execute. Use the LoadParms_RGRD method to get the
control file parameters into the RGRD object.
static create_img((GXContext)ctx, (GXVV)arg1, (GXVV)arg2, (GXVV)arg3, (GXIPJ)arg4, (str)arg5, (str)arg6) → GXIMG:
Run Rangrid directly on XYZ VV data, output to an IMG.
Parameters:
Returns:

IMG object
Return type:

geosoft.gx.GXIMG

New in version 7.0.1.

Note:

If the grid file name is defined, the IMG is tied to a new output file.
If the grid file name is not defined, the IMG is memory-based; not
tied to a file.
default((str)arg1, (GXDAT)arg2) → int:
Set the defaults.
Parameters:
  • arg1 (str) – Name of Z Channel to perfrom gridding on
  • arg2 (geosoft.gx.GXDAT) – Handle to source DAT object (from database)
Returns:

0 OK, 1 Error.
Return type:

int

New in version 6.0.1.

is_null() → bool

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

Returns:True if this is a null instance of geosoft.gx.GXRGRD, False otherwise.
Return type:bool`
load_parms((str)arg1) → int:
Retrieves a Rangrid 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 6.0.1.

Note:

If the control file name passed into this function is a file
which does not exist, then the defaults for a Rangrid control
file will be generated and put into the RGRD object.
Otherwise, the control file's settings are retrieved from
the file and loaded into the RGRD object.
static null() → GXRGRD

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

Returns:A null geosoft.gx.GXRGRD
Return type:geosoft.gx.GXRGRD
run((GXDAT)arg1, (GXDAT)arg2) → int:
Executes the Rangrid program, using the input channel and
output file parameters.
Parameters:
Returns:

0 OK, 1 Error.
Return type:

int

New in version 6.0.1.

static run2((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5, (str)arg6) → int:
Executes the Rangrid program directly on a database.
Parameters:
  • ctx (geosoft.gx.GXContext) – The GX execution context
  • arg1 (geosoft.gx.GXDB) – Handle to a database
  • arg2 (str) – Y Channel
  • arg3 (str) – X Channel
  • arg4 (str) – Data channel
  • arg5 (str) – RANGRID control file.
  • arg6 (str) – output grid name
Returns:

0, always.
Return type:

int

New in version 6.0.1.

static run_vv((GXContext)ctx, (GXVV)arg1, (GXVV)arg2, (GXVV)arg3, (GXIPJ)arg4, (str)arg5, (str)arg6) → None:
Executes the Rangrid program directly on input data VVs.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

save_parms((str)arg1) → int:
Puts the Rangrid object's control parameters back into
its control file.
Parameters:arg1 (str) – Name of file to put the parameter settings into
Returns:0 OK, 1 Error.
Return type:int

New in version 6.0.1.

Note:

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