UFO
ufo::PerformAction Class Reference

Perform the action specified in the action YAML section on each observation selected by the where statement. More...

#include <PerformAction.h>

Inheritance diagram for ufo::PerformAction:
Collaboration diagram for ufo::PerformAction:

Public Types

typedef PerformActionParameters Parameters_
 

Public Member Functions

 PerformAction (ioda::ObsSpace &, const Parameters_ &, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
 
- 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
 

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

Perform the action specified in the action YAML section on each observation selected by the where statement.

In contrast to other filters, this filter requires the action to be specified explicitly in the YAML file; there is no default action.

Definition at line 69 of file PerformAction.h.

Member Typedef Documentation

◆ Parameters_

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

Definition at line 74 of file PerformAction.h.

Constructor & Destructor Documentation

◆ PerformAction()

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

Definition at line 25 of file PerformAction.cc.

Member Function Documentation

◆ applyFilter()

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

Implements ufo::FilterBase.

Definition at line 35 of file PerformAction.cc.

Here is the call graph for this function:

◆ classname()

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

Definition at line 76 of file PerformAction.h.

◆ print()

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

Implements ufo::FilterBase.

Definition at line 47 of file PerformAction.cc.

◆ qcFlag()

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

Implements ufo::FilterBase.

Definition at line 86 of file PerformAction.h.

Member Data Documentation

◆ parameters_

Parameters_ ufo::PerformAction::parameters_
private

Definition at line 88 of file PerformAction.h.


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