Options controlling the operation of history check filter. More...
#include <HistoryCheckParameters.h>
Public Attributes | |
| oops::RequiredParameter< SurfaceObservationSubtype > | surfaceObservationSubtype |
| oops::RequiredParameter< util::Duration > | timeBeforeStartOfWindow |
| Amount of time before start of assimilation window to collect for the history check. More... | |
| oops::OptionalParameter< TrackCheckShipCoreParameters > | trackCheckShipParameters |
| oops::OptionalParameter< StuckCheckCoreParameters > | stuckCheckParameters |
| oops::RequiredParameter< ioda::ObsTopLevelParameters > | largerObsSpace |
| oops::Parameter< bool > | resetLargerObsSpaceVariables |
| oops::Parameter< int > | stationIdMaxStringLength |
 Public Attributes inherited from ufo::TrackCheckUtilsParameters | |
| oops::OptionalParameter< Variable > | stationIdVariable |
| 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 history check filter.
Definition at line 27 of file HistoryCheckParameters.h.
Member Data Documentation
◆ largerObsSpace
| oops::RequiredParameter<ioda::ObsTopLevelParameters> ufo::HistoryCheckParameters::largerObsSpace |
Creates a new obs space with the wider window that is determined by the observation subtype. Needs: name (can be set with setValue), simulated variables, obsdatain.obsfile.
Definition at line 57 of file HistoryCheckParameters.h.
◆ resetLargerObsSpaceVariables
| oops::Parameter<bool> ufo::HistoryCheckParameters::resetLargerObsSpaceVariables |
Controls whether all of the larger obs space's variables are reset to match the primary obs space's when filter is run. Used for unit testing (esp. stuck check portions).
Definition at line 63 of file HistoryCheckParameters.h.
◆ stationIdMaxStringLength
| oops::Parameter<int> ufo::HistoryCheckParameters::stationIdMaxStringLength |
Maximum number of characters for a string-labelled station id. This is used to ensure unique integer hashes if station ids are string labels.
Definition at line 69 of file HistoryCheckParameters.h.
◆ stuckCheckParameters
| oops::OptionalParameter<StuckCheckCoreParameters> ufo::HistoryCheckParameters::stuckCheckParameters |
The options for running the stuck check filter which can be optionally run, should the subtype not be TEMP/BATHY/TESAC/BUOYPROF. These must be filled in in order for the stuck filter to run.
Definition at line 51 of file HistoryCheckParameters.h.
◆ surfaceObservationSubtype
| oops::RequiredParameter<SurfaceObservationSubtype> ufo::HistoryCheckParameters::surfaceObservationSubtype |
Surface observation subtype determining if the track and/or stuck check could be run
- Todo:
- It is possible to use this to decide on the window length. Should the manual entry method be kept?
Definition at line 34 of file HistoryCheckParameters.h.
◆ timeBeforeStartOfWindow
| oops::RequiredParameter<util::Duration> ufo::HistoryCheckParameters::timeBeforeStartOfWindow |
Amount of time before start of assimilation window to collect for the history check.
Definition at line 38 of file HistoryCheckParameters.h.
◆ trackCheckShipParameters
| oops::OptionalParameter<TrackCheckShipCoreParameters> ufo::HistoryCheckParameters::trackCheckShipParameters |
The options for running the ship track check filter which can be optionally run, should the subtype not be LNDSYN/LNDSYB. These must be filled in in order for the track filter to run.
Definition at line 44 of file HistoryCheckParameters.h.
The documentation for this class was generated from the following file:
