GXVOX class

class geosoft.gxapi.GXVOX
High Performance 3D Grid. Designed for accessing
3D grids quickly using slices. It designed arround
non-uniform multi-resolution  compressed storage.
o sample a voxel at specific locations, use the VOXE class.
add_generate_by_subset_pg((GXPG)arg1, (int)arg2, (int)arg3) → None:
Add a subset 3D  pagers. These should be "slabs", 16 wide in the input direction, and the size of the
full voxel in the other two directions.
Parameters:
  • arg1 (geosoft.gxapi.GXPG) – Subset pager with the Voxel Data
  • arg2 (int) – Subset orientation - the “16” (thin) dimension is in the other axis.VOX_DIR constants
  • arg3 (int) – Offset of the subset PG corner, along the “thin” dimension.
Returns:

Nothing
Return type:

None

New in version 8.5.0.

Note:

See geosoft.gxapi.GXVOX.init_generate_by_subset_pg() and geosoft.gxapi.GXVOX.end_generate_by_subset_pg().
calc_stats((GXST)arg1) → None:
Calculate Statistics
Parameters:arg1 (geosoft.gxapi.GXST) – ST Object
Returns:Nothing
Return type:None

New in version 6.2.0.

can_append_to((str)arg1) → int:
Check if this voxel can append to a surface file.
Parameters:arg1 (str) – Surface file
Returns:1 if can append
Return type:int

New in version 8.0.0.

static compute_cell_size((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → float:
Compute the Cell size based on specific Area
Parameters:
  • arg1 (float) – MinX
  • arg2 (float) – MinY
  • arg3 (float) – MinZ
  • arg4 (float) – MaxX
  • arg5 (float) – MaxY
  • arg6 (float) – MaxZ
Returns:

Cell Size
Return type:

float

New in version 6.4.0.

convert_density_to_velocity((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (str)arg11) → None:
Produces a velocity voxel using the density values in this voxel.
Parameters:
  • arg1 (float) – 1.0, if this voxel is in g/cm^3. Otherwise, a value by which each input cell is multiplied to convert it into g/cm^3.
  • arg2 (float) – Lower bound on velocity values, in g/vm^3. If the input value (after being pre-multiplied by dInputScalingFactor) is less than this value, the output cell value will be DUMMY.
  • arg3 (float) – Upper bound on velocity values, in g/cm^3. If the input value (after being pre-multiplied by dInputScalingFactor) is greater than this value, the output cell value will be DUMMY.
  • arg4 (float) – Coefficient of fifth-order polynomial term.
  • arg5 (float) – Coefficient of fourth-order polynomial term.
  • arg6 (float) – Coefficient of third-order polynomial term.
  • arg7 (float) – Coefficient of second-order polynomial term.
  • arg8 (float) – Coefficient of first-order polynomial term.
  • arg9 (float) – Constant offset of output.
  • arg10 (float) – 1.0, to produce an output voxel that has units of meters per second. If different units are desired, pass in a different value, which will be multiplied into each output voxel cell.
  • arg11 (str) – Filename of the output voxel.
Returns:

Nothing
Return type:

None

New in version 8.4.

convert_numeric_to_thematic((GXVV)arg1, (str)arg2) → None:
Convert numeric voxel to thematic (lithology) voxel
Parameters:
  • arg1 (geosoft.gxapi.GXVV) – Translation VV handle.
  • arg2 (str) – Output voxel file name.
Returns:

Nothing
Return type:

None

New in version 8.4.

convert_thematic_to_numeric((GXVV)arg1, (str)arg2) → None:
Convert thematic (lithology) voxel to numeric voxel
Parameters:
  • arg1 (geosoft.gxapi.GXVV) – Translation VV handle.
  • arg2 (str) – Output voxel file name.
Returns:

Nothing
Return type:

None

New in version 8.4.

convert_velocity_in_range_to_density((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (str)arg11) → None:
Produces a density voxel using the velocity values in this voxel, as long as the velocity values are in range.
Parameters:
  • arg1 (float) – 1.0, if this voxel is in meters per second. Otherwise, a value by which each input cell is multiplied to convert it into meters per second.
  • arg2 (float) – Lower bound on velocity values, in meters per second. If the input value (after being pre-multiplied by dInputScalingFactor) is less than this value, the output cell value will be DUMMY.
  • arg3 (float) – Upper bound on velocity values, in meters per second. If the input value (after being pre-multiplied by dInputScalingFactor) is greater than this value, the output cell value will be DUMMY.
  • arg4 (float) – Coefficient of fifth-order polynomial term.
  • arg5 (float) – Coefficient of fourth-order polynomial term.
  • arg6 (float) – Coefficient of third-order polynomial term.
  • arg7 (float) – Coefficient of second-order polynomial term.
  • arg8 (float) – Coefficient of first-order polynomial term.
  • arg9 (float) – Constant offset of output.
  • arg10 (float) – 1.0, to produce an output voxel that has units of g/cm^3. If different units are desired, pass in a different value, which will be multiplied into each output voxel cell.
  • arg11 (str) – Filename of the output voxel.
Returns:

Nothing
Return type:

None

New in version 8.4.

convert_velocity_to_density((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (str)arg9) → None:
Produces a density voxel using the velocity values in this voxel.
Parameters:
  • arg1 (float) – 1.0, if this voxel is in meters per second. Otherwise, a value by which each input cell is multiplied to convert it into meters per second.
  • arg2 (float) – Coefficient of fifth-order polynomial term.
  • arg3 (float) – Coefficient of fourth-order polynomial term.
  • arg4 (float) – Coefficient of third-order polynomial term.
  • arg5 (float) – Coefficient of second-order polynomial term.
  • arg6 (float) – Coefficient of first-order polynomial term.
  • arg7 (float) – Constant offset of output.
  • arg8 (float) – 1.0, to produce an output voxel that has units of g/cm^3. If different units are desired, pass in a different value, which will be multiplied into each output voxel cell.
  • arg9 (str) – Filename of the output voxel.
Returns:

Nothing
Return type:

None

New in version 8.4.

static create((str)arg1) → GXVOX:
Create a handle to an VOX object
Parameters:arg1 (str) – File Name
Returns:VOX handle, terminates if creation fails
Return type:geosoft.gxapi.GXVOX

New in version 6.2.0.

create_pg() → GXPG:
Create a 3D PG from a VOX object
Returns:PG Object
Return type:geosoft.gxapi.GXPG

New in version 6.2.0.

create_type_pg((int)arg1) → GXPG:
Create a 3D PG from a VOX object with a specific Type
Parameters:arg1 (int) – GS_TYPES constants
Returns:PG Object
Return type:geosoft.gxapi.GXPG

New in version 6.2.0.

dump((str)arg1) → None:
Export all layers of this VOX in all directions.
Parameters:arg1 (str) – Name of grids (each layers adds _Dir_Z to the name)
Returns:Nothing
Return type:None

New in version 6.2.0.

static dw_grid_db((str)arg1, (GXDB)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6, (GXREG)arg7) → None:
geosoft.gxapi.GXVOX.dw_grid_db()     Inverse-distance weighting gridding method, DB version, 3D.
Parameters:
  • arg1 (str) – Output voxel name
  • arg2 (geosoft.gxapi.GXDB) – Database
  • arg3 (int) – X Channel [READONLY]
  • arg4 (int) – Y Channel [READONLY]
  • arg5 (int) – Z Channel [READONLY]
  • arg6 (int) – Data Channel [READONLY]
  • arg7 (geosoft.gxapi.GXREG) – Parameters (see above)
Returns:

Nothing
Return type:

None

New in version 8.4.0.

Note:

3D cells take on the averaged values within a search radius, weighted inversely by distance.

Weighting can be controlled using the power and slope properties;

weighting = 1 / (distance^wtpower + 1/slope) where distance is in
units of grid cells (X dimenstion). Default is 0.0,

If the blanking distance is set, all cells whose center point is not within the blanking distance of
at least one data point are set to dummy.

REG Parameters:

X0, Y0, Z0, DX, DY, DZ: Voxel origin, and cell sizes (required)
WT_POWER (default=2), WT_SLOPE (default=1) Weighting function parameters
SEARCH_RADIUS: Distance weighting limit (default = 4 * CUBE_ROOT(DX*DY*DZ))
BLANKING_DISTANCE: Dummy values farther from data than this distance. (default = 4 * CUBE_ROOT(DX*DY*DZ))
LOG: Apply log transform to input data before gridding (0:No (default), 1:Yes)?
LOG_BASE: One of VV_LOG_BASE_10 (default) or VV_LOG_BASE_E
LOG_NEGATIVE: One of VV_LOG_NEGATIVE_NO (default) or VV_LOG_NEGATIVE_YES
end_generate_by_subset_pg((str)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (GXIPJ)arg8, (GXMETA)arg9) → None:
Output the voxel, after adding all the subset PGs.
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (float) – Origin X
  • arg3 (float) – Origin Y
  • arg4 (float) – Origin Z
  • arg5 (float) – Cell Size X
  • arg6 (float) – Cell Size Y
  • arg7 (float) – Cell Size Z
  • arg8 (geosoft.gxapi.GXIPJ) – Projection
  • arg9 (geosoft.gxapi.GXMETA) – META data
Returns:

Nothing
Return type:

None

New in version 8.5.0.

Note:

You must begin by calling geosoft.gxapi.GXVOX.init_generate_by_subset_pg() and add data using geosoft.gxapi.GXVOX.add_generate_by_subset_pg().
export_db((GXDB)arg1, (str)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6, (int)arg7) → None:
Export a Voxel to a database
Parameters:
  • arg1 (geosoft.gxapi.GXDB) – Database
  • arg2 (str) – Channel Name
  • arg3 (int) – VOX_DIRECTION constants
  • arg4 (int) – Reverse X ? (0/1)
  • arg5 (int) – Reverse Y ? (0/1)
  • arg6 (int) – Reverse Z ? (0/1)
  • arg7 (int) – Write Dummies? (0/1)
Returns:

Nothing
Return type:

None

New in version 6.3.0.

Note:

The database lines contain a slice of the voxel at a time.
export_img((str)arg1, (int)arg2) → None:
Export all layers of this VOX into grid files.
Parameters:
  • arg1 (str) – Name of grids (each layers adds _Number to the name)
  • arg2 (int) – VOX_DIR constants
Returns:

Nothing
Return type:

None

New in version 6.2.0.

static export_ji_gs_xml((str)arg1, (str)arg2) → None:
Export a VOX to a compressed XML file. Verbose version.
Parameters:
  • arg1 (str) – Voxel file name
  • arg2 (str) – Output XML file
Returns:

Exports all values and stats by JIG.
Return type:

None

New in version 8.4.

export_seg_y((str)arg1, (float)arg2) → None:
Export a voxel to a depth SEG-Y file
Parameters:
  • arg1 (str) – SEG-Y filename to create
  • arg2 (float) – Sampling interval (can be GS_R8DM if input voxel has constant Z cell size)
Returns:

Nothing
Return type:

None

New in version 8.5.

export_to_grids((str)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (float)arg6, (int)arg7) → None:
Export all layers of this VOX into grid files, with optional cell size.
Parameters:
  • arg1 (str) – Name of grids (each layers adds _Number to the name)
  • arg2 (int) – VOX_DIR constants
  • arg3 (int) – Starting index
  • arg4 (int) – Increment in index
  • arg5 (int) – Total number of grids (-1 or iDUMMY for all)
  • arg6 (float) – Cell size (can be GS_R8DM)
  • arg7 (int) – VOX_SLICE_MODE constants
Returns:

Nothing
Return type:

None

New in version 7.3.0.

Note:

If the cell size is not specified, then:
1. If the cell sizes are uniform in a given direction, that size is used
2. If the cell sizes are variable in a given direction, then the smallest size is used
static export_xml((str)arg1, (int_ref)arg2, (str)arg3) → None:
Export a VOX to a compressed XML file
Parameters:
  • arg1 (str) – Voxel file name
  • arg2 (geosoft.gxapi.int_ref) – CRC returned - not implemented - always returns 0.
  • arg3 (str) – Output XML file
Returns:

Nothing
Return type:

None

New in version 6.2.0.

export_xyz((str)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6) → None:
Export a Voxel to an XYZ File
Parameters:
  • arg1 (str) – File Name
  • arg2 (int) – VOX_DIRECTION constants
  • arg3 (int) – Reverse X ? (0/1)
  • arg4 (int) – Reverse Y ? (0/1)
  • arg5 (int) – Reverse Z ? (0/1)
  • arg6 (int) – Write Dummies? (0/1)
Returns:

Nothing
Return type:

None

New in version 6.3.0.

filter((int)arg1, (str)arg2, (int)arg3, (int)arg4, (str)arg5) → None:
Apply a 3D filter to a voxel.
Parameters:
  • arg1 (int) – VOX_FILTER3D constants
  • arg2 (str) – filter file, if filter is VOX_FILTER3D_FILE
  • arg3 (int) – number of filter passes
  • arg4 (int) – (1: interpolate dummies)
  • arg5 (str) – Output voxel file name.
Returns:

Nothing
Return type:

None

New in version 7.3.0.

static generate_constant_value((str)arg1, (float)arg2, (int)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (int)arg10, (int)arg11, (int)arg12, (GXIPJ)arg13, (GXMETA)arg14) → GXVOX:
Generate a VOX with a constant value
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (float) – Value to use
  • arg3 (int) – GS_TYPES constants
  • arg4 (float) – Origin X
  • arg5 (float) – Origin Y
  • arg6 (float) – Origin Z
  • arg7 (float) – Cell Size X
  • arg8 (float) – Cell Size Y
  • arg9 (float) – Cell Size Z
  • arg10 (int) – Cell Count X
  • arg11 (int) – Cell Count Y
  • arg12 (int) – Cell Count Z
  • arg13 (geosoft.gxapi.GXIPJ) – Projection
  • arg14 (geosoft.gxapi.GXMETA) – META data
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 8.4.0.

static generate_constant_value_vv((str)arg1, (float)arg2, (int)arg3, (float)arg4, (float)arg5, (float)arg6, (GXVV)arg7, (GXVV)arg8, (GXVV)arg9, (GXIPJ)arg10, (GXMETA)arg11) → GXVOX:
Generate a VOX with a constant value, cells sizes passed in VVs.
Parameters:
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 8.4.0.

static generate_db((str)arg1, (GXDB)arg2, (int)arg3) → None:
Generate a VOX from a Database
Parameters:
  • arg1 (str) – Voxel Name
  • arg2 (geosoft.gxapi.GXDB) – DB To import from
  • arg3 (int) – Symbol to import data from
Returns:

Nothing
Return type:

None

New in version 6.3.0.

static generate_gocad((str)arg1, (str)arg2, (str)arg3, (GXIPJ)arg4) → GXVOX:
Generate a VOX from a GOCAD File
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (str) – Name of GOCAD Voxel file
  • arg3 (str) – Propert name to import
  • arg4 (geosoft.gxapi.GXIPJ) – IPJ
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 6.2.0.

static generate_oriented_gocad((str)arg1, (str)arg2, (str)arg3, (GXIPJ)arg4, (int)arg5) → GXVOX:
Generate a VOX from a GOCAD File
Parameters:
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 6.3.0.

Note:

Allows the Orientation flag to be specified.
static generate_pg((str)arg1, (GXPG)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (GXIPJ)arg9, (GXMETA)arg10) → GXVOX:
Generate a VOX from a 3D Pager
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (geosoft.gxapi.GXPG) – Pager with the Voxel Data
  • arg3 (float) – Origin X
  • arg4 (float) – Origin Y
  • arg5 (float) – Origin Z
  • arg6 (float) – Cell Size X
  • arg7 (float) – Cell Size Y
  • arg8 (float) – Cell Size Z
  • arg9 (geosoft.gxapi.GXIPJ) – Projection
  • arg10 (geosoft.gxapi.GXMETA) – META data
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 6.2.0.

static generate_pgvv((str)arg1, (GXPG)arg2, (float)arg3, (float)arg4, (float)arg5, (GXVV)arg6, (GXVV)arg7, (GXVV)arg8, (GXIPJ)arg9, (GXMETA)arg10) → GXVOX:
Generate a VOX from a 3D Pager, cells sizes passed in VVs.
Parameters:
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 8.0.0.

Note:

The input cell size VVs' lengths must match the input PG dimensions.
static generate_ubc((str)arg1, (str)arg2, (str)arg3, (float)arg4, (GXIPJ)arg5) → GXVOX:
Generate a VOX from a UBC File
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (str) – Name of UBC Mesh File
  • arg3 (str) – Name of UBC Mod File
  • arg4 (float) – Dummy Value
  • arg5 (geosoft.gxapi.GXIPJ) – Projection
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 6.2.0.

static generate_vector_voxel_from_db((str)arg1, (GXDB)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6, (float)arg7, (float)arg8) → None:
Generate a vector voxel VOX from a Database
Parameters:
  • arg1 (str) – Voxel Name
  • arg2 (geosoft.gxapi.GXDB) – DB To import from
  • arg3 (int) – VOX_VECTORVOX_IMPORT constantsImport XYZ, UVW or Amplitude/Inclination/Declination channels
  • arg4 (int) – Symbol to import X, U or Amplitude data from
  • arg5 (int) – Symbol to import Y, V or Inclination data from
  • arg6 (int) – Symbol to import Z, W or Declination data from
  • arg7 (float) – Inclination value for VOX_VECTORVOX_UVW (-90° to 90°)
  • arg8 (float) – Declination value for VOX_VECTORVOX_UVW (-180° to 180°)
Returns:

Nothing
Return type:

None

New in version 8.5.0.

static generate_xyz((str)arg1, (GXRA)arg2, (int)arg3, (GXIPJ)arg4) → None:
Generate a VOX from an XYZ File
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

get_area((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:
Get the area of the voxel.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

get_cell_size_strings((str_ref)arg1, (str_ref)arg2, (str_ref)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Get the Location Strings
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.1.

get_double_location((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (float_ref)arg9, (float_ref)arg10, (float_ref)arg11, (float_ref)arg12) → None:
Get the location of a voxel with origin and scaled xyz vectors
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

get_gocad_location((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (float_ref)arg9, (float_ref)arg10, (float_ref)arg11, (float_ref)arg12) → None:
Get the location of a voxel with origin and scaled xyz vectors for use with GOCAD.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.0.0.

Note:

This is used for GOCAD voxel calculations, and begins with the
origin at (0,0,0), not the actual location of the corner point.
get_grid_section_cell_sizes((float)arg1, (float_ref)arg2, (float_ref)arg3) → None:
Get default cell sizes in X and Y for a section grid.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.4.0.

Note:

This function determines default cell sizes for a vertical grid
slicing a voxel. It tries to match the "X" and "Y" sizes (in the grid
coordinates) with the projection of the voxel's cells onto the grid
plane. It uses a few simple rules:

If the voxel is rotated about a horizontal axis (i.e. if its own "Z" axis
is not vertical, then both cell sizes are set to the smallest voxel dimension
(a single volume pixel) in X, Y and Z.

If the voxel is "horizontal", then the angle between the
section azimuth and the voxel's own X and Y axes is used to
calculate a value which varies between the minimum X size and the
minimum Y size, and this is used for the grid's "X" cell size.
(in other words, if the section is parallel to the voxel "X" axis,
then the returned "X" cells size is equal to the voxel's minimum "Y" cell size.
The grid's "Y" cell size is set to the voxel's minimum "Z" cell size.
get_info((int_ref)arg1, (int_ref)arg2, (int_ref)arg3, (int_ref)arg4, (int_ref)arg5) → None:
Get information about a voxel.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

get_ipj((GXIPJ)arg1) → None:
Get the projection of the voxel.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ object to save VOX’s meta to
Returns:Nothing
Return type:None

New in version 6.2.0.

get_limits((int_ref)arg1, (int_ref)arg2, (int_ref)arg3, (int_ref)arg4, (int_ref)arg5, (int_ref)arg6) → None:
Get the range of indices with non-dummy data.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.4.0.

Note:

Find the non-dummy volume of a VOX object. If the voxel is all dummies,
returns iMAX for the minima, and iMIN for the maxima.
get_limits_xyz((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:
Get the range in true XYZ of non-dummy data.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.4.0.

Note:

Find the non-dummy volume of a VOX in true (X, Y, Z). This method
works for voxels which are rotated or oriented in 3D, and returns
the true min and max X, Y and Z limits in the data.
The bounds are the bounds for the voxel
center points. If the voxel is all dummies,
returns rMAX for the minima, and rMIN for the maxima.
get_location((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6) → None:
Get Location information
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

get_location_points((GXVV)arg1, (GXVV)arg2, (GXVV)arg3) → None:
Get the computed location points.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

get_meta((GXMETA)arg1) → None:
Get the metadata of a voxel.
Parameters:arg1 (geosoft.gxapi.GXMETA) – META object to save VOX’s meta to
Returns:Nothing
Return type:None

New in version 6.2.0.

get_simple_location((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:
Get Simple Location information
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

get_stats() → GXST:
Get precomputed statistics on this object.
Returns:ST object
Return type:geosoft.gxapi.GXST

New in version 6.2.0.

get_tpat((GXTPAT)arg1) → None:
Get a copy of a thematic voxel's TPAT object.
Parameters:arg1 (geosoft.gxapi.GXTPAT) – TPAT object to get
Returns:Nothing
Return type:None

New in version 7.0.0.

Note:

Each row in the TPAT object corresponds to a stored index
value in the thematic voxel. The TPAT should NOT be modified
by the addition or deletion of items, if it is to be
restored into the VOX object, but the CODE, LABEL, DESCRIPTION
or COLOR info can be changed.
The TPAT object is stored inside the VOX META object.
static grid_points((str)arg1, (str)arg2, (float)arg3, (int)arg4, (float)arg5, (float)arg6, (int)arg7, (int)arg8, (int)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (int)arg15, (GXVV)arg16, (GXVV)arg17, (GXVV)arg18, (GXVV)arg19, (GXIPJ)arg20) → GXVOX:
Grid a VOX from point VV's.
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (str) – Name of error VOX (“” for none)
  • arg3 (float) – Cell size (DUMMY for default)
  • arg4 (int) – Variogram Only
  • arg5 (float) – Minimum Search Radius (DUMMY for none)
  • arg6 (float) – Maximum Search Radius (DUMMY for none)
  • arg7 (int) – Minimum Search Points
  • arg8 (int) – Maximum Search Points
  • arg9 (int) – Model number 1-power, 2-sperical, 3-gaussian, 4-exponential
  • arg10 (float) – Power
  • arg11 (float) – Slope
  • arg12 (float) – Range
  • arg13 (float) – Nugget
  • arg14 (float) – Sill
  • arg15 (int) – GS_TYPES constants
  • arg16 (geosoft.gxapi.GXVV) – X VV
  • arg17 (geosoft.gxapi.GXVV) – Y VV
  • arg18 (geosoft.gxapi.GXVV) – Z VV
  • arg19 (geosoft.gxapi.GXVV) – Data VV
  • arg20 (geosoft.gxapi.GXIPJ) – IPJ
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 6.2.0.

static grid_points_z((str)arg1, (str)arg2, (float)arg3, (str)arg4, (int)arg5, (float)arg6, (float)arg7, (int)arg8, (int)arg9, (int)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (float)arg15, (int)arg16, (GXVV)arg17, (GXVV)arg18, (GXVV)arg19, (GXVV)arg20, (GXIPJ)arg21) → GXVOX:
Grid a VOX from point VV's (using variable Z's)
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (str) – Name of error VOX (“” for none)
  • arg3 (float) – Cell size (DUMMY for default)
  • arg4 (str) – Cell size in Z (“” for default)
  • arg5 (int) – Variogram Only
  • arg6 (float) – Minimum Search Radius (DUMMY for none)
  • arg7 (float) – Maximum Search Radius (DUMMY for none)
  • arg8 (int) – Minimum Search Points
  • arg9 (int) – Maximum Search Points
  • arg10 (int) – Model number 1-power, 2-sperical, 3-gaussian, 4-exponential
  • arg11 (float) – Power
  • arg12 (float) – Slope
  • arg13 (float) – Range
  • arg14 (float) – Nugget
  • arg15 (float) – Sill
  • arg16 (int) – GS_TYPES constants
  • arg17 (geosoft.gxapi.GXVV) – X VV
  • arg18 (geosoft.gxapi.GXVV) – Y VV
  • arg19 (geosoft.gxapi.GXVV) – Z VV
  • arg20 (geosoft.gxapi.GXVV) – Data VV
  • arg21 (geosoft.gxapi.GXIPJ) – IPJ
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 6.4.0.

static grid_points_z_ex((str)arg1, (str)arg2, (float)arg3, (str)arg4, (int)arg5, (float)arg6, (float)arg7, (int)arg8, (int)arg9, (int)arg10, (float)arg11, (float_ref)arg12, (float_ref)arg13, (float)arg14, (float_ref)arg15, (float)arg16, (float)arg17, (float)arg18, (float)arg19, (float)arg20, (int)arg21, (GXVV)arg22, (GXVV)arg23, (GXVV)arg24, (GXVV)arg25, (GXIPJ)arg26) → GXVOX:
Grid a VOX from point VV's (using variable Z's)
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (str) – Name of error VOX (“” for none)
  • arg3 (float) – Cell size (DUMMY for default)
  • arg4 (str) – Cell size in Z (“” for default)
  • arg5 (int) – Variogram Only
  • arg6 (float) – Minimum Search Radius (DUMMY for none)
  • arg7 (float) – Maximum Search Radius (DUMMY for none)
  • arg8 (int) – Minimum Search Points
  • arg9 (int) – Maximum Search Points
  • arg10 (int) – Model number 1-power, 2-sperical, 3-gaussian, 4-exponential
  • arg11 (float) – Power
  • arg12 (geosoft.gxapi.float_ref) – Slope
  • arg13 (geosoft.gxapi.float_ref) – Range
  • arg14 (float) – Nugget
  • arg15 (geosoft.gxapi.float_ref) – Sill
  • arg16 (float) – Strike
  • arg17 (float) – Dip
  • arg18 (float) – Plunge
  • arg19 (float) – Strike Weight
  • arg20 (float) – Dip Plane Weight
  • arg21 (int) – GS_TYPES constants
  • arg22 (geosoft.gxapi.GXVV) – X VV
  • arg23 (geosoft.gxapi.GXVV) – Y VV
  • arg24 (geosoft.gxapi.GXVV) – Z VV
  • arg25 (geosoft.gxapi.GXVV) – Data VV
  • arg26 (geosoft.gxapi.GXIPJ) – IPJ
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 6.4.0.

static init_generate_by_subset_pg((int)arg1, (int)arg2, (int)arg3, (int)arg4) → GXVOX:
Initialize the generate of a VOX from a series of 3D subset pagers
Parameters:
  • arg1 (int) – GS_TYPES constants
  • arg2 (int) – Points in X
  • arg3 (int) – Points in Y
  • arg4 (int) – Points in Z
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 8.5.0.

Note:

Call geosoft.gxapi.GXVOX.init_generate_by_subset_pg() first, then add a series of subset PGs using geosoft.gxapi.GXVOX.add_generate_by_subset_pg(), and finally
serialize using geosoft.gxapi.GXVOX.end_generate_by_subset_pg()
invert_z((str)arg1) → None:
Convert an inverted voxel to normal orientation
Parameters:arg1 (str) – Output voxel file name.
Returns:Nothing
Return type:None

New in version 8.4.

is_null() → bool

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

Returns:True if this is a null instance of geosoft.gxapi.GXVOX, False otherwise.
Return type:bool`
is_thematic() → int:
Is this a thematic voxel?
Returns:1 if VOX is thematic
Return type:int

New in version 7.0.0.

Note:

A thematic voxel is one where the stored integer values
represent indices into an internally stored TPAT object.
Thematic voxels contain their own color definitions, and
normal numerical operations, such as applying ITRs for display,
are not valid.
is_vector_voxel() → int:
Is this a vector voxel?
Returns:1 if VOX is a vector voxel
Return type:int

New in version 8.2.0.

Note:

A vector voxel is one where each data element consists of 3 4-byte float values.
Vector voxels normally have the file type "geosoft_vectorvoxel".
static krig((str)arg1, (float)arg2, (int)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6, (GXVV)arg7, (GXIPJ)arg8, (GXREG)arg9) → GXVOX:
A more compact and extensible form of geosoft.gxapi.GXVOX.log_grid_points_z_ex().
Parameters:
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 8.2.0.

Note:

Optional Parameters.

If these values are not set in the REG, then default parameters will be used.

ERROR_VOXEL:            Name of error VOX ("" for none)
CELLSIZEZ:      Z Cell size string (space delimited, "" for default)
RADIUS_MIN:             Minimum Search Radius (REAL) (Default = 4) (Blanking Distance)
RADIUS_MAX:             Maximum Search Radius (REAL) (Default = 16)
SEARCH_MIN:             Minimum Search Points (INT) (Default = 16)
SEARCH_MAX:             Maximum Search Points (INT) (Default = 32)
VARIOGRAM_ONLY: Set to 1 to calculate the variogram only (INT) (Default = 0)
MODEL:                          Variogram Model number 1-power, 2-sperical, 3-gaussian, 4-exponential  (INT) (Default = 2)
POWER:          Power (Default = DUMMY)
SLOPE:          Slope (REAL) (if input is DUMMY, value calculated and set on return)
RANGE:          Range (REAL) (if input is DUMMY, value calculated and set on return)
SILL :          Sill (REAL) (if input is DUMMY, value calculated and set on return)
STRIKE:                         Strike (REAL) (Default = 0)
DIP:                                    Dip (REAL)      (Default = 90)
PLUNGE:                         Plunge (REAL) (Default = 0)
STRIKE WEIGHT:  Along-Strike Weight (REAL) (Default = 1)
DIP_WEIGHT:      Down-Dip Weight (REAL) (Default = 1)
LOG_OPT:                        One of VOX_GRID_LOGOPT (Default = 0)
MIN_LOG:                        Log Minimum (REAL)      (Default = 1)
MIN_X:                          Minimum X (REAL) (default = DUMMY to determine from the data. If input, nearest lt. or eq. multiple of cell size chosen)
MAX_X:                          Maximum X (REAL) (default = DUMMY to determine from the data. If input, nearest gt. or eq. multiple of cell size chosen)
MIN_Y:                          Minimum Y (REAL) (default = DUMMY to determine from the data. If input, nearest lt. or eq. external multiple of cell size chosen)
MAX_Y:                          Maximum Y (REAL) (default = DUMMY to determine from the data. If input, nearest gt. or eq. multiple of cell size chosen)
MIN_Z:                          Minimum Z (REAL) (default = DUMMY to determine from the data. If input, nearest lt. or eq. multiple of cell size chosen)
MAX_Z:                          Maximum Z (REAL) (default = DUMMY to determine from the data. If input, nearest gt. or eq. multiple of cell size chosen)A more compact and extensible form of geosoft.gxapi.GXVOX.log_grid_points_z_ex(). Only the most
basic parameters are entered directly. Optional parameters are passed via a REG object.
static list_gocad_properties((str)arg1, (GXLST)arg2) → GXVOX:
List all the properties available in this GOCAD file.
Parameters:
  • arg1 (str) – Name of GOCAD Voxel file
  • arg2 (geosoft.gxapi.GXLST) – List object to populate
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 6.2.0.

static log_grid_points_z_ex((str)arg1, (str)arg2, (float)arg3, (str)arg4, (int)arg5, (float)arg6, (float)arg7, (int)arg8, (int)arg9, (int)arg10, (float)arg11, (float_ref)arg12, (float_ref)arg13, (float)arg14, (float_ref)arg15, (float)arg16, (float)arg17, (float)arg18, (float)arg19, (float)arg20, (int)arg21, (float)arg22, (int)arg23, (GXVV)arg24, (GXVV)arg25, (GXVV)arg26, (GXVV)arg27, (GXIPJ)arg28) → GXVOX:
Log grid a VOX from point VV's (using variable Z's)
Parameters:
  • arg1 (str) – Name of output VOX
  • arg2 (str) – Name of error VOX (“” for none)
  • arg3 (float) – Cell size (DUMMY for default)
  • arg4 (str) – Cell size in Z (“” for default)
  • arg5 (int) – Variogram Only
  • arg6 (float) – Minimum Search Radius (DUMMY for none)
  • arg7 (float) – Maximum Search Radius (DUMMY for none)
  • arg8 (int) – Minimum Search Points
  • arg9 (int) – Maximum Search Points
  • arg10 (int) – Model number 1-power, 2-sperical, 3-gaussian, 4-exponential
  • arg11 (float) – Power
  • arg12 (geosoft.gxapi.float_ref) – Slope
  • arg13 (geosoft.gxapi.float_ref) – Range
  • arg14 (float) – Nugget
  • arg15 (geosoft.gxapi.float_ref) – Sill
  • arg16 (float) – Strike
  • arg17 (float) – Dip
  • arg18 (float) – Plunge
  • arg19 (float) – Strike Weight
  • arg20 (float) – Dip Plane Weight
  • arg21 (int) – VOX_GRID_LOGOPT constants Log Option
  • arg22 (float) – Minimum log
  • arg23 (int) – GS_TYPES constants
  • arg24 (geosoft.gxapi.GXVV) – X VV
  • arg25 (geosoft.gxapi.GXVV) – Y VV
  • arg26 (geosoft.gxapi.GXVV) – Z VV
  • arg27 (geosoft.gxapi.GXVV) – Data VV
  • arg28 (geosoft.gxapi.GXIPJ) – IPJ
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 7.2.0.

static math((str)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5, (GXLST)arg6) → GXVOX:
Produces a new voxes using a formula on existing voxels/Grids
Parameters:
  • arg1 (str) – Master VOX Name
  • arg2 (str) – Master VOX Variable Name
  • arg3 (str) – Output VOX Name
  • arg4 (str) – Output VOX Variable Name
  • arg5 (str) – Formula
  • arg6 (geosoft.gxapi.GXLST) – List of Voxels/Grids to use as inputs
Returns:

VOXEL handle
Return type:

geosoft.gxapi.GXVOX

New in version 6.3.0.

Note:

The input voxels must all be of the same type.
merge((GXVOX)arg1, (GXREG)arg2, (str)arg3) → None:
Merge two Voxels.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.3.0.

static nearest_neighbour_grid((str)arg1, (float)arg2, (float)arg3, (int)arg4, (GXVV)arg5, (GXVV)arg6, (GXVV)arg7, (GXVV)arg8, (GXIPJ)arg9) → GXVOX:
Grid a VOX from point VV's using the Nearest Neighbours method.
Parameters:
Returns:

VOX Object
Return type:

geosoft.gxapi.GXVOX

New in version 7.0.0.

static null() → GXVOX

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

Returns:A null geosoft.gxapi.GXVOX
Return type:geosoft.gxapi.GXVOX
re_grid((GXVOX)arg1, (GXREG)arg2, (str)arg3) → None:
Regrid a Voxel.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.3.0.

resample_pg((GXIPJ)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (int)arg8, (int)arg9, (int)arg10, (float)arg11, (float)arg12, (int)arg13) → GXPG:
Resample a voxel over an input volume to a PG.
Parameters:
  • arg1 (geosoft.gxapi.GXIPJ) – Projection to use for Origin, Spacing values
  • arg2 (float) – Origin X
  • arg3 (float) – Origin Y
  • arg4 (float) – Origin Z
  • arg5 (float) – Spacing in X
  • arg6 (float) – Spacing in Y
  • arg7 (float) – Spacing in Z
  • arg8 (int) – Samples in X
  • arg9 (int) – Samples in Y
  • arg10 (int) – Samples in Z
  • arg11 (float) – Minimum Z to resample (can be rDUMMY)
  • arg12 (float) – Maximum Z to resample (can be rDUMMY)
  • arg13 (int) – VOX_SLICE_MODE constants
Returns:

PG object, terminates on error
Return type:

geosoft.gxapi.GXPG

New in version 8.0.0.

Note:

Creates and dummies a PG object based on the input
dimensions, then resamples the voxel to the pager
at the locations determined by input projection, origin and spacings.
rescale_cell_sizes((float)arg1) → None:
Multiply all cell sizes by a fixed factor.
Parameters:arg1 (float) – Scaling factor (>0)
Returns:Nothing
Return type:None

New in version 7.3.0.

Note:

This is useful, for instance for converting sizes in one
unit to sizes in another unit if changing the projection
and the projection's unit changes, since the voxel inherits
its projection's units.
sample_cdi((GXDB)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6, (int)arg7, (int)arg8, (str)arg9) → None:
Sample a voxel at locations/elevations in a CDI database.
Parameters:
  • arg1 (geosoft.gxapi.GXDB) – CDI Database handle
  • arg2 (int) – Line handle
  • arg3 (int) – X channel handle
  • arg4 (int) – Y channel handle
  • arg5 (int) – depth array channel handle
  • arg6 (int) – depths sign: 0 - positive down, 1 - negative down
  • arg7 (int) – elevation channel handle (can be NULLSYMB)
  • arg8 (int) – interpolation mode: 0 - linear, 1 - nearest
  • arg9 (str) – Output channel name
Returns:

Nothing
Return type:

None

New in version 7.2.0.

Note:

A "CDI" database does not need to be conductivity/depth.
It normally contains an array channel of depth values for
each (X, Y) location, with corresponding data array channels of
values taken at those (X, Y, Z) locations.
If the optional elevation channel is used, its value is used as an
offset to the depth channel values. Depths are positive down by
default; use the "Negative depths down" parameter if the depths
become more negative as you go deeper.
sample_cdi_to_topography((GXDB)arg1, (int)arg2, (int)arg3, (int)arg4, (GXVV)arg5, (int)arg6, (str)arg7, (str)arg8) → None:
Sample a voxel at fixed elevations along a path in a CDI database, and output them to an array channel, deleting leading dummy values, and
writing the elevation of the first non-dummy item to a topography channel.
Parameters:
  • arg1 (geosoft.gxapi.GXDB) – CDI Database handle
  • arg2 (int) – Line handle
  • arg3 (int) – X channel handle
  • arg4 (int) – Y channel handle
  • arg5 (geosoft.gxapi.GXVV) – Z values to sample at each X, Y
  • arg6 (int) – interpolation mode: 0 - linear, 1 - nearest
  • arg7 (str) – Output data array channel name
  • arg8 (str) – Output topography channel name
Returns:

Nothing
Return type:

None

New in version 8.2.

sample_vv((GXVV)arg1, (GXVV)arg2, (GXVV)arg3, (int)arg4, (GXVV)arg5) → None:
Sample a voxel at multiple locations.
Parameters:
Returns:

Nothing
Return type:

None

New in version 8.2.0.

Note:

Sample at voxel at XYZ locations input in VVs. Values returned in a VV.
set_cell_size_strings((str)arg1, (str)arg2, (str)arg3) → int:
Set the Location Strings
Parameters:
  • arg1 (str) – X String
  • arg2 (str) – Y String
  • arg3 (str) – Z String
Returns:

0 - Ok 1 - Invalid data
Return type:

int

New in version 6.3.1.

set_ipj((GXIPJ)arg1) → None:
Set the projection of the voxel.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ object to save VOX’s meta to
Returns:Nothing
Return type:None

New in version 6.2.0.

set_location((float)arg1, (float)arg2, (float)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6) → None:
Set Location information
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

set_meta((GXMETA)arg1) → None:
Set the metadata of a voxel.
Parameters:arg1 (geosoft.gxapi.GXMETA) – META object to add to VOX’s meta
Returns:Nothing
Return type:None

New in version 6.2.0.

set_origin((int)arg1, (float)arg2, (float)arg3, (float)arg4) → None:
Set the Voxel Origin
Parameters:
  • arg1 (int) – Type of origin being set VOX_ORIGIN constants
  • arg2 (float) – Origin X
  • arg3 (float) – Origin Y
  • arg4 (float) – Origin Z
Returns:

Nothing
Return type:

None

New in version 6.3.1.

set_simple_location((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Set Simple Location information
Parameters:
  • arg1 (float) – Origin X
  • arg2 (float) – Origin Y
  • arg3 (float) – Origin Z
  • arg4 (float) – Cell Sizes in X (rDUMMY if not changed)
  • arg5 (float) – Cell Sizes in Y (rDUMMY if not changed)
  • arg6 (float) – Cell Sizes in Z (rDUMMY if not changed)
Returns:

Nothing
Return type:

None

New in version 6.2.0.

set_tpat((GXTPAT)arg1) → None:
Set a thematic voxel's TPAT object.
Parameters:arg1 (geosoft.gxapi.GXTPAT) – TPAT object to store
Returns:Nothing
Return type:None

New in version 7.0.0.

Note:

Each row in the TPAT object corresponds to a stored index
value in the thematic voxel. The TPAT should NOT be modified
by the addition or deletion of items, if it is to be
restored into the VOX object, but the CODE, LABEL, DESCRIPTION
or COLOR info can be changed.
The TPAT object is stored inside the VOX META object.
slice_ipj((str)arg1, (GXIPJ)arg2, (int)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (int)arg8, (int)arg9) → None:
Extract a slice of a voxel based on an IPJ
Parameters:
  • arg1 (str) – Grid Name
  • arg2 (geosoft.gxapi.GXIPJ) – Grid IPJ (includes orientation, etc)
  • arg3 (int) – VOX_SLICE_MODE constants
  • arg4 (float) – Grid Origin X
  • arg5 (float) – Grid Origin Y
  • arg6 (float) – Grid Cell Size in X
  • arg7 (float) – Grid Cell Size in Y
  • arg8 (int) – Grid cells in X
  • arg9 (int) – Grid cells in Y
Returns:

Nothing
Return type:

None

New in version 6.3.0.

slice_multi_layer_ipj((str)arg1, (GXIPJ)arg2, (int)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (int)arg8, (int)arg9, (int)arg10, (float)arg11, (float)arg12) → None:
Extract multiple slices of a voxel based on an IPJ
Parameters:
  • arg1 (str) – Grid Name
  • arg2 (geosoft.gxapi.GXIPJ) – Grid IPJ (includes orientation, etc)
  • arg3 (int) – VOX_SLICE_MODE constants
  • arg4 (float) – Grid Origin X
  • arg5 (float) – Grid Origin Y
  • arg6 (float) – Grid Cell Size in X
  • arg7 (float) – Grid Cell Size in Y
  • arg8 (int) – Grid cells in X
  • arg9 (int) – Grid cells in Y
  • arg10 (int) – Number of layers to extract
  • arg11 (float) – Start elevation
  • arg12 (float) – Elevation increment
Returns:

Nothing
Return type:

None

New in version 8.4.0.

subset_to_double_extents((str)arg1) → None:
Subset a VOX to real extents.
Parameters:arg1 (str) – Output voxel file name.
Returns:Nothing
Return type:None

New in version 7.3.0.

static sync((str)arg1) → None:
Syncronize the Metadata for this Voxel
Parameters:arg1 (str) – voxel name
Returns:Nothing
Return type:None

New in version 7.0.0.

static tin_grid_db((str)arg1, (GXDB)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6, (int)arg7, (GXVV)arg8, (GXREG)arg9) → None:
geosoft.gxapi.GXVOX.tin_grid_db()   TIN-Gridding, DB version, 3D.
Parameters:
  • arg1 (str) – Output voxel name
  • arg2 (geosoft.gxapi.GXDB) – Database
  • arg3 (int) – X Channel [READONLY]
  • arg4 (int) – Y Channel [READONLY]
  • arg5 (int) – Z Channel [READONLY]
  • arg6 (int) – Data Channel [READONLY]
  • arg7 (int) – Gridding method (0: Linear, 1: Natural Neighbour, 2: Nearest Neightbour
  • arg8 (geosoft.gxapi.GXVV) – Z Cell sizes (bottom to top)
  • arg9 (geosoft.gxapi.GXREG) – Parameters (see above)
Returns:

Nothing
Return type:

None

New in version 8.5.0.

Note:

Designed for data in array channels position vertically at single XY locations.
Creates a TIN using the XY locations and uses the coefficients for the top layer on
each layer below to make it efficient.

REG Parameters:

X0, Y0, Z0, DX, DY, DZ: Voxel origin, and cell sizes (required)
NX, NY, NZ: Voxel dimensions.
DZ and NZ are used only if the input cell sizes VV is of zero length.
window_ply((GXPLY)arg1, (int)arg2, (float)arg3, (float)arg4, (str)arg5, (int)arg6) → None:
Window a VOX to a PLY file and Z.
Parameters:
  • arg1 (geosoft.gxapi.GXPLY) – PLY object
  • arg2 (int) – Mask (0: inside PLY, 1: outside PLY)
  • arg3 (float) – Minimum Z (optional, rDUMMY for no minimum)
  • arg4 (float) – Maximum Z (optional, rDUMMY for no maximun)
  • arg5 (str) – Output voxel file name.
  • arg6 (int) – Clip extents to remove dummies (0: no (same size), 1: yes (smaller))
Returns:

Nothing
Return type:

None

New in version 7.3.0.

Note:

The voxel is windowed horizontally to the input PLY file.
Optionally, it will be windowed to the input Z range as well.
The output can be clipped to the non-dummied cells.
window_xyz((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (str)arg7, (int)arg8) → None:
Window a VOX to ranges in X, Y and Z.
Parameters:
  • arg1 (float) – Minimum X (optional, rDUMMY for no minimum)
  • arg2 (float) – Minimum Y (optional, rDUMMY for no minimum)
  • arg3 (float) – Minimum Z (optional, rDUMMY for no minimum)
  • arg4 (float) – Maximum X (optional, rDUMMY for no maximun)
  • arg5 (float) – Maximum Y (optional, rDUMMY for no maximun)
  • arg6 (float) – Maximum Z (optional, rDUMMY for no maximun)
  • arg7 (str) – Output voxel file name.
  • arg8 (int) – Clip extents to remove dummies (0: no (same size), 1: yes (smaller))
Returns:

Nothing
Return type:

None

New in version 7.3.0.

Note:

The six minima and maxima are optional.
The output can be clipped to the non-dummied cells.
write_xml((str)arg1) → None:
Export the VOX to XML
Parameters:arg1 (str) – XML file to create
Returns:Nothing
Return type:None

New in version 6.2.0.

VOX_DIR constants

Voxel direction
gxapi.VOX_DIR_XY = 0
X/Y Plane (Fastest)
gxapi.VOX_DIR_XZ = 1
X/Z Plane (Middle)
gxapi.VOX_DIR_YZ = 2
Y/Z Plane (Slowest)

VOX_DIRECTION constants

Voxel export direction
gxapi.VOX_3D_DIR_XYZ = 0
XYZ
gxapi.VOX_3D_DIR_YXZ = 1
YXZ
gxapi.VOX_3D_DIR_XZY = 2
XZY
gxapi.VOX_3D_DIR_YZX = 3
YZX
gxapi.VOX_3D_DIR_ZXY = 4
ZXY
gxapi.VOX_3D_DIR_ZYX = 5
ZYX

VOX_FILTER3D constants

Voxel filter type
gxapi.VOX_FILTER3D_FILE = 0
Specify a file containing the 27-point filter
gxapi.VOX_FILTER3D_SMOOTHING = 1
Smoothing filter
gxapi.VOX_FILTER3D_LAPLACE = 2
Laplace filter
gxapi.VOX_FILTER3D_X_GRADIENT = 3
X-Gradient filter
gxapi.VOX_FILTER3D_Y_GRADIENT = 4
Y-Gradient filter
gxapi.VOX_FILTER3D_Z_GRADIENT = 5
Z-Gradient filter
gxapi.VOX_FILTER3D_TOTAL_GRADIENT = 6
Total-Gradient filter

VOX_GOCAD_ORIENTATION constants

GOCAD Orientations
gxapi.VOX_GOCAD_ORIENTATIONS_NORMAL = 0
Normal
gxapi.VOX_GOCAD_ORIENTATIONS_INVERTED = 1
Inverted (Z)
gxapi.VOX_GOCAD_ORIENTATIONS_NORMAL_ZFIRST = 2
Normal (ZFirst)
gxapi.VOX_GOCAD_ORIENTATIONS_INVERTED_ZFIRST = 3
Inverted (Z) (ZFirst)

VOX_GRID_LOGOPT constants

Voxel log gridding options
gxapi.VOX_GRID_LOGOPT_LINEAR = 0
linear
gxapi.VOX_GRID_LOGOPT_LOG_SAVELINEAR = -1
log, save as linear
gxapi.VOX_GRID_LOGOPT_LOGLINEAR_SAVELINEAR = -2
log-linear, save as linear
gxapi.VOX_GRID_LOGOPT_LOG_SAVELOG = 1
log, save as log
gxapi.VOX_GRID_LOGOPT_LOGLINEAR_SAVELOG = 2
log-linear, save as log

VOX_ORIGIN constants

Voxel origin
gxapi.VOX_ORIGIN_BOTTOM = 0
Bottom corner (standard Geosoft)
gxapi.VOX_ORIGIN_TOP = 1
Top corner

VOX_SLICE_MODE constants

Voxel export direction
gxapi.VOX_SLICE_MODE_LINEAR = 1
Linear
gxapi.VOX_SLICE_MODE_NEAREST = 0
Nearest

VOX_VECTORVOX_IMPORT constants

Voxel direction
gxapi.VOX_VECTORVOX_XYZ = 0
X, Y and Z
gxapi.VOX_VECTORVOX_UVW = 1
U, V and W
gxapi.VOX_VECTORVOX_AID = 2
Amplitude, Inclination and Declination