UFO
TotalColumnVaporGuess.h
Go to the documentation of this file.
1 /*
2  * (C) Copyright 2021 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_OBSFUNCTIONS_TOTALCOLUMNVAPORGUESS_H_
9 #define UFO_FILTERS_OBSFUNCTIONS_TOTALCOLUMNVAPORGUESS_H_
10 
11 #include <string>
12 #include <vector>
13 
14 #include "oops/util/parameters/Parameter.h"
15 #include "oops/util/parameters/Parameters.h"
16 #include "oops/util/parameters/RequiredParameter.h"
17 
20 #include "ufo/filters/Variables.h"
21 
22 namespace ufo {
23 
24 ///
25 /// \brief Calculate column water vapor mass in guess at observation locations.
26 ///
27 class TotalColumnVaporGuess : public ObsFunctionBase<float> {
28  public:
29  explicit TotalColumnVaporGuess(const eckit::LocalConfiguration &
30  = eckit::LocalConfiguration());
32 
33  void compute(const ObsFilterData &,
35  const ufo::Variables & requiredVariables() const;
36  private:
38 };
39 
40 // -----------------------------------------------------------------------------
41 
42 } // namespace ufo
43 
44 #endif // UFO_FILTERS_OBSFUNCTIONS_TOTALCOLUMNVAPORGUESS_H_
ObsFilterData provides access to all data related to an ObsFilter.
Calculate column water vapor mass in guess at observation locations.
void compute(const ObsFilterData &, ioda::ObsDataVector< float > &) const
compute the result of the function
TotalColumnVaporGuess(const eckit::LocalConfiguration &=eckit::LocalConfiguration())
const ufo::Variables & requiredVariables() const
geovals required to compute the function
Definition: RunCRTM.h:27