ufo::ObsBoundsCheckParameters Class Reference

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

#include <ObsBoundsCheck.h>

Inheritance diagram for ufo::ObsBoundsCheckParameters:

Collaboration diagram for ufo::ObsBoundsCheckParameters:

Public Attributes
oops::OptionalParameter< float >	minvalue {"minvalue", this}
	Minimum allowed value of the tested variables. More...
oops::OptionalParameter< float >	maxvalue {"maxvalue", this}
	Maximum allowed value of the tested variables. More...
oops::OptionalParameter< std::vector< Variable > >	testVariables {"test variables", this}
oops::Parameter< bool >	flagAllFilterVarsIfAnyTestVarOutOfBounds
oops::Parameter< bool >	onlyTestGoodFilterVarsForFlagAllFilterVars
oops::Parameter< bool >	treatMissingAsOutOfBounds {"treat missing as out of bounds", true, 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 FilterActionParametersBase &	action () const override
	Return parameters defining the action performed on observations flagged by the filter. More...

Detailed Description

Parameters controlling the operation of the ObsBoundsCheck filter.

Definition at line 36 of file ObsBoundsCheck.h.

Member Data Documentation

flagAllFilterVarsIfAnyTestVarOutOfBounds

oops::Parameter<bool> ufo::ObsBoundsCheckParameters::flagAllFilterVarsIfAnyTestVarOutOfBounds

Initial value:

{
    "flag all filter variables if any test variable is out of bounds", false, this}

Set this option to true to flag all filter variables at each location where any test variable lies outside the specified bounds.

This option is ignored if the test variables option is not set.

Definition at line 72 of file ObsBoundsCheck.h.

maxvalue

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

Maximum allowed value of the tested variables.

Definition at line 44 of file ObsBoundsCheck.h.

minvalue

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

Minimum allowed value of the tested variables.

Definition at line 41 of file ObsBoundsCheck.h.

onlyTestGoodFilterVarsForFlagAllFilterVars

oops::Parameter<bool> ufo::ObsBoundsCheckParameters::onlyTestGoodFilterVarsForFlagAllFilterVars

Initial value:

{
    "test only filter variables with passed qc when flagging all filter variables", false, this}

Set this option to true to only test the current filter variable if it is flagged as pass qc when using "flag all filter variables if any test variables out of bounds".

This option is not used if "flagAllFilterVarsIfAnyTestVarOutOfBounds" is false.

Definition at line 79 of file ObsBoundsCheck.h.

testVariables

oops::OptionalParameter<std::vector<Variable> > ufo::ObsBoundsCheckParameters::testVariables {"test variables", this}

Variables to be compared against the bounds specified in the minvalue and maxvalue options.

There are three valid possibilities:

• If this option is not set, the filter will flag each filter variable at each location where the measured value of that variable lies outside the specified bounds.
• If this option is set to a single-element list containing only one single-channel variable or the flag all filter variables if any test variable is out of bounds option is set to true, the filter will flag each filter variable at each location where any test variable lies outside the specified bounds. If test only filter variables with passed qc when flagging all filter variables is set to true and the number of filter vars is not equal to the number of test vars an error will be thrown.
• If this option is set to a list with as many elements as there are filter variables and the flag all filter variables if any test variable is out of bounds option is set to false, the filter will flag each filter variable at each location where the corresponding test variable lies outside the specified bounds.

Definition at line 66 of file ObsBoundsCheck.h.

treatMissingAsOutOfBounds

oops::Parameter<bool> ufo::ObsBoundsCheckParameters::treatMissingAsOutOfBounds {"treat missing as out of bounds", true, this}

By default, the filter flags filter variables at locations where the corresponding test variable is set to the missing value indicator. Set this option to false to stop it from doing so (hence assuming "optimistically" that the test variable was in fact in bounds).

Definition at line 85 of file ObsBoundsCheck.h.

---

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

• ObsBoundsCheck.h