geoh5py.objects.surveys

• geoh5py.objects.surveys.electromagnetics
  • geoh5py.objects.surveys.electromagnetics.airborne_tem
    • AirborneTEMReceivers
      • AirborneTEMReceivers.complement
      • AirborneTEMReceivers.default_type_uid()
      • AirborneTEMReceivers.type
    • AirborneTEMSurvey
      • AirborneTEMSurvey.base_receiver_type
      • AirborneTEMSurvey.base_transmitter_type
      • AirborneTEMSurvey.default_metadata
      • AirborneTEMSurvey.default_receiver_type
      • AirborneTEMSurvey.default_transmitter_type
    • AirborneTEMTransmitters
      • AirborneTEMTransmitters.complement
      • AirborneTEMTransmitters.default_type_uid()
      • AirborneTEMTransmitters.type
  • geoh5py.objects.surveys.electromagnetics.base
    • AirborneEMSurvey
      • AirborneEMSurvey.crossline_offset
      • AirborneEMSurvey.default_input_types
      • AirborneEMSurvey.fetch_metadata()
      • AirborneEMSurvey.inline_offset
      • AirborneEMSurvey.loop_radius
      • AirborneEMSurvey.pitch
      • AirborneEMSurvey.relative_to_bearing
      • AirborneEMSurvey.roll
      • AirborneEMSurvey.set_metadata()
      • AirborneEMSurvey.vertical_offset
      • AirborneEMSurvey.yaw
    • BaseEMSurvey
      • BaseEMSurvey.add_components_data()
      • BaseEMSurvey.add_validate_component_data()
      • BaseEMSurvey.channels
      • BaseEMSurvey.complement
      • BaseEMSurvey.components
      • BaseEMSurvey.copy()
      • BaseEMSurvey.copy_complement()
      • BaseEMSurvey.default_input_types
      • BaseEMSurvey.default_metadata
      • BaseEMSurvey.default_receiver_type
      • BaseEMSurvey.default_transmitter_type
      • BaseEMSurvey.default_type_uid()
      • BaseEMSurvey.default_units
      • BaseEMSurvey.edit_em_metadata()
      • BaseEMSurvey.edit_metadata()
      • BaseEMSurvey.input_type
      • BaseEMSurvey.metadata
      • BaseEMSurvey.receivers
      • BaseEMSurvey.survey_type
      • BaseEMSurvey.transmitters
      • BaseEMSurvey.type
      • BaseEMSurvey.unit
    • FEMSurvey
      • FEMSurvey.default_units
    • LargeLoopGroundEMSurvey
      • LargeLoopGroundEMSurvey.base_receiver_type
      • LargeLoopGroundEMSurvey.base_transmitter_type
      • LargeLoopGroundEMSurvey.copy_complement()
      • LargeLoopGroundEMSurvey.default_input_types
      • LargeLoopGroundEMSurvey.tx_id_property
    • MovingLoopGroundEMSurvey
      • MovingLoopGroundEMSurvey.base_receiver_type
      • MovingLoopGroundEMSurvey.base_transmitter_type
      • MovingLoopGroundEMSurvey.default_input_types
      • MovingLoopGroundEMSurvey.loop_radius
    • TEMSurvey
      • TEMSurvey.default_units
      • TEMSurvey.timing_mark
      • TEMSurvey.waveform
      • TEMSurvey.waveform_parameters
  • geoh5py.objects.surveys.electromagnetics.magnetotellurics
    • MTReceivers
      • MTReceivers.base_receiver_type
      • MTReceivers.base_transmitter_type
      • MTReceivers.default_input_types
      • MTReceivers.default_metadata
      • MTReceivers.default_receiver_type
      • MTReceivers.default_transmitter_type
      • MTReceivers.default_type_uid()
      • MTReceivers.type
  • geoh5py.objects.surveys.electromagnetics.tipper
    • TipperBaseStations
      • TipperBaseStations.complement
      • TipperBaseStations.default_type_uid()
      • TipperBaseStations.type
    • TipperReceivers
      • TipperReceivers.complement
      • TipperReceivers.default_type_uid()
      • TipperReceivers.type
    • TipperSurvey
      • TipperSurvey.base_receiver_type
      • TipperSurvey.base_stations
      • TipperSurvey.base_transmitter_type
      • TipperSurvey.copy_from_extent()
      • TipperSurvey.default_input_types
      • TipperSurvey.default_metadata
      • TipperSurvey.default_receiver_type
      • TipperSurvey.default_transmitter_type
      • TipperSurvey.default_units

geoh5py.objects.surveys.direct_current

class geoh5py.objects.surveys.direct_current.BaseElectrode(object_type: ObjectType, **kwargs)

Bases: Curve, ABC

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, clear_cache: bool = False, mask: ndarray | None = None, cell_mask: ndarray | None = None, **kwargs)

Sub-class extension of copy().

abstract property current_electrodes

The associated current_electrodes (transmitters)

abstract classmethod default_type_uid() → UUID

Default unique identifier. Implemented on the child class.

property metadata: dict | None

Metadata attached to the entity. To update the metadata, use the setter method. To remove the metadata, set it to None.

abstract property potential_electrodes

The associated potential_electrodes (receivers)

class geoh5py.objects.surveys.direct_current.CurrentElectrode(object_type: ObjectType, **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 current_electrodes

The associated current electrode object (sources).

classmethod default_type_uid() → UUID

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)

Bases: BaseElectrode

Ground potential electrode (receiver).

property current_electrodes

The associated current electrode object (sources).

classmethod default_type_uid() → UUID

Returns:

Default unique identifier

property potential_electrodes

The associated potential_electrodes (receivers)

geoh5py.objects.surveys.magnetics

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

Bases: Curve

An airborne magnetic survey object.

Warning

Partially implemented.

classmethod default_type_uid() → UUID

Returns:

Default unique identifier