UFO
Public Member Functions | Protected Attributes | Private Attributes | List of all members
ufo::PredictorBase Class Referenceabstract

#include <PredictorBase.h>

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

Public Member Functions

 PredictorBase (const PredictorParametersBase &, const oops::Variables &)
 
virtual ~PredictorBase ()=default
 
virtual void compute (const ioda::ObsSpace &, const GeoVaLs &, const ObsDiagnostics &, ioda::ObsVector &) const =0
 compute the predictor More...
 
const oops::Variables & requiredGeovars () const
 geovars names required to compute the predictor More...
 
const oops::Variables & requiredHdiagnostics () const
 hdiags names required to compute the predictor More...
 
std::string & name ()
 predictor name More...
 
const std::string & name () const
 

Protected Attributes

oops::Variables vars_
 variables that will be bias-corrected using this predictor More...
 
oops::Variables geovars_
 required GeoVaLs More...
 
oops::Variables hdiags_
 required ObsDiagnostics More...
 

Private Attributes

std::string func_name_
 predictor name More...
 

Detailed Description

Base class for computing predictors

Note: each concrete implementation should typedef Parameters_ to the name of a subclass of PredictorParametersBase encapsulating its configuration options. It should also provide a constructor with the following signature: 

PredictorBase(const Parameters_ &, const oops::Variables &);

Definition at line 62 of file PredictorBase.h.

Constructor & Destructor Documentation

◆ PredictorBase()

ufo::PredictorBase::PredictorBase ( const PredictorParametersBase &  parameters,
const oops::Variables &  vars 
)
explicit

Definition at line 21 of file PredictorBase.cc.

◆ ~PredictorBase()

virtual ufo::PredictorBase::~PredictorBase ( )
virtualdefault

Member Function Documentation

◆ compute()

virtual void ufo::PredictorBase::compute ( const ioda::ObsSpace &  ,
const GeoVaLs &  ,
const ObsDiagnostics &  ,
ioda::ObsVector &   
) const
pure virtual

compute the predictor

Implemented in ufo::Thickness, ufo::SineOfLatitude, ufo::ScanAngle, ufo::SatelliteSelector, ufo::OrbitalAngle, ufo::Legendre, ufo::LapseRate, ufo::InterpolateDataFromFile, ufo::Emissivity, ufo::CosineOfLatitudeTimesOrbitNode, ufo::Constant, and ufo::CloudLiquidWater.

◆ name() [1/2]

std::string& ufo::PredictorBase::name ( )
inline

predictor name

Definition at line 80 of file PredictorBase.h.

Here is the caller graph for this function:

◆ name() [2/2]

const std::string& ufo::PredictorBase::name ( ) const
inline

Definition at line 81 of file PredictorBase.h.

Here is the caller graph for this function:

◆ requiredGeovars()

const oops::Variables& ufo::PredictorBase::requiredGeovars ( ) const
inline

geovars names required to compute the predictor

Definition at line 74 of file PredictorBase.h.

◆ requiredHdiagnostics()

const oops::Variables& ufo::PredictorBase::requiredHdiagnostics ( ) const
inline

hdiags names required to compute the predictor

Definition at line 77 of file PredictorBase.h.

Member Data Documentation

◆ func_name_

std::string ufo::PredictorBase::func_name_
private

predictor name

Definition at line 89 of file PredictorBase.h.

◆ geovars_

oops::Variables ufo::PredictorBase::geovars_
protected

required GeoVaLs

Definition at line 85 of file PredictorBase.h.

◆ hdiags_

oops::Variables ufo::PredictorBase::hdiags_
protected

required ObsDiagnostics

Definition at line 86 of file PredictorBase.h.

◆ vars_

oops::Variables ufo::PredictorBase::vars_
protected

variables that will be bias-corrected using this predictor

Definition at line 84 of file PredictorBase.h.

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