Source code for geoh5py.objects.surveys.electromagnetics.magnetotellurics

#  Copyright (c) 2023 Mira Geoscience Ltd.
#  This file is part of geoh5py.
#  geoh5py is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Lesser General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#  geoh5py is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  GNU Lesser General Public License for more details.
#  You should have received a copy of the GNU Lesser General Public License
#  along with geoh5py.  If not, see <>.

from __future__ import annotations

import uuid

from geoh5py.objects.object_base import ObjectType
from geoh5py.objects.points import Points

from .base import BaseEMSurvey

[docs]class MTReceivers(BaseEMSurvey, Points): """ A magnetotellurics survey object. """ __TYPE_UID = uuid.UUID("{b99bd6e5-4fe1-45a5-bd2f-75fc31f91b38}") __TYPE = "Receivers" __UNITS = [ "Hertz (Hz)", "KiloHertz (kHz)", "MegaHertz (MHz)", "Gigahertz (GHz)", ] __INPUT_TYPE = ["Rx only"] def __init__(self, object_type: ObjectType, name="Magnetotellurics rx", **kwargs): super().__init__(object_type, name=name, **kwargs) @property def default_input_types(self) -> list[str]: """Choice of survey creation types.""" return self.__INPUT_TYPE @property def default_metadata(self) -> dict: """ :return: Default unique identifier """ return { "EM Dataset": { "Channels": [], "Input type": "Rx only", "Property groups": [], "Receivers": None, "Survey type": "Magnetotellurics", "Unit": "Hertz (Hz)", } } @property def default_receiver_type(self): """ :return: Transmitter class """ return MTReceivers @property def default_transmitter_type(self): """ :return: Transmitter class """ return type(None)
[docs] @classmethod def default_type_uid(cls) -> uuid.UUID: """ :return: Default unique identifier """ return cls.__TYPE_UID
@property def default_units(self) -> list[str]: """Accepted time units. Must be one of "Seconds (s)", "Milliseconds (ms)", "Microseconds (us)" or "Nanoseconds (ns)" """ return self.__UNITS @property def type(self): """Survey element type""" return self.__TYPE