UFO
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ufo::ObsErrorDiagonal Class Reference

Diagonal observation error covariance matrix. More...

#include <ObsErrorDiagonal.h>

Inheritance diagram for ufo::ObsErrorDiagonal:
Inheritance graph
[legend]
Collaboration diagram for ufo::ObsErrorDiagonal:
Collaboration graph
[legend]

Public Types

typedef ObsErrorDiagonalParameters Parameters_
 

Public Member Functions

 ObsErrorDiagonal (const Parameters_ &, ioda::ObsSpace &, const eckit::mpi::Comm &timeComm)
 
void update (const ioda::ObsVector &) override
 Update after obs errors potentially changed. More...
 
void multiply (ioda::ObsVector &) const override
 Multiply a Departure by \(R\). More...
 
void inverseMultiply (ioda::ObsVector &) const override
 Multiply a Departure by \(R^{-1}\). More...
 
void randomize (ioda::ObsVector &) const override
 Generate random perturbation. More...
 
void save (const std::string &) const override
 Save obs errors. More...
 
double getRMSE () const override
 Get mean error for Jo table. More...
 
std::unique_ptr< ioda::ObsVector > getObsErrors () const override
 Get obs errors std deviation. More...
 
std::unique_ptr< ioda::ObsVector > getInverseVariance () const override
 Return inverseVariance. More...
 

Static Public Member Functions

static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

ioda::ObsVector stddev_
 
ioda::ObsVector inverseVariance_
 
Parameters_ options_
 

Detailed Description

Diagonal observation error covariance matrix.

Definition at line 44 of file ObsErrorDiagonal.h.

Member Typedef Documentation

◆ Parameters_

typedef ObsErrorDiagonalParameters ufo::ObsErrorDiagonal::Parameters_

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

Definition at line 48 of file ObsErrorDiagonal.h.

Constructor & Destructor Documentation

◆ ObsErrorDiagonal()

ufo::ObsErrorDiagonal::ObsErrorDiagonal ( const Parameters_ &  options,
ioda::ObsSpace &  obsgeom,
const eckit::mpi::Comm &  timeComm 
)

Definition at line 19 of file ObsErrorDiagonal.cc.

Member Function Documentation

◆ classname()

static const std::string ufo::ObsErrorDiagonal::classname ( )
inlinestatic

Definition at line 50 of file ObsErrorDiagonal.h.

◆ getInverseVariance()

std::unique_ptr< ioda::ObsVector > ufo::ObsErrorDiagonal::getInverseVariance ( ) const
override

Return inverseVariance.

Definition at line 75 of file ObsErrorDiagonal.cc.

◆ getObsErrors()

std::unique_ptr< ioda::ObsVector > ufo::ObsErrorDiagonal::getObsErrors ( ) const
override

Get obs errors std deviation.

Definition at line 69 of file ObsErrorDiagonal.cc.

◆ getRMSE()

double ufo::ObsErrorDiagonal::getRMSE ( ) const
inlineoverride

Get mean error for Jo table.

Definition at line 71 of file ObsErrorDiagonal.h.

◆ inverseMultiply()

void ufo::ObsErrorDiagonal::inverseMultiply ( ioda::ObsVector &  dy) const
override

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

Definition at line 49 of file ObsErrorDiagonal.cc.

◆ multiply()

void ufo::ObsErrorDiagonal::multiply ( ioda::ObsVector &  dy) const
override

Multiply a Departure by \(R\).

Definition at line 43 of file ObsErrorDiagonal.cc.

◆ print()

void ufo::ObsErrorDiagonal::print ( std::ostream &  os) const
overrideprivate

Definition at line 80 of file ObsErrorDiagonal.cc.

◆ randomize()

void ufo::ObsErrorDiagonal::randomize ( ioda::ObsVector &  dy) const
override

Generate random perturbation.

Definition at line 55 of file ObsErrorDiagonal.cc.

◆ save()

void ufo::ObsErrorDiagonal::save ( const std::string &  name) const
override

Save obs errors.

Definition at line 63 of file ObsErrorDiagonal.cc.

◆ update()

void ufo::ObsErrorDiagonal::update ( const ioda::ObsVector &  obserr)
override

Update after obs errors potentially changed.

Definition at line 33 of file ObsErrorDiagonal.cc.

Member Data Documentation

◆ inverseVariance_

ioda::ObsVector ufo::ObsErrorDiagonal::inverseVariance_
private

Definition at line 82 of file ObsErrorDiagonal.h.

◆ options_

Parameters_ ufo::ObsErrorDiagonal::options_
private

Definition at line 83 of file ObsErrorDiagonal.h.

◆ stddev_

ioda::ObsVector ufo::ObsErrorDiagonal::stddev_
private

Definition at line 81 of file ObsErrorDiagonal.h.

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