.. role:: red .. role:: blue .. role:: navy StridingWindowCoherence ======================= :navy:`name` ~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **name** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Name of the feature. | simple | | | | coherence | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`description` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **description** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | A full description of what the feature | Simple | | | estimates. | coherence | | **Type**: | | measures the | | | | coherence | | **Units**: None | | between | | | | measured | | | | electric and | | | | magnetic | | | | fields. | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`domain` ~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **domain** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Temporal domain the feature is estimated in [ | frequency | | | 'frequency' | 'time' ] | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`comments.author` ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **comments.author** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | person who authored the comment | J. Pedantic | | | | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`comments.time_stamp` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **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:`comments.value` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **comments.value** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | comment string | failure at | | | | midnight. | | **Type**: str | list | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`data` ~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **data** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | The data associated with the feature. | path/to/datafil| | | | e.nc | | **Type**: xarray.core.dataarray.DataArray | | | | | xarray.core.dataset.Dataset | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`channel_1` ~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channel_1** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | The first channel of two channels in the | ex | | | coherence calculation. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`channel_2` ~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **channel_2** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | The second channel of two channels in the | hy | | | coherence calculation. | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`detrend` ~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **detrend** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | How to detrend the data segments before fft. | constant | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`station_1` ~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **station_1** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | The station associated with the first channel | PKD | | | in the coherence calculation. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`station_2` ~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **station_2** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | The station associated with the second | SAO | | | channel in the coherence calculation. | | | **Type**: str | None | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`window.num_samples` ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **window.num_samples** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of samples in a single window | 256 | | | | | | **Type**: | | | | | | | | **Units**: samples | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`window.overlap` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **window.overlap** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of samples overlapped by adjacent | 32 | | | windows | | | **Type**: | | | | | | | | **Units**: samples | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`window.type` ~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **window.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | name of the window type | hamming | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`window.clock_zero_type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **window.clock_zero_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | how the clock-zero is specified | user specified | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`window.clock_zero` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **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:`window.normalized` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **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:`window.additional_args` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **window.additional_args** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Additional arguments for the window function | {'param': | | | | 'value'} | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`subwindow.num_samples` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **subwindow.num_samples** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of samples in a single window | 256 | | | | | | **Type**: | | | | | | | | **Units**: samples | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`subwindow.overlap` ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **subwindow.overlap** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | Number of samples overlapped by adjacent | 32 | | | windows | | | **Type**: | | | | | | | | **Units**: samples | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`subwindow.type` ~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **subwindow.type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | name of the window type | hamming | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`subwindow.clock_zero_type` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **subwindow.clock_zero_type** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :red:`True` | how the clock-zero is specified | user specified | | | | | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+ :navy:`subwindow.clock_zero` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **subwindow.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:`subwindow.normalized` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **subwindow.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:`subwindow.additional_args` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: .. table:: :class: tight-table :widths: 45 45 15 +----------------------------------------------+-----------------------------------------------+----------------+ | **subwindow.additional_args** | **Description** | **Example** | +==============================================+===============================================+================+ | **Required**: :blue:`False` | Additional arguments for the window function | {'param': | | | | 'value'} | | **Type**: | | | | | | | | **Units**: None | | | | | | | | | | | | | | | | | | | | | | | | | | | +----------------------------------------------+-----------------------------------------------+----------------+