GXMULTIVOXSET class¶

class GXMULTIVOXSET(handle=0)¶

GXMULTIVOXSET class.

High Performance 3D Grid.

classmethod check_equal_to_legacy_voxel(voxel_file, legacy_voxel_file)¶

Compare GXMULTIVOXSET to Legacy Voxel

Parameters:	voxel_file (str) – Voxel file legacy_voxel_file (str) – Legacy Voxel file

New in version 9.3.

License: Geosoft Open License

classmethod compute_default_cell_size(min_x, max_x, min_y, max_y, min_z, max_z)¶

Used if the user does not provide a default cell size.

Parameters:	min_x (float) – MinX max_x (float) – MaxX min_y (float) – MinY max_y (float) – MaxY min_z (float) – MinZ max_z (float) – MaxZ
Returns:	Default Cell Size
Return type:	float

New in version 9.3.

License: Geosoft End-User License

Note: Compute a default cell size for a voxel given a data range.

classmethod convert_double_to_vector(x_file_name, y_file_name, z_file_name, out_file_name, inclination, declination, rotated)¶

Convert 3 Double Voxels to a Vector Voxel

Parameters:	x_file_name (str) – Input X Voxel file y_file_name (str) – Input Y Voxel file z_file_name (str) – Input Z Voxel file out_file_name (str) – Output Vector Voxel file inclination (float) – Inclination declination (float) – Declination rotated (bool) – Rotated?

New in version 9.3.

License: Geosoft Open License

classmethod convert_vector_to_double(file_name, x_file_name, y_file_name, z_file_name, rotated)¶

Convert a Vector Voxel to 3 double Voxels

Parameters:	file_name (str) – Input Vector Voxel file x_file_name (str) – Output X Voxel file y_file_name (str) – Output Y Voxel file z_file_name (str) – Output Z Voxel file rotated (bool) – Rotated?

New in version 9.3.

License: Geosoft Open License

classmethod create_double_constant(name, value, ox, oy, oz, cell_x, cell_y, cell_z, size_x, size_y, size_z, ipj)¶

Generate a double MultiVoxset with a constant value

Parameters:

name (str) – Name of output Voxel File
value (float) – Constant Value to use - DUMMY for a trully sparse voxel
ox (float) – Origin X
oy (float) – Origin Y
oz (float) – Origin Z
cell_x (float) – Cell Size X
cell_y (float) – Cell Size Y
cell_z (float) – Cell Size Z
size_x (int) – Cell Count X
size_y (int) – Cell Count Y
size_z (int) – Cell Count Z
ipj (GXIPJ) – Projection

New in version 9.3.

License: Geosoft Open License

classmethod create_double_constant_vv(name, value, ox, oy, oz, cx, cy, cz, ipj)¶

Generate a double MultiVoxset with a constant value and non-uniform cell sizes

Parameters:	name (str) – Name of output Voxel value (float) – The contant Value to fill with - DUMMY for a trully sparse voxel ox (float) – Origin X oy (float) – Origin Y oz (float) – Origin Z cx (GXVV) – Cell Sizes X cy (GXVV) – Cell Sizes Y cz (GXVV) – Cell Sizes Z ipj (GXIPJ) – Projection

New in version 9.3.

License: Geosoft Open License

classmethod create_thematic_constant(name, value, ox, oy, oz, cell_x, cell_y, cell_z, size_x, size_y, size_z, ipj)¶

Generate a double MultiVoxset with a constant value

Parameters:

name (str) – Name of output Voxel File
value (int) – Constant Value to use - DUMMY for a trully sparse voxel
ox (float) – Origin X
oy (float) – Origin Y
oz (float) – Origin Z
cell_x (float) – Cell Size X
cell_y (float) – Cell Size Y
cell_z (float) – Cell Size Z
size_x (int) – Cell Count X
size_y (int) – Cell Count Y
size_z (int) – Cell Count Z
ipj (GXIPJ) – Projection

New in version 9.3.

License: Geosoft Open License

classmethod create_thematic_constant_vv(name, value, ox, oy, oz, cx, cy, cz, ipj)¶

Generate a double MultiVoxset with a constant value and non-uniform cell sizes

Parameters:	name (str) – Name of output Voxel value (int) – The contant Value to fill with - DUMMY for a trully sparse voxel ox (float) – Origin X oy (float) – Origin Y oz (float) – Origin Z cx (GXVV) – Cell Sizes X cy (GXVV) – Cell Sizes Y cz (GXVV) – Cell Sizes Z ipj (GXIPJ) – Projection

New in version 9.3.

License: Geosoft Open License

classmethod create_vector_constant(name, value_x, value_y, value_z, ox, oy, oz, cell_x, cell_y, cell_z, size_x, size_y, size_z, ipj)¶

Generate a double MultiVoxset with a constant value

Parameters:

name (str) – Name of output Voxel File
value_x (float) – X Constant Value to use - DUMMY for a trully sparse voxel
value_y (float) – Y Constant Value to use - DUMMY for a trully sparse voxel
value_z (float) – Z Constant Value to use - DUMMY for a trully sparse voxel
ox (float) – Origin X
oy (float) – Origin Y
oz (float) – Origin Z
cell_x (float) – Cell Size X
cell_y (float) – Cell Size Y
cell_z (float) – Cell Size Z
size_x (int) – Cell Count X
size_y (int) – Cell Count Y
size_z (int) – Cell Count Z
ipj (GXIPJ) – Projection

New in version 9.3.

License: Geosoft Open License

classmethod create_vector_constant_vv(name, x_value, y_value, z_value, ox, oy, oz, cx, cy, cz, ipj)¶

Generate a double MultiVoxset with a constant value and non-uniform cell sizes

Parameters:

name (str) – Name of output Voxel
x_value (float) – The X contant Value to fill with - DUMMY for a trully sparse voxel
y_value (float) – The Y contant Value to fill with - DUMMY for a trully sparse voxel
z_value (float) – The Z contant Value to fill with - DUMMY for a trully sparse voxel
ox (float) – Origin X
oy (float) – Origin Y
oz (float) – Origin Z
cx (GXVV) – Cell Sizes X
cy (GXVV) – Cell Sizes Y
cz (GXVV) – Cell Sizes Z
ipj (GXIPJ) – Projection

New in version 9.3.

License: Geosoft Open License

classmethod export_to_binary(voxel_file, binary_file, dir, rev_x, rev_y, rev_z, swap, output_type)¶

Export contents of GXMULTIVOXSET to a Binary File.

Parameters:	voxel_file (str) – Input Voxel file binary_file (str) – Binary file to write to dir (int) – DIRECTION3D constants rev_x (bool) – Reverse X? rev_y (bool) – Reverse Y? rev_z (bool) – Reverse Z? swap (bool) – Swap Bytes? output_type (int) – Output Type (Geosoft Type)

New in version 9.3.

License: Geosoft End-User License

classmethod export_to_gdb(voxel_file, db, chan, dir, rev_x, rev_y, rev_z, dummies)¶

Export To GDB

Parameters:	voxel_file (str) – Input Voxel file db (GXDB) – Database chan (str) – Channel Name dir (int) – DIRECTION3D constants rev_x (bool) – Reverse X? rev_y (bool) – Reverse Y? rev_z (bool) – Reverse Z? dummies (bool) – Write Dummies?

New in version 9.3.

License: Geosoft Open License

classmethod export_to_segy(voxel_file, voxel_name, output_segy_filename, sample_interval)¶

Export To SEGY

Parameters:	voxel_file (str) – Input Voxel file voxel_name (str) – Voxel Name output_segy_filename (str) – Output Segy file sample_interval (float) – Sampling Internal

New in version 9.3.

License: Geosoft Open License

classmethod export_to_voxel(project_file, multi_voxset_uuid, multi_voxset_attribute, voxel_file)¶

Exports a Multi-Voxset into a Voxel

Parameters:	project_file (str) – Project file multi_voxset_uuid (str) – Multi-Voxset UUID multi_voxset_attribute (str) – Multi-Voxset attribute voxel_file (str) – Output Voxel file

New in version 9.3.

License: Geosoft Open License

classmethod export_to_wa(file_name, wa, dir, rev_x, rev_y, rev_z, dummy)¶

Export To GDB

Parameters:	file_name (str) – Input Voxel file wa (GXWA) – `GXWA` File dir (int) – DIRECTION3D constants rev_x (bool) – Reverse X? rev_y (bool) – Reverse Y? rev_z (bool) – Reverse Z? dummy (str) – The Dummy string to write

New in version 9.3.

License: Geosoft Open License

classmethod export_to_xml(voxel_file, xml_file)¶

Export a GXMULTIVOXSET to XML

Parameters:	voxel_file (str) – Voxel file xml_file (str) – XML file

New in version 9.3.

License: Geosoft Open License

classmethod export_to_xyz(voxel_file, xyz, dir, rev_x, rev_y, rev_z, dummies)¶

Export a GXMULTIVOXSET to an XYZ File

Parameters:	voxel_file (str) – Input Voxel file xyz (str) – File Name dir (int) – DIRECTION3D constants rev_x (bool) – Reverse X? rev_y (bool) – Reverse Y? rev_z (bool) – Reverse Z? dummies (bool) – Write Dummies?

New in version 9.3.

License: Geosoft Open License

classmethod filter(input_file, output_file, filter, filter_file, n_passes, interpolate_dummies)¶

Apply a 3D filter to a voxel.

Parameters:	input_file (str) – Name of the input voxel output_file (str) – Name of the output voxel filter (int) – FILTER3D constants filter_file (str) – Filter file, if filter is `VOX_FILTER3D_FILE` n_passes (int) – Number of filter passes interpolate_dummies (int) – (1: interpolate dummies)

New in version 9.3.

License: Geosoft End-User License

classmethod grid_direct_from_gdb(output_voxel_filename, origin_x, origin_y, origin_z, cell_count_x, cell_count_y, cell_count_z, cell_size_x, cell_size_y, cell_size_z, method, db, x_channel, y_channel, z_channel, data_channel)¶

Create a voxel using direct gridding.

Parameters:

output_voxel_filename (str) – Output voxel filename
origin_x (float) – Voxel origin X
origin_y (float) – Voxel origin Y
origin_z (float) – Voxel origin Z
cell_count_x (int) – Voxel cell count X
cell_count_y (int) – Voxel cell count Y
cell_count_z (int) – Voxel cell count Z
cell_size_x (float) – Voxel cell size X
cell_size_y (float) – Voxel cell size Y
cell_size_z (float) – Voxel cell size Z
method (int) – MULTIVOXSET_DIRECTGRID_METHOD constants
db (GXDB) – Database
x_channel (int) – X channel [DB_LOCK_READONLY]
y_channel (int) – Y channel [DB_LOCK_READONLY]
z_channel (int) – Z channel [DB_LOCK_READONLY]
data_channel (int) – Data channel [DB_LOCK_READONLY]

New in version 9.3.

License: Geosoft End-User License

Note: The Z and Data channels may be array channels. If they are, the array sizes must match.

classmethod import_from_datamine(file, field, ipj, voxel)¶

Create a Geosoft Voxel file from a Datamine block model file.

Parameters:	file (str) – Datamine file name field (str) – Field to use for data ipj (GXIPJ) – Projection to set voxel (str) – Output voxel file name

New in version 9.3.

License: Geosoft End-User License

Note: Create a Geosoft Voxel file from a Datamine block model file.

classmethod import_from_gdb(voxel_file, db, symb)¶

Imports from a Geosoft Database

Parameters:	voxel_file (str) – Name of output Voxel file db (GXDB) – `GXDB` To import from symb (int) – Symbol to import data from

New in version 9.3.

License: Geosoft Open License

classmethod import_from_gocad(name, header, property, ipj, orientation)¶

Imports a MultiVoxset from a GOCAD File

Parameters:	name (str) – Name of output `GXVOX` header (str) – Name of GOCAD Voxel file property (str) – Propert name to import orientation (int) – GOCAD_ORIENTATION constants

New in version 9.3.

License: Geosoft Open License

classmethod import_from_ubc(name, mesh, mod, dummy, ipj)¶

Import UBC file into a MultiVoxset

Parameters:	name (str) – Name of output `GXVOX` mesh (str) – Name of UBC Mesh File mod (str) – Name of UBC Mod File dummy (float) – Dummy Value ipj (GXIPJ) – Projection

New in version 9.3.

License: Geosoft Open License

classmethod import_from_vector_gdb(voxel_file, db, vector_type, symb_x, symb_y, symb_z, inc, dec)¶

Imports from a Vector Geosoft Database

Parameters:

voxel_file (str) – Voxel Name
db (GXDB) – GXDB To import from
vector_type (int) – VECTOR_IMPORTImport XYZ, UVW or Amplitude/Inclination/Declination channels
symb_x (int) – Symbol to import X, U or Amplitude data from
symb_y (int) – Symbol to import Y, V or Inclination data from
symb_z (int) – Symbol to import Z, W or Declination data from
inc (float) – Inclination value for VOX_VECTORVOX_UVW (-90° to 90°)
dec (float) – Declination value for VOX_VECTORVOX_UVW (-180° to 180°)

New in version 9.3.

License: Geosoft Open License

classmethod import_from_voxel(project_file, voxel_file, multi_voxset_attribute, p_uuid_string)¶

Import a Voxel directly into a Multi-Voxset

Parameters:	project_file (str) – Project file voxel_file (str) – Input Voxel file multi_voxset_attribute (str) – Multi-Voxset attribute p_uuid_string (str_ref) – UUID string returned

New in version 9.3.

License: Geosoft Open License

classmethod import_from_xyz(name, ra, type, ipj)¶

Import XYZ file into a Multi-Voxset

Parameters:	name (str) – Name of output Voxel file ra (GXRA) – `GXRA` To import from type (int) – Data Type GS_TYPES constants ipj (GXIPJ) – Projection

New in version 9.3.

License: Geosoft Open License

is_null()¶

Check if this is a null (undefined) instance

Returns:	True if this is a null (undefined) instance, False otherwise.
Return type:	bool

classmethod list_properties_gocad(header, lst)¶

List all the properties available in this GOCAD file.

Parameters:	header (str) – Name of GOCAD Voxel file lst (GXLST) – List object to populate

New in version 9.3.

License: Geosoft Open License

classmethod null()¶

A null (undefined) instance of GXMULTIVOXSET

Returns:	A null `GXMULTIVOXSET`
Return type:	GXMULTIVOXSET

DIRECTION3D constants¶

Direction in 3D

DIRECTION3D_XYZ¶

XYZ

gxapi.DIRECTION3D_XYZ = 0

DIRECTION3D_YXZ¶

YXZ

gxapi.DIRECTION3D_YXZ = 1

DIRECTION3D_XZY¶

XZY

gxapi.DIRECTION3D_XZY = 2

DIRECTION3D_YZX¶

YZX

gxapi.DIRECTION3D_YZX = 3

DIRECTION3D_ZXY¶

ZXY

gxapi.DIRECTION3D_ZXY = 4

DIRECTION3D_ZYX¶

ZYX

gxapi.DIRECTION3D_ZYX = 5

GOCAD_ORIENTATION constants¶

GOCAD Orientations

GOCAD_ORIENTATIONS_NORMAL¶

Normal

gxapi.GOCAD_ORIENTATIONS_NORMAL = 0

GOCAD_ORIENTATIONS_INVERTED¶

Inverted (Z)

gxapi.GOCAD_ORIENTATIONS_INVERTED = 1

GOCAD_ORIENTATIONS_NORMAL_ZFIRST¶

Normal (ZFirst)

gxapi.GOCAD_ORIENTATIONS_NORMAL_ZFIRST = 2

GOCAD_ORIENTATIONS_INVERTED_ZFIRST¶

Inverted (Z) (ZFirst)

gxapi.GOCAD_ORIENTATIONS_INVERTED_ZFIRST = 3

VECTOR_IMPORT constants¶

Vector voxel import direction

VECTOR_IMPORT_XYZ¶

X, Y and Z

gxapi.VECTOR_IMPORT_XYZ = 0

VECTOR_IMPORT_UVW¶

U, V and W

gxapi.VECTOR_IMPORT_UVW = 1

VECTOR_IMPORT_AID¶

Amplitude, Inclination and Declination

gxapi.VECTOR_IMPORT_AID = 2

FILTER3D constants¶

Voxel filter type

FILTER3D_FILE¶

Specify a file containing the 27-point filter

gxapi.FILTER3D_FILE = 0

FILTER3D_SMOOTHING¶

Smoothing filter

gxapi.FILTER3D_SMOOTHING = 1

FILTER3D_LAPLACE¶

Laplace filter

gxapi.FILTER3D_LAPLACE = 2

FILTER3D_X_GRADIENT¶

X-Gradient filter

gxapi.FILTER3D_X_GRADIENT = 3

FILTER3D_Y_GRADIENT¶

Y-Gradient filter

gxapi.FILTER3D_Y_GRADIENT = 4

FILTER3D_Z_GRADIENT¶

Z-Gradient filter

gxapi.FILTER3D_Z_GRADIENT = 5

FILTER3D_TOTAL_GRADIENT¶

Total-Gradient filter

gxapi.FILTER3D_TOTAL_GRADIENT = 6

MULTIVOXSET_DIRECTGRID_METHOD constants¶

How to calculate the cell values for direct gridding.

MULTIVOXSET_DIRECTGRID_MIN¶

Multivoxset directgrid min

gxapi.MULTIVOXSET_DIRECTGRID_MIN = 0

MULTIVOXSET_DIRECTGRID_MAX¶

Multivoxset directgrid max

gxapi.MULTIVOXSET_DIRECTGRID_MAX = 1

MULTIVOXSET_DIRECTGRID_MEAN¶

Multivoxset directgrid mean

gxapi.MULTIVOXSET_DIRECTGRID_MEAN = 2

Table Of Contents

This Page

GXMULTIVOXSET class¶

DIRECTION3D constants¶

GOCAD_ORIENTATION constants¶

VECTOR_IMPORT constants¶

FILTER3D constants¶

MULTIVOXSET_DIRECTGRID_METHOD constants¶