StridingWindowCoherence

name

name	Description	Example
Required: True Type: <class ‘str’> Units: None	Name of the feature.	simple coherence

description

description	Description	Example
Required: True Type: <class ‘str’> Units: None	A full description of what the feature estimates.	Simple coherence measures the coherence between measured electric and magnetic fields.

domain

domain	Description	Example
Required: True Type: <enum ‘DomainEnum’> Units: None	Temporal domain the feature is estimated in [ ‘frequency’ | ‘time’ ]	frequency

comments.author

comments.author	Description	Example
Required: False Type: str | None Units: None	person who authored the comment	Pedantic

comments.time_stamp

comments.time_stamp	Description	Example
Required: False Type: float | int | numpy.datetime64 | pa ndas._libs.tslibs.timestamps.Timest Units: None	Date and time of in UTC of when comment was made.	2020-02- 01T09:23:45.453 670+00:00

comments.value

comments.value	Description	Example
Required: False Type: str | list | None Units: None	comment string	failure at midnight.

data

data	Description	Example
Required: True Type: xarray.core.dataarray.DataArray | xarray.core.dataset.Dataset | Units: None	The data associated with the feature.	path/to/datafil e.nc

channel_1

channel_1	Description	Example
Required: True Type: <class ‘str’> Units: None	The first channel of two channels in the coherence calculation.	ex

channel_2

channel_2	Description	Example
Required: True Type: <class ‘str’> Units: None	The second channel of two channels in the coherence calculation.	hy

detrend

detrend	Description	Example
Required: True Type: <enum ‘DetrendEnum’> Units: None	How to detrend the data segments before fft.	constant

station_1

station_1	Description	Example
Required: True Type: str | None Units: None	The station associated with the first channel in the coherence calculation.	PKD

station_2

station_2	Description	Example
Required: True Type: str | None Units: None	The station associated with the second channel in the coherence calculation.	SAO

window.num_samples

window.num_samples	Description	Example
Required: True Type: <class ‘int’> Units: samples	Number of samples in a single window	256

window.overlap

window.overlap	Description	Example
Required: True Type: <class ‘int’> Units: samples	Number of samples overlapped by adjacent windows	32

window.type

window.type	Description	Example
Required: True Type: <enum ‘TypeEnum’> Units: None	name of the window type	hamming

window.clock_zero_type

window.clock_zero_type	Description	Example
Required: True Type: <enum ‘ClockZeroTypeEnum’> Units: None	how the clock-zero is specified	user specified

window.clock_zero

window.clock_zero	Description	Example
Required: False Type: mt_metadata.common.mttime.MTime | str | float | int | Units: None	Start date and time of the first data window	2020-02- 01T09:23:45.453 670+00:00

window.normalized

window.normalized	Description	Example
Required: True Type: <class ‘bool’> Units: None	True if the window shall be normalized so the sum of the coefficients is 1	False

window.additional_args

window.additional_args	Description	Example
Required: False Type: <class ‘dict’> Units: None	Additional arguments for the window function	{‘param’: ‘value’}

subwindow.num_samples

subwindow.num_samples	Description	Example
Required: True Type: <class ‘int’> Units: samples	Number of samples in a single window	256

subwindow.overlap

subwindow.overlap	Description	Example
Required: True Type: <class ‘int’> Units: samples	Number of samples overlapped by adjacent windows	32

subwindow.type

subwindow.type	Description	Example
Required: True Type: <enum ‘TypeEnum’> Units: None	name of the window type	hamming

subwindow.clock_zero_type

subwindow.clock_zero_type	Description	Example
Required: True Type: <enum ‘ClockZeroTypeEnum’> Units: None	how the clock-zero is specified	user specified

subwindow.clock_zero

subwindow.clock_zero	Description	Example
Required: False Type: mt_metadata.common.mttime.MTime | str | float | int | Units: None	Start date and time of the first data window	2020-02- 01T09:23:45.453 670+00:00

subwindow.normalized

subwindow.normalized	Description	Example
Required: True Type: <class ‘bool’> Units: None	True if the window shall be normalized so the sum of the coefficients is 1	False

subwindow.additional_args

subwindow.additional_args	Description	Example
Required: False Type: <class ‘dict’> Units: None	Additional arguments for the window function	{‘param’: ‘value’}