UFO
Public Member Functions | List of all members
ufo::ObsFunctionBase Class Referenceabstract

Base class for computing functions on observation data. More...

#include <ObsFunctionBase.h>

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

Public Member Functions

 ObsFunctionBase (const eckit::LocalConfiguration conf=eckit::LocalConfiguration())
 
virtual ~ObsFunctionBase ()
 
virtual void compute (const ObsFilterData &, ioda::ObsDataVector< float > &) const =0
 compute the result of the function More...
 
virtual const ufo::Variables & requiredVariables () const =0
 geovals required to compute the function More...
 

Detailed Description

Base class for computing functions on observation data.

Definition at line 26 of file ObsFunctionBase.h.

Constructor & Destructor Documentation

◆ ObsFunctionBase()

ufo::ObsFunctionBase::ObsFunctionBase ( const eckit::LocalConfiguration  conf = eckit::LocalConfiguration())
inlineexplicit

Definition at line 28 of file ObsFunctionBase.h.

◆ ~ObsFunctionBase()

virtual ufo::ObsFunctionBase::~ObsFunctionBase ( )
inlinevirtual

Definition at line 29 of file ObsFunctionBase.h.

Member Function Documentation

◆ compute()

virtual void ufo::ObsFunctionBase::compute ( const ObsFilterData &  ,
ioda::ObsDataVector< float > &   
) const
pure virtual

compute the result of the function

Implemented in ufo::ObsErrorModelRamp, ufo::ObsErrorModelQuad, ufo::SCATRetMW, ufo::HydrometeorCheckAMSUA, ufo::HydrometeorCheckATMS, ufo::CLWRetMW, ufo::ObsErrorFactorSituDependMW, ufo::SIRetMW, ufo::ObsErrorBoundMW, ufo::CloudDetectMinResidualIR, ufo::NearSSTRetCheckIR, ufo::ObsErrorBoundIR, ufo::ObsErrorFactorSurfJacobianRad, ufo::CLWMatchIndexMW, ufo::ObsErrorFactorTopoRad, ufo::InterChannelConsistencyCheck, ufo::ObsErrorFactorWavenumIR, ufo::ObsErrorFactorLatRad, ufo::ObsErrorFactorTransmitTopRad, ufo::ChannelUseflagCheckRad, ufo::SymmCldImpactIR, ufo::CLWRetSymmetricMW, ufo::SIRetSymmetricMW, ufo::ObsFunctionVelocity, and ufo::ObsFunctionScattering.

◆ requiredVariables()

virtual const ufo::Variables& ufo::ObsFunctionBase::requiredVariables ( ) const
pure virtual

geovals required to compute the function

Implemented in ufo::ObsErrorModelRamp, ufo::ObsErrorModelQuad, ufo::SCATRetMW, ufo::HydrometeorCheckAMSUA, ufo::HydrometeorCheckATMS, ufo::CLWRetMW, ufo::ObsErrorFactorSituDependMW, ufo::SIRetMW, ufo::ObsErrorBoundMW, ufo::CloudDetectMinResidualIR, ufo::NearSSTRetCheckIR, ufo::ObsErrorBoundIR, ufo::ObsErrorFactorSurfJacobianRad, ufo::CLWMatchIndexMW, ufo::ObsErrorFactorTopoRad, ufo::InterChannelConsistencyCheck, ufo::ObsErrorFactorWavenumIR, ufo::ObsErrorFactorLatRad, ufo::ObsErrorFactorTransmitTopRad, ufo::ChannelUseflagCheckRad, ufo::SymmCldImpactIR, ufo::CLWRetSymmetricMW, ufo::SIRetSymmetricMW, ufo::ObsFunctionVelocity, and ufo::ObsFunctionScattering.

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