UFO
ufo::BennartzScatIndexParameters Class Reference

Options for calculating scattering index from 89 GHz and 150 GHz channels. More...

#include <BennartzScatIndex.h>

Inheritance diagram for ufo::BennartzScatIndexParameters:
Collaboration diagram for ufo::BennartzScatIndexParameters:

Public Attributes

oops::RequiredParameter< int > ch89 {"channel_89ghz", this, {oops::minConstraint(1)}}
 Channel number corresponding to 89 GHz (or nearby frequency depending on sensor channel specification) More...
 
oops::RequiredParameter< int > ch150 {"channel_150ghz", this, {oops::minConstraint(1)}}
 Channel number corresponding to 150 GHz (or nearby frequency depending on sensor channel specification) More...
 
oops::RequiredParameter< float > coeff1 {"bennartz_coeff_1", this}
 First coefficient used to compute scattering index. More...
 
oops::RequiredParameter< float > coeff2 {"bennartz_coeff_2", this}
 Second coefficient used to compute scattering index. More...
 
oops::Parameter< std::string > applyBias {"apply_bias", "", this}
 Name of the bias correction group used to apply correction to ObsValue. More...
 

Detailed Description

Options for calculating scattering index from 89 GHz and 150 GHz channels.

Definition at line 30 of file BennartzScatIndex.h.

Member Data Documentation

◆ applyBias

oops::Parameter<std::string> ufo::BennartzScatIndexParameters::applyBias {"apply_bias", "", this}

Name of the bias correction group used to apply correction to ObsValue.

Default (missing optional parameter) applies no bias

Example: use ObsBias correction values

     apply_bias: ObsBias 

Definition at line 67 of file BennartzScatIndex.h.

◆ ch150

oops::RequiredParameter<int> ufo::BennartzScatIndexParameters::ch150 {"channel_150ghz", this, {oops::minConstraint(1)}}

Channel number corresponding to 150 GHz (or nearby frequency depending on sensor channel specification)

Example: MHS channel 2 at 157 GHz

     channel_150ghz: 2 

Definition at line 48 of file BennartzScatIndex.h.

◆ ch89

oops::RequiredParameter<int> ufo::BennartzScatIndexParameters::ch89 {"channel_89ghz", this, {oops::minConstraint(1)}}

Channel number corresponding to 89 GHz (or nearby frequency depending on sensor channel specification)

Example: MHS channel 1 at 89 GHz

     channel_89ghz: 1 

Definition at line 40 of file BennartzScatIndex.h.

◆ coeff1

oops::RequiredParameter<float> ufo::BennartzScatIndexParameters::coeff1 {"bennartz_coeff_1", this}

First coefficient used to compute scattering index.

Offset term is calculated as coeff1 + coeff2*sensor_zenith_angle

Definition at line 53 of file BennartzScatIndex.h.

◆ coeff2

oops::RequiredParameter<float> ufo::BennartzScatIndexParameters::coeff2 {"bennartz_coeff_2", this}

Second coefficient used to compute scattering index.

Offset term is calculated as coeff1 + coeff2*sensor_zenith_angle

Definition at line 58 of file BennartzScatIndex.h.


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