UFO
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ufo::EntireSampleDataHandler Class Reference

Retrieve and store data for entire sample. This class uses lazy loading; vectors of variables are retrieved once requested and cached after that. Variables in certain groups are optional, meaning that if they are not present on the obsdb they will be filled with a default value if requested. More...

#include <EntireSampleDataHandler.h>

Collaboration diagram for ufo::EntireSampleDataHandler:
Collaboration graph
[legend]

Public Member Functions

 EntireSampleDataHandler (ioda::ObsSpace &obsdb, const DataHandlerParameters &options)
 
template<typename T >
std::vector< T > & get (const std::string &fullname)
 
void writeQuantitiesToObsdb ()
 

Private Member Functions

template<typename T >
void putDataVector (const std::string &fullname, const std::vector< T > &datavec)
 Put entire data vector on obsdb. More...
 
int defaultValue (const std::vector< int > &vec)
 Default value used to fill vector of integers. More...
 
float defaultValue (const std::vector< float > &vec)
 Default value used to fill vector of floats. More...
 
std::string defaultValue (const std::vector< std::string > &vec)
 Default value used to fill vector of strings. More...
 

Private Attributes

ioda::ObsSpace & obsdb_
 Observation database. More...
 
const DataHandlerParameters & options_
 Configurable parameters. More...
 
std::unordered_map< std::string, boost::variant< std::vector< int >, std::vector< float >, std::vector< std::string > > > entireSampleData_
 Container of each variable in the entire data set. More...
 

Detailed Description

Retrieve and store data for entire sample. This class uses lazy loading; vectors of variables are retrieved once requested and cached after that. Variables in certain groups are optional, meaning that if they are not present on the obsdb they will be filled with a default value if requested.

Definition at line 42 of file EntireSampleDataHandler.h.

Constructor & Destructor Documentation

◆ EntireSampleDataHandler()

ufo::EntireSampleDataHandler::EntireSampleDataHandler ( ioda::ObsSpace &  obsdb,
const DataHandlerParameters &  options 
)

Definition at line 14 of file EntireSampleDataHandler.cc.

Member Function Documentation

◆ defaultValue() [1/3]

float ufo::EntireSampleDataHandler::defaultValue ( const std::vector< float > &  vec)
inlineprivate

Default value used to fill vector of floats.

Definition at line 136 of file EntireSampleDataHandler.h.

◆ defaultValue() [2/3]

int ufo::EntireSampleDataHandler::defaultValue ( const std::vector< int > &  vec)
inlineprivate

Default value used to fill vector of integers.

Definition at line 133 of file EntireSampleDataHandler.h.

Here is the caller graph for this function:

◆ defaultValue() [3/3]

std::string ufo::EntireSampleDataHandler::defaultValue ( const std::vector< std::string > &  vec)
inlineprivate

Default value used to fill vector of strings.

Definition at line 139 of file EntireSampleDataHandler.h.

◆ get()

template<typename T >
std::vector<T>& ufo::EntireSampleDataHandler::get ( const std::string &  fullname)
inline

Retrieve a vector containing the requested variable for the entire data sample.

  1. If the variable has previously been placed in a vector, return the vector.
  2. If the variable is present in the input data set, fill the vector with those values.
  3. If the variable is not present in the input data set, and 'optional' is true, fill the vector with zeros.
  4. If the variable is not present in the input data set, and 'optional' is false, do not fill the vector. Also store the name of the variable, enabling it to be retrieved later.

Definition at line 56 of file EntireSampleDataHandler.h.

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

◆ putDataVector()

template<typename T >
void ufo::EntireSampleDataHandler::putDataVector ( const std::string &  fullname,
const std::vector< T > &  datavec 
)
inlineprivate

Put entire data vector on obsdb.

Definition at line 114 of file EntireSampleDataHandler.h.

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

◆ writeQuantitiesToObsdb()

void ufo::EntireSampleDataHandler::writeQuantitiesToObsdb ( )

Write various quantities to the obsdb so they can be used in future QC checks. The particular variables written out are hardcoded but this could be changed to a configurable list if requred.

Definition at line 20 of file EntireSampleDataHandler.cc.

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

Member Data Documentation

◆ entireSampleData_

std::unordered_map<std::string, boost::variant <std::vector <int>, std::vector <float>, std::vector <std::string> > > ufo::EntireSampleDataHandler::entireSampleData_
private

Container of each variable in the entire data set.

Definition at line 143 of file EntireSampleDataHandler.h.

◆ obsdb_

ioda::ObsSpace& ufo::EntireSampleDataHandler::obsdb_
private

Observation database.

Definition at line 127 of file EntireSampleDataHandler.h.

◆ options_

const DataHandlerParameters& ufo::EntireSampleDataHandler::options_
private

Configurable parameters.

Definition at line 130 of file EntireSampleDataHandler.h.

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