ObsErrorDiagonal.h

Go to the documentation of this file.

/*
 * (C) Copyright 2021 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_ERRORS_OBSERRORDIAGONAL_H_
#define UFO_ERRORS_OBSERRORDIAGONAL_H_
 
#include <memory>
#include <string>
 
#include "eckit/config/Configuration.h"
 
#include "ioda/ObsVector.h"
 
#include "oops/interface/ObsErrorBase.h"
#include "oops/util/parameters/Parameter.h"
#include "oops/util/parameters/Parameters.h"
 
#include "ufo/ObsTraits.h"
 
namespace eckit {
  class Configuration;
}
 
namespace ioda {
  class ObsSpace;
}
 
namespace ufo {
 
/// \brief Parameters for diagonal obs errors
class ObsErrorDiagonalParameters : public oops::ObsErrorParametersBase {
  OOPS_CONCRETE_PARAMETERS(ObsErrorDiagonalParameters, ObsErrorParametersBase)
 public:
  /// perturbation amplitude multiplier
  oops::Parameter<double> pert{"random amplitude", 1.0, this};
};
 
// -----------------------------------------------------------------------------
/// \brief Diagonal observation error covariance matrix.
class ObsErrorDiagonal : public oops::interface::ObsErrorBase<ObsTraits> {
 public:
  /// The type of parameters passed to the constructor.
  /// This typedef is used by the ObsErrorFactory.
  typedef ObsErrorDiagonalParameters Parameters_;
 
  static const std::string classname() {return "ufo::ObsErrorDiagonal";}
 
  ObsErrorDiagonal(const Parameters_ &, ioda::ObsSpace &,
                   const eckit::mpi::Comm &timeComm);
 
/// Update after obs errors potentially changed
  void update(const ioda::ObsVector &) override;
 
/// Multiply a Departure by \f$R\f$
  void multiply(ioda::ObsVector &) const override;
 
/// Multiply a Departure by \f$R^{-1}\f$
  void inverseMultiply(ioda::ObsVector &) const override;
 
/// Generate random perturbation
  void randomize(ioda::ObsVector &) const override;
 
/// Save obs errors
  void save(const std::string &) const override;
 
/// Get mean error for Jo table
  double getRMSE() const override {return stddev_.rms();}
 
/// Get obs errors std deviation
  std::unique_ptr<ioda::ObsVector> getObsErrors() const override;
 
/// Return inverseVariance
  std::unique_ptr<ioda::ObsVector> getInverseVariance() const override;
 
 private:
  void print(std::ostream &) const override;
  ioda::ObsVector stddev_;
  ioda::ObsVector inverseVariance_;
  Parameters_ options_;
};
 
// -----------------------------------------------------------------------------
 
}  // namespace ufo
 
#endif  // UFO_ERRORS_OBSERRORDIAGONAL_H_