.. role:: red .. role:: blue .. role:: navy TransferFunction ================ :navy:`id` ~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **id** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | transfer function id | mt01_256 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`sign_convention` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **sign_convention** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | sign of the transfer function estimates | + | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`units` ~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **units** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | units of the impedance tensor estimates | milliVolt per | | | | kilometer per | | **Type**: | | nanoTesla | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`runs_processed` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **runs_processed** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | list of runs used in the processing | ['MT001a', | | | | 'MT001c'] | | **Type**: list[str] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`remote_references` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **remote_references** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | list of remote references | ['MT002b', | | | | 'MT002c'] | | **Type**: list[str] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processed_date` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processed_date** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | date the data were processed | 2020-01- | | | | 01T12:00:00 | | **Type**: mt_metadata.common.mttime.MTime | | | | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processing_parameters` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processing_parameters** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | list of processing parameters with structure | ['nfft=4096', | | | name = value | 'n_windows=16']| | **Type**: list[str] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processed_by.organization` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processed_by.organization** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Organization full name | mt gurus | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processed_by.email` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processed_by.email** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Email of the contact person | mt.guru@em.org | | | | | | **Type**: pydantic.networks.EmailStr | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processed_by.url` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processed_by.url** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | URL of the contact person | https://em.org | | | | | | **Type**: pydantic.networks.AnyUrl | None | | | | | str | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processed_by.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processed_by.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processed_by.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processed_by.comments.time_stamp** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Date and time of in UTC of when comment was | 2020-02- | | | made. | 01T09:23:45.453| | **Type**: float | int | numpy.datetime64 | pa| | 670+00:00 | | ndas._libs.tslibs.timestamps.Timest | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processed_by.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processed_by.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processed_by.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processed_by.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Persons name, should be full first and last | person name | | | name. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processing_type` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processing_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Type of processing | robust remote | | | | reference | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`software.author` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **software.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Author of the software | Neo | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`software.version` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **software.version** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Software version | 12.01a | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`software.last_updated` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **software.last_updated** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Most recent date the software was updated. | 2020-01-01 | | | Prefer to use version, but this works for | | | **Type**: mt_metadata.common.mttime.MTime | | non-versioned software. | | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`software.name` ~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **software.name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Software name | mtrules | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.warnings` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.warnings** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | any warnings about the data that should be | periodic | | | noted | pipeline noise | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.good_from_period` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.good_from_period** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Data are good for periods larger than this | 0.01 | | | number | | | **Type**: float | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.good_to_period` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.good_to_period** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Data are good for periods smaller than this | 1000 | | | number | | | **Type**: float | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.flag` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.flag** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Flag for data quality | 0 | | | | | | **Type**: int | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.comments.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.comments.time_stamp** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Date and time of in UTC of when comment was | 2020-02- | | | made. | 01T09:23:45.453| | **Type**: float | int | numpy.datetime64 | pa| | 670+00:00 | | ndas._libs.tslibs.timestamps.Timest | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.comments.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.rating.author` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.rating.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Author of who rated the data. | gradstudent ace| | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.rating.method` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.rating.method** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | The method used to rate the data. | standard | | | | deviation | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_quality.rating.value` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_quality.rating.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | A rating from 1-5 where 1 is bad and 5 is | 4 | | | good and 0 if unrated. | | | **Type**: int | None | str | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`coordinate_system` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **coordinate_system** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | coordinate system that the transfer function | geographic | | | is in. It is strongly recommended that the | | | **Type**: | geographic coordinates with geographic north | | | **Units**: None | as 0 and east as 90. | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`processing_config` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **processing_config** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | processing configuration | aurora.processi| | | | ng | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+