GXCSYMB3D class¶

class GXCSYMB3D(handle=0)[source]¶

GXCSYMB3D class.

This class is used for generating and modifying 3D colored symbol objects. Symbols are assigned colors based on their Z values and a zone, Aggregate or GXITR file which defines what colors are associated with different ranges of Z values. The position of a symbol is defined by its X,Y,Z coordinates.

__init__(handle=0)[source]¶

add_color_data(vv_data)[source]¶

Add data for colors to a CSYMB3D object.

Parameters:: vv_data (GXVV) – GXVV for colour data values.

New in version 2024.1.

License: Geosoft Open License

Note: To use these values, add a colour transform using the SetITR function. Ensure you add an equal number of locations.

add_locations(vv_x, vv_y, vv_z)[source]¶

Add x,y,z locations to a CSYMB3D object.

Parameters:

vv_x (GXVV) – GXVV for X locations
vv_y (GXVV) – GXVV for Y locations
vv_z (GXVV) – GXVV for Z locations

New in version 2024.1.

License: Geosoft Open License

add_size_data(vv_data)[source]¶

Add data for sizes to a CSYMB3D object.

Parameters:: vv_data (GXVV) – GXVV for size data values.

New in version 2024.1.

License: Geosoft Open License

Note: To use these values, call the SetSizeScale or SetSizeMinMax functions. Ensure you add an equal number of locations.

classmethod create(size, colour)[source]¶

Create a GXCSYMB3D.

Parameters:

size (float) – Symbol size (> 0.0)
colour (int) – colour to use for the fixed colour

Returns:

GXCSYMB3D handle

Return type:

New in version 2024.1.

License: Geosoft Open License

Note: The default object uses fixed size and colour.

fixed_color()[source]¶

Return whether colours are fixed (1) or use a transform (0)

Return type:: int

New in version 2024.1.

License: Geosoft Open License

get_color_data(vv_data)[source]¶

Get data for colors from a CSYMB3D object.

Parameters:: vv_data (GXVV) – GXVV for colour data values.

New in version 2024.1.

License: Geosoft Open License

get_fixed_color()[source]¶

Get the fixed colour. There is always one even if we are using an ITR

Return type:: int

New in version 2024.1.

License: Geosoft Open License

get_itr(itr)[source]¶

Get the GXITR of the GXCSYMB3D

Parameters:: itr (GXITR) – GXITR object

New in version 2024.1.

License: Geosoft Open License

Note: Returns an empty ITR if fixed colours are being used.

get_locations(vv_x, vv_y, vv_z)[source]¶

Get x,y,z locations from a color symbol object.

Parameters:

vv_x (GXVV) – GXVV for X locations
vv_y (GXVV) – GXVV for Y locations
vv_z (GXVV) – GXVV for Z locations

New in version 2024.1.

License: Geosoft Open License

get_size_data(vv_data)[source]¶

Get data for sizes from a CSYMB3D object.

Parameters:: vv_data (GXVV) – GXVV for size data values.

New in version 2024.1.

License: Geosoft Open License

get_st(st)[source]¶

Get a copy of the CSYMB3D statistics object

Parameters:: st (GXST) – GXST Handle

New in version 2024.1.

License: Geosoft Open License

Note: Returns all dummies if no values are input with the locations. If both colour and size data are present, returns the colour ST.

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

classmethod null()[source]¶

A null (undefined) instance of GXCSYMB3D

Returns:: A null GXCSYMB3D
Return type:: GXCSYMB3D

set_fixed_color(colour)[source]¶

Set symbols to a fixed colour

Parameters:: colour (int) – colour to use for the fixed colour

New in version 2024.1.

License: Geosoft Open License

set_fixed_size(size)[source]¶

Fix the symbol size.

Parameters:: size (float) – Symbol size (> 0.0)

New in version 2024.1.

License: Geosoft Open License

set_itr(itr)[source]¶

Set the GXITR of the GXCSYMB3D

Parameters:: itr (GXITR) – GXITR object

New in version 2024.1.

License: Geosoft Open License

Note: Setting the ITR puts the symbols in colour-transform mode. Data for colours must be added using the AddSizeData function.

set_size_min_max(min_size, max_size, log_scaling, log_minimum)[source]¶

Scale the symbol size based on value. By default symbols are fixed size

Parameters:

min_size (float) – If defined, make smallest symbol this size (>=0)
max_size (float) – If defined, make largest symbol this size
log_scaling (int) – If 1, use log scaling, 0 - linear between min and max
log_minimum (float) – divide by this value before taking the log (default = 1.0, must be > 0.0)

New in version 2024.1.

License: Geosoft Open License

Note: Data for sizes must be added using the AddSizeData function. For log scaling, take the log then apply the scaling method to get the symbol size (negative logs do not plot).

set_size_scale(scale, log_scaling, log_minimum)[source]¶

Set the symbol size based on a scale.

Parameters:

scale (float) – Symbol scale (> 0.0)
log_scaling (int) – 1 - Use log scaling, 0 - linear scaling
log_minimum (float) – divide by this value before taking the log (default = 1.0, must be > 0.0

New in version 2024.1.

License: Geosoft Open License

Note: Data for sizes must be added using the AddSizeData function. For log scaling, take the log then apply the scale factor to get the symbol size (negative logs do not plot).

set_symbol(symbol)[source]¶

Set the symbol type.

Parameters:: symbol (int) – CSYMB3D_SYMBOL constants

New in version 2024.1.

License: Geosoft Open License

statistics(st)[source]¶

Add the CSYMB values to a statistics object

Parameters:: st (GXST) – GXST Handle

New in version 2024.1.

License: Geosoft Open License

Note: Returns all dummies if no values are input with the locations. If both colour and size data are present, uses the colour data.

CSYMB3D_SYMBOL constants¶

Color Symbol Type defines

CSYMB_SYMBOL_SPHERE¶

Csymb symbol sphere

gxapi.CSYMB_SYMBOL_SPHERE = 30¶

CSYMB_SYMBOL_CUBE¶

Csymb symbol cube

gxapi.CSYMB_SYMBOL_CUBE = 31¶

CSYMB_SYMBOL_CYLINDER¶

Csymb symbol cylinder

gxapi.CSYMB_SYMBOL_CYLINDER = 32¶

CSYMB_SYMBOL_CONE¶

Csymb symbol cone

gxapi.CSYMB_SYMBOL_CONE = 33¶

CSYMB_SYMBOL_DOT¶

Csymb symbol dot

gxapi.CSYMB_SYMBOL_DOT = 34¶