Options controlling the operation of the EntireSampleDataHandler and ProfileDataHandler classes. More...
#include <DataHandlerParameters.h>
Public Member Functions | |
| bool | getOptional (const std::string &groupname) const |
| Determine whether a variable group is optional or not. More... | |
| size_t | getEntriesPerProfile (const std::string &groupname) const |
| Determine number of entries per profile for a variable group. More... | |
Public Attributes | |
| oops::Parameter< std::vector< std::string > > | groups_optional {"groups_optional", {"Corrections", "Counters"}, this} |
| oops::Parameter< std::vector< std::string > > | groups_singlevalue {"groups_singlevalue", {}, this} |
| Groups of variables which have one value per profile. More... | |
| oops::Parameter< std::vector< std::string > > | groups_modellevels |
| Groups of variables which are on model levels. More... | |
| oops::Parameter< std::vector< std::string > > | groups_modelrholevels |
| Groups of variables which are on model rho levels. More... | |
| oops::Parameter< int > | nErrorsFail {"nErrorsFail", 1, this} |
| Number of errors, accumulated over checks, that cause the observation to have failed. More... | |
| oops::OptionalParameter< int > | maxlev {"maxlev", this} |
| oops::Parameter< bool > | ValidateTotalNumProf {"ValidateTotalNumProf", true, this} |
| If not sorting observations, ensure number of profiles is consistent. More... | |
| oops::Parameter< std::string > | ModelLevelsDerivedValuesFilename {"ModelLevelsDerivedValuesFilename", "ModelLevelsDerivedValues.nc4", this} |
| Output filename for saving derived values on model levels. More... | |
| oops::Parameter< std::string > | defaultVerticalCoordinate {"defaultVerticalCoordinate", "air_pressure", this} |
| oops::Parameter< std::map< std::string, std::string > > | alternativeVerticalCoordinate |
| ModelParameters | ModParameters {this} |
| Parameters related to the model. More... | |
Detailed Description
Options controlling the operation of the EntireSampleDataHandler and ProfileDataHandler classes.
Definition at line 29 of file DataHandlerParameters.h.
Member Function Documentation
◆ getEntriesPerProfile()
|
inline |
Determine number of entries per profile for a variable group.
Definition at line 44 of file DataHandlerParameters.h.
◆ getOptional()
|
inline |
Determine whether a variable group is optional or not.
Definition at line 34 of file DataHandlerParameters.h.
Member Data Documentation
◆ alternativeVerticalCoordinate
| oops::Parameter<std::map<std::string, std::string> > ufo::DataHandlerParameters::alternativeVerticalCoordinate |
Alternative vertical coordinate(s) to use in the slant path location algorithm. The first string in each pair is the name of the variable whose slanted profile is to be determined, and the second string is the vertical coordinate that should be used to find the slant path locations for the variable. This will typically be useful for models whose variables appear on staggered vertical levels (e.g. with vertical coordinates 'air_pressure' and 'air_pressure_levels').
Definition at line 110 of file DataHandlerParameters.h.
◆ defaultVerticalCoordinate
| oops::Parameter<std::string> ufo::DataHandlerParameters::defaultVerticalCoordinate {"defaultVerticalCoordinate", "air_pressure", this} |
Default vertical coordinate to use in the slant path location algorithm. This can be overridden for each variable by using the alternativeVerticalCoordinate option.
Definition at line 101 of file DataHandlerParameters.h.
◆ groups_modellevels
| oops::Parameter<std::vector<std::string> > ufo::DataHandlerParameters::groups_modellevels |
Groups of variables which are on model levels.
Definition at line 75 of file DataHandlerParameters.h.
◆ groups_modelrholevels
| oops::Parameter<std::vector<std::string> > ufo::DataHandlerParameters::groups_modelrholevels |
Groups of variables which are on model rho levels.
Definition at line 80 of file DataHandlerParameters.h.
◆ groups_optional
| oops::Parameter<std::vector<std::string> > ufo::DataHandlerParameters::groups_optional {"groups_optional", {"Corrections", "Counters"}, this} |
Groups of variables whose presence in the input sample is optional (if not present, all variables are initially set to zero).
Definition at line 67 of file DataHandlerParameters.h.
◆ groups_singlevalue
| oops::Parameter<std::vector<std::string> > ufo::DataHandlerParameters::groups_singlevalue {"groups_singlevalue", {}, this} |
Groups of variables which have one value per profile.
Definition at line 71 of file DataHandlerParameters.h.
◆ maxlev
| oops::OptionalParameter<int> ufo::DataHandlerParameters::maxlev {"maxlev", this} |
Maximum number of profile levels to be processed (a legacy of the OPS code). No maximum is assigned if this parameter is not specified.
Definition at line 89 of file DataHandlerParameters.h.
◆ ModelLevelsDerivedValuesFilename
| oops::Parameter<std::string> ufo::DataHandlerParameters::ModelLevelsDerivedValuesFilename {"ModelLevelsDerivedValuesFilename", "ModelLevelsDerivedValues.nc4", this} |
Output filename for saving derived values on model levels.
Definition at line 95 of file DataHandlerParameters.h.
◆ ModParameters
| ModelParameters ufo::DataHandlerParameters::ModParameters {this} |
Parameters related to the model.
Definition at line 116 of file DataHandlerParameters.h.
◆ nErrorsFail
| oops::Parameter<int> ufo::DataHandlerParameters::nErrorsFail {"nErrorsFail", 1, this} |
Number of errors, accumulated over checks, that cause the observation to have failed.
Definition at line 85 of file DataHandlerParameters.h.
◆ ValidateTotalNumProf
| oops::Parameter<bool> ufo::DataHandlerParameters::ValidateTotalNumProf {"ValidateTotalNumProf", true, this} |
If not sorting observations, ensure number of profiles is consistent.
Definition at line 92 of file DataHandlerParameters.h.
The documentation for this class was generated from the following file:
