DecimationLevel
bands |
Description |
Example |
|---|---|---|
Required: True Type: list[mt_metadata.common.band.Band] Units: None |
List of bands |
[] |
channel_weight_specs |
Description |
Example |
|---|---|---|
Required: True Type: typing.List[mt_metadata.features.we ights.channel_weight_spec.ChannelWe Units: None |
List of weighting schemes to use for TF processing for each output channel |
[] |
input_channels |
Description |
Example |
|---|---|---|
Required: True Type: list[str] Units: None |
list of input channels (sources) |
hx, hy |
output_channels |
Description |
Example |
|---|---|---|
Required: True Type: list[str] Units: None |
list of output channels (responses) |
ex, ey, hz |
reference_channels |
Description |
Example |
|---|---|---|
Required: True Type: list[str] Units: None |
list of reference channels (remote sources) |
hx, hy |
save_fcs |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘bool’> Units: None |
Whether the Fourier coefficients are saved [True] or not [False]. |
True |
save_fcs_type |
Description |
Example |
|---|---|---|
Required: False Type: mt_metadata.processing.aurora.decim ation_level.SaveFcsTypeEnum | None Units: None |
Format to use for fc storage |
h5 |
decimation.level |
Description |
Example |
|---|---|---|
Required: True Type: int | None Units: None |
Decimation level, must be a non-negative integer starting at 0 |
0 |
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 |
decimation.method |
Description |
Example |
|---|---|---|
Required: True Type: <enum ‘MethodEnum’> Units: |
Type of decimation |
default |
decimation.sample_rate |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘float’> Units: samples per second |
Sample rate of the decimation level data (after decimation). |
256 |
decimation.anti_alias_filter |
Description |
Example |
|---|---|---|
Required: True Type: str | None Units: None |
Type of anti alias filter for decimation. |
default |
estimator.engine |
Description |
Example |
|---|---|---|
Required: True Type: <enum ‘EngineEnum’> Units: None |
The transfer function estimator engine |
RME_RR |
estimator.estimate_per_channel |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘bool’> Units: None |
Estimate per channel |
True |
regression.minimum_cycles |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘int’> Units: None |
Minimum number of cycles in the regression |
10 |
regression.max_iterations |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘int’> Units: None |
Max iterations of the regression |
10 |
regression.max_redescending_iterations |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘int’> Units: None |
Max redescending iterations of the regression |
2 |
regression.r0 |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘float’> Units: None |
The number of standard deviations where the influence function changes from linear to quadratic |
1.4 |
regression.u0 |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘float’> Units: None |
Control for redescending Huber regression weights. |
2.8 |
regression.tolerance |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘float’> Units: None |
Control for convergence of RME algorithm. Lower means more iterations |
0.005 |
regression.verbosity |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘int’> Units: None |
Control for logging messages during regression – Higher means more messages |
1 |
stft.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] |
stft.method |
Description |
Example |
|---|---|---|
Required: True Type: <enum ‘MethodEnum’> Units: None |
Fourier transform method |
fft |
stft.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 |
stft.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 |
stft.pre_fft_detrend_type |
Description |
Example |
|---|---|---|
Required: True Type: <enum ‘PreFftDetrendTypeEnum’> Units: None |
Pre FFT detrend method to be applied |
linear |
stft.prewhitening_type |
Description |
Example |
|---|---|---|
Required: True Type: <enum ‘PrewhiteningTypeEnum’> Units: None |
Prewhitening method to be applied |
first difference |
stft.recoloring |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘bool’> Units: None |
Whether the data are recolored [True] or not [False]. |
True |
stft.window.num_samples |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘int’> Units: samples |
Number of samples in a single window |
256 |
stft.window.overlap |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘int’> Units: samples |
Number of samples overlapped by adjacent windows |
32 |
stft.window.type |
Description |
Example |
|---|---|---|
Required: True Type: <enum ‘TypeEnum’> Units: None |
name of the window type |
hamming |
stft.window.clock_zero_type |
Description |
Example |
|---|---|---|
Required: True Type: <enum ‘ClockZeroTypeEnum’> Units: None |
how the clock-zero is specified |
user specified |
stft.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 |
stft.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 |
stft.window.additional_args |
Description |
Example |
|---|---|---|
Required: False Type: <class ‘dict’> Units: None |
Additional arguments for the window function |
{‘param’: ‘value’} |