GXKGRD class

class geosoft.gx.GXKGRD
The KGRD object is used as a storage place for the control
parameters that the Krigrid program needs to execute. The
Run_KGRD function executes the Krigrid program using the
KGRD object.
clear() → None:
Clears all the parameters in a KGRD object
Returns:Nothing
Return type:None

New in version 5.0.0.

static create((GXContext)ctx) → GXKGRD:
Create a handle to a Krigrid object
Parameters:ctx (geosoft.gx.GXContext) – The GX execution context
Returns:KGRD Object
Return type:geosoft.gx.GXKGRD

New in version 5.0.0.

Note:

The Krigrid object is initially empty. It will store the
control file parameters which the Krigrid program needs
to execute. Use the LoadParms_KGRD method to get the
control file parameters into the KGRD object.
is_null() → bool

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

Returns:True if this is a null instance of geosoft.gx.GXKGRD, False otherwise.
Return type:bool`
load_parms((str)arg1) → int:
Retrieves a Krigrid object's control parameters from a file.
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 Krigrid control
file will be generated and put into the KGRD object.
Otherwise, the control file's settings are retrieved from
the file and loaded into the KGRD object.
static null() → GXKGRD

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

Returns:A null geosoft.gx.GXKGRD
Return type:geosoft.gx.GXKGRD
run((str)arg1, (GXDAT)arg2, (GXDAT)arg3, (GXDAT)arg4, (str)arg5, (str)arg6, (int)arg7, (int)arg8, (int)arg9) → int:
Executes the Krigrid program, using the input channel and
output file parameters.
Parameters:
  • arg1 (str) – Name of Z Channel to perfrom gridding on
  • arg2 (geosoft.gx.GXDAT) – Handle to source DAT object (from database)
  • arg3 (geosoft.gx.GXDAT) – Handle to output grid file DAT
  • arg4 (geosoft.gx.GXDAT) – Handle to output error grid file DAT ((DAT)0) if no error grid required
  • arg5 (str) – Name of input variogram file
  • arg6 (str) – Name of output variogram file
  • arg7 (int) – Flag of variogram only
  • arg8 (int) – Flag of input variogram
  • arg9 (int) – Flag of output variogram
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, (str)arg7, (str)arg8, (str)arg9, (int)arg10) → int:
Executes the Krigrid 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) – KRIGRID control file.
  • arg6 (str) – (output grid name (not required if variogram analysis only))
  • arg7 (str) – (output error file, “” for none)
  • arg8 (str) – (input variogram file, “” for none)
  • arg9 (str) – (output variogram file, “” for none)
  • arg10 (int) – 1 if Variogram Analysis Only, other wise 0
Returns:

0 OK, 1 Error.
Return type:

int

New in version 6.0.1.

static run3((GXContext)ctx, (GXDB)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5, (str)arg6, (str)arg7, (str)arg8, (str)arg9, (str)arg10, (int)arg11) → int:
Executes the Krigrid program directly on a database and specifies the log file
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) – KRIGRID control file.
  • arg6 (str) – (output grid name (not required if variogram analysis only))
  • arg7 (str) – (output error file, “” for none)
  • arg8 (str) – (input variogram file, “” for none)
  • arg9 (str) – (output variogram file, “” for none)
  • arg10 (str) – (log file name, “” for default)
  • arg11 (int) – 1 if Variogram Analysis Only, other wise 0
Returns:

0 OK, 1 Error.
Return type:

int

New in version 6.4.0.

save_parms((str)arg1) → int:
Puts the Krigrid 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.