OOPS
Public Member Functions | Private Types | List of all members
oops::ObsErrorBase< OBS > Class Template Referenceabstract

Base class for observation error covariance matrices. More...

#include <ObsErrorBase.h>

Inheritance diagram for oops::ObsErrorBase< OBS >:
Inheritance graph
[legend]
Collaboration diagram for oops::ObsErrorBase< OBS >:
Collaboration graph
[legend]

Public Member Functions

 ObsErrorBase ()=default
 
virtual ~ObsErrorBase ()=default
 
virtual void multiply (ObsVector_ &dy) const =0
 Multiply a Departure dy by \(R\)$. More...
 
virtual void inverseMultiply (ObsVector_ &dy) const =0
 Multiply a Departure dy by \(R^{-1}\). More...
 
virtual void randomize (ObsVector_ &dy) const =0
 Generate random perturbation in dy. More...
 
virtual const ObsVector_ & inverseVariance () const =0
 Return inverseVariance. More...
 
virtual double getRMSE () const =0
 Get mean error for Jo table. More...
 

Private Types

typedef ObsVector< OBS > ObsVector_
 
typedef ObsSpace< OBS > ObsSpace_
 

Detailed Description

template<typename OBS>
class oops::ObsErrorBase< OBS >

Base class for observation error covariance matrices.

Definition at line 31 of file ObsErrorBase.h.

Member Typedef Documentation

◆ ObsSpace_

template<typename OBS >
typedef ObsSpace<OBS> oops::ObsErrorBase< OBS >::ObsSpace_
private

Definition at line 34 of file ObsErrorBase.h.

◆ ObsVector_

template<typename OBS >
typedef ObsVector<OBS> oops::ObsErrorBase< OBS >::ObsVector_
private

Definition at line 33 of file ObsErrorBase.h.

Constructor & Destructor Documentation

◆ ObsErrorBase()

template<typename OBS >
oops::ObsErrorBase< OBS >::ObsErrorBase ( )
default

◆ ~ObsErrorBase()

template<typename OBS >
virtual oops::ObsErrorBase< OBS >::~ObsErrorBase ( )
virtualdefault

Member Function Documentation

◆ getRMSE()

template<typename OBS >
virtual double oops::ObsErrorBase< OBS >::getRMSE ( ) const
pure virtual

Get mean error for Jo table.

Implemented in oops::ObsErrorDiag< OBS >, and oops::ObsErrorCovariance< OBS, OBSERR >.

◆ inverseMultiply()

template<typename OBS >
virtual void oops::ObsErrorBase< OBS >::inverseMultiply ( ObsVector_ &  dy) const
pure virtual

Multiply a Departure dy by \(R^{-1}\).

Implemented in oops::ObsErrorDiag< OBS >, and oops::ObsErrorCovariance< OBS, OBSERR >.

◆ inverseVariance()

template<typename OBS >
virtual const ObsVector_& oops::ObsErrorBase< OBS >::inverseVariance ( ) const
pure virtual

Return inverseVariance.

Implemented in oops::ObsErrorDiag< OBS >.

◆ multiply()

template<typename OBS >
virtual void oops::ObsErrorBase< OBS >::multiply ( ObsVector_ &  dy) const
pure virtual

Multiply a Departure dy by \(R\)$.

Implemented in oops::ObsErrorDiag< OBS >, and oops::ObsErrorCovariance< OBS, OBSERR >.

◆ randomize()

template<typename OBS >
virtual void oops::ObsErrorBase< OBS >::randomize ( ObsVector_ &  dy) const
pure virtual

Generate random perturbation in dy.

Implemented in oops::ObsErrorDiag< OBS >, and oops::ObsErrorCovariance< OBS, OBSERR >.

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