geoh5py.shared package

Submodules

geoh5py.shared.coord3d module

class geoh5py.shared.coord3d.Coord3D(xyz: numpy.ndarray = array([[6.92508828e-310, 4.66979099e-310, 6.92508841e-310]]))[source]

Bases: object

property locations
property x
property y
property z

geoh5py.shared.date_time module

class geoh5py.shared.date_time.DateTime[source]

Bases: object

geoh5py.shared.distance_unit module

class geoh5py.shared.distance_unit.DistanceUnit[source]

Bases: object

geoh5py.shared.entity module

class geoh5py.shared.entity.Entity(**kwargs)[source]

Bases: abc.ABC

add_children(self, children: List[ForwardRef(‘shared.Entity’)])[source]
Parameters

children – Add children entities to the list of children

property allow_delete

bool: if True the Entity can be deleted from the geoh5

property allow_move

bool: if True the Entity can change parent

property allow_rename

bool: if True the Entity can change name

property attribute_map
property children

List of children entities in the workspace tree

copy(self, parent=None, copy_children: bool = True)[source]

Function to copy an entity to a different parent entity

Parameters
  • parent – Target parent to copy the entity under

  • copy_children – Copy all children of the entity

Returns

Entity: Registered to the workspace.

classmethod create(workspace, \*\*kwargs)[source]

Function to create an object with data

Parameters
  • workspace – Workspace to be added to

  • kwargs – List of keyword arguments

Returns

Entity: Registered to the workspace.

abstract property entity_type
property existing_h5_entity
classmethod fix_up_name(name: str) → str[source]

If the given name is not a valid one, transforms it to make it valid :return: a valid name built from the given name. It simply returns the given name if it was already valid.

property modified_attributes
property name

Name of the entity

property parent
property public

bool: if True the Entity is visible in camera

remove_children(self, children: List[ForwardRef(‘shared.Entity’)])[source]
Parameters

children – Remove children entities to the list of children

property uid
property visible
property workspace

Workspace to which the Entity belongs

geoh5py.shared.entity_type module

class geoh5py.shared.entity_type.EntityType(workspace: ws.Workspace, **kwargs)[source]

Bases: abc.ABC

property attribute_map
property description
property existing_h5_entity
classmethod find(workspace: “‘ws.Workspace’”, type_uid: ‘uuid.UUID’) → ’Optional[TEntityType]’[source]

Finds in the given Workspace the EntityType with the given UUID for this specific EntityType implementation class.

Returns None if not found.

property modified_attributes
property name
property uid
property workspace

Return the workspace which owns this type.

geoh5py.shared.file_name module

class geoh5py.shared.file_name.FileName[source]

Bases: object

geoh5py.shared.version_number module

class geoh5py.shared.version_number.VersionNumber(number: float)[source]

Bases: object

property value

geoh5py.shared.version_string module

class geoh5py.shared.version_string.VersionString(value: str)[source]

Bases: object

property value

geoh5py.shared.vertex_index module

class geoh5py.shared.vertex_index.VertexIndex[source]

Bases: object

geoh5py.shared.weakref_utils module

geoh5py.shared.weakref_utils.get_clean_ref(some_dict: ‘Dict[K, ReferenceType[T]]’, key: ‘K’) → ’Optional[T]’[source]

Gets the referent value for the given key in a some_dict of weakref values. In case key points to a reference to a deleted value, remove that key from some_dict on the fly, and returns None. :param some_dict: The dictionary of weakref values. :param key: The key :return: the referent value for key if found in the the dictionary, else None.

geoh5py.shared.weakref_utils.insert_once(some_dict: ‘Dict[K, ReferenceType]’, key: ‘K’, value)[source]

TODO :param some_dict: :param key: :param value: :return:

geoh5py.shared.weakref_utils.remove_none_referents(some_dict: ‘Dict[K, ReferenceType]’)[source]

Removes any key from the given some_dict where the value is a reference to a deleted value (that is where referent of the weakref value is None).

Parameters

some_dict – The dictionary to be cleaned up.

Module contents