GXDCOL class

class GXDCOL(handle=0)

GXDCOL class.

Object to interface with 2D map and 3D view objects that supports colour tool editing.

__init__(handle=0)

end(apply_changes)

TODO

Parameters:

apply_changes (bool) – Apply changes to map.

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

get_brightness(layerSelection, layer)

Get the brightness of a single layer, or all the layers

Parameters:

• layerSelection (int) – BRIGHT constants

• layer (int) – layer index (required for BRIGHT_LAYER

Return type:

float

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

get_brightness_type()

Is brightness set separately by layer and by object or just by object?

Returns:

BRIGHTNESS_ALL - Set brightness for the object as a whole only BRIGHTNESS_ALL_AND_LAYERS - Set brightness either for the object as a whole or by layer

Return type:

int

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

Note: For some objects (like AGG) brightness can be set for each layer, or for the object as a whole, while in others (like CSYMB) it can be set only for the object as a whole.

get_layer_histogram(index, incr, min)

Get a GXVV filled with histogram bin counts for each zone of the ITR

Parameters:

• index (int) – Index of layer

• incr (float_ref) – width of bin increment

• min (float_ref) – Min (value at start of 2nd bin)

Returns:

GXVV object

Return type:

GXVV

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

get_layer_info(index, itr, layer_name)

Get a layer’s information

Parameters:

• index (int) – Index of layer

• itr (GXITR) – GXITR Handle

• layer_name (str_ref) – Name returned

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

get_layer_itr(index, itr)

Get a layer’s ITR

Parameters:

• index (int) – Index of layer

• itr (GXITR) – GXITR Handle

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

get_layer_statistics(index)

Get a GXST filled with layer statistics

Parameters:

index (int) – Index of layer

Returns:

GXST object

Return type:

GXST

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

get_transparency()

Get the transparency. This is returned for the entire map group.

Return type:

float

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

get_type()

Get a layer’s type

Returns:

DCOL_TYPE constants

Return type:

int

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

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

A null (undefined) instance of GXDCOL

Returns:

A null GXDCOL

Return type:

GXDCOL

number_of_layers()

Get the number of layers.

Returns:

The number of layers (often just one).

Return type:

int

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

reset()

Reset the AGG back to its initial state. Same as cancelling out of the colour tool and restarting; all layers are reset.

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

save_layer_itr(index)

Save the layer’s ITR to a file. A dialog prompts for the file name.

Parameters:

index (int) – Index of layer

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

set_brightness(brightness, layerSelection, layer)

Set the brightness of a single layer, or all the layers

Parameters:

• brightness (float) – Brightness value (-1.0 (black) <= brightness <= 1.0 (white))

• layerSelection (int) – BRIGHT constants

• layer (int) – layer index (required for BRIGHT_LAYER

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

set_itr_transform_from_layer(index, itr, transformType)

Set the input ITR transform to the provided type, based on the statistics of the chosen layer.

Parameters:

• index (int) – Index of layer

• itr (GXITR) – GXITR Handle

• transformType (int) – ITR_ZONE_MODEL constants

Returns:

0 - Ok 1 - Cancel

Return type:

int

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

Note: If the input tranform type is ITR_ZONE_MODEL_NOZONE or ITR_ZONE_MODEL_NONE then the user-preference default will be used. NOTE: This alters the input ITR, not the selected layer’s own ITR. The layer is accessed purely to get the current statistics.

set_layer_itr(index, itr, redrawMap)

Set a layer’s ITR

Parameters:

• index (int) – Index of layer

• itr (GXITR) – GXITR Handle

• redrawMap (int) – Force redraw of map (0: No, 1: Yes)?

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

set_transparency(transparency)

Set the transparency. This is set for the entire map group.

Parameters:

transparency (float) – Transparency value (1.0 - Opaque, 0.0 - Transparent)

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

update_zone_transform_parameters(index)

Recalculate the layer’s ITR, based on the current type of the GXDCOL. Launches anappropriate zone transform type parameter GUI based on the current selection.

Parameters:

index (int) – Index of layer

Returns:

0 - Ok 1 - Cancel

Return type:

int

New in version 2022.1.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

Note: The transform type assumed is the current transform type for the GXDCOL. The dialogs to enter parameters are shown for Linear, Log, Normal and Equal.

update_zone_transform_type(index, transformType)

Recalculate the layer’s ITR to the provided type, based on the statistics of the chosen layer.

Parameters:

• index (int) – Index of layer

• transformType (int) – ITR_ZONE_MODEL constants

Returns:

0 - Ok 1 - Cancel

Return type:

int

New in version 2021.2.

License: Geosoft Open License

Limitations: May not be available while executing a command line program.

Note: If the input tranform type is ITR_ZONE_MODEL_NOZONE, ITR_ZONE_MODEL_NONE then nothing will happen and the function will return 1. The dialogs to enter parameters are shown for Linear, Log, Normal and Equal.

BRIGHT constants

Brightness type

BRIGHT_ALL

Set the brightness of all the layers

gxapi.BRIGHT_ALL = 0

BRIGHT_LAYER

Set the brightness of the current layer

gxapi.BRIGHT_LAYER = 1

BRIGHTNESS_TYPES constants

Detrending option

BRIGHTNESS_ALL

Can set the brightness only for object as a whole

gxapi.BRIGHTNESS_ALL = 0

BRIGHTNESS_ALL_AND_LAYERS

Can set the brightness for object as a whole and for individual layers

gxapi.BRIGHTNESS_ALL_AND_LAYERS = 1

DCOL_TYPE constants

Layer type

DCOL_TYPE_UNKNOWN

Unknown

gxapi.DCOL_TYPE_UNKNOWN = 0

DCOL_TYPE_GRID

Grid

gxapi.DCOL_TYPE_GRID = 1

DCOL_TYPE_SYMBOLS

Symbols

gxapi.DCOL_TYPE_SYMBOLS = 2

DCOL_TYPE_VOXEL

Voxel

gxapi.DCOL_TYPE_VOXEL = 3

DCOL_TYPE_VECTOR_VOXEL

Vector voxel

gxapi.DCOL_TYPE_VECTOR_VOXEL = 4