UFO
ufo::ObsCategoricalParameters Class Reference

Configuration options recognized by the Categorical operator. More...

#include <ObsCategoricalParameters.h>

Inheritance diagram for ufo::ObsCategoricalParameters:
Collaboration diagram for ufo::ObsCategoricalParameters:

Public Attributes

oops::RequiredParameter< std::string > categoricalVariable {"categorical variable", this}
 Categorical variable used to divide H(x) into sections. More...
 
oops::RequiredParameter< std::string > fallbackOperatorName {"fallback operator", this}
 
oops::RequiredParameter< std::map< std::string, std::string > > categorisedOperatorNames {"categorised operators", this}
 
oops::RequiredParameter< std::vector< eckit::LocalConfiguration > > operatorConfigurations {"operator configurations", this}
 
- Public Attributes inherited from ufo::ObsOperatorParametersBase
oops::OptionalParameter< std::string > name {"name", this}
 Observation operator type. More...
 

Detailed Description

Configuration options recognized by the Categorical operator.

Definition at line 22 of file ObsCategoricalParameters.h.

Member Data Documentation

◆ categoricalVariable

oops::RequiredParameter<std::string> ufo::ObsCategoricalParameters::categoricalVariable {"categorical variable", this}

Categorical variable used to divide H(x) into sections.

Definition at line 27 of file ObsCategoricalParameters.h.

◆ categorisedOperatorNames

oops::RequiredParameter<std::map<std::string, std::string> > ufo::ObsCategoricalParameters::categorisedOperatorNames {"categorised operators", this}

Map between values of the categorical variable and the corresponding observation operators. The fallback observation operator will be used for all values of the categorical variable that are not represented in this map.

Definition at line 38 of file ObsCategoricalParameters.h.

◆ fallbackOperatorName

oops::RequiredParameter<std::string> ufo::ObsCategoricalParameters::fallbackOperatorName {"fallback operator", this}

Name of the fallback observation operator to use. This will be used to produce H(x) at all locations whose value of the categorical variable does not appear in the categorisedOperatorNames map.

Definition at line 32 of file ObsCategoricalParameters.h.

◆ operatorConfigurations

oops::RequiredParameter<std::vector<eckit::LocalConfiguration> > ufo::ObsCategoricalParameters::operatorConfigurations {"operator configurations", this}

A list of configuration options for each observation operator (i.e. the default operator and any operators that have been specified in the categorisedOperatorNames map).

Definition at line 43 of file ObsCategoricalParameters.h.


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