UFO
ufo::Cal_RelativeHumidity Class Reference

Relative Humidity filter. More...

#include <Cal_Humidity.h>

Inheritance diagram for ufo::Cal_RelativeHumidity:
Collaboration diagram for ufo::Cal_RelativeHumidity:

Public Member Functions

 Cal_RelativeHumidity (const VariableTransformsParameters &options, const ObsFilterData &data, const std::shared_ptr< ioda::ObsDataVector< int >> &flags)
 
void runTransform (const std::vector< bool > &apply) override
 Run variable conversion. More...
 
- Public Member Functions inherited from ufo::TransformBase
 TransformBase (const VariableTransformsParameters &options, const ObsFilterData &data, const std::shared_ptr< ioda::ObsDataVector< int >> &flags)
 
virtual ~TransformBase ()
 Destructor. More...
 
virtual Variables requiredVariables () const
 Return list of required geovals. More...
 

Private Member Functions

void methodDEFAULT (const std::vector< bool > &apply)
 
void methodUKMO (const std::vector< bool > &apply)
 

Additional Inherited Members

- Protected Member Functions inherited from ufo::TransformBase
template<typename T >
void getObservation (const std::string &originalTag, const std::string &varName, std::vector< T > &obsVector, bool require=false) const
 templated function for float, int data types More...
 
template<typename T >
void putObservation (const std::string &varName, const std::vector< T > &obsVector)
 Save a transformed variable to the DerivedObsValue group of the obs space. More...
 
formulas::MethodFormulation method () const
 subclasses to access Method and formualtion used for the calculation More...
 
formulas::MethodFormulation formulation () const
 
bool UseValidDataOnly () const
 
bool AllowSuperSaturation () const
 
void SetUseValidDataOnly (bool t)
 
std::string obsName () const
 subclasses to access the observation name More...
 
- Protected Attributes inherited from ufo::TransformBase
const VariableTransformsParametersoptions_
 Configurable parameters. More...
 
ObsFilterData data_
 Observation and geoval data. More...
 
ioda::ObsSpace & obsdb_ = data_.obsspace()
 Observation space. More...
 
ioda::ObsDataVector< int > & flags_
 
const int missingValueInt = util::missingValue(1)
 Missing value (int) More...
 
const float missingValueFloat = util::missingValue(1.0f)
 Missing value (float) More...
 
const std::string outputTag = "DerivedObsValue"
 output tag for derived parameters More...
 

Detailed Description

Relative Humidity filter.

Performs a variable conversion from specific_humidity, temperature, and pressure to relative humidity. The newly calculated variable is included in the same obs space.

Example:

obs filters:
- filter: Variables Transform
Transform: ["RelativeHumidity"]
Formulation: Sonntag # Using Sonntag formulation

See VariableTransformsParameters for filter setup.

Definition at line 40 of file Cal_Humidity.h.

Constructor & Destructor Documentation

◆ Cal_RelativeHumidity()

ufo::Cal_RelativeHumidity::Cal_RelativeHumidity ( const VariableTransformsParameters options,
const ObsFilterData data,
const std::shared_ptr< ioda::ObsDataVector< int >> &  flags 
)

Definition at line 19 of file Cal_Humidity.cc.

Member Function Documentation

◆ methodDEFAULT()

void ufo::Cal_RelativeHumidity::methodDEFAULT ( const std::vector< bool > &  apply)
private

Definition at line 229 of file Cal_Humidity.cc.

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

◆ methodUKMO()

void ufo::Cal_RelativeHumidity::methodUKMO ( const std::vector< bool > &  apply)
private

Definition at line 68 of file Cal_Humidity.cc.

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

◆ runTransform()

void ufo::Cal_RelativeHumidity::runTransform ( const std::vector< bool > &  apply)
overridevirtual

Run variable conversion.

Implements ufo::TransformBase.

Definition at line 27 of file Cal_Humidity.cc.

Here is the call graph for this function:

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