Options controlling the operation of the TemporalThinning filter. More...
#include <TemporalThinningParameters.h>
Public Attributes | |
| oops::Parameter< util::Duration > | minSpacing {"min_spacing", util::Duration("PT1H"), this} |
| Minimum spacing between two successive retained observations. More... | |
| oops::Parameter< util::Duration > | tolerance {"tolerance", util::Duration("PT0H"), this} |
| oops::OptionalParameter< util::DateTime > | seedTime {"seed_time", this} |
| oops::OptionalParameter< Variable > | categoryVariable {"category_variable", this} |
| oops::OptionalParameter< Variable > | priorityVariable {"priority_variable", this} |
 Public Attributes inherited from ufo::FilterParametersBaseWithAbstractAction | |
| oops::OptionalParameter< std::vector< Variable > > | filterVariables |
| oops::Parameter< std::vector< WhereParameters > > | where {"where", {}, this} |
| oops::Parameter< bool > | deferToPost {"defer to post", false, this} |
Additional Inherited Members | |
| Public Member Functions inherited from ufo::FilterParametersBase | |
| const FilterActionParametersBase & | action () const override |
| Return parameters defining the action performed on observations flagged by the filter. More... | |
Detailed Description
Options controlling the operation of the TemporalThinning filter.
Definition at line 28 of file TemporalThinningParameters.h.
Member Data Documentation
◆ categoryVariable
| oops::OptionalParameter<Variable> ufo::TemporalThinningParameters::categoryVariable {"category_variable", this} |
A string- or integer-valued variable. Observations with different values of that variable will be thinned separately.
If not set and observations were grouped into records when the observation space was constructed, observations from each record will be thinned separately. If not set and observations were not grouped into records, all observations will be thinned together.
Note: the variable used to group observations into records can be set with the obs space.obsdatain.obsgrouping.group variable YAML option.
Definition at line 59 of file TemporalThinningParameters.h.
◆ minSpacing
| oops::Parameter<util::Duration> ufo::TemporalThinningParameters::minSpacing {"min_spacing", util::Duration("PT1H"), this} |
Minimum spacing between two successive retained observations.
Definition at line 33 of file TemporalThinningParameters.h.
◆ priorityVariable
| oops::OptionalParameter<Variable> ufo::TemporalThinningParameters::priorityVariable {"priority_variable", this} |
Variable storing observation priorities. Used together with tolerance; see the documentation of that parameter for more information.
Definition at line 63 of file TemporalThinningParameters.h.
◆ seedTime
| oops::OptionalParameter<util::DateTime> ufo::TemporalThinningParameters::seedTime {"seed_time", this} |
If not set, the thinning filter will consider observations as candidates for retaining in chronological order.
If set, the filter will start from the observation taken as close as possible to seed_time, then consider all successive observations in chronological order, and finally all preceding observations in reverse chronological order.
Definition at line 48 of file TemporalThinningParameters.h.
◆ tolerance
| oops::Parameter<util::Duration> ufo::TemporalThinningParameters::tolerance {"tolerance", util::Duration("PT0H"), this} |
Only relevant if priority_variable is set.
If tolerance is nonzero, then whenever an observation O lying at least min_spacing from the previous retained observation O' is found, the filter will inspect all observations lying no more than tolerance further from O' and retain the one with the highest priority.
Definition at line 40 of file TemporalThinningParameters.h.
The documentation for this class was generated from the following file:
