GXMULTIGRID3DUTIL class¶
-
class
GXMULTIGRID3DUTIL
(handle=0)¶ GXMULTIGRID3DUTIL class.
High Performance 3D Grid.
-
classmethod
check_equal_to_legacy_voxel
(grid3d_file, legacy_grid3d_file)¶ Compare
GXMULTIGRID3D
to Legacy VoxelParameters: - grid3d_file (str) – Voxel file
- legacy_grid3d_file (str) – Legacy Voxel file
New in version 9.4.
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.4.
License: Geosoft End-User License
Note: Compute a default cell size for a grid3d given a data range.
-
classmethod
convert_density_to_velocity
(input_grid3d_filename, input_scaling_factor, input_lower_bound, input_upper_bound, a5, a4, a3, a2, a1, a0, output_scaling_factor, output_grid3d_filename)¶ Convert Density MultiVoxset to Velocity MultiVoxset
Parameters: - input_grid3d_filename (str) – Input grid3d filename
- input_scaling_factor (float) – 1.0, if this grid3d is in meters per second. Otherwise, a value by which each input cell is multiplied to convert it into meters per second.
- input_lower_bound (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.
- input_upper_bound (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.
- a5 (float) – Coefficient of fifth-order polynomial term.
- a4 (float) – Coefficient of fourth-order polynomial term.
- a3 (float) – Coefficient of third-order polynomial term.
- a2 (float) – Coefficient of second-order polynomial term.
- a1 (float) – Coefficient of first-order polynomial term.
- a0 (float) – Constant offset of output.
- output_scaling_factor (float) – 1.0, to produce an output grid3d that has units of g/cm^3. If different units are desired, pass in a different value, which will be multiplied into each output grid3d cell.
- output_grid3d_filename (str) – Output grid3d filename
New in version 9.4.
License: Geosoft Open License
-
classmethod
convert_double_to_thematic
(input_grid3d_filename, translate_vv, output_grid3d_filename)¶ Convert Double MultiVoxset to Thematic MultiVoxset
Parameters: - input_grid3d_filename (str) – Input grid3d filename
- translate_vv (GXVV) – Translation VV handle
- output_grid3d_filename (str) – Output grid3d filename
New in version 9.4.
License: Geosoft Open License
-
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.4.
License: Geosoft Open License
-
classmethod
convert_thematic_to_double
(input_grid3d_filename, translate_vv, output_grid3d_filename)¶ Convert Thematic MultiVoxset to Double MultiVoxset
Parameters: - input_grid3d_filename (str) – Input grid3d filename
- translate_vv (GXVV) – Translation VV handle
- output_grid3d_filename (str) – Output grid3d filename
New in version 9.4.
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.4.
License: Geosoft Open License
-
classmethod
convert_velocity_to_density
(input_grid3d_filename, input_scaling_factor, input_lower_bound, input_upper_bound, a5, a4, a3, a2, a1, a0, output_scaling_factor, output_grid3d_filename)¶ Convert Velocity MultiVoxset to Density MultiVoxset
Parameters: - input_grid3d_filename (str) – Input grid3d filename
- input_scaling_factor (float) – 1.0, if this grid3d is in meters per second. Otherwise, a value by which each input cell is multiplied to convert it into meters per second.
- input_lower_bound (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.
- input_upper_bound (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.
- a5 (float) – Coefficient of fifth-order polynomial term.
- a4 (float) – Coefficient of fourth-order polynomial term.
- a3 (float) – Coefficient of third-order polynomial term.
- a2 (float) – Coefficient of second-order polynomial term.
- a1 (float) – Coefficient of first-order polynomial term.
- a0 (float) – Constant offset of output.
- output_scaling_factor (float) – 1.0, to produce an output grid3d that has units of g/cm^3. If different units are desired, pass in a different value, which will be multiplied into each output grid3d cell.
- output_grid3d_filename (str) – Output grid3d filename
New in version 9.4.
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 grid3d
- 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.4.
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: New in version 9.4.
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 grid3d
- 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.4.
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: New in version 9.4.
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 grid3d
- value_y (float) – Y Constant Value to use - DUMMY for a trully sparse grid3d
- value_z (float) – Z Constant Value to use - DUMMY for a trully sparse grid3d
- 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.4.
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 grid3d
- y_value (float) – The Y contant Value to fill with - DUMMY for a trully sparse grid3d
- z_value (float) – The Z contant Value to fill with - DUMMY for a trully sparse grid3d
- 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.4.
License: Geosoft Open License
-
classmethod
export_to_binary
(grid3d_file, binary_file, dir, rev_x, rev_y, rev_z, swap, output_type)¶ Export contents of
GXMULTIGRID3D
to a Binary File.Parameters: - grid3d_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.4.
License: Geosoft End-User License
-
classmethod
export_to_gdb
(grid3d_file, db, chan, dir, rev_x, rev_y, rev_z, dummies)¶ Export To GDB
Parameters: - grid3d_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.4.
License: Geosoft Open License
-
classmethod
export_to_segy
(grid3d_file, grid3d_name, output_segy_filename, sample_interval)¶ Export To SEGY
Parameters: - grid3d_file (str) – Input Voxel file
- grid3d_name (str) – Voxel Name
- output_segy_filename (str) – Output Segy file
- sample_interval (float) – Sampling Internal
New in version 9.4.
License: Geosoft Open License
-
classmethod
export_to_voxel
(project_file, multi_voxset_uuid, multi_voxset_attribute, grid3d_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
- grid3d_file (str) – Output Voxel file
New in version 9.4.
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.4.
License: Geosoft Open License
-
classmethod
export_to_xml
(grid3d_file, xml_file)¶ Export a
GXMULTIGRID3D
to XMLParameters: - grid3d_file (str) – Voxel file
- xml_file (str) – XML file
New in version 9.4.
License: Geosoft Open License
-
classmethod
export_to_xyz
(grid3d_file, xyz, dir, rev_x, rev_y, rev_z, dummies)¶ Export a
GXMULTIGRID3D
to an XYZ FileParameters: - grid3d_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.4.
License: Geosoft Open License
-
classmethod
filter
(input_file, output_file, filter, filter_file, n_passes, interpolate_dummies)¶ Apply a 3D filter to a grid3d.
Parameters: - input_file (str) – Name of the input grid3d
- output_file (str) – Name of the output grid3d
- 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.4.
License: Geosoft End-User License
-
classmethod
get_gocad_location
(input_grid3d_filename, origin_x, origin_y, origin_z, vect_xx, vect_xy, vect_xz, vect_yx, vect_yy, vect_yz, vect_zx, vect_zy, vect_zz)¶ Get the location of a grid3d with origin and scaled xyz vectors for use with GOCAD.
Parameters: - input_grid3d_filename (str) – Input grid3d filename
- origin_x (float_ref) – Origin X
- origin_y (float_ref) – Origin Y
- origin_z (float_ref) – Origin Z
- vect_xx (float_ref) – VectX X
- vect_xy (float_ref) – VectX Y
- vect_xz (float_ref) – VectX Z
- vect_yx (float_ref) – VectY X
- vect_yy (float_ref) – VectY Y
- vect_yz (float_ref) – VectY Z
- vect_zx (float_ref) – VectZ X
- vect_zy (float_ref) – VectZ Y
- vect_zz (float_ref) – VectZ Z
New in version 9.4.
License: Geosoft Open License
-
classmethod
grid_direct_from_gdb
(output_grid3d_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 grid3d using direct gridding.
Parameters: - output_grid3d_filename (str) – Output grid3d 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) – MULTIGRID3D_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.4.
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, grid3d)¶ 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
- grid3d (str) – Output grid3d file name
New in version 9.4.
License: Geosoft End-User License
Note: Create a Geosoft Voxel file from a Datamine block model file.
-
classmethod
import_from_gdb
(grid3d_file, db, symb)¶ Imports from a Geosoft Database
Parameters: New in version 9.4.
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.4.
License: Geosoft Open License
- name (str) – Name of output
-
classmethod
import_from_ubc
(name, mesh, mod, dummy, ipj)¶ Import UBC file into a MultiVoxset
Parameters: New in version 9.4.
License: Geosoft Open License
-
classmethod
import_from_vector_gdb
(grid3d_file, db, vector_type, symb_x, symb_y, symb_z, inc, dec)¶ Imports from a Vector Geosoft Database
Parameters: - grid3d_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.4.
License: Geosoft Open License
-
classmethod
import_from_voxel
(project_file, grid3d_file, multi_voxset_attribute, p_uuid_string)¶ Import a Voxel directly into a Multi-Voxset
Parameters: - project_file (str) – Project file
- grid3d_file (str) – Input Voxel file
- multi_voxset_attribute (str) – Multi-Voxset attribute
- p_uuid_string (str_ref) – UUID string returned
New in version 9.4.
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.4.
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.4.
License: Geosoft Open License
-
classmethod
null
()¶ A null (undefined) instance of
GXMULTIGRID3DUTIL
Returns: A null GXMULTIGRID3DUTIL
Return type: GXMULTIGRID3DUTIL
-
classmethod