UFO
ufo::ObsBiasIncrement Class Reference

Contains increments to bias correction coefficients. More...

#include <ObsBiasIncrement.h>

Inheritance diagram for ufo::ObsBiasIncrement:
Collaboration diagram for ufo::ObsBiasIncrement:

Public Types

typedef ObsBiasParameters Parameters_
 

Public Member Functions

 ObsBiasIncrement (const ioda::ObsSpace &odb, const Parameters_ &params)
 
 ObsBiasIncrement (const ObsBiasIncrement &, const bool=true)
 
void diff (const ObsBias &, const ObsBias &)
 
void zero ()
 
ObsBiasIncrementoperator= (const ObsBiasIncrement &)
 
ObsBiasIncrementoperator+= (const ObsBiasIncrement &)
 
ObsBiasIncrementoperator-= (const ObsBiasIncrement &)
 
ObsBiasIncrementoperator*= (const double)
 
void axpy (const double, const ObsBiasIncrement &)
 
double dot_product_with (const ObsBiasIncrement &) const
 
void read (const eckit::Configuration &)
 
void write (const eckit::Configuration &) const
 
double norm () const
 
const Eigen::VectorXd & data () const
 Return bias coefficient increments. More...
 
Eigen::VectorXd & data ()
 
std::vector< double > coefficients (size_t jpred) const
 Return bias coefficient increments for predictor with index jpred. More...
 
void updateCoeff (size_t jpred, const std::vector< double > &coeffs)
 
std::size_t serialSize () const
 
void serialize (std::vector< double > &) const
 
void deserialize (const std::vector< double > &, std::size_t &)
 
 operator bool () const
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

Eigen::VectorXd biascoeffsinc_
 Bias coefficient increments. More...
 
std::vector< std::string > prednames_
 
oops::Variables vars_
 Variables that need to be bias-corrected. More...
 

Detailed Description

Contains increments to bias correction coefficients.

Definition at line 27 of file ObsBiasIncrement.h.

Member Typedef Documentation

◆ Parameters_

Constructor & Destructor Documentation

◆ ObsBiasIncrement() [1/2]

ufo::ObsBiasIncrement::ObsBiasIncrement ( const ioda::ObsSpace &  odb,
const Parameters_ params 
)

Definition at line 22 of file ObsBiasIncrement.cc.

Here is the call graph for this function:

◆ ObsBiasIncrement() [2/2]

ufo::ObsBiasIncrement::ObsBiasIncrement ( const ObsBiasIncrement other,
const bool  copy = true 
)

Definition at line 43 of file ObsBiasIncrement.cc.

Member Function Documentation

◆ axpy()

void ufo::ObsBiasIncrement::axpy ( const double  fact,
const ObsBiasIncrement rhs 
)

Definition at line 103 of file ObsBiasIncrement.cc.

◆ coefficients()

std::vector<double> ufo::ObsBiasIncrement::coefficients ( size_t  jpred) const
inline

Return bias coefficient increments for predictor with index jpred.

Definition at line 57 of file ObsBiasIncrement.h.

Here is the caller graph for this function:

◆ data() [1/2]

Eigen::VectorXd& ufo::ObsBiasIncrement::data ( )
inline

Definition at line 52 of file ObsBiasIncrement.h.

◆ data() [2/2]

const Eigen::VectorXd& ufo::ObsBiasIncrement::data ( ) const
inline

Return bias coefficient increments.

Definition at line 51 of file ObsBiasIncrement.h.

Here is the caller graph for this function:

◆ deserialize()

void ufo::ObsBiasIncrement::deserialize ( const std::vector< double > &  vect,
std::size_t &  index 
)

Definition at line 133 of file ObsBiasIncrement.cc.

Here is the call graph for this function:

◆ diff()

void ufo::ObsBiasIncrement::diff ( const ObsBias b1,
const ObsBias b2 
)

Definition at line 59 of file ObsBiasIncrement.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dot_product_with()

double ufo::ObsBiasIncrement::dot_product_with ( const ObsBiasIncrement rhs) const

Definition at line 109 of file ObsBiasIncrement.cc.

◆ norm()

double ufo::ObsBiasIncrement::norm ( ) const

Definition at line 115 of file ObsBiasIncrement.cc.

Here is the caller graph for this function:

◆ operator bool()

ufo::ObsBiasIncrement::operator bool ( ) const
inline

Definition at line 78 of file ObsBiasIncrement.h.

◆ operator*=()

ObsBiasIncrement & ufo::ObsBiasIncrement::operator*= ( const double  fact)

Definition at line 96 of file ObsBiasIncrement.cc.

◆ operator+=()

ObsBiasIncrement & ufo::ObsBiasIncrement::operator+= ( const ObsBiasIncrement rhs)

Definition at line 82 of file ObsBiasIncrement.cc.

◆ operator-=()

ObsBiasIncrement & ufo::ObsBiasIncrement::operator-= ( const ObsBiasIncrement rhs)

Definition at line 89 of file ObsBiasIncrement.cc.

◆ operator=()

ObsBiasIncrement & ufo::ObsBiasIncrement::operator= ( const ObsBiasIncrement rhs)

Definition at line 71 of file ObsBiasIncrement.cc.

◆ print()

void ufo::ObsBiasIncrement::print ( std::ostream &  os) const
private

Definition at line 141 of file ObsBiasIncrement.cc.

Here is the call graph for this function:

◆ read()

void ufo::ObsBiasIncrement::read ( const eckit::Configuration &  )
inline

Definition at line 46 of file ObsBiasIncrement.h.

◆ serialize()

void ufo::ObsBiasIncrement::serialize ( std::vector< double > &  vect) const

Definition at line 125 of file ObsBiasIncrement.cc.

Here is the call graph for this function:

◆ serialSize()

std::size_t ufo::ObsBiasIncrement::serialSize ( ) const
inline

Definition at line 73 of file ObsBiasIncrement.h.

Here is the caller graph for this function:

◆ updateCoeff()

void ufo::ObsBiasIncrement::updateCoeff ( size_t  jpred,
const std::vector< double > &  coeffs 
)
inline

Increment bias coeffiecient increments for predictor with index jpred with coeffs

Definition at line 66 of file ObsBiasIncrement.h.

Here is the caller graph for this function:

◆ write()

void ufo::ObsBiasIncrement::write ( const eckit::Configuration &  ) const
inline

Definition at line 47 of file ObsBiasIncrement.h.

◆ zero()

void ufo::ObsBiasIncrement::zero ( )

Definition at line 65 of file ObsBiasIncrement.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ biascoeffsinc_

Eigen::VectorXd ufo::ObsBiasIncrement::biascoeffsinc_
private

Bias coefficient increments.

Definition at line 84 of file ObsBiasIncrement.h.

◆ prednames_

std::vector<std::string> ufo::ObsBiasIncrement::prednames_
private

Definition at line 85 of file ObsBiasIncrement.h.

◆ vars_

oops::Variables ufo::ObsBiasIncrement::vars_
private

Variables that need to be bias-corrected.

Definition at line 88 of file ObsBiasIncrement.h.


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