UFO
ufo::DifferenceCheckParameters Class Reference

Parameters controlling the operation of the DifferenceCheck filter. More...

#include <DifferenceCheck.h>

Inheritance diagram for ufo::DifferenceCheckParameters:
Collaboration diagram for ufo::DifferenceCheckParameters:

Public Attributes

oops::RequiredParameter< Variableref {"reference", this}
 Name of the reference variable. More...
 
oops::RequiredParameter< Variableval {"value", this}
 Name of the test variable. More...
 
oops::OptionalParameter< float > minvalue {"minvalue", this}
 
oops::OptionalParameter< float > maxvalue {"maxvalue", this}
 
oops::OptionalParameter< float > threshold {"threshold", this}
 
- Public Attributes inherited from ufo::FilterParametersBaseWithAbstractAction
oops::OptionalParameter< std::vector< Variable > > filterVariables
 
oops::Parameter< std::vector< WhereParameters > > where {"where", {}, this}
 
oops::Parameter< bool > deferToPost {"defer to post", false, this}
 

Additional Inherited Members

- Public Member Functions inherited from ufo::FilterParametersBase
const FilterActionParametersBaseaction () const override
 Return parameters defining the action performed on observations flagged by the filter. More...
 

Detailed Description

Parameters controlling the operation of the DifferenceCheck filter.

Definition at line 36 of file DifferenceCheck.h.

Member Data Documentation

◆ maxvalue

oops::OptionalParameter<float> ufo::DifferenceCheckParameters::maxvalue {"maxvalue", this}

The filter will flag observations for which the difference test - reference is above maxvalue.

Definition at line 50 of file DifferenceCheck.h.

◆ minvalue

oops::OptionalParameter<float> ufo::DifferenceCheckParameters::minvalue {"minvalue", this}

The filter will flag observations for which the difference test - reference is below minvalue.

Definition at line 47 of file DifferenceCheck.h.

◆ ref

oops::RequiredParameter<Variable> ufo::DifferenceCheckParameters::ref {"reference", this}

Name of the reference variable.

Definition at line 41 of file DifferenceCheck.h.

◆ threshold

oops::OptionalParameter<float> ufo::DifferenceCheckParameters::threshold {"threshold", this}

If the threshold option is specified, the filter behaves as if minvalue was set to -threshold and maxvalue was set to threshold (overriding any values of these options specified independently).

Definition at line 55 of file DifferenceCheck.h.

◆ val

oops::RequiredParameter<Variable> ufo::DifferenceCheckParameters::val {"value", this}

Name of the test variable.

Definition at line 43 of file DifferenceCheck.h.


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