mt_metadata.transfer_functions.io.zonge.metadata.rx
Classes
str(object='') -> str |
|
Base class for all metadata objects with Pydantic validation. |
Module Contents
- class mt_metadata.transfer_functions.io.zonge.metadata.rx.CmpEnum
Bases:
str,enum.Enumstr(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’.
- zxx = 'zxx'
- zyy = 'zyy'
- zyx = 'zyx'
- zxy = 'zxy'
- txy = 'txy'
- tyx = 'tyx'
- null = ''
- class mt_metadata.transfer_functions.io.zonge.metadata.rx.Rx(**data)
Bases:
mt_metadata.base.MetadataBaseBase class for all metadata objects with Pydantic validation.
MetadataBase extends DotNotationBaseModel (which inherits from Pydantic’s BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange.
- _skip_equals
Private attribute listing fields to skip in equality comparisons
- Type:
list[str]
- _fields
Private attribute caching field information
- Type:
dict[str, Any]
Notes
All field assignments are validated automatically via Pydantic
None values are converted to appropriate defaults (empty string or 0.0)
Supports nested attribute access via dot notation
Thread-safe for read operations after initialization
- gdp_stn: Annotated[str, Field(default='', description='Station name', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['24']})]
- length: Annotated[float, Field(default=0.0, description='Generic dipole length', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['100']})]
- h_p_r: Annotated[list[float], Field(default=[], description='Horizontal, pitch, roll of array', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['0, 0, 180']})]
- cmp: Annotated[CmpEnum, Field(default='', description='processed component of impedance or tipper', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['zxx']})]
- center: Annotated[str | None, Field(default=None, description='center of the sounding location', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2 m']})]
- x_y_z1: Annotated[str | None, Field(default=None, description='xyz of local station', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2']})]
- x_y_z2: Annotated[str | None, Field(default=None, description='xyz of remote station', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2']})]
- u_t_m1: Annotated[str | None, Field(default=None, description='UTM location of local station', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2']})]
- a_space: Annotated[str | None, Field(default=None, description='spacing of lines', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['100 m']})]
- s_space: Annotated[str | None, Field(default=None, description='spacing of stations along the line', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['100']})]