Base class for generic implementations of observation error covariance matrices. More...
#include <ObsErrorBase.h>
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 void | save (const std::string &name) const =0 |
Save obs errors to the group name. More... | |
| virtual ObsVector_ | obserrors () const =0 |
| virtual void | update (const ObsVector_ &stddev)=0 |
Set the diagonal of the covariance matrix to stddev squared. More... | |
| virtual ObsVector_ | inverseVariance () const =0 |
| Return the vector of inverse obs error variances. More... | |
| virtual double | getRMSE () const =0 |
| Get mean error for Jo table. More... | |
Private Types | |
| typedef ObsVector< OBS > | ObsVector_ |
| typedef ObsSpace< OBS > | ObsSpace_ |
Private Member Functions | |
| virtual void | print (std::ostream &) const =0 |
Detailed Description
template<typename OBS>
class oops::ObsErrorBase< OBS >
Base class for generic implementations of observation error covariance matrices.
Use this class as a base class for generic implementations, and interface::ObsErrorBase as a base class for OBS-specific implementations.
Note: each generic implementation should typedef Parameters_ to the name of a subclass of ObsErrorParametersBase holding its configuration settings and provide a constructor with the following signature:
ObsErrorBase(const Parameters_ &, ObsSpace<OBS> &);
Definition at line 45 of file generic/ObsErrorBase.h.
Member Typedef Documentation
◆ ObsSpace_
|
private |
Definition at line 48 of file generic/ObsErrorBase.h.
◆ ObsVector_
|
private |
Definition at line 47 of file generic/ObsErrorBase.h.
Constructor & Destructor Documentation
◆ ObsErrorBase()
|
default |
◆ ~ObsErrorBase()
|
virtualdefault |
Member Function Documentation
◆ getRMSE()
|
pure virtual |
Get mean error for Jo table.
Implemented in oops::ObsErrorDiag< OBS >.
◆ inverseMultiply()
|
pure virtual |
Multiply a Departure dy by \(R^{-1}\).
Implemented in oops::interface::ObsErrorBase< OBS >, oops::interface::ObsErrorBase< OBS >, and oops::ObsErrorDiag< OBS >.
◆ inverseVariance()
|
pure virtual |
Return the vector of inverse obs error variances.
Implemented in oops::ObsErrorDiag< OBS >, and oops::interface::ObsErrorBase< OBS >.
◆ multiply()
|
pure virtual |
Multiply a Departure dy by \(R\).
Implemented in oops::interface::ObsErrorBase< OBS >, oops::interface::ObsErrorBase< OBS >, and oops::ObsErrorDiag< OBS >.
◆ obserrors()
|
pure virtual |
Return a copy of obs error std. dev. If this ObsVector_ is modified (e.g. by obs filters), it should be passed back to update() to ensure the covariance matrix stays consistent.
Implemented in oops::ObsErrorDiag< OBS >, and oops::interface::ObsErrorBase< OBS >.
◆ print()
|
privatepure virtual |
Implemented in oops::ObsErrorDiag< OBS >.
◆ randomize()
|
pure virtual |
Generate random perturbation in dy.
Implemented in oops::interface::ObsErrorBase< OBS >, oops::interface::ObsErrorBase< OBS >, and oops::ObsErrorDiag< OBS >.
◆ save()
|
pure virtual |
Save obs errors to the group name.
Implemented in oops::ObsErrorDiag< OBS >.
◆ update()
|
pure virtual |
Set the diagonal of the covariance matrix to stddev squared.
Implemented in oops::interface::ObsErrorBase< OBS >, oops::interface::ObsErrorBase< OBS >, and oops::ObsErrorDiag< OBS >.
The documentation for this class was generated from the following file:
