UFO
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ufo::BackgroundCheck Class Reference

#include <BackgroundCheck.h>

Inheritance diagram for ufo::BackgroundCheck:
Inheritance graph
[legend]
Collaboration diagram for ufo::BackgroundCheck:
Collaboration graph
[legend]

Public Types

typedef BackgroundCheckParameters Parameters_
 

Public Member Functions

 BackgroundCheck (ioda::ObsSpace &, const Parameters_ &, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
 
 ~BackgroundCheck ()
 
- 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
 
Variable backgrErrVariable (const Variable &filterVariable) const
 Return the name of the variable containing the background error estimate of the specified filter variable. More...
 

Private Attributes

Parameters_ parameters_
 

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

BackgroundCheck: check observation closeness to background.

See BackgroundCheckParameters for the documentation of the parameters controlling this filter.

Definition at line 85 of file BackgroundCheck.h.

Member Typedef Documentation

◆ Parameters_

typedef BackgroundCheckParameters ufo::BackgroundCheck::Parameters_

The type of parameters accepted by the constructor of this filter. This typedef is used by the FilterFactory.

Definition at line 90 of file BackgroundCheck.h.

Constructor & Destructor Documentation

◆ BackgroundCheck()

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

Definition at line 34 of file BackgroundCheck.cc.

Here is the call graph for this function:

◆ ~BackgroundCheck()

ufo::BackgroundCheck::~BackgroundCheck ( )

Definition at line 70 of file BackgroundCheck.cc.

Member Function Documentation

◆ applyFilter()

void ufo::BackgroundCheck::applyFilter ( const std::vector< bool > &  apply,
const Variables &  filtervars,
std::vector< std::vector< bool >> &  flagged 
) const
overrideprivatevirtual

Implements ufo::FilterBase.

Definition at line 84 of file BackgroundCheck.cc.

Here is the call graph for this function:

◆ backgrErrVariable()

Variable ufo::BackgroundCheck::backgrErrVariable ( const Variable &  filterVariable) const
private

Return the name of the variable containing the background error estimate of the specified filter variable.

Return the name of the variable containing the background error estimate of the specified filter variable.

Definition at line 78 of file BackgroundCheck.cc.

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

◆ classname()

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

Definition at line 92 of file BackgroundCheck.h.

◆ print()

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

Implements ufo::FilterBase.

Definition at line 182 of file BackgroundCheck.cc.

◆ qcFlag()

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

Implements ufo::FilterBase.

Definition at line 103 of file BackgroundCheck.h.

Member Data Documentation

◆ parameters_

Parameters_ ufo::BackgroundCheck::parameters_
private

Definition at line 108 of file BackgroundCheck.h.

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