geoh5py.objects.surveys

geoh5py.objects.surveys.direct_current

class geoh5py.objects.surveys.direct_current.CurrentElectrode(object_type: ObjectType, **kwargs)[source]

Bases: PotentialElectrode

Ground direct current electrode (transmitter).

add_default_ab_cell_id()[source]

Utility function to set ab_cell_id’s based on curve cells.

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

Function to copy a survey to a different parent entity.

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

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

Return entity

Registered Entity to the workspace.

property current_electrodes

The associated current electrode object (sources).

classmethod default_type_uid() UUID[source]
Returns

Default unique identifier

property potential_electrodes: PotentialElectrode | None

The associated potential_electrodes (receivers)

class geoh5py.objects.surveys.direct_current.PotentialElectrode(object_type: ObjectType, **kwargs)[source]

Bases: Curve

Ground potential electrode (receiver).

property ab_cell_id: ReferencedData | None

Reference data entity mapping cells to a unique current dipole.

property ab_map: dict | None

Get the ReferenceData.value_map of the ab_value_id

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

Function to copy a survey to a different parent entity.

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

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

Return entity

Registered Entity to the workspace.

property current_electrodes

The associated current electrode object (sources).

classmethod default_type_uid() UUID[source]
Returns

Default unique identifier

property metadata

Metadata attached to the entity.

property potential_electrodes

The associated potential_electrodes (receivers)

geoh5py.objects.surveys.magnetics

class geoh5py.objects.surveys.magnetics.AirborneMagnetics(object_type: ObjectType, name='Curve', **kwargs)[source]

Bases: Curve

An airborne magnetic survey object.

Warning

Partially implemented.

classmethod default_type_uid() UUID[source]
Returns

Default unique identifier