GXVOXE class

class geosoft.gxapi.GXVOXE
VOX evaluator class. Used to sample values from
the voxel.
static create((GXVOX)arg1) → GXVOXE:
Create a handle to an VOXE object
Parameters:arg1 (geosoft.gxapi.GXVOX) – VOX Object
Returns:VOXE handle, terminates if creation fails
Return type:geosoft.gxapi.GXVOXE

New in version 6.3.0.

is_null() → bool

Check if the instance of geosoft.gxapi.GXVOXE is null (undefined)

Returns:True if this is a null instance of geosoft.gxapi.GXVOXE, False otherwise.
Return type:bool`
static null() → GXVOXE

A null (undefined) instance of geosoft.gxapi.GXVOXE

Returns:A null geosoft.gxapi.GXVOXE
Return type:geosoft.gxapi.GXVOXE
profile((GXVV)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (int)arg5) → None:
Extract a profile of data along points provided.
Parameters:
Returns:

Nothing

Return type:

None

New in version 6.3.0.

value((float)arg1, (float)arg2, (float)arg3, (int)arg4) → float:
Get a value at a specific point
Parameters:
  • arg1 (float) – X Location
  • arg2 (float) – Y Location
  • arg3 (float) – Z Location
  • arg4 (int) – VOXE_EVAL constants
Returns:

Value at the point or DUMMY if not valid

Return type:

float

New in version 6.3.0.

vector((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (GXVV)arg7, (int)arg8) → None:
Extract a profile of data along a vector
Parameters:
  • arg1 (float) – X Origin
  • arg2 (float) – Y Origin
  • arg3 (float) – Z Origin
  • arg4 (float) – X Delta
  • arg5 (float) – Y Delta
  • arg6 (float) – Z Delta
  • arg7 (geosoft.gxapi.GXVV) – Data VV (must be double)
  • arg8 (int) – VOXE_EVAL constants
Returns:

Nothing

Return type:

None

New in version 6.3.0.

VOXE_EVAL constants

Voxel Evaluation modes
gxapi.VOXE_EVAL_NEAR = 0
Nearest value
gxapi.VOXE_EVAL_INTERP = 1
Linear Interpolation
gxapi.VOXE_EVAL_BEST = 2
Best Interpolation