Holds observation vector (e.g. vector of observation values, or of computed H(x)) More...

#include <ObsVector.h>

Inheritance diagram for oops::interface::ObsVector< OBS >:

[legend]

Collaboration diagram for oops::interface::ObsVector< OBS >:

Public Member Functions
	ObsVector (const ObsSpace< OBS > &obsspace, const std::string name="")

	ObsVector (std::unique_ptr< ObsVector_ > obsvector)

	ObsVector (const ObsVector &)
	Copy constructor. More...

	~ObsVector ()
	Destructor (defined explicitly for timing and tracing) More...

ObsVector_ &	obsvector ()
	Accessor. More...

const ObsVector_ &	obsvector () const
	Const accessor. More...

ObsVector &	operator= (const ObsVector &)
	Linear algebra operators. More...

ObsVector &	operator*= (const double &)

ObsVector &	operator+= (const ObsVector &)

ObsVector &	operator-= (const ObsVector &)

ObsVector &	operator*= (const ObsVector &)

ObsVector &	operator/= (const ObsVector &)

void	axpy (const double &zz, const ObsVector &rhs)
	Add `zz` * `rhs` to the ObsVector. More...

Eigen::VectorXd	packEigen (const ObsVector &mask) const

size_t	packEigenSize (const ObsVector &mask) const

void	zero ()
	Zero out this ObsVector. More...

void	ones ()
	Set this ObsVector to ones (used in tests) More...

void	invert ()
	Set each value in this ObsVector to its inverse. More...

void	random ()
	Set each value in this ObsVector to a random value. More...

double	dot_product_with (const ObsVector &other) const
	Return the dot product between this ObsVector and another one `other`. More...

double	rms () const
	Return this ObsVector rms. More...

void	mask (const ObsDataVector< OBS, int > &mask)
	Mask out elements of the vector where `mask` is > 0. More...

void	mask (const ObsVector &mask)
	Mask out elements of the vector where `mask` is a missing value. More...

ObsVector &	operator= (const ObsDataVector< OBS, float > &rhs)
	Assignment operator from `rhs` ObsDataVector<OBS, float> More...

void	save (const std::string &) const
	Save this ObsVector as group `name` in the ObsSpace. More...

void	read (const std::string &)
	Fill ObsVector with data with group `name` from the associated ObsSpace. More...

unsigned int	nobs () const
	Number of non-masked out observations (across all MPI tasks) More...

Static Public Member Functions
static const std::string	classname ()

Private Types
typedef OBS::ObsVector	ObsVector_

Private Member Functions
void	print (std::ostream &) const

Private Attributes
std::unique_ptr< ObsVector_ >	data_

Detailed Description

template<typename OBS>
class oops::interface::ObsVector< OBS >

Holds observation vector (e.g. vector of observation values, or of computed H(x))

Definition at line 46 of file oops/interface/ObsVector.h.

Member Typedef Documentation

◆ ObsVector_

template<typename OBS >

typedef OBS::ObsVector oops::interface::ObsVector< OBS >::ObsVector_

private

Definition at line 48 of file oops/interface/ObsVector.h.

Constructor & Destructor Documentation

◆ ObsVector() [1/3]

template<typename OBS >

oops::interface::ObsVector< OBS >::ObsVector	(	const ObsSpace< OBS > &	obsspace,
		const std::string	name = `""`
	)

explicit

Creates vector from obsspace. If name is specified, reads the specified name variable from obsspace. Otherwise, zero vector is created.

Definition at line 123 of file oops/interface/ObsVector.h.

Here is the call graph for this function:

◆ ObsVector() [2/3]

template<typename OBS >

oops::interface::ObsVector< OBS >::ObsVector ( std::unique_ptr< ObsVector_ > obsvector )

explicit

Wraps an existing ObsVector_. This wrapping constructor doesn't need to be implemented in an ObsVector implementation.

Parameters

obsvector The vector to wrap.

Definition at line 133 of file oops/interface/ObsVector.h.

Here is the call graph for this function:

◆ ObsVector() [3/3]

template<typename OBS >

oops::interface::ObsVector< OBS >::ObsVector ( const ObsVector< OBS > & other )

Copy constructor.

Definition at line 142 of file oops/interface/ObsVector.h.

Here is the call graph for this function:

◆ ~ObsVector()

template<typename OBS >

oops::interface::ObsVector< OBS >::~ObsVector

Destructor (defined explicitly for timing and tracing)

Definition at line 151 of file oops/interface/ObsVector.h.

Member Function Documentation

◆ axpy()

template<typename OBS >

void oops::interface::ObsVector< OBS >::axpy	(	const double &	zz,
		const ObsVector< OBS > &	rhs
	)

Add zz * rhs to the ObsVector.

Definition at line 245 of file oops/interface/ObsVector.h.

◆ classname()

template<typename OBS >

static const std::string oops::interface::ObsVector< OBS >::classname ( )

inlinestatic

Definition at line 51 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

◆ dot_product_with()

template<typename OBS >

double oops::interface::ObsVector< OBS >::dot_product_with ( const ObsVector< OBS > & other ) const

Return the dot product between this ObsVector and another one other.

Definition at line 275 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

◆ invert()

template<typename OBS >

void oops::interface::ObsVector< OBS >::invert

Set each value in this ObsVector to its inverse.

Definition at line 255 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

◆ mask() [1/2]

template<typename OBS >

void oops::interface::ObsVector< OBS >::mask ( const ObsDataVector< OBS, int > & mask )

Mask out elements of the vector where mask is > 0.

Definition at line 286 of file oops/interface/ObsVector.h.

Here is the call graph for this function:

◆ mask() [2/2]

template<typename OBS >

void oops::interface::ObsVector< OBS >::mask ( const ObsVector< OBS > & mask )

Mask out elements of the vector where mask is a missing value.

Definition at line 294 of file oops/interface/ObsVector.h.

Here is the call graph for this function:

◆ nobs()

template<typename OBS >

unsigned int oops::interface::ObsVector< OBS >::nobs

Number of non-masked out observations (across all MPI tasks)

Definition at line 322 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

◆ obsvector() [1/2]

template<typename OBS >

ObsVector_& oops::interface::ObsVector< OBS >::obsvector ( )

inline

Accessor.

Definition at line 67 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

◆ obsvector() [2/2]

template<typename OBS >

const ObsVector_& oops::interface::ObsVector< OBS >::obsvector ( ) const

inline

Const accessor.

Definition at line 69 of file oops/interface/ObsVector.h.

◆ ones()

template<typename OBS >

void oops::interface::ObsVector< OBS >::ones

Set this ObsVector to ones (used in tests)

Definition at line 235 of file oops/interface/ObsVector.h.

◆ operator*=() [1/2]

template<typename OBS >

ObsVector< OBS > & oops::interface::ObsVector< OBS >::operator*= ( const double & zz )

Definition at line 170 of file oops/interface/ObsVector.h.

◆ operator*=() [2/2]

template<typename OBS >

ObsVector< OBS > & oops::interface::ObsVector< OBS >::operator*= ( const ObsVector< OBS > & rhs )

Definition at line 203 of file oops/interface/ObsVector.h.

◆ operator+=()

template<typename OBS >

ObsVector< OBS > & oops::interface::ObsVector< OBS >::operator+= ( const ObsVector< OBS > & rhs )

Definition at line 181 of file oops/interface/ObsVector.h.

◆ operator-=()

template<typename OBS >

ObsVector< OBS > & oops::interface::ObsVector< OBS >::operator-= ( const ObsVector< OBS > & rhs )

Definition at line 192 of file oops/interface/ObsVector.h.

◆ operator/=()

template<typename OBS >

ObsVector< OBS > & oops::interface::ObsVector< OBS >::operator/= ( const ObsVector< OBS > & rhs )

Definition at line 214 of file oops/interface/ObsVector.h.

◆ operator=() [1/2]

template<typename OBS >

ObsVector< OBS > & oops::interface::ObsVector< OBS >::operator= ( const ObsDataVector< OBS, float > & rhs )

Assignment operator from rhs ObsDataVector<OBS, float>

Definition at line 302 of file oops/interface/ObsVector.h.

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename OBS >

ObsVector< OBS > & oops::interface::ObsVector< OBS >::operator= ( const ObsVector< OBS > & rhs )

Linear algebra operators.

Definition at line 159 of file oops/interface/ObsVector.h.

◆ packEigen()

template<typename OBS >

Eigen::VectorXd oops::interface::ObsVector< OBS >::packEigen ( const ObsVector< OBS > & mask ) const

Pack observations local to this MPI task into an Eigen vector (excluding vector elements that are masked out: where mask is a missing value)

Definition at line 346 of file oops/interface/ObsVector.h.

Here is the call graph for this function:

◆ packEigenSize()

template<typename OBS >

size_t oops::interface::ObsVector< OBS >::packEigenSize ( const ObsVector< OBS > & mask ) const

Number of non-masked out observations local to this MPI task (size of an Eigen vector returned by packEigen)

Definition at line 357 of file oops/interface/ObsVector.h.

Here is the call graph for this function:

◆ print()

template<typename OBS >

void oops::interface::ObsVector< OBS >::print ( std::ostream & os ) const

private

Definition at line 328 of file oops/interface/ObsVector.h.

◆ random()

template<typename OBS >

void oops::interface::ObsVector< OBS >::random

Set each value in this ObsVector to a random value.

Definition at line 265 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

◆ read()

template<typename OBS >

void oops::interface::ObsVector< OBS >::read ( const std::string & name )

Fill ObsVector with data with group name from the associated ObsSpace.

Definition at line 368 of file oops/interface/ObsVector.h.

◆ rms()

template<typename OBS >

double oops::interface::ObsVector< OBS >::rms

Return this ObsVector rms.

Definition at line 311 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

◆ save()

template<typename OBS >

void oops::interface::ObsVector< OBS >::save ( const std::string & name ) const

Save this ObsVector as group name in the ObsSpace.

Definition at line 336 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

◆ zero()

template<typename OBS >

void oops::interface::ObsVector< OBS >::zero

Zero out this ObsVector.

Definition at line 225 of file oops/interface/ObsVector.h.

Here is the caller graph for this function:

Member Data Documentation

◆ data_

template<typename OBS >

std::unique_ptr<ObsVector_> oops::interface::ObsVector< OBS >::data_

private

Definition at line 118 of file oops/interface/ObsVector.h.

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

oops/interface/ObsVector.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename OBS> class oops::interface::ObsVector< OBS >

Member Typedef Documentation

◆ ObsVector_

Constructor & Destructor Documentation

◆ ObsVector() [1/3]

◆ ObsVector() [2/3]

◆ ObsVector() [3/3]

◆ ~ObsVector()

Member Function Documentation

◆ axpy()

◆ classname()

◆ dot_product_with()

◆ invert()

◆ mask() [1/2]

◆ mask() [2/2]

◆ nobs()

◆ obsvector() [1/2]

◆ obsvector() [2/2]

◆ ones()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ packEigen()

◆ packEigenSize()

◆ print()

◆ random()

◆ read()

◆ rms()

◆ save()

◆ zero()

Member Data Documentation

◆ data_

template<typename OBS>
class oops::interface::ObsVector< OBS >