UFO
ufo::LinearCombination Class Reference

Outputs a linear combination of variables. More...

#include <ObsFunctionLinearCombination.h>

Inheritance diagram for ufo::LinearCombination:
Collaboration diagram for ufo::LinearCombination:

Public Member Functions

 LinearCombination (const eckit::LocalConfiguration &)
 
 ~LinearCombination ()
 
void compute (const ObsFilterData &, ioda::ObsDataVector< float > &) const
 compute the result of the function More...
 
const ufo::VariablesrequiredVariables () const
 geovals required to compute the function More...
 
- Public Member Functions inherited from ufo::ObsFunctionBase< float >
 ObsFunctionBase (const eckit::LocalConfiguration conf=eckit::LocalConfiguration())
 
virtual ~ObsFunctionBase ()
 

Private Attributes

LinearCombinationParameters options_
 
ufo::Variables invars_
 

Additional Inherited Members

- Public Types inherited from ufo::ObsFunctionBase< float >
typedef float Value_
 Type of the values produced by the function. More...
 

Detailed Description

Outputs a linear combination of variables.

Example 1

obs function: name: LinearCombination@ObsFunction options: variables: [representation_error@GeoVaLs, sea_water_temperature@ObsError] coefs: [0.1, 1.0]

will return 0.1 * representation_error@GeoVaLs + 1.0 * sea_water_temperature@ObsError

Example 2 - multi-channel

obs function: name: LinearCombination@ObsFunction channels: &select_chans 6-15, 18-22 # this line may be needed depending on the filter used options: variables:

  • name: brightness_temperature@ObsValue channels: *select_chans
  • name: brightness_temperature@ObsError channels: *select_chans coefs: [1.0, 0.5]

will return 1.0 * brightness_temperature_<channel>@ObsValue + 0.5 * brightness_temperature_<channel>@ObsError

Definition at line 71 of file ObsFunctionLinearCombination.h.

Constructor & Destructor Documentation

◆ LinearCombination()

ufo::LinearCombination::LinearCombination ( const eckit::LocalConfiguration &  conf)
explicit

Definition at line 25 of file ObsFunctionLinearCombination.cc.

◆ ~LinearCombination()

ufo::LinearCombination::~LinearCombination ( )

Definition at line 38 of file ObsFunctionLinearCombination.cc.

Member Function Documentation

◆ compute()

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

compute the result of the function

Implements ufo::ObsFunctionBase< float >.

Definition at line 42 of file ObsFunctionLinearCombination.cc.

Here is the call graph for this function:

◆ requiredVariables()

const ufo::Variables & ufo::LinearCombination::requiredVariables ( ) const
virtual

geovals required to compute the function

Implements ufo::ObsFunctionBase< float >.

Definition at line 77 of file ObsFunctionLinearCombination.cc.

Member Data Documentation

◆ invars_

ufo::Variables ufo::LinearCombination::invars_
private

Definition at line 81 of file ObsFunctionLinearCombination.h.

◆ options_

LinearCombinationParameters ufo::LinearCombination::options_
private

Definition at line 80 of file ObsFunctionLinearCombination.h.


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