ObsVector class to handle vectors in observation space for IODA. More...

#include <ObsVector.h>

Inheritance diagram for ioda::ObsVector:

Collaboration diagram for ioda::ObsVector:

[legend]

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

	ObsVector (const ObsVector &)

	~ObsVector ()

ObsVector &	operator= (const ObsVector &)

ObsVector &	operator*= (const double &)

ObsVector &	operator+= (const ObsVector &)

ObsVector &	operator-= (const ObsVector &)

ObsVector &	operator*= (const ObsVector &)

ObsVector &	operator/= (const ObsVector &)

ObsVector &	operator= (const ObsDataVector< float > &)

void	zero ()

void	ones ()
	set all elements to one (used in tests) More...

void	axpy (const double &beta, const ObsVector &y)
	adds `beta` * `y` to the current vector More...

void	axpy (const std::vector< double > &beta, const ObsVector &y)

void	invert ()

void	random ()

double	dot_product_with (const ObsVector &other) const
	global (across all MPI tasks) dot product of this with `other` More...

std::vector< double >	multivar_dot_product_with (const ObsVector &other) const

double	rms () const

std::size_t	size () const

const double &	operator[] (const std::size_t ii) const

double &	operator[] (const std::size_t ii)

unsigned int	nobs () const
	Number of active observations (missing values not included) across all MPI tasks. More...

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

size_t	packEigenSize (const ObsVector &mask) const

const double &	toFortran () const

double &	toFortran ()

ObsSpace &	space ()

const ObsSpace &	space () const

const std::string &	obstype () const

const oops::Variables &	varnames () const

std::size_t	nvars () const

std::size_t	nlocs () const

void	mask (const ObsDataVector< int > &mask)
	Set this ObsVector values to missing where `mask` is non-zero. More...

void	mask (const ObsVector &mask)
	Set this ObsVector values to missing where `mask` has missing values. More...

bool	has (const std::string &var) const

int64_t	getSeed () const

void	save (const std::string &) const

void	read (const std::string &)

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

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

Private Attributes
ObsSpace &	obsdb_
	Associate ObsSpace object. More...

oops::Variables	obsvars_
	Variables. More...

std::size_t	nvars_
	Number of variables. More...

std::size_t	nlocs_

std::vector< double >	values_
	Vector data. More...

const double	missing_
	Missing data mark. More...

Detailed Description

ObsVector class to handle vectors in observation space for IODA.

This class holds observation vector data. Examples of an obs vector are the y vector and the H(x) vector. The methods of this class that implement vector operations (e.g., bitwise add, bitwise subtract, dot product) are capable of handling missing values in the obs data.

Definition at line 33 of file src/ObsVector.h.

Constructor & Destructor Documentation

◆ ObsVector() [1/2]

ioda::ObsVector::ObsVector	(	ObsSpace &	obsdb,
		const std::string &	name = `""`
	)

explicit

Definition at line 25 of file ObsVector.cc.

Here is the call graph for this function:

◆ ObsVector() [2/2]

ioda::ObsVector::ObsVector ( const ObsVector & other )

Definition at line 35 of file ObsVector.cc.

◆ ~ObsVector()

ioda::ObsVector::~ObsVector ( )

Definition at line 42 of file ObsVector.cc.

Member Function Documentation

◆ axpy() [1/2]

void ioda::ObsVector::axpy	(	const double &	beta,
		const ObsVector &	y
	)

adds beta * y to the current vector

Definition at line 121 of file ObsVector.cc.

◆ axpy() [2/2]

void ioda::ObsVector::axpy	(	const std::vector< double > &	beta,
		const ObsVector &	y
	)

adds beta[ivar] * y[ivar] for each variable in the current vector. beta has to be size of variables

Definition at line 133 of file ObsVector.cc.

◆ classname()

static const std::string ioda::ObsVector::classname ( )

inlinestatic

Definition at line 36 of file src/ObsVector.h.

◆ dot_product_with()

double ioda::ObsVector::dot_product_with ( const ObsVector & other ) const

global (across all MPI tasks) dot product of this with other

Definition at line 164 of file ObsVector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSeed()

int64_t ioda::ObsVector::getSeed ( ) const

inline

Definition at line 103 of file src/ObsVector.h.

◆ has()

bool ioda::ObsVector::has ( const std::string & var ) const

inline

Definition at line 101 of file src/ObsVector.h.

◆ invert()

void ioda::ObsVector::invert ( )

Definition at line 149 of file ObsVector.cc.

◆ mask() [1/2]

void ioda::ObsVector::mask ( const ObsDataVector< int > & mask )

Set this ObsVector values to missing where mask is non-zero.

Definition at line 281 of file ObsVector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mask() [2/2]

void ioda::ObsVector::mask ( const ObsVector & mask )

Set this ObsVector values to missing where mask has missing values.

Definition at line 293 of file ObsVector.cc.

Here is the call graph for this function:

◆ multivar_dot_product_with()

std::vector< double > ioda::ObsVector::multivar_dot_product_with ( const ObsVector & other ) const

global (across all MPI tasks) dot product of this with other, variable by variable. Returns vectors size of nvars_

Definition at line 169 of file ObsVector.cc.

Here is the call graph for this function:

◆ nlocs()

std::size_t ioda::ObsVector::nlocs ( ) const

inline

Definition at line 94 of file src/ObsVector.h.

Here is the caller graph for this function:

◆ nobs()

unsigned int ioda::ObsVector::nobs ( ) const

Number of active observations (missing values not included) across all MPI tasks.

Definition at line 301 of file ObsVector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nvars()

std::size_t ioda::ObsVector::nvars ( ) const

inline

Definition at line 93 of file src/ObsVector.h.

◆ obstype()

const std::string& ioda::ObsVector::obstype ( ) const

inline

Definition at line 91 of file src/ObsVector.h.

◆ ones()

void ioda::ObsVector::ones ( )

set all elements to one (used in tests)

Definition at line 117 of file ObsVector.cc.

◆ operator*=() [1/2]

ObsVector & ioda::ObsVector::operator*= ( const double & zz )

Definition at line 50 of file ObsVector.cc.

◆ operator*=() [2/2]

ObsVector & ioda::ObsVector::operator*= ( const ObsVector & rhs )

Definition at line 85 of file ObsVector.cc.

◆ operator+=()

ObsVector & ioda::ObsVector::operator+= ( const ObsVector & rhs )

Definition at line 59 of file ObsVector.cc.

◆ operator-=()

ObsVector & ioda::ObsVector::operator-= ( const ObsVector & rhs )

Definition at line 72 of file ObsVector.cc.

◆ operator/=()

ObsVector & ioda::ObsVector::operator/= ( const ObsVector & rhs )

Definition at line 98 of file ObsVector.cc.

◆ operator=() [1/2]

ObsVector & ioda::ObsVector::operator= ( const ObsDataVector< float > & rhs )

Definition at line 258 of file ObsVector.cc.

Here is the call graph for this function:

◆ operator=() [2/2]

ObsVector & ioda::ObsVector::operator= ( const ObsVector & rhs )

Definition at line 45 of file ObsVector.cc.

◆ operator[]() [1/2]

double& ioda::ObsVector::operator[] ( const std::size_t ii )

inline

Definition at line 73 of file src/ObsVector.h.

◆ operator[]() [2/2]

const double& ioda::ObsVector::operator[] ( const std::size_t ii ) const

inline

Definition at line 72 of file src/ObsVector.h.

◆ packEigen()

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

Pack observations local to this MPI task into an Eigen vector (excluding vector elements that are missing values, or where mask is equal to missing values

Definition at line 245 of file ObsVector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ packEigenSize()

size_t ioda::ObsVector::packEigenSize ( const ObsVector & mask ) const

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

Definition at line 235 of file ObsVector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

void ioda::ObsVector::print ( std::ostream & os ) const

private

Definition at line 315 of file ObsVector.cc.

Here is the call graph for this function:

◆ random()

void ioda::ObsVector::random ( )

Definition at line 157 of file ObsVector.cc.

Here is the caller graph for this function:

◆ read()

void ioda::ObsVector::read ( const std::string & name )

Definition at line 194 of file ObsVector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rms()

double ioda::ObsVector::rms ( ) const

Definition at line 186 of file ObsVector.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

void ioda::ObsVector::save ( const std::string & name ) const

Definition at line 217 of file ObsVector.cc.

Here is the call graph for this function:

◆ size()

std::size_t ioda::ObsVector::size ( ) const

inline

Definition at line 71 of file src/ObsVector.h.

◆ space() [1/2]

ObsSpace& ioda::ObsVector::space ( )

inline

Definition at line 89 of file src/ObsVector.h.

◆ space() [2/2]

const ObsSpace& ioda::ObsVector::space ( ) const

inline

Definition at line 90 of file src/ObsVector.h.

◆ toFortran() [1/2]

double & ioda::ObsVector::toFortran ( )

Definition at line 311 of file ObsVector.cc.

◆ toFortran() [2/2]

const double & ioda::ObsVector::toFortran ( ) const

Definition at line 307 of file ObsVector.cc.

◆ varnames()

const oops::Variables& ioda::ObsVector::varnames ( ) const

inline

Definition at line 92 of file src/ObsVector.h.

◆ zero()

void ioda::ObsVector::zero ( )

Definition at line 111 of file ObsVector.cc.

Member Data Documentation

◆ missing_

const double ioda::ObsVector::missing_

private

Missing data mark.

Definition at line 126 of file src/ObsVector.h.

◆ nlocs_

std::size_t ioda::ObsVector::nlocs_

private

Definition at line 120 of file src/ObsVector.h.

◆ nvars_

std::size_t ioda::ObsVector::nvars_

private

Number of variables.

Definition at line 119 of file src/ObsVector.h.

◆ obsdb_

ObsSpace& ioda::ObsVector::obsdb_

private

Associate ObsSpace object.

Definition at line 113 of file src/ObsVector.h.

◆ obsvars_

oops::Variables ioda::ObsVector::obsvars_

private

Variables.

Definition at line 116 of file src/ObsVector.h.

◆ values_

std::vector<double> ioda::ObsVector::values_

private

Vector data.

Definition at line 123 of file src/ObsVector.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ObsVector() [1/2]

◆ ObsVector() [2/2]

◆ ~ObsVector()

Member Function Documentation

◆ axpy() [1/2]

◆ axpy() [2/2]

◆ classname()

◆ dot_product_with()

◆ getSeed()

◆ has()

◆ invert()

◆ mask() [1/2]

◆ mask() [2/2]

◆ multivar_dot_product_with()

◆ nlocs()

◆ nobs()

◆ nvars()

◆ obstype()

◆ ones()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ packEigen()

◆ packEigenSize()

◆ print()

◆ random()

◆ read()

◆ rms()

◆ save()

◆ size()

◆ space() [1/2]

◆ space() [2/2]

◆ toFortran() [1/2]

◆ toFortran() [2/2]

◆ varnames()

◆ zero()

Member Data Documentation

◆ missing_

◆ nlocs_

◆ nvars_

◆ obsdb_

◆ obsvars_

◆ values_