Options used to configure comparison of a variable generated by a filter against a reference variable loaded from the input IODA file. More...
#include <ObsFilters.h>
Public Attributes | |
| oops::RequiredParameter< ufo::Variable > | test {"test", this} |
| Variable that should be contained against reference values. More... | |
| oops::RequiredParameter< ufo::Variable > | reference {"reference", this} |
| Variable containing the reference values. More... | |
| oops::OptionalParameter< float > | absTol {"absTol", this} |
| oops::OptionalParameter< float > | relTol {"relTol", this} |
Detailed Description
Options used to configure comparison of a variable generated by a filter against a reference variable loaded from the input IODA file.
Definition at line 62 of file ObsFilters.h.
Member Data Documentation
◆ absTol
| oops::OptionalParameter<float> ufo::test::CompareVariablesParameters::absTol {"absTol", this} |
If set, the comparison will fail if any corresponding elements of the test and reference variables differ by more than absTol. If neither absTol nor relTol is set, the comparison will fail if any corresponding elements do not match exactly.
Definition at line 74 of file ObsFilters.h.
◆ reference
| oops::RequiredParameter<ufo::Variable> ufo::test::CompareVariablesParameters::reference {"reference", this} |
Variable containing the reference values.
Definition at line 69 of file ObsFilters.h.
◆ relTol
| oops::OptionalParameter<float> ufo::test::CompareVariablesParameters::relTol {"relTol", this} |
If set, the comparison will fail if the relative difference of any pair of corresponding elements of the test and reference variables exceeds relTol. If neither absTol nor relTol is set, the comparison will fail if any corresponding elements do not match exactly.
Definition at line 79 of file ObsFilters.h.
◆ test
| oops::RequiredParameter<ufo::Variable> ufo::test::CompareVariablesParameters::test {"test", this} |
Variable that should be contained against reference values.
Definition at line 67 of file ObsFilters.h.
The documentation for this class was generated from the following file:
