UFO
ufo::HistoryCheck Class Reference

#include <HistoryCheck.h>

Inheritance diagram for ufo::HistoryCheck:
Collaboration diagram for ufo::HistoryCheck:

Public Types

typedef HistoryCheckParameters Parameters_
 

Public Member Functions

 HistoryCheck (ioda::ObsSpace &obsdb, const Parameters_ &parameters, std::shared_ptr< ioda::ObsDataVector< int > > flags, std::shared_ptr< ioda::ObsDataVector< float > > obserr)
 
 HistoryCheck (ioda::ObsSpace &obsdb, const Parameters_ &parameters, std::shared_ptr< ioda::ObsDataVector< int > > flags, std::shared_ptr< ioda::ObsDataVector< float > > obserr, const eckit::LocalConfiguration &conf)
 
- Public Member Functions inherited from ufo::FilterBase
 FilterBase (ioda::ObsSpace &, const FilterParametersBaseWithAbstractAction &parameters, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
 
 FilterBase (ioda::ObsSpace &, const eckit::Configuration &, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
 
 ~FilterBase ()
 
- Public Member Functions inherited from ufo::ObsProcessorBase
 ObsProcessorBase (ioda::ObsSpace &, bool deferToPost, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
 
 ~ObsProcessorBase ()
 
void preProcess () override
 
void priorFilter (const GeoVaLs &) override
 
void postFilter (const ioda::ObsVector &, const ioda::ObsVector &, const ObsDiagnostics &) override
 
oops::Variables requiredVars () const override
 
oops::Variables requiredHdiagnostics () const override
 

Static Public Member Functions

static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const override
 
void applyFilter (const std::vector< bool > &, const Variables &, std::vector< std::vector< bool >> &) const override
 
int qcFlag () const override
 
std::vector< int > getStationIds (const std::map< std::string, int > &stringMap, const boost::optional< Variable > &stationIdVar, const ioda::ObsSpace &obsdb, const ObsAccessor &obsacc) const
 Retrieve all station ids from the ObsAccessor. If string-labelled, ids will be converted to integers. More...
 

Private Attributes

Parameters_ options_
 
eckit::LocalConfiguration unitTestConfig_
 

Additional Inherited Members

- Protected Attributes inherited from ufo::FilterBase
const eckit::LocalConfiguration config_
 
ufo::Variables filtervars_
 
- Protected Attributes inherited from ufo::ObsProcessorBase
ioda::ObsSpace & obsdb_
 
std::shared_ptr< ioda::ObsDataVector< int > > flags_
 
std::shared_ptr< ioda::ObsDataVector< float > > obserr_
 
ufo::Variables allvars_
 
ObsFilterData data_
 

Detailed Description

Definition at line 31 of file src/ufo/filters/HistoryCheck.h.

Member Typedef Documentation

◆ Parameters_

Constructor & Destructor Documentation

◆ HistoryCheck() [1/2]

ufo::HistoryCheck::HistoryCheck ( ioda::ObsSpace &  obsdb,
const Parameters_ parameters,
std::shared_ptr< ioda::ObsDataVector< int > >  flags,
std::shared_ptr< ioda::ObsDataVector< float > >  obserr 
)

Track checks and stuck value checks.

  1. Read in wider window of observations
  2. Apply track check and stuck value check over wider window
  3. Apply flags over wider window to observations in main window.

Definition at line 39 of file HistoryCheck.cc.

◆ HistoryCheck() [2/2]

ufo::HistoryCheck::HistoryCheck ( ioda::ObsSpace &  obsdb,
const Parameters_ parameters,
std::shared_ptr< ioda::ObsDataVector< int > >  flags,
std::shared_ptr< ioda::ObsDataVector< float > >  obserr,
const eckit::LocalConfiguration &  conf 
)

Definition at line 47 of file HistoryCheck.cc.

Member Function Documentation

◆ applyFilter()

void ufo::HistoryCheck::applyFilter ( const std::vector< bool > &  ,
const Variables ,
std::vector< std::vector< bool >> &   
) const
overrideprivatevirtual

This filter runs the ship track check and stuck check filters consecutively over an auxiliary obs space (which is assumed to be a superset of obsdb_ with an earlier starting time), before checking which observations have both been (1) flagged by either of the sub-filters from the superset obs space and (2) are located within obsdb_

Implements ufo::FilterBase.

Definition at line 61 of file HistoryCheck.cc.

Here is the call graph for this function:

◆ classname()

static const std::string ufo::HistoryCheck::classname ( )
inlinestatic

Definition at line 36 of file src/ufo/filters/HistoryCheck.h.

◆ getStationIds()

std::vector< int > ufo::HistoryCheck::getStationIds ( const std::map< std::string, int > &  stringMap,
const boost::optional< Variable > &  stationIdVar,
const ioda::ObsSpace &  obsdb,
const ObsAccessor obsacc 
) const
private

Retrieve all station ids from the ObsAccessor. If string-labelled, ids will be converted to integers.

stringMap A previously-created map of all unique string station ids across obs spaces, used as a "central source-of-truth" for the integer values the strings should be mapped to. stationIdVar The parameter used to specify which variable is used to store station ids. obsdb The ObsSpace which station ids will be needed for. obsacc The ObsAccessor used to access observations from the associated ObsSpace.

Definition at line 253 of file HistoryCheck.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ print()

void ufo::HistoryCheck::print ( std::ostream &  os) const
overrideprivatevirtual

Implements ufo::FilterBase.

Definition at line 293 of file HistoryCheck.cc.

◆ qcFlag()

int ufo::HistoryCheck::qcFlag ( ) const
inlineoverrideprivatevirtual

Implements ufo::FilterBase.

Definition at line 60 of file src/ufo/filters/HistoryCheck.h.

Member Data Documentation

◆ options_

Parameters_ ufo::HistoryCheck::options_
private

Definition at line 54 of file src/ufo/filters/HistoryCheck.h.

◆ unitTestConfig_

eckit::LocalConfiguration ufo::HistoryCheck::unitTestConfig_
private

Definition at line 55 of file src/ufo/filters/HistoryCheck.h.


The documentation for this class was generated from the following files: