GXGRID3D class

class GXGRID3D(handle=0)[source]

GXGRID3D class.

High Performance 3D Grid.

__init__(handle=0)[source]

Initialize self. See help(type(self)) for accurate signature.

fill_double(value)[source]

Fill the grid3d with a single double value.

Parameters

value (float) – Fill Value

New in version 9.4.

License: Geosoft Open License

fill_thematic(value)[source]

Fill the grid3d with a single thematic value.

Parameters

value (int) – Fill Value

New in version 9.4.

License: Geosoft Open License

fill_vector(value_x, value_y, value_z)[source]

Fill the grid3d with a single vector value.

Parameters

  • value_x (float) – Fill Value X

  • value_y (float) – Fill Value Y

  • value_z (float) – Fill Value Z

New in version 9.4.

License: Geosoft Open License

get_double_stats(num_valid, num_dummies, min, max, mean, stddev)[source]

Get Double statistics.

Parameters

New in version 9.4.

License: Geosoft Open License

get_elements_in_block_x()[source]

Get the number of cells in the block in the X direction

Return type

int

New in version 9.4.

License: Geosoft Open License

get_elements_in_block_y()[source]

Get the number of cells in the block in the Y direction

Return type

int

New in version 9.4.

License: Geosoft Open License

get_elements_in_block_z()[source]

Get the number of cells in the block in the Z direction

Return type

int

New in version 9.4.

License: Geosoft Open License

get_thematic_stats(num_valid, num_dummies, min, max, mean, stddev)[source]

Get Thematic Data statistics.

Parameters

  • num_valid (int_ref) – Number of valid values

  • num_dummies (int_ref) – Number of invalid values

  • min (int_ref) – Min value

  • max (int_ref) – Maximum value

  • mean (int_ref) – Mean value

  • stddev (int_ref) – Standard Deviation

New in version 9.4.

License: Geosoft Open License

get_tpat(ipj)[source]

Get the TPAT from the thematic grid3d.

Parameters

ipj (GXTPAT) – GXTPAT object

New in version 9.4.

License: Geosoft Open License

get_type()[source]

Get the type of this GRID3D

Return type

int

New in version 9.4.

License: Geosoft Open License

get_vector_stats(num_valid, num_dummies, min_x, min_y, min_z, max_x, max_y, max_z, mean_x, mean_y, mean_z, stddev_x, stddev_y, stddev_z)[source]

Get Vector Data statistics.

Parameters

New in version 9.4.

License: Geosoft Open License

is_double()[source]

Does this grid3d contain floating point data

Return type

bool

New in version 9.4.

License: Geosoft Open License

is_null()[source]

Check if this is a null (undefined) instance

Returns

True if this is a null (undefined) instance, False otherwise.

Return type

bool

is_thematic()[source]

Does this grid3d contain thematic data

Return type

bool

New in version 9.4.

License: Geosoft Open License

is_vector()[source]

Does this grid3d contain vector data

Return type

bool

New in version 9.4.

License: Geosoft Open License

classmethod null()[source]

A null (undefined) instance of GXGRID3D

Returns

A null GXGRID3D

Return type

GXGRID3D

read_x(x, y, z, VV)[source]

Read data from a GRID3D in the x direction (MOST EFFICIENT)

Parameters

  • x (int) – X location

  • y (int) – Y location

  • z (int) – Z location

  • VV (GXVV) – VV Containing Data

Return type

int

New in version 9.4.

License: Geosoft Open License

read_y(x, y, z, VV)[source]

Read data from a GRID3D in the Y direction

Parameters

  • x (int) – X location

  • y (int) – Y location

  • z (int) – Z location

  • VV (GXVV) – VV Containing Data

Return type

int

New in version 9.4.

License: Geosoft Open License

read_z(x, y, z, VV)[source]

Read data from a GRID3D in the Z direction

Parameters

  • x (int) – X location

  • y (int) – Y location

  • z (int) – Z location

  • VV (GXVV) – VV Containing Data

Return type

int

New in version 9.4.

License: Geosoft Open License

set_tpat(ipj)[source]

Set the TPAT of a thematic grid3d.

Parameters

ipj (GXTPAT) – GXTPAT object

New in version 9.4.

License: Geosoft Open License

write_x(x, y, z, VV)[source]

Write data to a GRID3D in the X direction (MOST EFFICIENT)

Parameters

  • x (int) – X location

  • y (int) – Y location

  • z (int) – Z location

  • VV (GXVV) – VV Containing Data

Return type

int

New in version 9.4.

License: Geosoft Open License

write_y(x, y, z, VV)[source]

Write data to a GRID3D in the Y direction

Parameters

  • x (int) – X location

  • y (int) – Y location

  • z (int) – Z location

  • VV (GXVV) – VV Containing Data

Return type

int

New in version 9.4.

License: Geosoft Open License

write_z(x, y, z, VV)[source]

Write data to a GRID3D in the Z direction

Parameters

  • x (int) – X location

  • y (int) – Y location

  • z (int) – Z location

  • VV (GXVV) – VV Containing Data

Return type

int

New in version 9.4.

License: Geosoft Open License

GRID3D_TYPE constants

Type of Voxset

GRID3D_DOUBLE

DOUBLE

gxapi.GRID3D_DOUBLE = 0
GRID3D_VECTOR

VECTOR

gxapi.GRID3D_VECTOR = 1
GRID3D_THEMATIC

THEMATIC

gxapi.GRID3D_THEMATIC = 2