mapteksdk.geologycore.drillhole_field_type module

Enumeration used to represent the type of a drillhole field.

class DrillholeFieldType(value)

Bases: Enum

Enumeration of supported common field types.

The field type indicates what the data in the field is intended to represent.

NONE = ''

This field stores custom data not covered by another field type.

EASTING = 'Easting'

NORTHING = 'Northing'

ELEVATION = 'RL'

TOTAL_DEPTH = 'Total depth'

FROM_DEPTH = 'From depth'

TO_DEPTH = 'To depth'

THICKNESS = 'Thickness'

ROCK_TYPE = 'Rock type'

HORIZON = 'Horizon'

DEPTH = 'Depth'

AZIMUTH = 'Azimuth'

DIP = 'Dip'

UNKNOWN = '?'

can_be_repeated()

True if a table can contain multiple fields of this type.

Return type:

bool

supports_data_type(data_type)

Determine if this field type supports the specified data type.

Parameters:

data_type (np.dtype | type) – Data type to check if it is supported.

Returns:

True if the data type is supported.

Return type:

bool

property is_built_in: bool

If the field is a built in field.

This will return False for DrillholeFieldType.NONE and True for every other field type.

property is_custom: bool

If the field is a user-defined field.

This is the inverse of is_built_in.

property supports_distance_units: bool

True if this field type supports distance units.

property supports_angle_units: bool

True if the field type supports angle units.

property default_unit: DistanceUnit | AngleUnit | NoUnitType

The default unit for fields of this type.

This is NO_UNIT for the OTHER field type, metres for distance fields and radians for angle fields.