.. role:: red .. role:: blue .. role:: navy DecimationLevel =============== :navy:`bands` ~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **bands** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | List of bands | [] | | | | | | **Type**: list[mt_metadata.common.band.Band] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`channel_weight_specs` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channel_weight_specs** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | List of weighting schemes to use for TF | [] | | | processing for each output channel | | | **Type**: typing.List[mt_metadata.features.we| | | | ights.channel_weight_spec.ChannelWe | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`input_channels` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **input_channels** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | list of input channels (sources) | hx, hy | | | | | | **Type**: list[str] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`output_channels` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **output_channels** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | list of output channels (responses) | ex, ey, hz | | | | | | **Type**: list[str] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`reference_channels` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **reference_channels** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | list of reference channels (remote sources) | hx, hy | | | | | | **Type**: list[str] | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`save_fcs` ~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **save_fcs** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Whether the Fourier coefficients are saved | True | | | [True] or not [False]. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`save_fcs_type` ~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **save_fcs_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Format to use for fc storage | h5 | | | | | | **Type**: mt_metadata.processing.aurora.decim| | | | ation_level.SaveFcsTypeEnum | None | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`decimation.level` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **decimation.level** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Decimation level, must be a non-negative | 0 | | | integer starting at 0 | | | **Type**: int | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`decimation.factor` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **decimation.factor** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Decimation factor between parent sample rate | 4.0 | | | and decimated time series sample rate. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`decimation.method` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **decimation.method** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Type of decimation | default | | | | | | **Type**: | | | | | | | | **Units**: | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`decimation.sample_rate` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **decimation.sample_rate** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Sample rate of the decimation level data | 256 | | | (after decimation). | | | **Type**: | | | | | | | | **Units**: samples per second | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`decimation.anti_alias_filter` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **decimation.anti_alias_filter** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Type of anti alias filter for decimation. | default | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`estimator.engine` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **estimator.engine** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | The transfer function estimator engine | RME_RR | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`estimator.estimate_per_channel` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **estimator.estimate_per_channel** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Estimate per channel | True | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`regression.minimum_cycles` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **regression.minimum_cycles** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Minimum number of cycles in the regression | 10 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`regression.max_iterations` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **regression.max_iterations** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Max iterations of the regression | 10 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`regression.max_redescending_iterations` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **regression.max_redescending_iterations** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Max redescending iterations of the regression | 2 | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`regression.r0` ~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **regression.r0** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | The number of standard deviations where the | 1.4 | | | influence function changes from linear to | | | **Type**: | quadratic | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`regression.u0` ~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **regression.u0** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Control for redescending Huber regression | 2.8 | | | weights. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`regression.tolerance` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **regression.tolerance** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Control for convergence of RME algorithm. | 0.005 | | | Lower means more iterations | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`regression.verbosity` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **regression.verbosity** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Control for logging messages during | 1 | | | regression -- Higher means more messages | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.harmonic_indices` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.harmonic_indices** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | List of harmonics indices kept, if all use -1 | [0, 4, 8] | | | | | | **Type**: typing.Union[int, list[int], | | | | NoneType] | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.method` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.method** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Fourier transform method | fft | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.min_num_stft_windows` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.min_num_stft_windows** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | How many FFT windows must be available for | 4 | | | the time series to valid for STFT. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.per_window_detrend_type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.per_window_detrend_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Additional detrending applied per window. | linear | | | Not available for standard scipy spectrogram | | | **Type**: | -- placholder for ARMA prewhitening. | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.pre_fft_detrend_type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.pre_fft_detrend_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Pre FFT detrend method to be applied | linear | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.prewhitening_type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.prewhitening_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Prewhitening method to be applied | first | | | | difference | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.recoloring` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.recoloring** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Whether the data are recolored [True] or not | True | | | [False]. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.window.num_samples` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.window.num_samples** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of samples in a single window | 256 | | | | | | **Type**: | | | | | | | | **Units**: samples | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.window.overlap` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.window.overlap** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of samples overlapped by adjacent | 32 | | | windows | | | **Type**: | | | | | | | | **Units**: samples | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.window.type` ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.window.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | name of the window type | hamming | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.window.clock_zero_type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.window.clock_zero_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | how the clock-zero is specified | user specified | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.window.clock_zero` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.window.clock_zero** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Start date and time of the first data window | 2020-02- | | | | 01T09:23:45.453| | **Type**: mt_metadata.common.mttime.MTime | | | 670+00:00 | | str | float | int | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.window.normalized` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.window.normalized** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | True if the window shall be normalized so the | False | | | sum of the coefficients is 1 | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`stft.window.additional_args` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **stft.window.additional_args** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Additional arguments for the window function | {'param': | | | | 'value'} | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+