UFO
ObsDiagnosticsWriter.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_OBSDIAGNOSTICSWRITER_H_
9 #define UFO_FILTERS_OBSDIAGNOSTICSWRITER_H_
10 
11 #include <memory>
12 #include <ostream>
13 #include <string>
14 
15 #include "ioda/ObsDataVector.h"
16 #include "oops/base/Variables.h"
17 #include "oops/util/Printable.h"
18 #include "ufo/filters/Variables.h"
19 #include "ufo/ObsDiagnostics.h"
20 
21 namespace eckit {
22  class Configuration;
23  class LocalConfiguration;
24 }
25 
26 namespace ioda {
27  template <typename DATATYPE> class ObsDataVector;
28  class ObsSpace;
29  class ObsVector;
30 }
31 
32 namespace ufo {
33 class GeoVaLs;
34 
35 class ObsDiagnosticsWriter : public util::Printable,
36  private util::ObjectCounter<ObsDiagnosticsWriter> {
37  public:
38  static const std::string classname() {return "ufo::ObsDiagnosticsWriter";}
39 
40  ObsDiagnosticsWriter(ioda::ObsSpace &, const eckit::Configuration &,
41  std::shared_ptr<ioda::ObsDataVector<int> >,
42  std::shared_ptr<ioda::ObsDataVector<float> >);
44 
45  void preProcess() const {}
46  void priorFilter(const GeoVaLs &) const {}
47  void postFilter(const ioda::ObsVector &, const ObsDiagnostics & diags) {
48  diags.write(config_);
49  }
50 
51  const oops::Variables & requiredVars() const {return nogeovals_;}
52  const oops::Variables & requiredHdiagnostics() const {return extradiagvars_;}
53 
54  private:
55  void print(std::ostream &) const;
56  const eckit::LocalConfiguration config_;
57  const oops::Variables nogeovals_;
58  oops::Variables extradiagvars_;
59 };
60 
61 } // namespace ufo
62 
63 #endif // UFO_FILTERS_OBSDIAGNOSTICSWRITER_H_
ufo::ObsDiagnosticsWriter::classname
static const std::string classname()
Definition: ObsDiagnosticsWriter.h:38
ufo::ObsDiagnosticsWriter::print
void print(std::ostream &) const
Definition: ObsDiagnosticsWriter.cc:38
ufo::ObsDiagnosticsWriter::requiredVars
const oops::Variables & requiredVars() const
Definition: ObsDiagnosticsWriter.h:51
ufo::ObsDiagnosticsWriter
Definition: ObsDiagnosticsWriter.h:36
ufo::ObsDiagnosticsWriter::preProcess
void preProcess() const
Definition: ObsDiagnosticsWriter.h:45
ioda
Definition: ObsAtmSfcInterp.h:24
ufo
Definition: RunCRTM.h:27
Variables.h
eckit
Forward declarations.
Definition: ObsAtmSfcInterp.h:20
ufo::ObsDiagnostics
Definition: src/ufo/ObsDiagnostics.h:35
ufo::ObsDiagnosticsWriter::priorFilter
void priorFilter(const GeoVaLs &) const
Definition: ObsDiagnosticsWriter.h:46
ufo::ObsDiagnosticsWriter::ObsDiagnosticsWriter
ObsDiagnosticsWriter(ioda::ObsSpace &, const eckit::Configuration &, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
Definition: ObsDiagnosticsWriter.cc:23
ufo::ObsDiagnostics::write
void write(const eckit::Configuration &config) const
Definition: src/ufo/ObsDiagnostics.h:54
ufo::ObsDiagnosticsWriter::config_
const eckit::LocalConfiguration config_
Definition: ObsDiagnosticsWriter.h:56
ufo::GeoVaLs
GeoVaLs: geophysical values at locations.
Definition: src/ufo/GeoVaLs.h:39
ioda::ObsDataVector< int >
ufo::ObsDiagnosticsWriter::requiredHdiagnostics
const oops::Variables & requiredHdiagnostics() const
Definition: ObsDiagnosticsWriter.h:52
ufo::ObsDiagnosticsWriter::postFilter
void postFilter(const ioda::ObsVector &, const ObsDiagnostics &diags)
Definition: ObsDiagnosticsWriter.h:47
ufo::ObsDiagnosticsWriter::extradiagvars_
oops::Variables extradiagvars_
Definition: ObsDiagnosticsWriter.h:58
ufo::ObsDiagnosticsWriter::~ObsDiagnosticsWriter
~ObsDiagnosticsWriter()
Definition: ObsDiagnosticsWriter.h:43
ufo::ObsDiagnosticsWriter::nogeovals_
const oops::Variables nogeovals_
Definition: ObsDiagnosticsWriter.h:57