UFO
SIRetSymmetricMW.h
Go to the documentation of this file.
1 /*
2  * (C) Copyright 2020 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_SIRETSYMMETRICMW_H_
9 #define UFO_FILTERS_OBSFUNCTIONS_SIRETSYMMETRICMW_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 
21 #include "ufo/filters/Variables.h"
22 
23 namespace ufo {
24 
25 ///
26 /// \brief Options applying to the calculation of symmetric cloud amount
27 ///
29 
30 ///
31 /// \brief Calculate symmetric (mean) cloud amount from the cloud amount retrieved
32 /// from the observed and simulated measurements
33 ///
35  public:
36  explicit SIRetSymmetricMW(const eckit::LocalConfiguration &
37  = eckit::LocalConfiguration());
39 
40  void compute(const ObsFilterData &,
42  const ufo::Variables & requiredVariables() const;
43  private:
45  eckit::LocalConfiguration conf_;
46 };
47 
48 // -----------------------------------------------------------------------------
49 
50 } // namespace ufo
51 
52 #endif // UFO_FILTERS_OBSFUNCTIONS_SIRETSYMMETRICMW_H_
ufo::SIRetMWParameters
Options applying to the retrieval of scattering index from 90.0 GHz and.
Definition: SIRetMW.h:28
ObsFunctionBase.h
ufo::SIRetSymmetricMW
Calculate symmetric (mean) cloud amount from the cloud amount retrieved from the observed and simulat...
Definition: SIRetSymmetricMW.h:34
ufo::Variables
Definition: src/ufo/filters/Variables.h:24
ufo::SIRetSymmetricMW::invars_
ufo::Variables invars_
Definition: SIRetSymmetricMW.h:44
ufo::ObsFunctionBase
Base class for computing functions on observation data.
Definition: ObsFunctionBase.h:26
ufo
Definition: RunCRTM.h:27
ufo::SIRetSymmetricMW::~SIRetSymmetricMW
~SIRetSymmetricMW()
Definition: SIRetSymmetricMW.cc:40
Variables.h
SIRetMW.h
ioda::ObsDataVector
Definition: BackgroundCheck.h:26
ObsFilterData.h
ufo::SIRetSymmetricMW::conf_
eckit::LocalConfiguration conf_
Definition: SIRetSymmetricMW.h:45
ufo::SIRetSymmetricMW::SIRetSymmetricMW
SIRetSymmetricMW(const eckit::LocalConfiguration &=eckit::LocalConfiguration())
Definition: SIRetSymmetricMW.cc:30
ufo::SIRetSymmetricMW::compute
void compute(const ObsFilterData &, ioda::ObsDataVector< float > &) const
compute the result of the function
Definition: SIRetSymmetricMW.cc:44
ufo::ObsFilterData
ObsFilterData provides access to all data related to an ObsFilter.
Definition: src/ufo/filters/ObsFilterData.h:40
ufo::SIRetSymmetricMW::requiredVariables
const ufo::Variables & requiredVariables() const
geovals required to compute the function
Definition: SIRetSymmetricMW.cc:65
ufo::SIRetSymmetricMWParameters
SIRetMWParameters SIRetSymmetricMWParameters
Options applying to the calculation of symmetric cloud amount.
Definition: SIRetSymmetricMW.h:28