ObsDataVector is a vector templated on data type, in the observation space. More...
#include <ObsDataVector_head.h>
Public Member Functions | |
| ObsDataVector (const ObsSpace< OBS > &os, const Variables &vars, const std::string name="") | |
| ObsDataVector (const ObsDataVector &other) | |
Copy constructor from other. More... | |
| ObsDataVector (ObsVector< OBS > &other) | |
| ~ObsDataVector () | |
| Destructor (defined explicitly for timing and tracing) More... | |
| ObsDataVec_ & | obsdatavector () |
| Accessor to the data. More... | |
| const ObsDataVec_ & | obsdatavector () const |
| const accessor to the data More... | |
| std::shared_ptr< ObsDataVec_ > | obsdatavectorptr () |
| Accessor returning pointer to the data. More... | |
| std::shared_ptr< const ObsDataVec_ > | obsdatavectorptr () const |
| const accessor returning pointer to the data More... | |
| ObsDataVector & | operator= (const ObsDataVector &) |
| Assignment operator. More... | |
| void | zero () |
| Zero out this ObsDataVector. More... | |
| void | mask (const ObsDataVector< OBS, int > &qc) |
| unsigned int | nobs () const |
| Return the number of observations that aren't set to missing, across all MPI tasks. More... | |
| void | read (const std::string &name) |
Fill ObsDataVector with data with group name from the associated ObsSpace. More... | |
| void | save (const std::string &name) const |
Save this ObsDataVector as group name in the ObsSpace. More... | |
Static Public Member Functions | |
| static const std::string | classname () |
Private Types | |
| typedef OBS::template ObsDataVector< DATATYPE > | ObsDataVec_ |
Private Member Functions | |
| void | print (std::ostream &) const |
Private Attributes | |
| std::shared_ptr< ObsDataVec_ > | data_ |
| Pointer to the ObsDataVector implementation. More... | |
Detailed Description
template<typename OBS, typename DATATYPE>
class oops::ObsDataVector< OBS, DATATYPE >
ObsDataVector is a vector templated on data type, in the observation space.
oops currently uses ObsDataVector<int> and ObsDataVector<float>);
Definition at line 31 of file ObsDataVector_head.h.
Member Typedef Documentation
◆ ObsDataVec_
|
private |
Definition at line 33 of file ObsDataVector_head.h.
Constructor & Destructor Documentation
◆ ObsDataVector() [1/3]
| oops::ObsDataVector< OBS, DATATYPE >::ObsDataVector | ( | const ObsSpace< OBS > & | os, |
| const Variables & | vars, | ||
| const std::string | name = "" |
||
| ) |
Constructor for specified ObsSpace os, with variables. If the group name is specified, the data is read from ObsSpace for specified variables and group. Otherwise ObsDataVector is allocated for specified variables and filled with zeros.
Definition at line 29 of file oops/interface/ObsDataVector.h.
◆ ObsDataVector() [2/3]
| oops::ObsDataVector< OBS, DATATYPE >::ObsDataVector | ( | const ObsDataVector< OBS, DATATYPE > & | other | ) |
Copy constructor from other.
Definition at line 40 of file oops/interface/ObsDataVector.h.
◆ ObsDataVector() [3/3]
|
explicit |
Constructor from other ObsVector. ObsDataVector is created with variables from ObsVector and assigned ObsVector values. This is only well defined for numeric DATATYPE.
Definition at line 48 of file oops/interface/ObsDataVector.h.
◆ ~ObsDataVector()
| oops::ObsDataVector< OBS, DATATYPE >::~ObsDataVector |
Destructor (defined explicitly for timing and tracing)
Definition at line 56 of file oops/interface/ObsDataVector.h.
Member Function Documentation
◆ classname()
|
inlinestatic |
◆ mask()
| void oops::ObsDataVector< OBS, DATATYPE >::mask | ( | const ObsDataVector< OBS, int > & | qc | ) |
Mask values by reading another ObsDataVector qc that has the same variables and contains the masking information. Elements of this corresponding to non-zero elements of qc are set to missing.
Definition at line 81 of file oops/interface/ObsDataVector.h.
◆ nobs()
|
inline |
Return the number of observations that aren't set to missing, across all MPI tasks.
Definition at line 70 of file ObsDataVector_head.h.
◆ obsdatavector() [1/2]
|
inline |
Accessor to the data.
Definition at line 51 of file ObsDataVector_head.h.
◆ obsdatavector() [2/2]
|
inline |
const accessor to the data
Definition at line 53 of file ObsDataVector_head.h.
◆ obsdatavectorptr() [1/2]
|
inline |
Accessor returning pointer to the data.
Definition at line 56 of file ObsDataVector_head.h.
◆ obsdatavectorptr() [2/2]
|
inline |
const accessor returning pointer to the data
Definition at line 58 of file ObsDataVector_head.h.
◆ operator=()
| ObsDataVector< OBS, DATATYPE > & oops::ObsDataVector< OBS, DATATYPE >::operator= | ( | const ObsDataVector< OBS, DATATYPE > & | rhs | ) |
Assignment operator.
Definition at line 64 of file oops/interface/ObsDataVector.h.
◆ print()
|
private |
Definition at line 89 of file oops/interface/ObsDataVector.h.
◆ read()
| void oops::ObsDataVector< OBS, DATATYPE >::read | ( | const std::string & | name | ) |
Fill ObsDataVector with data with group name from the associated ObsSpace.
Definition at line 97 of file oops/interface/ObsDataVector.h.
◆ save()
| void oops::ObsDataVector< OBS, DATATYPE >::save | ( | const std::string & | name | ) | const |
Save this ObsDataVector as group name in the ObsSpace.
Definition at line 105 of file oops/interface/ObsDataVector.h.
◆ zero()
| void oops::ObsDataVector< OBS, DATATYPE >::zero |
Zero out this ObsDataVector.
Definition at line 73 of file oops/interface/ObsDataVector.h.
Member Data Documentation
◆ data_
|
private |
Pointer to the ObsDataVector implementation.
Definition at line 80 of file ObsDataVector_head.h.
The documentation for this class was generated from the following files:
