UFO
ufo::BackgroundCheckParameters Class Reference

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

#include <BackgroundCheck.h>

Inheritance diagram for ufo::BackgroundCheckParameters:
Collaboration diagram for ufo::BackgroundCheckParameters:

Public Attributes

oops::OptionalParameter< std::string > threshold {"threshold", this}
 
oops::Parameter< bool > thresholdWrtBGerror {"threshold wrt background error", false, this}
 
oops::OptionalParameter< std::string > absoluteThreshold {"absolute threshold", this}
 
oops::OptionalParameter< std::vector< Variable > > functionAbsoluteThreshold
 
oops::Parameter< bool > removeBiasCorrection {"remove bias correction", false, this}
 The filter uses bias-corrected H(x) unless remove bias correction is set to true. More...
 
oops::Parameter< std::string > test_hofx {"test_hofx", "HofX", this}
 Name of the HofX group used to replace the default group (default is HofX) More...
 
- 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 BackgroundCheck filter.

Definition at line 36 of file BackgroundCheck.h.

Member Data Documentation

◆ absoluteThreshold

oops::OptionalParameter<std::string> ufo::BackgroundCheckParameters::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 61 of file BackgroundCheck.h.

◆ functionAbsoluteThreshold

oops::OptionalParameter<std::vector<Variable> > ufo::BackgroundCheckParameters::functionAbsoluteThreshold
Initial value:
{
"function absolute threshold", this}

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

function absolute threshold should be a list of ObsFunctions (but only the first element of this list is currently taken into account). The ObsFunctions may return multiple values per observation, which is especially useful for quality checking data with multiple channels.

If function absolute threshold is set, neither threshold nor absolute threshold should be set.

Definition at line 72 of file BackgroundCheck.h.

◆ removeBiasCorrection

oops::Parameter<bool> ufo::BackgroundCheckParameters::removeBiasCorrection {"remove bias correction", false, this}

The filter uses bias-corrected H(x) unless remove bias correction is set to true.

Definition at line 76 of file BackgroundCheck.h.

◆ test_hofx

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

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

Definition at line 79 of file BackgroundCheck.h.

◆ threshold

oops::OptionalParameter<std::string> ufo::BackgroundCheckParameters::threshold {"threshold", this}

The filter will flag observations whose bias-corrected value differs from its model equivalent by more than threshold times the current estimate of the observation error. Or if the option "threshold wrt background error" is true, the threshold is multiplied by the background error rather than observation error. E.g.

filter variables:

  • name: sea_surface_height threshold wrt background error: true threshold: 3.0

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

Definition at line 51 of file BackgroundCheck.h.

◆ thresholdWrtBGerror

oops::Parameter<bool> ufo::BackgroundCheckParameters::thresholdWrtBGerror {"threshold wrt background error", false, this}

A switch indicating whether threshold must be multiplied by background error rather than observation error. If true, threshold must have a value.

Definition at line 55 of file BackgroundCheck.h.


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