geoh5py.data package

Submodules

geoh5py.data.blob_data module

class geoh5py.data.blob_data.BlobData(data_type: geoh5py.data.data_type.DataType, **kwargs)[source]

Bases: geoh5py.data.data.Data

classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]

geoh5py.data.color_map module

class geoh5py.data.color_map.ColorMap(**kwargs)[source]

Bases: object

Records colors assigned to value ranges (where Value is the start of the range).

property name

str: Name of the colormap

property values

numpy.array: Colormap defined by values and corresponding RGBA:

\[[[V_1, R_1, G_1, B_1, A_1], ..., [V_i, R_i, G_i, B_i, A_i]]\]

where V (Values) are sorted floats defining the position of each RGBA. R (Red), G (Green), B (Blue) and A (Alpha) are integer values between [0, 255].

geoh5py.data.data module

class geoh5py.data.data.Data(data_type: geoh5py.data.data_type.DataType, **kwargs)[source]

Bases: geoh5py.shared.entity.Entity

Base class for Data entities.

property association

DataAssociationEnum: Relationship made between the values() and elements of the parent object. Association can be set from a str chosen from the list of available DataAssociationEnum options.

property entity_type

DataType

classmethod find_or_create_type(workspace: 'workspace.Workspace', \*\*kwargs)geoh5py.data.data_type.DataType[source]

Find or create a type for a given object class

Parameters

workspace (Current) – Workspace

Returns

A new or existing object type

property n_values

int: Number of expected data values based on association

property no_data_value

float: Default no-data-value

abstract classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]
property values

Data values

geoh5py.data.data_association_enum module

class geoh5py.data.data_association_enum.DataAssociationEnum[source]

Bases: enum.Enum

Known data association between values and the parent object. Available options:

CELL = 2
FACE = 4
GROUP = 5
OBJECT = 1
UNKNOWN = 0
VERTEX = 3

geoh5py.data.data_type module

class geoh5py.data.data_type.DataType(workspace: workspace.Workspace, **kwargs)[source]

Bases: geoh5py.shared.entity_type.EntityType

DataType class

property color_map

ColorMap: Colormap used for plotting

The colormap can be set from a dict of sorted values with corresponding RGBA color.

\[\{val_1: [r_1, g_1, b_1, a_1], ..., val_i: [r_i, g_i, b_i, a_i]\}\]
classmethod create(workspace: “‘workspace.Workspace’”, data_class: “Type[‘data.Data’]”) → ’DataType’[source]

Creates a new instance of DataType with corresponding PrimitiveTypeEnum

Parameters

data_class – A Data implementation class.

Returns

A new instance of DataType.

classmethod find_or_create(workspace: "'workspace.Workspace'", \*\*kwargs) → ’DataType’[source]

Find or creates an EntityType with given UUID that matches the given Group implementation class.

Parameters

workspace – An active Workspace class

Returns

A new instance of DataType.

classmethod for_x_data(workspace: “‘workspace.Workspace’”) → ’DataType’[source]
classmethod for_y_data(workspace: “‘workspace.Workspace’”) → ’DataType’[source]
classmethod for_z_data(workspace: “‘workspace.Workspace’”) → ’DataType’[source]
property hidden

bool: Hidden data [False]

property mapping

str: Color stretching type chosen from: ‘linear’, [‘equal_area’], ‘logarithmic’, ‘cdf’, ‘missing’

property number_of_bins

int: Number of bins used by the histogram [50]

property primitive_type

PrimitiveTypeEnum

property transparent_no_data

bool: Use transparent for no-data-value [True]

property units

str: Data units

geoh5py.data.data_unit module

class geoh5py.data.data_unit.DataUnit(unit_name: str = None)[source]

Bases: object

Data unit

property name

geoh5py.data.datetime_data module

class geoh5py.data.datetime_data.DatetimeData(data_type: geoh5py.data.data_type.DataType, **kwargs)[source]

Bases: geoh5py.data.data.Data

classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]

geoh5py.data.filename_data module

class geoh5py.data.filename_data.FilenameData(data_type: geoh5py.data.data_type.DataType, **kwargs)[source]

Bases: geoh5py.data.data.Data

classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]

geoh5py.data.float_data module

class geoh5py.data.float_data.FloatData(data_type: geoh5py.data.data_type.DataType, **kwargs)[source]

Bases: geoh5py.data.data.Data

Data container for floats values

check_vector_length(self, values) → numpy.ndarray[source]
classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]
property values
Returns

values: An array of float values

geoh5py.data.geometric_data_constants module

class geoh5py.data.geometric_data_constants.GeometricDataConstants[source]

Bases: object

classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]
classmethod x_datatype_uid() → uuid.UUID[source]
classmethod y_datatype_uid() → uuid.UUID[source]
classmethod z_datatype_uid() → uuid.UUID[source]

geoh5py.data.integer_data module

class geoh5py.data.integer_data.IntegerData(data_type: geoh5py.data.data_type.DataType, **kwargs)[source]

Bases: geoh5py.data.data.Data

classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]
property values
Returns

values: An array of int values

geoh5py.data.primitive_type_enum module

class geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]

Bases: enum.Enum

Known data type.

Available options:

BLOB = 6
DATETIME = 8
FILENAME = 5
FLOAT = 2
GEOMETRIC = 9
INTEGER = 1
INVALID = 0
REFERENCED = 4
TEXT = 3
VECTOR = 7

geoh5py.data.reference_value_map module

class geoh5py.data.reference_value_map.ReferenceValue(value: str = None)[source]

Bases: object

Represents a value for ReferencedData as a string.

property value
class geoh5py.data.reference_value_map.ReferenceValueMap(color_map: Dict[int, geoh5py.data.reference_value_map.ReferenceValue] = None)[source]

Bases: object

Maps from reference index to reference value of ReferencedData.

geoh5py.data.referenced_data module

class geoh5py.data.referenced_data.ReferencedData(data_type: geoh5py.data.data_type.DataType, **kwargs)[source]

Bases: geoh5py.data.float_data.FloatData

classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]

geoh5py.data.text_data module

class geoh5py.data.text_data.TextData(data_type: geoh5py.data.data_type.DataType, **kwargs)[source]

Bases: geoh5py.data.data.Data

classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]
property values

Data values

geoh5py.data.unknown_data module

class geoh5py.data.unknown_data.UnknownData(data_type: geoh5py.data.data_type.DataType, association: geoh5py.data.data_association_enum.DataAssociationEnum, name: str, uid: uuid.UUID = None)[source]

Bases: geoh5py.data.data.Data

classmethod primitive_type()geoh5py.data.primitive_type_enum.PrimitiveTypeEnum[source]

Module contents