UFO
ufo::ObsErrorModelRampParameters Class Reference

Options controlling the ObsErrorModelRamp ObsFunction. More...

#include <ObsErrorModelRamp.h>

Inheritance diagram for ufo::ObsErrorModelRampParameters:
Collaboration diagram for ufo::ObsErrorModelRampParameters:

Public Attributes

oops::RequiredParameter< Variablexvar {"xvar", this}
 x variable of the piece-wise function More...
 
oops::OptionalParameter< std::string > chlist {"channels", this}
 
oops::RequiredParameter< std::vector< float > > x0 {"x0", this}
 x-coordinate of the lower ramp inflection point More...
 
oops::RequiredParameter< std::vector< float > > x1 {"x1", this}
 x-coordinate of the upper ramp inflection point More...
 
oops::OptionalParameter< std::vector< float > > x2 {"x2", this}
 (optinal) an extra upper ramp. More...
 
oops::RequiredParameter< std::vector< float > > err0 {"err0", this}
 y-coordinate of the lower ramp inflection point More...
 
oops::RequiredParameter< std::vector< float > > err1 {"err1", this}
 y-coordinate of the upper ramp inflection point More...
 
oops::OptionalParameter< std::vector< float > > err2 {"err2", this}
 (optional) an extra error value. More...
 
oops::Parameter< bool > save {"save", false, this}
 whether to save xvar values to the ObsSpace More...
 

Detailed Description

Options controlling the ObsErrorModelRamp ObsFunction.

Definition at line 31 of file ObsErrorModelRamp.h.

Member Data Documentation

◆ chlist

oops::OptionalParameter<std::string> ufo::ObsErrorModelRampParameters::chlist {"channels", this}

channels; channels for which to calculate the ObsError for radiances Omit channels for application to a single non-radiance filter variable. When multiple "filter variables" are provided without channels, they will have the same observation error.

Definition at line 41 of file ObsErrorModelRamp.h.

◆ err0

oops::RequiredParameter<std::vector<float> > ufo::ObsErrorModelRampParameters::err0 {"err0", this}

y-coordinate of the lower ramp inflection point

Definition at line 49 of file ObsErrorModelRamp.h.

◆ err1

oops::RequiredParameter<std::vector<float> > ufo::ObsErrorModelRampParameters::err1 {"err1", this}

y-coordinate of the upper ramp inflection point

Definition at line 51 of file ObsErrorModelRamp.h.

◆ err2

oops::OptionalParameter<std::vector<float> > ufo::ObsErrorModelRampParameters::err2 {"err2", this}

(optional) an extra error value.

Definition at line 53 of file ObsErrorModelRamp.h.

◆ save

oops::Parameter<bool> ufo::ObsErrorModelRampParameters::save {"save", false, this}

whether to save xvar values to the ObsSpace

Definition at line 55 of file ObsErrorModelRamp.h.

◆ x0

oops::RequiredParameter<std::vector<float> > ufo::ObsErrorModelRampParameters::x0 {"x0", this}

x-coordinate of the lower ramp inflection point

Definition at line 43 of file ObsErrorModelRamp.h.

◆ x1

oops::RequiredParameter<std::vector<float> > ufo::ObsErrorModelRampParameters::x1 {"x1", this}

x-coordinate of the upper ramp inflection point

Definition at line 45 of file ObsErrorModelRamp.h.

◆ x2

oops::OptionalParameter<std::vector<float> > ufo::ObsErrorModelRampParameters::x2 {"x2", this}

(optinal) an extra upper ramp.

Definition at line 47 of file ObsErrorModelRamp.h.

◆ xvar

oops::RequiredParameter<Variable> ufo::ObsErrorModelRampParameters::xvar {"xvar", this}

x variable of the piece-wise function

Definition at line 36 of file ObsErrorModelRamp.h.


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