Contents of a single element of the list taken by the where option of each filter, used to select the subset of observation locations that should be processed by the filter. More...

#include <processWhere.h>

Inheritance diagram for ufo::WhereParameters:

[legend]

Collaboration diagram for ufo::WhereParameters:

[legend]

Public Attributes
oops::RequiredParameter< Variable >	variable {"variable", this}
	Variable whose value must fulfil the conditions specified in the remaining parameters. More...

oops::OptionalParameter< float >	absolutetolerance {"absolute_tolerance", this}

oops::OptionalParameter< float >	relativetolerance {"relative_tolerance", this}

oops::OptionalParameter< util::AnyOf< int, float, util::PartialDateTime > >	minvalue

oops::OptionalParameter< util::AnyOf< int, float, util::PartialDateTime > >	maxvalue

oops::OptionalParameter< util::AnyOf< std::set< int >, std::vector< std::string > > >	isIn

oops::OptionalParameter< std::vector< float > >	isClose {"is_close_to_any_of", this}

oops::OptionalParameter< util::AnyOf< std::set< int >, std::vector< std::string > > >	isNotIn

oops::OptionalParameter< std::vector< float > >	isNotClose {"is_not_close_to_any_of", this}

oops::OptionalParameter< void >	isDefined {"is_defined", this}
	Select locations at which the condition variable is not set to to the missing value indicator. More...

oops::OptionalParameter< void >	isNotDefined {"is_not_defined", this}
	Select locations at which the condition variable is set to to the missing value indicator. More...

oops::OptionalParameter< std::set< int > >	anyBitSetOf {"any_bit_set_of", this}
	Select locations at which any of the specified bits in the condition variable is set. More...

oops::OptionalParameter< std::set< int > >	anyBitUnsetOf {"any_bit_unset_of", this}
	Select locations at which any of the specified bits in the condition variable is unset. More...

oops::OptionalParameter< std::string >	matchesWildcard {"matches_wildcard", this}

oops::OptionalParameter< std::vector< std::string > >	matchesAnyWildcard
	Select locations at which the condition variable matches any of the specified wildcards. More...

oops::OptionalParameter< std::string >	matchesRegex {"matches_regex", this}
	Select locations at which the condition variable matches the specified regular expression. More...

Private Member Functions
	OOPS_CONCRETE_PARAMETERS (WhereParameters, Parameters)

Detailed Description

Contents of a single element of the list taken by the where option of each filter, used to select the subset of observation locations that should be processed by the filter.

Definition at line 33 of file src/ufo/filters/processWhere.h.

Member Function Documentation

◆ OOPS_CONCRETE_PARAMETERS()

ufo::WhereParameters::OOPS_CONCRETE_PARAMETERS	(	WhereParameters	,
		Parameters
	)

private

Member Data Documentation

◆ absolutetolerance

oops::OptionalParameter<float> ufo::WhereParameters::absolutetolerance {"absolute_tolerance", this}

This is a tolerance used for absolute float comparison. Currently used for float comparison with isClose and isNotClose.

Definition at line 42 of file src/ufo/filters/processWhere.h.

◆ anyBitSetOf

oops::OptionalParameter<std::set<int> > ufo::WhereParameters::anyBitSetOf {"any_bit_set_of", this}

Select locations at which any of the specified bits in the condition variable is set.

Definition at line 94 of file src/ufo/filters/processWhere.h.

◆ anyBitUnsetOf

oops::OptionalParameter<std::set<int> > ufo::WhereParameters::anyBitUnsetOf {"any_bit_unset_of", this}

Select locations at which any of the specified bits in the condition variable is unset.

Definition at line 97 of file src/ufo/filters/processWhere.h.

◆ isClose

oops::OptionalParameter<std::vector<float> > ufo::WhereParameters::isClose {"is_close_to_any_of", this}

Select locations at which the condition variable is within tolerance to specified values. For float variables, this should be a bracketed list of floats (e.g. [0.0, 0.5]) which are compared within a tolerance. A tolerance must be provided by the user and is a float either called absolute_tolerance or relative_tolerance (see above);

Definition at line 71 of file src/ufo/filters/processWhere.h.

◆ isDefined

oops::OptionalParameter<void> ufo::WhereParameters::isDefined {"is_defined", this}

Select locations at which the condition variable is not set to to the missing value indicator.

Definition at line 88 of file src/ufo/filters/processWhere.h.

◆ isIn

oops::OptionalParameter<util::AnyOf<std::set<int>, std::vector<std::string> > > ufo::WhereParameters::isIn

Initial value:

{

"is_in", this}

Select locations at which the condition variable takes one of the specified values. For integer variables, this can be an integer, range of integers (e.g. 3-5) or a comma-separated list of integers and/or ranges (e.g. 3-5, 7-8, 10). For string variables, this should be a bracketed list of strings (e.g. [abc, def]);

Definition at line 64 of file src/ufo/filters/processWhere.h.

◆ isNotClose

oops::OptionalParameter<std::vector<float> > ufo::WhereParameters::isNotClose {"is_not_close_to_any_of", this}

Select locations at which the condition variable is not within tolerance of the specified values. For float variables, this should be a bracketed list of floats (e.g. [0.0, 0.5]) which are compared within a tolerance A tolerance must be provided by the user and is a float either called absolute_tolerance or relative_tolerance (see above);

Definition at line 85 of file src/ufo/filters/processWhere.h.

◆ isNotDefined

oops::OptionalParameter<void> ufo::WhereParameters::isNotDefined {"is_not_defined", this}

Select locations at which the condition variable is set to to the missing value indicator.

Definition at line 91 of file src/ufo/filters/processWhere.h.

◆ isNotIn

oops::OptionalParameter<util::AnyOf<std::set<int>, std::vector<std::string> > > ufo::WhereParameters::isNotIn

Initial value:

{

"is_not_in", this}

Select locations at which the condition variable does not take any of the specified values. For integer variables, this can be an integer, range of integers (e.g. 3-5) or a comma-separated list of integers and/or ranges (e.g. 3-5, 7-8, 10). For string variables, this should be a bracketed list of strings (e.g. [abc, def]);

Definition at line 77 of file src/ufo/filters/processWhere.h.

◆ matchesAnyWildcard

oops::OptionalParameter<std::vector<std::string> > ufo::WhereParameters::matchesAnyWildcard

Initial value:

{

"matches_any_wildcard", this}

Select locations at which the condition variable matches any of the specified wildcards.

Definition at line 105 of file src/ufo/filters/processWhere.h.

◆ matchesRegex

oops::OptionalParameter<std::string> ufo::WhereParameters::matchesRegex {"matches_regex", this}

Select locations at which the condition variable matches the specified regular expression.

Definition at line 109 of file src/ufo/filters/processWhere.h.

◆ matchesWildcard

oops::OptionalParameter<std::string> ufo::WhereParameters::matchesWildcard {"matches_wildcard", this}

Select locations at which the condition variable matches the specified wildcard (which may contain the wildcard characters *, standing for any number of characters, and ?, standing for any character).

Definition at line 102 of file src/ufo/filters/processWhere.h.

◆ maxvalue

oops::OptionalParameter<util::AnyOf<int, float, util::PartialDateTime> > ufo::WhereParameters::maxvalue

Initial value:

{

"maxvalue", this}

Select locations at which the condition variable is less than or equal to the specified value. Can be set to an int, float or datetime in the ISO 8601 format (if any datetime components are zero, they are ignored).

Definition at line 57 of file src/ufo/filters/processWhere.h.

◆ minvalue

oops::OptionalParameter<util::AnyOf<int, float, util::PartialDateTime> > ufo::WhereParameters::minvalue

Initial value:

{

"minvalue", this}

Select locations at which the condition variable is greater than or equal to the specified value. Can be set to an int, float or datetime in the ISO 8601 format (if any datetime components are zero, they are ignored).

Definition at line 51 of file src/ufo/filters/processWhere.h.

◆ relativetolerance

oops::OptionalParameter<float> ufo::WhereParameters::relativetolerance {"relative_tolerance", this}

This is a tolerance used for relative tolerance comparison. Currently used for float comparison with isClose and isNotClose.

Definition at line 46 of file src/ufo/filters/processWhere.h.

◆ variable

oops::RequiredParameter<Variable> ufo::WhereParameters::variable {"variable", this}

Variable whose value must fulfil the conditions specified in the remaining parameters.

Definition at line 38 of file src/ufo/filters/processWhere.h.

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

src/ufo/filters/processWhere.h

Public Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ OOPS_CONCRETE_PARAMETERS()

Member Data Documentation

◆ absolutetolerance

◆ anyBitSetOf

◆ anyBitUnsetOf

◆ isClose

◆ isDefined

◆ isIn

◆ isNotClose

◆ isNotDefined

◆ isNotIn

◆ matchesAnyWildcard

◆ matchesRegex

◆ matchesWildcard

◆ maxvalue

◆ minvalue

◆ relativetolerance

◆ variable