UFO
ObsBoundsCheck.h
Go to the documentation of this file.
1 /*
2  * (C) Copyright 2018-2019 UCAR
3  *
4  * This software is licensed under the terms of the Apache Licence Version 2.0
5  * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
6  */
7 
8 #ifndef UFO_FILTERS_OBSBOUNDSCHECK_H_
9 #define UFO_FILTERS_OBSBOUNDSCHECK_H_
10 
11 #include <memory>
12 #include <ostream>
13 #include <string>
14 #include <vector>
15 
16 #include "oops/util/ObjectCounter.h"
17 #include "ufo/filters/FilterBase.h"
18 #include "ufo/filters/QCflags.h"
19 
20 namespace eckit {
21  class Configuration;
22 }
23 
24 namespace ioda {
25  template <typename DATATYPE> class ObsDataVector;
26  class ObsSpace;
27 }
28 
29 namespace ufo {
30 
31 /// ObsBoundsCheck: generic quality control based on observation data only
32 
33 // Check that observations are within some bounds over some domain
34 
35 class ObsBoundsCheck : public FilterBase,
36  private util::ObjectCounter<ObsBoundsCheck> {
37  public:
38  static const std::string classname() {return "ufo::ObsBoundsCheck";}
39 
40  ObsBoundsCheck(ioda::ObsSpace &, const eckit::Configuration &,
41  std::shared_ptr<ioda::ObsDataVector<int> >,
42  std::shared_ptr<ioda::ObsDataVector<float> >);
44 
45  private:
46  void print(std::ostream &) const override;
47  void applyFilter(const std::vector<bool> &, const Variables &,
48  std::vector<std::vector<bool>> &) const override;
49  int qcFlag() const override {return QCflags::bounds;}
50 };
51 
52 } // namespace ufo
53 
54 #endif // UFO_FILTERS_OBSBOUNDSCHECK_H_
FilterBase.h
ufo::Variables
Definition: src/ufo/filters/Variables.h:24
ufo::FilterBase
FilterBase: Base class for UFO QC filters.
Definition: FilterBase.h:42
ioda
Definition: ObsAtmSfcInterp.h:24
ufo
Definition: RunCRTM.h:27
eckit
Forward declarations.
Definition: ObsAtmSfcInterp.h:20
ufo::ObsBoundsCheck
ObsBoundsCheck: generic quality control based on observation data only.
Definition: ObsBoundsCheck.h:36
ufo::ObsBoundsCheck::print
void print(std::ostream &) const override
Definition: ObsBoundsCheck.cc:156
QCflags.h
ioda::ObsDataVector< int >
ufo::ObsBoundsCheck::applyFilter
void applyFilter(const std::vector< bool > &, const Variables &, std::vector< std::vector< bool >> &) const override
Definition: ObsBoundsCheck.cc:49
ufo::ObsBoundsCheck::qcFlag
int qcFlag() const override
Definition: ObsBoundsCheck.h:49
ufo::ObsBoundsCheck::ObsBoundsCheck
ObsBoundsCheck(ioda::ObsSpace &, const eckit::Configuration &, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
Definition: ObsBoundsCheck.cc:30
ufo::ObsBoundsCheck::~ObsBoundsCheck
~ObsBoundsCheck()
Definition: ObsBoundsCheck.cc:45
ufo::QCflags::bounds
constexpr int bounds
Definition: QCflags.h:17
ufo::ObsBoundsCheck::classname
static const std::string classname()
Definition: ObsBoundsCheck.h:38