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

Observations Class. More...

#include <Observations.h>

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

Public Member Functions

 Observations (const ObsSpaces_ &, const std::string &name="")
 create Observations for all obs (read from ObsSpace if name is specified) More...
 
 ~Observations ()=default
 destructor and copy/move constructor/assignments More...
 
 Observations (const Observations &)
 
 Observations (Observations &&)
 
Observations & operator= (const Observations &)
 
Observations & operator= (Observations &&)
 
std::size_t size () const
 Access. More...
 
ObsVector_ & operator[] (const std::size_t ii)
 
const ObsVector_ & operator[] (const std::size_t ii) const
 
Departures_ operator- (const Observations &other) const
 Interactions with Departures. More...
 
Observations & operator+= (const Departures_ &)
 
void save (const std::string &) const
 Save/read observations values. More...
 
void read (const std::string &)
 
void zero ()
 Accumulator. More...
 
void accumul (const Observations &)
 
Observations & operator*= (const double)
 
void perturb (const ObsErrors_ &)
 Perturbations. More...
 

Private Types

typedef Departures< OBS > Departures_
 
typedef ObsErrors< OBS > ObsErrors_
 
typedef ObsSpaces< OBS > ObsSpaces_
 
typedef ObsVector< OBS > ObsVector_
 

Private Member Functions

void print (std::ostream &) const
 
size_t nobs () const
 

Private Attributes

const ObsSpaces_ & obsdb_
 Data. More...
 
std::vector< ObsVector_ > obs_
 

Detailed Description

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

Observations Class.

Contains observed values or their model equivalents

Definition at line 35 of file Observations.h.

Member Typedef Documentation

◆ Departures_

template<typename OBS >
typedef Departures<OBS> oops::Observations< OBS >::Departures_
private

Definition at line 36 of file Observations.h.

◆ ObsErrors_

template<typename OBS >
typedef ObsErrors<OBS> oops::Observations< OBS >::ObsErrors_
private

Definition at line 37 of file Observations.h.

◆ ObsSpaces_

template<typename OBS >
typedef ObsSpaces<OBS> oops::Observations< OBS >::ObsSpaces_
private

Definition at line 38 of file Observations.h.

◆ ObsVector_

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

Definition at line 39 of file Observations.h.

Constructor & Destructor Documentation

◆ Observations() [1/3]

template<typename OBS >
oops::Observations< OBS >::Observations ( const ObsSpaces_ &  obsdb,
const std::string &  name = "" 
)
explicit

create Observations for all obs (read from ObsSpace if name is specified)

Definition at line 85 of file Observations.h.

Here is the call graph for this function:

◆ ~Observations()

template<typename OBS >
oops::Observations< OBS >::~Observations ( )
default

destructor and copy/move constructor/assignments

◆ Observations() [2/3]

template<typename OBS >
oops::Observations< OBS >::Observations ( const Observations< OBS > &  other)

Definition at line 96 of file Observations.h.

◆ Observations() [3/3]

template<typename OBS >
oops::Observations< OBS >::Observations ( Observations< OBS > &&  other)

Definition at line 102 of file Observations.h.

Member Function Documentation

◆ accumul()

template<typename OBS >
void oops::Observations< OBS >::accumul ( const Observations< OBS > &  y)

Definition at line 162 of file Observations.h.

Here is the caller graph for this function:

◆ nobs()

template<typename OBS >
size_t oops::Observations< OBS >::nobs
private

Definition at line 177 of file Observations.h.

◆ operator*=()

template<typename OBS >
Observations< OBS > & oops::Observations< OBS >::operator*= ( const double  factor)

Definition at line 169 of file Observations.h.

◆ operator+=()

template<typename OBS >
Observations< OBS > & oops::Observations< OBS >::operator+= ( const Departures_ &  dy)

Definition at line 133 of file Observations.h.

◆ operator-()

template<typename OBS >
Departures< OBS > oops::Observations< OBS >::operator- ( const Observations< OBS > &  other) const

Interactions with Departures.

Definition at line 123 of file Observations.h.

◆ operator=() [1/2]

template<typename OBS >
Observations< OBS > & oops::Observations< OBS >::operator= ( const Observations< OBS > &  other)

Definition at line 107 of file Observations.h.

◆ operator=() [2/2]

template<typename OBS >
Observations< OBS > & oops::Observations< OBS >::operator= ( Observations< OBS > &&  other)

Definition at line 115 of file Observations.h.

◆ operator[]() [1/2]

template<typename OBS >
ObsVector_& oops::Observations< OBS >::operator[] ( const std::size_t  ii)
inline

Definition at line 54 of file Observations.h.

◆ operator[]() [2/2]

template<typename OBS >
const ObsVector_& oops::Observations< OBS >::operator[] ( const std::size_t  ii) const
inline

Definition at line 55 of file Observations.h.

◆ perturb()

template<typename OBS >
void oops::Observations< OBS >::perturb ( const ObsErrors_ &  Rmat)

Perturbations.

Definition at line 186 of file Observations.h.

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

◆ print()

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

Definition at line 194 of file Observations.h.

◆ read()

template<typename OBS >
void oops::Observations< OBS >::read ( const std::string &  name)

Definition at line 148 of file Observations.h.

Here is the caller graph for this function:

◆ save()

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

Save/read observations values.

Definition at line 141 of file Observations.h.

Here is the caller graph for this function:

◆ size()

template<typename OBS >
std::size_t oops::Observations< OBS >::size ( ) const
inline

Access.

Definition at line 53 of file Observations.h.

◆ zero()

template<typename OBS >
void oops::Observations< OBS >::zero

Accumulator.

Definition at line 155 of file Observations.h.

Here is the caller graph for this function:

Member Data Documentation

◆ obs_

template<typename OBS >
std::vector<ObsVector_> oops::Observations< OBS >::obs_
private

Definition at line 79 of file Observations.h.

◆ obsdb_

template<typename OBS >
const ObsSpaces_& oops::Observations< OBS >::obsdb_
private

Data.

Definition at line 78 of file Observations.h.

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