UFO
ufo::OrbitalAngle Class Reference

#include <OrbitalAngle.h>

Inheritance diagram for ufo::OrbitalAngle:
Collaboration diagram for ufo::OrbitalAngle:

Public Types

typedef OrbitalAngleParameters Parameters_
 

Public Member Functions

 OrbitalAngle (const Parameters_ &, const oops::Variables &)
 
void compute (const ioda::ObsSpace &, const GeoVaLs &, const ObsDiagnostics &, ioda::ObsVector &) const override
 compute the predictor More...
 
- Public Member Functions inherited from ufo::PredictorBase
 PredictorBase (const PredictorParametersBase &, const oops::Variables &)
 
virtual ~PredictorBase ()=default
 
const oops::Variables & requiredGeovars () const
 geovars names required to compute the predictor More...
 
const oops::Variables & requiredHdiagnostics () const
 hdiags names required to compute the predictor More...
 
std::string & name ()
 predictor name More...
 
const std::string & name () const
 

Private Attributes

int order_
 
FourierTermType component_
 

Additional Inherited Members

- Protected Attributes inherited from ufo::PredictorBase
oops::Variables vars_
 variables that will be bias-corrected using this predictor More...
 
oops::Variables geovars_
 required GeoVaLs More...
 
oops::Variables hdiags_
 required ObsDiagnostics More...
 

Detailed Description

This orbital angle predictor is used to fit residual errors as a function of satellite orbital angle using a Fourier series. The data must contain this orbital angle time series in the variable "satellite_orbital_angle@MetaData". Two member variables are used to store the order of the term in the series being calculated (order_) and the Fourier component (cos or sin), respectively. These are read from the yaml configuration file.

Definition at line 75 of file OrbitalAngle.h.

Member Typedef Documentation

◆ Parameters_

The type of parameters accepted by the constructor of this predictor. This typedef is used by the PredictorFactory.

Definition at line 79 of file OrbitalAngle.h.

Constructor & Destructor Documentation

◆ OrbitalAngle()

ufo::OrbitalAngle::OrbitalAngle ( const Parameters_ parameters,
const oops::Variables &  vars 
)

Definition at line 25 of file OrbitalAngle.cc.

Here is the call graph for this function:

Member Function Documentation

◆ compute()

void ufo::OrbitalAngle::compute ( const ioda::ObsSpace &  ,
const GeoVaLs ,
const ObsDiagnostics ,
ioda::ObsVector &   
) const
overridevirtual

compute the predictor

Implements ufo::PredictorBase.

Definition at line 37 of file OrbitalAngle.cc.

Here is the call graph for this function:

Member Data Documentation

◆ component_

FourierTermType ufo::OrbitalAngle::component_
private

Definition at line 90 of file OrbitalAngle.h.

◆ order_

int ufo::OrbitalAngle::order_
private

Definition at line 89 of file OrbitalAngle.h.


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