UFO
ufo::VariableTransformsParameters Class Reference

Options controlling the operation of the variablestansform filter. More...

#include <VariableTransformsParameters.h>

Inheritance diagram for ufo::VariableTransformsParameters:
Collaboration diagram for ufo::VariableTransformsParameters:

Public Attributes

oops::RequiredParameter< std::vector< std::string > > Transform
 
oops::Parameter< std::string > Method {"Method", "default", this}
 
oops::Parameter< std::string > Formulation {"Formulation", "", this}
 
oops::Parameter< bool > UseValidDataOnly {"UseValidDataOnly", true, this}
 
oops::Parameter< bool > AllowSuperSaturation {"AllowSuperSaturation", false, this}
 

Detailed Description

Options controlling the operation of the variablestansform filter.

Definition at line 31 of file VariableTransformsParameters.h.

Member Data Documentation

◆ AllowSuperSaturation

oops::Parameter<bool> ufo::VariableTransformsParameters::AllowSuperSaturation {"AllowSuperSaturation", false, this}

Should we allow super-saturated relative humidity? [Optional]: By default AllowSuperSaturation is set to false. See ReadTheDoc for more details

Definition at line 76 of file VariableTransformsParameters.h.

◆ Formulation

oops::Parameter<std::string> ufo::VariableTransformsParameters::Formulation {"Formulation", "", this}

Formulation possible [Optional]: By default formulation is set to the Method. See ReadTheDoc for more details

Definition at line 66 of file VariableTransformsParameters.h.

◆ Method

oops::Parameter<std::string> ufo::VariableTransformsParameters::Method {"Method", "default", this}

Method used for calculation [Optional]: Related to Met Center - See ReadTheDoc for more details.

Definition at line 61 of file VariableTransformsParameters.h.

◆ Transform

oops::RequiredParameter<std::vector<std::string> > ufo::VariableTransformsParameters::Transform
Initial value:
{"Transform",
this}

List of possible transformatioins:

  • Pressure from height:
    • "PressureFromHeightForProfile":
      Retrieve pressure from observation height. This conversion require a vertical profile. See Cal_PressureFromHeightForProfile for details.
    • "PressureFromHeightForICAO":
      Retrieve pressure from observation height using ICAO standard. See Cal_PressureFromHeightForICAO for details.
    • "WindSpeedAndDirection":
      Retrieve wind speed and direction from the eastward(u), and northward (v) wind components.
    • "WindComponents":
      Retrieve the eastward(u), and northward (v) wind components from wind speed and direction
    • "SpecificHumidity":
      Retrieve the specific humidity from relative humidity
    • "RelativeHumidity":
      Retrieve the relative humidity from specific humidity

Definition at line 56 of file VariableTransformsParameters.h.

◆ UseValidDataOnly

oops::Parameter<bool> ufo::VariableTransformsParameters::UseValidDataOnly {"UseValidDataOnly", true, this}

Should we use only the valid data? [Optional]: By default UseValidDataOnly is set to true. See ReadTheDoc for more details

Definition at line 71 of file VariableTransformsParameters.h.


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