GXGRID3D class

class GXGRID3D(handle=0)

GXGRID3D class.

High Performance 3D Grid.

fill_double(value)

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)

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)

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)

Get Double statistics.

Parameters:

• num_valid (int_ref) – Number of valid values
• num_dummies (int_ref) – Number of invalid values
• min (float_ref) – Min value
• max (float_ref) – Maximum value
• mean (float_ref) – Mean value
• stddev (float_ref) – Standard Deviation

New in version 9.4.

License: Geosoft Open License

get_elements_in_block_x()

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()

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()

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)

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)

Get the TPAT from the thematic grid3d.

Parameters:ipj (GXTPAT) – GXTPAT object

New in version 9.4.

License: Geosoft Open License

get_type()

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)

Get Vector Data statistics.

Parameters:

• num_valid (int_ref) – Number of valid values
• num_dummies (int_ref) – Number of invalid values
• min_x (float_ref) – Min X value
• min_y (float_ref) – Min Y value
• min_z (float_ref) – Min Z value
• max_x (float_ref) – Maximum X value
• max_y (float_ref) – Maximum Y value
• max_z (float_ref) – Maximum Z value
• mean_x (float_ref) – Mean X value
• mean_y (float_ref) – Mean Y value
• mean_z (float_ref) – Mean Z value
• stddev_x (float_ref) – Standard X Deviation
• stddev_y (float_ref) – Standard Y Deviation
• stddev_z (float_ref) – Standard Z Deviation

New in version 9.4.

License: Geosoft Open License

is_double()

Does this grid3d contain floating point data

Return type:bool

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

is_thematic()

Does this grid3d contain thematic data

Return type:bool

New in version 9.4.

License: Geosoft Open License

is_vector()

Does this grid3d contain vector data

Return type:bool

New in version 9.4.

License: Geosoft Open License

classmethod null()

A null (undefined) instance of GXGRID3D

Returns:A null GXGRID3D Return type:GXGRID3D

read_x(x, y, z, VV)

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)

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)

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)

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)

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)

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)

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