geoh5py.groups package¶
Submodules¶
geoh5py.groups.base module¶
- class geoh5py.groups.base.Group(**kwargs)[source]¶
Bases:
EntityContainer
Base Group class
- copy(parent=None, *, copy_children: bool = True, clear_cache: bool = False, mask: ndarray | None = None, **kwargs)[source]¶
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 [source]¶
Sub-class extension of
copy_from_extent()
.
- 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 [source]¶
Find or create a type instance for a given object class.
- Parameters:
workspace – Target
Workspace
.- Returns:
The ObjectType instance for the given object class.
- mask_by_extent(extent: ndarray, inverse: bool = False) None [source]¶
Sub-class extension of
mask_by_extent()
.
geoh5py.groups.container module¶
geoh5py.groups.custom module¶
geoh5py.groups.drillhole module¶
- class geoh5py.groups.drillhole.DrillholeGroup(**kwargs)[source]¶
Bases:
Group
The type for the group containing drillholes.
- class geoh5py.groups.drillhole.IntegratorDrillholeGroup(**kwargs)[source]¶
Bases:
DrillholeGroup
The type for the group containing drillholes.
geoh5py.groups.giftools module¶
geoh5py.groups.group_type module¶
- class geoh5py.groups.group_type.GroupType(workspace: Workspace, allow_move_content: bool = True, allow_delete_content: bool = True, **kwargs)[source]¶
Bases:
EntityType
- property allow_delete_content: bool¶
bool
: [True] Allow to delete the groupchildren
.
- property allow_move_content: bool¶
Allow to move the group.
geoh5py.groups.integrator module¶
- class geoh5py.groups.integrator.AirborneTheme(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR Airborne Theme.
- class geoh5py.groups.integrator.EarthModelsTheme(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR Earth Models Theme.
- class geoh5py.groups.integrator.GeochemistryMineralogyDataSet(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR Geochemistry & Mineralogy DataSet.
- class geoh5py.groups.integrator.GeochemistryMineralogyTheme(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR Geochemistry & Mineralogy Theme.
- class geoh5py.groups.integrator.GeophysicsTheme(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR Geophysics Theme.
- class geoh5py.groups.integrator.GroundTheme(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR Ground Theme.
- class geoh5py.groups.integrator.IntegratorGroup(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR group.
- class geoh5py.groups.integrator.IntegratorProject(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR group.
- class geoh5py.groups.integrator.ObservationPointsTheme(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR Observation Points Theme.
- class geoh5py.groups.integrator.QueryGroup(**kwargs)[source]¶
Bases:
Group
The type for a INTEGRATOR Query Group.
geoh5py.groups.maps module¶
geoh5py.groups.notype module¶
geoh5py.groups.property_group module¶
- class geoh5py.groups.property_group.PropertyGroup(parent: ObjectBase, *, association: str | DataAssociationEnum | None = None, allow_delete: bool = True, name: str = 'Property Group', on_file: bool = False, uid: UUID | None = None, property_group_type: GroupTypeEnum | str = GroupTypeEnum.SIMPLE, properties: list[UUID | Data | str] | None = None, **_)[source]¶
Bases:
object
Property group listing data children of an object. This group is not registered to the workspace and only visible to the parent object.
- Parameters:
parent – Parent object.
association – Association of the data.
allow_delete – Allow deleting the group.
name – Name of the group.
on_file – Property group is on file.
uid – Unique identifier.
property_group_type – Type of property group.
properties – List of data or unique identifiers for the data.
- add_properties(data: str | Data | list[str | Data | UUID] | UUID)[source]¶
Add data to properties.
- Parameters:
data – Data to add to the group. It can be the name, the uuid or the data itself in a list or alone.
- property allow_delete: bool¶
Allow deleting the group
- property association: DataAssociationEnum¶
The association of the data.
- property attribute_map: dict¶
Attribute names mapping between geoh5 and geoh5py
- property collect_values: list | None¶
The values of the properties in the group.
- property name: str¶
Name of the group
- property on_file¶
Property group is on geoh5 file.
- property parent: ObjectBase¶
The parent of the PropertyGroup.
- property properties: list[UUID] | None¶
List of unique identifiers for the
Data
contained in the property group.
- property properties_name: list[str] | None¶
List of names of the properties`
- property property_group_type: GroupTypeEnum¶
Type of property group.
- remove_properties(data: str | Data | list[str | Data | UUID] | UUID)[source]¶
Remove data from the properties.
- Parameters:
data – Data to remove from the group. It can be the name, the uuid or the data itself in a list or alone.
- property table: PropertyGroupTable¶
Create an object to access the data of the property group.
- property uid: UUID¶
Unique identifier
geoh5py.groups.property_group_table module¶
- class geoh5py.groups.property_group_table.PropertyGroupTable(property_group: PropertyGroup)[source]¶
Bases:
ABC
A class to store the information of a property group.
- Parameters:
property_group – The property group to extract the data from.
- property locations: ndarray¶
The locations of the association table.
This function is needed as a data can be both associated to cell or vertex in CellObjects.
- locations_keys = ('X', 'Y', 'Z')¶
- property property_group: PropertyGroup¶
The property group to extract the data from.
- property size: int¶
The size of the properties in the group.
geoh5py.groups.root module¶
- class geoh5py.groups.root.RootGroup(allow_move=False, allow_delete=False, allow_rename=False, **kwargs)[source]¶
Bases:
NoTypeGroup
The Root group of a workspace.
- property parent¶
Parental entity of root is always None
geoh5py.groups.simpeg module¶
- class geoh5py.groups.simpeg.SimPEGGroup(options: dict | ndarray | bytes | None = None, **kwargs)[source]¶
Bases:
UIJsonGroup
Group for SimPEG inversions.
geoh5py.groups.survey module¶
geoh5py.groups.uijson module¶
- class geoh5py.groups.uijson.UIJsonGroup(options: dict | ndarray | bytes | None = None, **kwargs)[source]¶
Bases:
Group
Group for SimPEG inversions.
- add_ui_json(name: str | None = None)[source]¶
Add ui.json file to entity.
- Parameters:
name – Name of the file in the workspace.
- static format_input_options(options: dict | ndarray | bytes | None) dict [source]¶
Format input options to a dictionary.
- Parameters:
options – Input options.
- Returns:
Formatted options.
- property options: dict¶
Metadata attached to the entity.