mt_metadata.common.enumerations =============================== .. py:module:: mt_metadata.common.enumerations Classes ------- .. autoapisummary:: mt_metadata.common.enumerations.StrEnumerationBase mt_metadata.common.enumerations.YesNoEnum mt_metadata.common.enumerations.DataTypeEnum mt_metadata.common.enumerations.ArrayDTypeEnum mt_metadata.common.enumerations.EstimateIntentionEnum mt_metadata.common.enumerations.ChannelLayoutEnum mt_metadata.common.enumerations.ElectrodeLocationEnum mt_metadata.common.enumerations.OrientationMethodEnum mt_metadata.common.enumerations.GeographicReferenceFrameEnum mt_metadata.common.enumerations.ChannelOrientationEnum mt_metadata.common.enumerations.GeomagneticModelEnum mt_metadata.common.enumerations.FilterTypeEnum mt_metadata.common.enumerations.SymmetryEnum mt_metadata.common.enumerations.SignConventionEnum mt_metadata.common.enumerations.StdEDIversionsEnum mt_metadata.common.enumerations.ReleaseStatusEnum mt_metadata.common.enumerations.ChannelEnum mt_metadata.common.enumerations.LicenseEnumMeta mt_metadata.common.enumerations.LicenseEnum Module Contents --------------- .. py:class:: StrEnumerationBase Bases: :py:obj:`str`, :py:obj:`enum.Enum` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:class:: YesNoEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: yes :value: 'yes' .. py:attribute:: no :value: 'no' .. py:class:: DataTypeEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: RMT :value: 'RMT' .. py:attribute:: AMT :value: 'AMT' .. py:attribute:: BBMT :value: 'BBMT' .. py:attribute:: LPMT :value: 'LPMT' .. py:attribute:: ULPMT :value: 'ULPMT' .. py:attribute:: MT :value: 'MT' .. py:attribute:: LP :value: 'LP' .. py:attribute:: BB :value: 'BB' .. py:attribute:: WB :value: 'WB' .. py:attribute:: MT_TF :value: 'MT_TF' .. py:attribute:: BBMT_TF :value: 'BBMT_TF' .. py:attribute:: WBMT_TF :value: 'WBMT_TF' .. py:attribute:: LPMT_TF :value: 'LPMT_TF' .. py:attribute:: CSAMT :value: 'CSAMT' .. py:attribute:: NSAMT :value: 'NSAMT' .. py:class:: ArrayDTypeEnum Bases: :py:obj:`str`, :py:obj:`enum.Enum` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: real_type :value: 'real' .. py:attribute:: complex_type :value: 'complex' .. py:attribute:: float_type :value: 'float' .. py:attribute:: int_type :value: 'int' .. py:attribute:: complex_128_type :value: 'complex128' .. py:attribute:: complex_64_type :value: 'complex64' .. py:attribute:: float_64_type :value: 'float64' .. py:attribute:: float_32_type :value: 'float32' .. py:attribute:: float_16_type :value: 'float16' .. py:attribute:: int_64_type :value: 'int64' .. py:attribute:: int_32_type :value: 'int32' .. py:attribute:: int_16_type :value: 'int16' .. py:attribute:: int_8_type :value: 'int8' .. py:class:: EstimateIntentionEnum Bases: :py:obj:`str`, :py:obj:`enum.Enum` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: error_estimate :value: 'error estimate' .. py:attribute:: signal_coherence :value: 'signal coherence' .. py:attribute:: signal_power_estimate :value: 'signal power estimate' .. py:attribute:: primary_data_type :value: 'primary data type' .. py:attribute:: derived_data_type :value: 'derived data type' .. py:class:: ChannelLayoutEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: L :value: 'L' .. py:attribute:: X :value: 'X' .. py:attribute:: plus :value: '+' .. py:class:: ElectrodeLocationEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: N :value: 'N' .. py:attribute:: S :value: 'S' .. py:attribute:: E :value: 'E' .. py:attribute:: W :value: 'W' .. py:attribute:: NONE :value: '' .. py:class:: OrientationMethodEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: compass :value: 'compass' .. py:attribute:: GPS :value: 'GPS' .. py:attribute:: theodolite :value: 'theodolite' .. py:class:: GeographicReferenceFrameEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: geographic :value: 'geographic' .. py:attribute:: geomagnetic :value: 'geomagnetic' .. py:attribute:: station :value: 'station' .. py:attribute:: site_layout :value: 'sitelayout' .. py:class:: ChannelOrientationEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: orthogonal :value: 'orthogonal' .. py:attribute:: station :value: 'station' .. py:attribute:: site_layout :value: 'sitelayout' .. py:class:: GeomagneticModelEnum Bases: :py:obj:`str`, :py:obj:`enum.Enum` split by - if needed .. py:attribute:: EMAG2 :value: 'EMAG2' .. py:attribute:: EMM :value: 'EMM' .. py:attribute:: HDGM :value: 'HDGM' .. py:attribute:: IGRF :value: 'IGRF' .. py:attribute:: WMM :value: 'WMM' .. py:attribute:: unknown :value: 'unknown' .. py:class:: FilterTypeEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: fap_table :value: 'fap' .. py:attribute:: zpk :value: 'zpk' .. py:attribute:: time_delay :value: 'time_delay' .. py:attribute:: coefficient :value: 'coefficient' .. py:attribute:: fir :value: 'fir' .. py:class:: SymmetryEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: NONE :value: 'NONE' .. py:attribute:: ODD :value: 'ODD' .. py:attribute:: EVEN :value: 'EVEN' .. py:class:: SignConventionEnum Bases: :py:obj:`str`, :py:obj:`enum.Enum` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: plus :value: '+' .. py:attribute:: minus :value: '-' .. py:attribute:: exp_plus :value: 'exp(+iwt)' .. py:attribute:: exp_minus :value: 'exp(-iwt)' .. py:attribute:: exp_plus_iwt :value: 'exp(+ i\\omega t)' .. py:attribute:: exp_minus_iwt :value: 'exp(- i\\omega t)' .. py:class:: StdEDIversionsEnum Bases: :py:obj:`str`, :py:obj:`enum.Enum` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: SEG_1 :value: 'SEG 1.0' .. py:attribute:: one :value: '1.0' .. py:attribute:: SEG_10 :value: 'SEG_1.0' .. py:attribute:: SEG_101 :value: 'SEG 1.01' .. py:attribute:: SEG_1011 :value: 'SEG_1.01' .. py:class:: ReleaseStatusEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: Unrestricted_release :value: 'Unrestricted Release' .. py:attribute:: Restricted_release :value: 'Restricted Release' .. py:attribute:: Paper_Citation_Required :value: 'Paper Citation Required' .. py:attribute:: Academic_Use_Only :value: 'Academic Use Only' .. py:attribute:: Conditions_Apply :value: 'Conditions Apply' .. py:attribute:: Data_Citation_Required :value: 'Data Citation Required' .. py:class:: ChannelEnum Bases: :py:obj:`StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: ex :value: 'ex' .. py:attribute:: ey :value: 'ey' .. py:attribute:: hx :value: 'hx' .. py:attribute:: hy :value: 'hy' .. py:attribute:: hz :value: 'hz' .. py:attribute:: null :value: '' .. py:class:: LicenseEnumMeta Bases: :py:obj:`enum.EnumMeta` Metaclass to dynamically load license data when the enum is defined .. py:class:: LicenseEnum Bases: :py:obj:`str`, :py:obj:`enum.Enum` Enumeration of software licenses. Dynamically loaded from JSON data.