UFO
ufo::PassivateObs Class Reference

Flag observations as passive. More...

#include <PassivateObs.h>

Inheritance diagram for ufo::PassivateObs:
Collaboration diagram for ufo::PassivateObs:

Public Types

typedef PassivateObsParameters Parameters_
 

Public Member Functions

 PassivateObs (const Parameters_ &)
 
 ~PassivateObs ()
 
void apply (const Variables &, const std::vector< std::vector< bool >> &, const ObsFilterData &, int, ioda::ObsDataVector< int > &, ioda::ObsDataVector< float > &) const override
 
const ufo::VariablesrequiredVariables () const override
 
- Public Member Functions inherited from ufo::FilterActionBase
 FilterActionBase ()
 
virtual ~FilterActionBase ()
 

Private Attributes

Variables allvars_
 

Detailed Description

Flag observations as passive.

Definition at line 29 of file PassivateObs.h.

Member Typedef Documentation

◆ Parameters_

The type of parameters accepted by the constructor of this action. This typedef is used by the FilterActionFactory.

Definition at line 33 of file PassivateObs.h.

Constructor & Destructor Documentation

◆ PassivateObs()

ufo::PassivateObs::PassivateObs ( const Parameters_ parameters)
explicit

Definition at line 22 of file PassivateObs.cc.

◆ ~PassivateObs()

ufo::PassivateObs::~PassivateObs ( )
inline

Definition at line 36 of file PassivateObs.h.

Member Function Documentation

◆ apply()

void ufo::PassivateObs::apply ( const Variables vars,
const std::vector< std::vector< bool >> &  flagged,
const ObsFilterData data,
int  filterQCflag,
ioda::ObsDataVector< int > &  flags,
ioda::ObsDataVector< float > &  obserr 
) const
overridevirtual
Parameters
varsThe list of filter variables.
flaggedIf flagged[i][j] is true, it means that the action should be performed on jth observation of ith filter variable.
dataAccessor to obs filter data.
filterQCflagQC flag identifying observations rejected by the type of filter performing the action. (Relevant only for actions rejecting observations.)
flagsQC flags of all "simulated variables".
obserrObs error estimates of all "simulated variables".

Implements ufo::FilterActionBase.

Definition at line 28 of file PassivateObs.cc.

Here is the call graph for this function:

◆ requiredVariables()

const ufo::Variables& ufo::PassivateObs::requiredVariables ( ) const
inlineoverridevirtual

Implements ufo::FilterActionBase.

Definition at line 41 of file PassivateObs.h.

Member Data Documentation

◆ allvars_

Variables ufo::PassivateObs::allvars_
private

Definition at line 43 of file PassivateObs.h.


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