UFO
ufo::DrawObsErrorFromFile Class Reference

Derive observation error from a file representing the variance or the covariance matrix. More...

#include <DrawObsErrorFromFile.h>

Inheritance diagram for ufo::DrawObsErrorFromFile:
Collaboration diagram for ufo::DrawObsErrorFromFile:

Public Member Functions

 DrawObsErrorFromFile (const eckit::LocalConfiguration &)
 
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

DrawValueFromFile< float > drawValueFromFile_
 

Additional Inherited Members

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

Detailed Description

Derive observation error from a file representing the variance or the covariance matrix.

See DataExtractor for details on the format of this file.

example configurations:

- Filter: Perform Action
filter variables:
- name: air_temperature
channels: &all_channels 1-3
action:
name: assign error
error function:
name: DrawObsErrorFromFile@ObsFunction
channels: *all_channels
options:
file: <filepath>
channels: *all_channels
interpolation:
- name: satellite_id@MetaData
method: exact
- name: processing_center@MetaData
method: exact
- name: air_pressure@MetaData
method: linear

Note that channel number extraction is implicit, using the channels selected and performed as an exact match before any user defined interpolation takes place.

Definition at line 48 of file DrawObsErrorFromFile.h.

Constructor & Destructor Documentation

◆ DrawObsErrorFromFile()

ufo::DrawObsErrorFromFile::DrawObsErrorFromFile ( const eckit::LocalConfiguration &  config)
explicit

Definition at line 25 of file DrawObsErrorFromFile.cc.

Member Function Documentation

◆ compute()

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

compute the result of the function

Implements ufo::ObsFunctionBase< float >.

Definition at line 29 of file DrawObsErrorFromFile.cc.

Here is the call graph for this function:

◆ requiredVariables()

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

geovals required to compute the function

Implements ufo::ObsFunctionBase< float >.

Definition at line 43 of file DrawObsErrorFromFile.cc.

Here is the call graph for this function:

Member Data Documentation

◆ drawValueFromFile_

DrawValueFromFile<float> ufo::DrawObsErrorFromFile::drawValueFromFile_
private

Definition at line 56 of file DrawObsErrorFromFile.h.


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