UFO
ufo::ProfileBackgroundCheckParameters Class Reference

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

#include <ProfileBackgroundCheck.h>

Inheritance diagram for ufo::ProfileBackgroundCheckParameters:
Collaboration diagram for ufo::ProfileBackgroundCheckParameters:

Public Attributes

oops::OptionalParameter< std::string > relativeThreshold {"relative threshold", this}
 
oops::OptionalParameter< std::string > absoluteThreshold {"absolute 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 ProfileBackgroundCheck filter.

Definition at line 36 of file ProfileBackgroundCheck.h.

Member Data Documentation

◆ absoluteThreshold

oops::OptionalParameter<std::string> ufo::ProfileBackgroundCheckParameters::absoluteThreshold {"absolute threshold", this}

The filter will flag observations whose bias-corrected value differs from its model equivalent by more than absolute threshold

absolute threshold can be a real number or the name of a variable.

Definition at line 50 of file ProfileBackgroundCheck.h.

◆ relativeThreshold

oops::OptionalParameter<std::string> ufo::ProfileBackgroundCheckParameters::relativeThreshold {"relative threshold", this}

The filter will flag observations whose bias-corrected value differs from its model equivalent by more than relative threshold times the current estimate of the observation error.

relative threshold can be a real number or the name of a variable.

Definition at line 44 of file ProfileBackgroundCheck.h.


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