ProfileCheckBackgroundGeopotentialHeight.h

Go to the documentation of this file.

/*
 * (C) Crown copyright 2020, Met Office
 * 
 * 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_PROFILE_PROFILECHECKBACKGROUNDGEOPOTENTIALHEIGHT_H_
#define UFO_PROFILE_PROFILECHECKBACKGROUNDGEOPOTENTIALHEIGHT_H_
 
#include <algorithm>
#include <cmath>
#include <vector>
 
#include "ufo/profile/ProfileCheckBase.h"
#include "ufo/profile/ProfileDataHandler.h"
 
#include "ufo/utils/ProbabilityOfGrossError.h"
 
namespace ioda {
  class ObsSpace;
}
 
namespace ufo {
  class ConventionalProfileProcessingParameters;
}
 
namespace ufo {
 
  /// \brief Profile QC: compare geopotential height data against model background values
  /// using a Bayesian method.
  /// This check can be performed on both reported level data and on data which have been
  /// averaged onto model levels.
  /// QC flags are not set for reported level data so that all levels
  /// (except those with PGE > 0.999) will be used in vertical averaging.
  class ProfileCheckBackgroundGeopotentialHeight : public ProfileCheckBase {
   public:
    explicit ProfileCheckBackgroundGeopotentialHeight
      (const ConventionalProfileProcessingParameters &options);
 
    /// Run check
    void runCheck(ProfileDataHandler &profileDataHandler) override;
 
    /// List of names of required obs diagnostics.
    oops::Variables getObsDiagNames() override {
      return oops::Variables({ufo::VariableNames::bkgerr_geopotential_height});
    }
  };
}  // namespace ufo
 
#endif  // UFO_PROFILE_PROFILECHECKBACKGROUNDGEOPOTENTIALHEIGHT_H_