Decimation

id

id

Description

Example

Required: True

Type: <class ‘str’>

Units: None

Decimation level ID

1

channels_estimated

channels_estimated

Description

Example

Required: True

Type: list[str]

Units: None

list of channels

[ex, hy]

time_period.end

time_period.end

Description

Example

Required: True

Type: str | float | int | numpy.datetime64 | pandas._libs.tsl Units: None

End date and time of collection in UTC.

2020-02- 04T16:23:45.453 670+00:00

time_period.start

time_period.start

Description

Example

Required: True

Type: str | float | int | numpy.datetime64 | pandas._libs.tsl Units: None

Start date and time of collection in UTC.

2020-02- 01T09:23:45.453 670+00:00

channels

channels

Description

Example

Required: True

Type: <class ‘mt_metadata.common.list_dic t.ListDict’> Units: None

List of channels

[ex, hy]

time_series_decimation.level

time_series_decimation.level

Description

Example

Required: True

Type: int | None

Units: None

Decimation level, must be a non-negative integer starting at 0

0

time_series_decimation.factor

time_series_decimation.factor

Description

Example

Required: True

Type: <class ‘float’>

Units: None

Decimation factor between parent sample rate and decimated time series sample rate.

4.0

time_series_decimation.method

time_series_decimation.method

Description

Example

Required: True

Type: <enum ‘MethodEnum’>

Units:

Type of decimation

default

time_series_decimation.sample_rate

time_series_decimation.sample_rate

Description

Example

Required: True

Type: <class ‘float’>

Units: samples per second

Sample rate of the decimation level data (after decimation).

256

time_series_decimation.anti_alias_filter

time_series_decimation.anti_alias_filter

Description

Example

Required: True

Type: str | None

Units: None

Type of anti alias filter for decimation.

default

short_time_fourier_transform.harmonic_indices

short_time_fourier_transform.harmonic_indices

Description

Example

Required: True

Type: typing.Union[int, list[int], NoneType]

Units: None

List of harmonics indices kept, if all use -1

[0, 4, 8]

short_time_fourier_transform.method

short_time_fourier_transform.method

Description

Example

Required: True

Type: <enum ‘MethodEnum’>

Units: None

Fourier transform method

fft

short_time_fourier_transform.min_num_stft_windows

short_time_fourier_transform.min_num_stft_windows

Description

Example

Required: True

Type: <class ‘int’>

Units: None

How many FFT windows must be available for the time series to valid for STFT.

4

short_time_fourier_transform.per_window_detrend_type

short_time_fourier_transform.per_window_detrend_type

Description

Example

Required: True

Type: <enum ‘PerWindowDetrendTypeEnum’>

Units: None

Additional detrending applied per window. Not available for standard scipy spectrogram – placholder for ARMA prewhitening.

linear

short_time_fourier_transform.pre_fft_detrend_type

short_time_fourier_transform.pre_fft_detrend_type

Description

Example

Required: True

Type: <enum ‘PreFftDetrendTypeEnum’>

Units: None

Pre FFT detrend method to be applied

linear

short_time_fourier_transform.prewhitening_type

short_time_fourier_transform.prewhitening_type

Description

Example

Required: True

Type: <enum ‘PrewhiteningTypeEnum’>

Units: None

Prewhitening method to be applied

first difference

short_time_fourier_transform.recoloring

short_time_fourier_transform.recoloring

Description

Example

Required: True

Type: <class ‘bool’>

Units: None

Whether the data are recolored [True] or not [False].

True

short_time_fourier_transform.window.num_samples

short_time_fourier_transform.window.num_samples

Description

Example

Required: True

Type: <class ‘int’>

Units: samples

Number of samples in a single window

256

short_time_fourier_transform.window.overlap

short_time_fourier_transform.window.overlap

Description

Example

Required: True

Type: <class ‘int’>

Units: samples

Number of samples overlapped by adjacent windows

32

short_time_fourier_transform.window.type

short_time_fourier_transform.window.type

Description

Example

Required: True

Type: <enum ‘TypeEnum’>

Units: None

name of the window type

hamming

short_time_fourier_transform.window.clock_zero_type

short_time_fourier_transform.window.clock_zero_type

Description

Example

Required: True

Type: <enum ‘ClockZeroTypeEnum’>

Units: None

how the clock-zero is specified

user specified

short_time_fourier_transform.window.clock_zero

short_time_fourier_transform.window.clock_zero

Description

Example

Required: False

Type: mt_metadata.common.mttime.MTime | str | float | int | numpy.datetime64 | Units: None

Start date and time of the first data window

2020-02- 01T09:23:45.453 670+00:00

short_time_fourier_transform.window.normalized

short_time_fourier_transform.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

short_time_fourier_transform.window.additional_args

short_time_fourier_transform.window.additional_args

Description

Example

Required: False

Type: <class ‘dict’>

Units: None

Additional arguments for the window function

{‘param’: ‘value’}