UFO
ufo::BgdDepartureAnomalyParameters Class Reference

Options for calculating the background departure anomaly between two channels. More...

#include <BgdDepartureAnomaly.h>

Inheritance diagram for ufo::BgdDepartureAnomalyParameters:
Collaboration diagram for ufo::BgdDepartureAnomalyParameters:

Public Attributes

oops::RequiredParameter< int > obslow {"channel_low_freq", this, {oops::minConstraint(1)}}
 Lower frequency channel number. More...
 
oops::RequiredParameter< int > obshigh {"channel_high_freq", this, {oops::minConstraint(1)}}
 Higher frequency channel number. More...
 
oops::Parameter< std::string > ObsBias {"ObsBias", "", this}
 Name of the bias correction group used to apply correction to ObsValue. More...
 
oops::Parameter< std::string > testHofX {"test_hofx", "HofX", this}
 Name of the HofX group used to replace the default group (default is HofX) More...
 

Detailed Description

Options for calculating the background departure anomaly between two channels.

Definition at line 30 of file BgdDepartureAnomaly.h.

Member Data Documentation

◆ ObsBias

oops::Parameter<std::string> ufo::BgdDepartureAnomalyParameters::ObsBias {"ObsBias", "", 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

     ObsBias: ObsBias 

Definition at line 55 of file BgdDepartureAnomaly.h.

◆ obshigh

oops::RequiredParameter<int> ufo::BgdDepartureAnomalyParameters::obshigh {"channel_high_freq", this, {oops::minConstraint(1)}}

Higher frequency channel number.

Example: AMSR2 channel 13 corresponding to 89 GHz H-pol

     channel_high_freq: 13 

Definition at line 46 of file BgdDepartureAnomaly.h.

◆ obslow

oops::RequiredParameter<int> ufo::BgdDepartureAnomalyParameters::obslow {"channel_low_freq", this, {oops::minConstraint(1)}}

Lower frequency channel number.

Example: AMSR2 channel 11 corresponding to 36.5 GHz H-pol

     channel_low_freq: 11 

Definition at line 39 of file BgdDepartureAnomaly.h.

◆ testHofX

oops::Parameter<std::string> ufo::BgdDepartureAnomalyParameters::testHofX {"test_hofx", "HofX", this}

Name of the HofX group used to replace the default group (default is HofX)

Definition at line 58 of file BgdDepartureAnomaly.h.


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