.. role:: red .. role:: blue .. role:: navy Header ====== :navy:`latitude` ~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **latitude** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Latitude of the location. | 12.324 | | | | | | **Type**: float | None | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`longitude` ~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **longitude** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Longitude of the location. | 12.324 | | | | | | **Type**: float | None | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`elevation` ~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **elevation** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Elevation of the location. | 1234.0 | | | | | | **Type**: | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`datum` ~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **datum** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Datum of the location values. Usually a well | WGS 84 | | | known datum like WGS84. | | | **Type**: str | int | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`x` ~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **x** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative distance to the center of the | 10.0 | | | station | | | **Type**: | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`y` ~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **y** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative distance to the center of the | 10.0 | | | station | | | **Type**: | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`z` ~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **z** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | relative elevation to the center of the | 10.0 | | | station | | | **Type**: | | | | | | | | **Units**: meters | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`title` ~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **title** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | title of file | BIRRP Version 5| | | | basic mode | | **Type**: | | output | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`station` ~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **station** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | station name | mt001 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`azimuth` ~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **azimuth** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | rotation of full impedance tensor | 0 | | | | | | **Type**: | | | | | | | | **Units**: degrees | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.outputs` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.outputs** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of output channels | 2 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.inputs` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.inputs** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of input channels | 2 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.references` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.references** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of reference channels | 2 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.tbw` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.tbw** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | total bandwidth of window | 2.0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.deltat` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.deltat** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | sampling spacing, if negative sample rate. | 1.0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.nfft` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.nfft** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | length of time window. | 8192 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.nsctinc` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.nsctinc** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | number by which the segment length is divided | 2.0 | | | by to get next window. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.nsctmax` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.nsctmax** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | maximum number of sections | 2.0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.nf1` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.nf1** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | index of first frequency | 4 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.nfinc` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.nfinc** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | increment value of next frequency | 2 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.nfsect` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.nfsect** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | total number of frequencies to process. | 4 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.uin` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.uin** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | small leverage point minimum | 0.00 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.ainlin` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.ainlin** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | bounded influence value | -999 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.ainuin` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.ainuin** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | large leverage point minimu | 0.99 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.c2threshe` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.c2threshe** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | coherencey threshold for electric channels | 0.35 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.nz` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.nz** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Use threshold for hz channels | 0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.c2threshe1` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.c2threshe1** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | coherencey threshold for hz channels | 0.35 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.npcs` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.npcs** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | number of data segments used | 2 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.nar` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.nar** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | order of auto-regressive prewhitening filter. | 5 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.imode` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.imode** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | input data file mode | 0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.jmode` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.jmode** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | input time mode | 0 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`birrp_parameters.ncomp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **birrp_parameters.ncomp** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | number of components | 5 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data_blocks` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data_blocks** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | BIRRP data blocks | BirrpBlock(...)| | | | | | **Type**: list[mt_metadata.transfer_functions| | | | .io.jfiles.metadata.birrp_block.Bir | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`angles` ~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **angles** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | BIRRP angles | BirrpAngles(...| | | | ) | | **Type**: list[mt_metadata.transfer_functions| | | | .io.jfiles.metadata.birrp_angles.Bi | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+