BlackList.h

Go to the documentation of this file.

/*
 * (C) Copyright 2018-2019 UCAR
 * 
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. 
 */
 
#ifndef UFO_FILTERS_BLACKLIST_H_
#define UFO_FILTERS_BLACKLIST_H_
 
#include <memory>
#include <ostream>
#include <string>
#include <vector>
 
#include "oops/util/ObjectCounter.h"
#include "ufo/filters/FilterBase.h"
#include "ufo/filters/QCflags.h"
 
namespace eckit {
  class Configuration;
}
 
namespace ioda {
  template <typename DATATYPE> class ObsDataVector;
  class ObsSpace;
}
 
namespace ufo {
 
class BlackListParameters : public FilterParametersBase {
  OOPS_CONCRETE_PARAMETERS(BlackListParameters, FilterParametersBase)
 
  // This filter doesn't take any extra parameters.
};
 
/// \brief Generic black listing of observations.
///
/// Filters observations out regardless of obs value
/// The same effect can be achieved with opposite criteria through the "Domain Check",
/// the choice is a matter of convenience or which seems more natural.
 
class BlackList : public FilterBase,
                  private util::ObjectCounter<BlackList> {
 public:
  /// The type of parameters accepted by the constructor of this filter.
  /// This typedef is used by the FilterFactory.
  typedef BlackListParameters Parameters_;
 
  static const std::string classname() {return "ufo::BlackList";}
 
  BlackList(ioda::ObsSpace &, const Parameters_ &,
            std::shared_ptr<ioda::ObsDataVector<int> >,
            std::shared_ptr<ioda::ObsDataVector<float> >);
  ~BlackList();
 
 private:
  void print(std::ostream &) const override;
  void applyFilter(const std::vector<bool> &, const Variables &,
                   std::vector<std::vector<bool>> &) const override;
  int qcFlag() const override {return QCflags::black;}
 
  Parameters_ parameters_;
};
 
}  // namespace ufo
 
#endif  // UFO_FILTERS_BLACKLIST_H_