UFO
ufo::ObsFunction< FunctionValue > Class Template Reference

A function of observation data. More...

#include <ObsFunction.h>

Inheritance diagram for ufo::ObsFunction< FunctionValue >:
Collaboration diagram for ufo::ObsFunction< FunctionValue >:

Public Member Functions

 ObsFunction (const Variable &)
 constructor takes function name (for factory) on input More...
 
 ~ObsFunction ()
 
void compute (const ObsFilterData &, ioda::ObsDataVector< FunctionValue > &) const
 compute(metadata, obs values, output) More...
 
const ufo::VariablesrequiredVariables () const
 required variables More...
 

Private Attributes

std::unique_ptr< ObsFunctionBase< FunctionValue > > obsfct_
 

Detailed Description

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

A function of observation data.

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

Definition at line 32 of file src/ufo/filters/obsfunctions/ObsFunction.h.

Constructor & Destructor Documentation

◆ ObsFunction()

template<typename FunctionValue >
ufo::ObsFunction< FunctionValue >::ObsFunction ( const Variable var)
explicit

constructor takes function name (for factory) on input

Definition at line 19 of file ObsFunction.cc.

◆ ~ObsFunction()

template<typename FunctionValue >
ufo::ObsFunction< FunctionValue >::~ObsFunction

Definition at line 26 of file ObsFunction.cc.

Member Function Documentation

◆ compute()

template<typename FunctionValue >
void ufo::ObsFunction< FunctionValue >::compute ( const ObsFilterData in,
ioda::ObsDataVector< FunctionValue > &  out 
) const

compute(metadata, obs values, output)

Definition at line 31 of file ObsFunction.cc.

Here is the caller graph for this function:

◆ requiredVariables()

template<typename FunctionValue >
const ufo::Variables & ufo::ObsFunction< FunctionValue >::requiredVariables

required variables

Definition at line 39 of file ObsFunction.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ obsfct_

template<typename FunctionValue >
std::unique_ptr<ObsFunctionBase<FunctionValue> > ufo::ObsFunction< FunctionValue >::obsfct_
private

Definition at line 45 of file src/ufo/filters/obsfunctions/ObsFunction.h.


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