ufo::ObsFunctionBase< FunctionValue > Class Template Reference

#include <ObsFunctionBase.h>

Inheritance diagram for ufo::ObsFunctionBase< FunctionValue >:

Collaboration diagram for ufo::ObsFunctionBase< FunctionValue >:

Public Types
typedef FunctionValue	Value_
	Type of the values produced by the function. More...

Public Member Functions
	ObsFunctionBase (const eckit::LocalConfiguration conf=eckit::LocalConfiguration())
virtual	~ObsFunctionBase ()
virtual void	compute (const ObsFilterData &, ioda::ObsDataVector< FunctionValue > &) 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

template<typename FunctionValue>
class ufo::ObsFunctionBase< FunctionValue >

Base class for computing functions on observation data

Template Parameters

FunctionValue

Type of the values produced by the function. Must be float, int, std::string or util::DateTime.

Definition at line 30 of file ObsFunctionBase.h.

Member Typedef Documentation

Value_

template<typename FunctionValue >

typedef FunctionValue ufo::ObsFunctionBase< FunctionValue >::Value_

Type of the values produced by the function.

Definition at line 33 of file ObsFunctionBase.h.

Constructor & Destructor Documentation

ObsFunctionBase()

template<typename FunctionValue >

ufo::ObsFunctionBase< FunctionValue >::ObsFunctionBase ( const eckit::LocalConfiguration  conf = eckit::LocalConfiguration() )

inlineexplicit

Definition at line 35 of file ObsFunctionBase.h.

~ObsFunctionBase()

template<typename FunctionValue >

virtual ufo::ObsFunctionBase< FunctionValue >::~ObsFunctionBase ( )

inlinevirtual

Definition at line 36 of file ObsFunctionBase.h.

Member Function Documentation

compute()

template<typename FunctionValue >

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

pure virtual

compute the result of the function

Implemented in ufo::DrawValueFromFile< T >, ufo::Conditional< FunctionValue >, ufo::SolarZenith, ufo::SetSurfaceType, ufo::TotalColumnVaporGuess, ufo::SymmCldImpactIR, ufo::SunGlintAngle, ufo::SIRetSymmetricMW, ufo::SIRetMW, ufo::SCATRetMW, ufo::SatwindIndivErrors, ufo::ObsFunctionVelocity, ufo::ObsFunctionScattering, ufo::LinearCombination, ufo::ObsErrorModelStepwiseLinear, ufo::ObsErrorModelQuad, ufo::ObsErrorFactorWavenumIR, ufo::ObsErrorFactorTransmitTopRad, ufo::ObsErrorFactorTopoRad, ufo::ObsErrorFactorSurfJacobianRad, ufo::ObsErrorFactorSituDependMW, ufo::ObsErrorFactorQuotient, ufo::ObsErrorFactorLatRad, ufo::ObsErrorFactorConventional, ufo::ObsErrorBoundMW, ufo::ObsErrorBoundIR, ufo::NearSSTRetCheckIR, ufo::ModelHeightAdjustedWindVectorComponent< northwardWind >, ufo::ModelHeightAdjustedRelativeHumidity, ufo::ModelHeightAdjustedMarineWindComponent, ufo::ModelHeightAdjustedAirTemperature, ufo::LAMDomainCheck, ufo::InterChannelConsistencyCheck, ufo::ImpactHeight, ufo::HydrometeorCheckATMS, ufo::HydrometeorCheckAMSUA, ufo::DrawObsErrorFromFile, ufo::CLWRetSymmetricMW, ufo::CLWRetMW_SSMIS, ufo::CLWRetMW, ufo::CLWMatchIndexMW, ufo::CloudDetectMinResidualIR, ufo::CloudDetectMinResidualAVHRR, ufo::CloudCostFunction, ufo::ChannelUseflagCheckRad, ufo::BgdDepartureAnomaly, and ufo::BennartzScatIndex.

requiredVariables()

template<typename FunctionValue >

virtual const ufo::Variables& ufo::ObsFunctionBase< FunctionValue >::requiredVariables ( ) const

pure virtual

geovals required to compute the function

Implemented in ufo::SolarZenith, ufo::SetSurfaceType, ufo::TotalColumnVaporGuess, ufo::SymmCldImpactIR, ufo::SunGlintAngle, ufo::SIRetSymmetricMW, ufo::SIRetMW, ufo::SCATRetMW, ufo::SatwindIndivErrors, ufo::ObsFunctionVelocity, ufo::ObsFunctionScattering, ufo::LinearCombination, ufo::ObsErrorModelStepwiseLinear, ufo::ObsErrorModelQuad, ufo::ObsErrorFactorWavenumIR, ufo::ObsErrorFactorTransmitTopRad, ufo::ObsErrorFactorTopoRad, ufo::ObsErrorFactorSurfJacobianRad, ufo::ObsErrorFactorSituDependMW, ufo::ObsErrorFactorQuotient, ufo::ObsErrorFactorLatRad, ufo::ObsErrorFactorConventional, ufo::ObsErrorBoundMW, ufo::ObsErrorBoundIR, ufo::NearSSTRetCheckIR, ufo::ModelHeightAdjustedWindVectorComponent< northwardWind >, ufo::ModelHeightAdjustedRelativeHumidity, ufo::ModelHeightAdjustedMarineWindComponent, ufo::ModelHeightAdjustedAirTemperature, ufo::LAMDomainCheck, ufo::InterChannelConsistencyCheck, ufo::ImpactHeight, ufo::HydrometeorCheckATMS, ufo::HydrometeorCheckAMSUA, ufo::DrawValueFromFile< T >, ufo::DrawValueFromFile< float >, ufo::DrawObsErrorFromFile, ufo::Conditional< FunctionValue >, ufo::CLWRetSymmetricMW, ufo::CLWRetMW_SSMIS, ufo::CLWRetMW, ufo::CLWMatchIndexMW, ufo::CloudDetectMinResidualIR, ufo::CloudDetectMinResidualAVHRR, ufo::CloudCostFunction, ufo::ChannelUseflagCheckRad, ufo::BgdDepartureAnomaly, and ufo::BennartzScatIndex.

---

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

• ObsFunctionBase.h