mt_metadata.transfer_functions.io.jfiles.metadata.header

Classes

A partial location class that only includes the latitude, longitude, and elevation.

class mt_metadata.transfer_functions.io.jfiles.metadata.header.Header(**data)

A partial location class that only includes the latitude, longitude, and elevation. This is used to avoid circular imports.

title: Annotated[str, Field(default='', description='title of file', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['BIRRP Version 5 basic mode output']})]

station: Annotated[str, Field(default='', description='station name', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['mt001']})]

azimuth: Annotated[float, Field(default=0.0, description='rotation of full impedance tensor', alias=None, json_schema_extra={'units': 'degrees', 'required': True, 'examples': ['0']})]

birrp_parameters: Annotated[mt_metadata.transfer_functions.io.jfiles.metadata.BirrpParameters, Field(default_factory=BirrpParameters, description='BIRRP parameters', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['BirrpParameters(...)']})]

data_blocks: Annotated[list[mt_metadata.transfer_functions.io.jfiles.metadata.BirrpBlock], Field(default_factory=list, description='BIRRP data blocks', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['BirrpBlock(...)']})]

angles: Annotated[list[mt_metadata.transfer_functions.io.jfiles.metadata.BirrpAngles], Field(default_factory=list, description='BIRRP angles', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['BirrpAngles(...)']})]

read_header(j_lines)

Parsing the header lines of a j-file to extract processing information.

read_metadata(j_lines)

Read in the metadata of the station, or information of station logistics like: lat, lon, elevation

Parameters: