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} |
Detailed Description
Options controlling the operation of the TemporalThinning filter.
Definition at line 27 of file TemporalThinningParameters.h.
Member Data Documentation
◆ categoryVariable
| oops::OptionalParameter<Variable> ufo::TemporalThinningParameters::categoryVariable {"category_variable", this} |
Variable storing integer-valued IDs associated with observations. Observations belonging to different categories are thinned separately.
Definition at line 51 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 32 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 55 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 47 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 39 of file TemporalThinningParameters.h.
The documentation for this class was generated from the following file:
