geoh5py.groups

geoh5py.groups.container_group

class geoh5py.groups.container_group.ContainerGroup(group_type: GroupType, **kwargs)

Bases: Group

The type for the basic Container group.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

geoh5py.groups.custom_group

class geoh5py.groups.custom_group.CustomGroup(group_type: GroupType, **kwargs)

Bases: Group

A custom group, for an unlisted Group type.

classmethod default_type_uid() → UUID | None

Mock the default type uid for the custom group. It returns a new UUID every time this class is called.

geoh5py.groups.drillhole_group

class geoh5py.groups.drillhole_group.DrillholeGroup(group_type: GroupType, name='Drillholes Group', **kwargs)

Bases: Group

The type for the group containing drillholes.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.drillhole_group.IntegratorDrillholeGroup(group_type: GroupType, **kwargs)

Bases: DrillholeGroup

The type for the group containing drillholes.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

geoh5py.groups.giftools_group

class geoh5py.groups.giftools_group.GiftoolsGroup(group_type: GroupType, **kwargs)

Bases: Group

The type for a GIFtools group.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

geoh5py.groups.group

class geoh5py.groups.group.Group(group_type: GroupType, **kwargs)

Bases: EntityContainer

Base Group class

add_children(children: list[Entity])

Parameters:

children – Add a list of entities as children

add_comment(comment: str, author: str | None = None)

Add text comment to an object.

Parameters:

• comment – Text to be added as comment.

• author – Author’s name or contributors.

property comments

Fetch a CommentsData entity from children.

copy(parent=None, copy_children: bool = True, clear_cache: bool = False, mask: ndarray | None = None, **kwargs)

Function to copy a group to a different parent entity.

Parameters:

• parent – Target parent to copy the entity under. Copied to current parent if None.

• copy_children – (Optional) Create copies of all children entities along with it.

• clear_cache – Clear array attributes after copy.

• mask – Array of bool defining the values to keep.

• kwargs – Additional keyword arguments to pass to the copy constructor.

Return entity:

Registered Entity to the workspace.

copy_from_extent(extent: ndarray, parent=None, copy_children: bool = True, clear_cache: bool = False, inverse: bool = False, **kwargs) → Group | None

Sub-class extension of copy_from_extent().

abstract classmethod default_type_uid() → UUID | None

Abstract method to return the default type uid for the class.

property entity_type: GroupType

Abstract property to get the entity type of the entity.

property extent: ndarray | None

Geography bounding box of the object.

Returns:

shape(2, 3) Bounding box defined by the bottom South-West and top North-East coordinates.

classmethod find_or_create_type(workspace: Workspace, **kwargs) → GroupType

mask_by_extent(extent: ndarray, inverse: bool = False) → None

Sub-class extension of mask_by_extent().

geoh5py.groups.group_type

class geoh5py.groups.group_type.GroupType(workspace: Workspace, allow_move_content: bool = True, allow_delete_content: bool = True, **kwargs)

Bases: EntityType

property allow_delete_content: bool

bool: [True] Allow to delete the group children.

property allow_move_content: bool

Allow to move the group.

geoh5py.groups.integrator_group

class geoh5py.groups.integrator_group.AirborneTheme(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Airborne Theme.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.EarthModelsTheme(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Earth Models Theme.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.GeochemistryMineralogyDataSet(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Geochemistry & Mineralogy DataSet.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.GeochemistryMineralogyTheme(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Geochemistry & Mineralogy Theme.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.GeophysicsTheme(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Geophysics Theme.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.GroundTheme(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Ground Theme.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.IntegratorGroup(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR group.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.IntegratorProject(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR group.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.ObservationPointsTheme(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Observation Points Theme.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.QueryGroup(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Query Group.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.RockPropertiesTheme(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Rock Properties Theme.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

class geoh5py.groups.integrator_group.SamplesTheme(group_type: GroupType, **kwargs)

Bases: Group

The type for a INTEGRATOR Samples Theme.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

geoh5py.groups.maps_group

class geoh5py.groups.maps_group.MapsGroup(group_type: GroupType, **kwargs)

Bases: Group

The type for the basic Container group.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

geoh5py.groups.notype_group

class geoh5py.groups.notype_group.NoTypeGroup(group_type: GroupType, **kwargs)

Bases: Group

A group with no type.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

geoh5py.groups.property_group

class geoh5py.groups.property_group.PropertyGroup(parent: ObjectBase, name=None, on_file=False, uid=None, property_group_type='Multi-element', **kwargs)

Bases: ABC

Property group listing data children of an object. This group is not registered to the workspace and only visible to the parent object.

add_properties(data: Data | list[Data | UUID] | UUID)

Remove data from the properties.

property allow_delete: bool

bool Allow deleting the group

property association: DataAssociationEnum

DataAssociationEnum Data association

property attribute_map: dict

dict Attribute names mapping between geoh5 and geoh5py

property collect_values: list | None

The values of the properties in the group.

property name: str

str Name of the group

property on_file

Property group is on geoh5 file.

property parent: ObjectBase

The parent ObjectBase

property properties: list[UUID] | None

List of unique identifiers for the Data contained in the property group.

property property_group_type: str

remove_properties(data: Data | list[Data | UUID] | UUID)

Remove data from the properties.

property uid: UUID

uuid.UUID Unique identifier

geoh5py.groups.root_group

class geoh5py.groups.root_group.RootGroup(group_type: GroupType, **kwargs)

Bases: NoTypeGroup

The Root group of a workspace.

property parent

Parental entity of root is always None

geoh5py.groups.simpeg_group

class geoh5py.groups.simpeg_group.SimPEGGroup(group_type: GroupType, **kwargs)

Bases: Group

Group for SimPEG inversions.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.

property options: dict | None

Metadata attached to the entity.

geoh5py.groups.survey_group

class geoh5py.groups.survey_group.AirborneGeophysics(group_type: GroupType, **kwargs)

Bases: Group

The type for the basic Container group.

classmethod default_type_uid() → UUID

Abstract method to return the default type uid for the class.