geoh5py.objects.surveys package

Contents

geoh5py.objects.surveys package#

Subpackages#

geoh5py.objects.surveys.electromagnetics package

Submodules#

geoh5py.objects.surveys.direct_current module#

class geoh5py.objects.surveys.direct_current.BaseElectrode(**kwargs)#

Bases: BaseSurvey, Curve, ABC

property ab_cell_id: ReferencedData | None#: Reference data entity mapping cells to a unique current dipole.

property ab_map: ReferenceValueMap | None#: Get the ReferenceData.value_map of the ab_value_id

abstract property complement: BaseElectrode | None#: The complement object for the current object.

property complement_reference#: Reference data linking the geometry of complement entity.

abstract property current_electrodes#: The associated current_electrodes (transmitters)

property omit_list: tuple#: List of attributes to omit when copying.

abstract property potential_electrodes#: The associated potential_electrodes (receivers)

property type_map: dict[str, str]#: Mapping of the electrode types to the associated electrode.

static validate_metadata(value: dict | ndarray | bytes) → dict#

class geoh5py.objects.surveys.direct_current.CurrentElectrode(**kwargs)#

Bases: BaseElectrode

Ground direct current electrode (transmitter).

add_default_ab_cell_id()#: Utility function to set ab_cell_id’s based on curve cells.

property complement: PotentialElectrode | None#: The complement object for the current object.

property current_electrodes#: The associated current electrode object (sources).

property potential_electrodes: PotentialElectrode | None#: The associated potential_electrodes (receivers)

property type#: Survey element type

class geoh5py.objects.surveys.direct_current.PotentialElectrode(**kwargs)#

Bases: BaseElectrode

Ground potential electrode (receiver).

property complement: CurrentElectrode | None#: The complement object for the current object.

property current_electrodes#: The associated current electrode object (sources).

property potential_electrodes#: The associated potential_electrodes (receivers)

property type#: Survey element type

geoh5py.objects.surveys.magnetics module#

class geoh5py.objects.surveys.magnetics.AirborneMagnetics(current_line_id: UUID | None = None, parts: ndarray | None = None, vertices: ndarray | list | tuple | None = None, **kwargs)#

Bases: Curve

An airborne magnetic survey object.

Warning

Partially implemented.

Module contents#