Skip to content

Latest commit

 

History

History
682 lines (572 loc) · 51.6 KB

tf_processing_aurora_decimation_level.rst

File metadata and controls

682 lines (572 loc) · 51.6 KB

DecimationLevel

anti_alias_filter

anti_alias_filter Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: default

Name of anti alias filter to be applied default

recoloring

recoloring Description Example

Required: True

Units: None

Type: boolean

Style: free form

Default: True

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

min_num_stft_windows

min_num_stft_windows Description Example

Required: True

Units: None

Type: integer

Style: number

Default: 2

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

method

method Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: fft

Fourier transform method fft

prewhitening_type

prewhitening_type Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: first difference

Prewhitening method to be applied first difference

extra_pre_fft_detrend_type

extra_pre_fft_detrend_type Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: linear

Extra Pre FFT detrend method to be applied linear

pre_fft_detrend_type

pre_fft_detrend_type Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: linear

Pre FFT detrend method to be applied linear

bands

bands Description Example

Required: True

Units: None

Type: integer

Style: name list

Default: []

List of bands []

input_channels

input_channels Description Example

Required: True

Units: None

Type: string

Style: name list

Default: ['hx', 'hy']

list of input channels (sources) hx, hy

output_channels

output_channels Description Example

Required: True

Units: None

Type: string

Style: name list

Default: ['ex', 'ey', 'hz']

list of output channels (responses) ex, ey, hz

reference_channels

reference_channels Description Example

Required: True

Units: None

Type: string

Style: name list

Default: ['hx', 'hy']

list of reference channels (remote sources) hx, hy

save_fcs

save_fcs Description Example

Required: True

Units: None

Type: boolean

Style: free form

Default: False

Whether the Fourier coefficients are saved [True] or not [False]. True

save_fcs_type

save_fcs_type Description Example

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: None

Format to use for fc storage h5

decimation.level

decimation.level Description Example

Required: True

Units: None

Type: integer

Style: number

Default: 0

Decimation level in sequential order 0

decimation.factor

decimation.factor Description Example

Required: True

Units: None

Type: float

Style: number

Default: 1.0

Decimation factor 1

decimation.method

decimation.method Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: default

Type of decimation default

decimation.sample_rate

decimation.sample_rate Description Example

Required: True

Units: samples per second

Type: float

Style: number

Default: 1.0

Sample rate of the data after decimation. 256

window.num_samples

window.num_samples Description Example

Required: True

Units: samples

Type: integer

Style: number

Default: 128

Number of samples in a single window 256

window.overlap

window.overlap Description Example

Required: True

Units: samples

Type: integer

Style: number

Default: 32

Number of samples overlapped by adjacent windows 32

window.type

window.type Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: boxcar

name of the window type hamming

window.clock_zero_type

window.clock_zero_type Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: ignore

how the clock-zero is specified user specified

window.clock_zero

window.clock_zero Description Example

Required: False

Units: None

Type: string

Style: time

Default: 1980-01-01T00:00:00+00:00

Start date and time of the first data window 2020-02-01T09:2 3:45.453670+00: 00

regression.minimum_cycles

regression.minimum_cycles Description Example

Required: True

Units: None

Type: integer

Style: number

Default: 10

Minimum number of cycles in the regression 10

regression.max_iterations

regression.max_iterations Description Example

Required: True

Units: None

Type: integer

Style: number

Default: 10

Max iterations of the regression 10

regression.max_redescending_iterations

regression.max_redescending_iterations Description Example

Required: True

Units: None

Type: integer

Style: number

Default: 2

Max redescending iterations of the regression 2

estimator.engine

estimator.engine Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: RME_RR

The transfer function estimator engine RME_RR

estimator.estimate_per_channel

estimator.estimate_per_channel Description Example

Required: True

Units: None

Type: boolean

Style: free form

Default: True

Estimate per channel True