CoefficientFilter
name |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘str’> Units: None |
Name of filter applied or to be applied. If more than one filter input as a comma separated list. |
“lowpass_magnet ic” |
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 |
Description |
Example |
|---|---|---|
Required: False Type: str | list | None Units: None |
comment string |
failure at midnight. |
type |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘str’> Units: None |
Type of filter. Must be ‘coefficient’ |
coefficient |
units_in |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘str’> Units: None |
Name of the input units to the filter. Should be all lowercase and separated with an underscore, use ‘per’ if units are divided and ‘-’ if units are multiplied. |
count |
units_out |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘str’> Units: None |
Name of the output units. Should be all lowercase and separated with an underscore, use ‘per’ if units are divided and ‘-’ if units are multiplied. |
millivolt |
calibration_date |
Description |
Example |
|---|---|---|
Required: False Type: mt_metadata.common.mttime.MTime | str | float | int | Units: None |
Most recent date of filter calibration in ISO format of YYY-MM-DD. |
2020-01-01 |
gain |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘float’> Units: None |
Scale factor for a simple coefficient filter. |
100 |
sequence_number |
Description |
Example |
|---|---|---|
Required: True Type: <class ‘int’> Units: None |
Sequence number of the filter in the processing chain. |
1 |
comments.author
comments.author
Description
Example
Required: False
Type: str | None
Units: None
person who authored the comment
Pedantic