UFO
Public Member Functions | Private Attributes | List of all members
ufo::ObsCategoricalData< OPBASE > Class Template Reference

Data handler for the Categorical observation operator and TL/AD code. More...

#include <ObsCategoricalData.h>

Public Member Functions

void configure (const ioda::ObsSpace &odb, const ObsCategoricalParameters &parameters)
 Get all information related to the configuration of the Categorical operator and TL/AD code. More...
 
const oops::Variables & requiredVars () const
 Return required variables for the operator. More...
 
const std::map< std::string, std::unique_ptr< OPBASE > > & components () const
 Return component operators. More...
 
const std::vector< std::string > & locOperNames () const
 Return list of operator names to use at each location. More...
 
void fillHofX (const std::map< std::string, ioda::ObsVector > &ovecs, ioda::ObsVector &ovec) const
 Fill final H(x) vector from a list of components. More...
 
void print (std::ostream &os) const
 

Private Attributes

oops::Variables requiredVars_
 Required variables. More...
 
std::map< std::string, std::unique_ptr< OPBASE > > components_
 Observation operators which are run by the Categorical operator. More...
 
std::vector< std::string > categoricalVariable_
 Value of the categorical variable in the ObsSpace. More...
 
std::string fallbackOperatorName_
 Name of the fallback observation operator. More...
 
std::map< std::string, std::string > categorisedOperatorNames_
 Names of the categorised observation operators. More...
 
std::vector< std::string > locOperNames_
 Operator name at each location. More...
 

Detailed Description

template<typename OPBASE>
class ufo::ObsCategoricalData< OPBASE >

Data handler for the Categorical observation operator and TL/AD code.

Definition at line 66 of file ObsCategoricalData.h.

Member Function Documentation

◆ components()

template<typename OPBASE >
const std::map<std::string, std::unique_ptr<OPBASE> >& ufo::ObsCategoricalData< OPBASE >::components ( ) const
inline

Return component operators.

Definition at line 142 of file ObsCategoricalData.h.

◆ configure()

template<typename OPBASE >
void ufo::ObsCategoricalData< OPBASE >::configure ( const ioda::ObsSpace &  odb,
const ObsCategoricalParameters &  parameters 
)
inline

Get all information related to the configuration of the Categorical operator and TL/AD code.

Definition at line 69 of file ObsCategoricalData.h.

◆ fillHofX()

template<typename OPBASE >
void ufo::ObsCategoricalData< OPBASE >::fillHofX ( const std::map< std::string, ioda::ObsVector > &  ovecs,
ioda::ObsVector &  ovec 
) const
inline

Fill final H(x) vector from a list of components.

Definition at line 148 of file ObsCategoricalData.h.

◆ locOperNames()

template<typename OPBASE >
const std::vector<std::string>& ufo::ObsCategoricalData< OPBASE >::locOperNames ( ) const
inline

Return list of operator names to use at each location.

Definition at line 145 of file ObsCategoricalData.h.

◆ print()

template<typename OPBASE >
void ufo::ObsCategoricalData< OPBASE >::print ( std::ostream &  os) const
inline

Definition at line 162 of file ObsCategoricalData.h.

◆ requiredVars()

template<typename OPBASE >
const oops::Variables& ufo::ObsCategoricalData< OPBASE >::requiredVars ( ) const
inline

Return required variables for the operator.

Definition at line 139 of file ObsCategoricalData.h.

Member Data Documentation

◆ categoricalVariable_

template<typename OPBASE >
std::vector<std::string> ufo::ObsCategoricalData< OPBASE >::categoricalVariable_
private

Value of the categorical variable in the ObsSpace.

Definition at line 176 of file ObsCategoricalData.h.

◆ categorisedOperatorNames_

template<typename OPBASE >
std::map<std::string, std::string> ufo::ObsCategoricalData< OPBASE >::categorisedOperatorNames_
private

Names of the categorised observation operators.

Definition at line 182 of file ObsCategoricalData.h.

◆ components_

template<typename OPBASE >
std::map<std::string, std::unique_ptr<OPBASE> > ufo::ObsCategoricalData< OPBASE >::components_
private

Observation operators which are run by the Categorical operator.

Definition at line 173 of file ObsCategoricalData.h.

◆ fallbackOperatorName_

template<typename OPBASE >
std::string ufo::ObsCategoricalData< OPBASE >::fallbackOperatorName_
private

Name of the fallback observation operator.

Definition at line 179 of file ObsCategoricalData.h.

◆ locOperNames_

template<typename OPBASE >
std::vector<std::string> ufo::ObsCategoricalData< OPBASE >::locOperNames_
private

Operator name at each location.

Definition at line 185 of file ObsCategoricalData.h.

◆ requiredVars_

template<typename OPBASE >
oops::Variables ufo::ObsCategoricalData< OPBASE >::requiredVars_
private

Required variables.

Definition at line 170 of file ObsCategoricalData.h.

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