OOPS
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oops::ObsErrorDiag< OBS > Class Template Reference

Diagonal observation error covariance matrix. More...

#include <ObsErrorDiag.h>

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

Public Types

typedef ObsErrorDiagParameters Parameters_
 

Public Member Functions

 ObsErrorDiag (const Parameters_ &, const ObsSpace_ &)
 
void update (const ObsVector_ &) override
 Update after obs errors potentially changed. More...
 
void multiply (ObsVector_ &) const override
 Multiply a Departure by \(R\). More...
 
void inverseMultiply (ObsVector_ &) const override
 Multiply a Departure by \(R^{-1}\). More...
 
void randomize (ObsVector_ &) const override
 Generate random perturbation. More...
 
void save (const std::string &) const override
 Save obs errors. More...
 
double getRMSE () const override
 Get mean std deviation of errors for Jo table. More...
 
ObsVector_ obserrors () const override
 Get obs errors std deviation. More...
 
ObsVector_ inverseVariance () const override
 Get inverseVariance. More...
 
- Public Member Functions inherited from oops::ObsErrorBase< OBS >
 ObsErrorBase ()=default
 
virtual ~ObsErrorBase ()=default
 

Private Types

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

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

ObsVector_ stddev_
 
ObsVector_ inverseVariance_
 
Parameters_ options_
 

Detailed Description

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

Diagonal observation error covariance matrix.

Definition at line 39 of file ObsErrorDiag.h.

Member Typedef Documentation

◆ ObsSpace_

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

Definition at line 40 of file ObsErrorDiag.h.

◆ ObsVector_

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

Definition at line 41 of file ObsErrorDiag.h.

◆ Parameters_

template<typename OBS >
typedef ObsErrorDiagParameters oops::ObsErrorDiag< OBS >::Parameters_

The type of parameters passed to the constructor. This typedef is used by the ObsErrorFactory.

Definition at line 46 of file ObsErrorDiag.h.

Constructor & Destructor Documentation

◆ ObsErrorDiag()

template<typename OBS >
oops::ObsErrorDiag< OBS >::ObsErrorDiag ( const Parameters_ &  options,
const ObsSpace_ &  obsgeom 
)

Definition at line 84 of file ObsErrorDiag.h.

Here is the call graph for this function:

Member Function Documentation

◆ getRMSE()

template<typename OBS >
double oops::ObsErrorDiag< OBS >::getRMSE ( ) const
inlineoverridevirtual

Get mean std deviation of errors for Jo table.

Implements oops::ObsErrorBase< OBS >.

Definition at line 66 of file ObsErrorDiag.h.

Here is the call graph for this function:

◆ inverseMultiply()

template<typename OBS >
void oops::ObsErrorDiag< OBS >::inverseMultiply ( ObsVector_ &  dy) const
overridevirtual

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

Implements oops::ObsErrorBase< OBS >.

Definition at line 114 of file ObsErrorDiag.h.

◆ inverseVariance()

template<typename OBS >
ObsVector_ oops::ObsErrorDiag< OBS >::inverseVariance ( ) const
inlineoverridevirtual

Get inverseVariance.

Implements oops::ObsErrorBase< OBS >.

Definition at line 72 of file ObsErrorDiag.h.

◆ multiply()

template<typename OBS >
void oops::ObsErrorDiag< OBS >::multiply ( ObsVector_ &  dy) const
overridevirtual

Multiply a Departure by \(R\).

Implements oops::ObsErrorBase< OBS >.

Definition at line 107 of file ObsErrorDiag.h.

◆ obserrors()

template<typename OBS >
ObsVector_ oops::ObsErrorDiag< OBS >::obserrors ( ) const
inlineoverridevirtual

Get obs errors std deviation.

Implements oops::ObsErrorBase< OBS >.

Definition at line 69 of file ObsErrorDiag.h.

◆ print()

template<typename OBS >
void oops::ObsErrorDiag< OBS >::print ( std::ostream &  os) const
overrideprivatevirtual

Implements oops::ObsErrorBase< OBS >.

Definition at line 137 of file ObsErrorDiag.h.

◆ randomize()

template<typename OBS >
void oops::ObsErrorDiag< OBS >::randomize ( ObsVector_ &  dy) const
overridevirtual

Generate random perturbation.

Implements oops::ObsErrorBase< OBS >.

Definition at line 121 of file ObsErrorDiag.h.

Here is the call graph for this function:

◆ save()

template<typename OBS >
void oops::ObsErrorDiag< OBS >::save ( const std::string &  name) const
overridevirtual

Save obs errors.

Implements oops::ObsErrorBase< OBS >.

Definition at line 130 of file ObsErrorDiag.h.

◆ update()

template<typename OBS >
void oops::ObsErrorDiag< OBS >::update ( const ObsVector_ &  obserr)
overridevirtual

Update after obs errors potentially changed.

Implements oops::ObsErrorBase< OBS >.

Definition at line 96 of file ObsErrorDiag.h.

Here is the call graph for this function:

Member Data Documentation

◆ inverseVariance_

template<typename OBS >
ObsVector_ oops::ObsErrorDiag< OBS >::inverseVariance_
private

Definition at line 77 of file ObsErrorDiag.h.

◆ options_

template<typename OBS >
Parameters_ oops::ObsErrorDiag< OBS >::options_
private

Definition at line 78 of file ObsErrorDiag.h.

◆ stddev_

template<typename OBS >
ObsVector_ oops::ObsErrorDiag< OBS >::stddev_
private

Definition at line 76 of file ObsErrorDiag.h.

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