ObsBiasCovarianceDetails.h

Go to the documentation of this file.

/*
 * (C) Copyright 2020 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 TEST_UFO_OBSBIASCOVARIANCEDETAILS_H_
#define TEST_UFO_OBSBIASCOVARIANCEDETAILS_H_
 
#include <string>
#include <vector>
 
#define ECKIT_TESTING_SELF_REGISTER_CASES 0
 
#include "eckit/config/LocalConfiguration.h"
#include "eckit/testing/Test.h"
#include "ioda/ObsSpace.h"
#include "oops/mpi/mpi.h"
#include "oops/runs/Test.h"
#include "oops/util/DateTime.h"
#include "oops/util/Duration.h"
#include "oops/util/Logger.h"
#include "test/TestEnvironment.h"
#include "ufo/ObsBias.h"
#include "ufo/ObsBiasCovariance.h"
#include "ufo/ObsBiasIncrement.h"
 
namespace ufo {
namespace test {
// -----------------------------------------------------------------------------
 
void testObsBiasCovarianceDetails() {
  eckit::LocalConfiguration conf(::test::TestEnvironment::config());
 
  //  Setup ObsSpace
  util::DateTime bgn(conf.getString("window begin"));
  util::DateTime end(conf.getString("window end"));
  std::vector<eckit::LocalConfiguration> obsconfs
    = conf.getSubConfigurations("observations");
 
  for (auto & oconf : obsconfs) {
    ioda::ObsTopLevelParameters obsparams;
    obsparams.validateAndDeserialize(oconf.getSubConfiguration("obs space"));
    ioda::ObsSpace odb(obsparams, oops::mpi::world(), bgn, end, oops::mpi::myself());
 
    // Setup ObsBias
    eckit::LocalConfiguration biasconf = oconf.getSubConfiguration("obs bias");
    ObsBiasParameters biasparams;
    biasparams.validateAndDeserialize(biasconf);
    ObsBias ybias(odb, biasparams);
 
    // Setup ObsBiasIncrements
    eckit::LocalConfiguration biaserrconf = biasconf.getSubConfiguration("covariance");
    ObsBiasIncrement ybias_inc(odb, biasparams);
    ObsBiasIncrement ybias_inc_2(ybias_inc);
    ObsBiasIncrement ybias_inc_3(ybias_inc);
    ybias_inc_2.zero();
    ybias_inc_3.zero();
 
    // Setup ObsBiasCovariance (include reading from file)
    ObsBiasCovariance ybias_cov(odb, biasparams);
 
    // Randomize increments
    ybias_cov.randomize(ybias_inc);
 
    // linearize for first outer loop
    biaserrconf.set("iteration", 0);
    ybias_cov.linearize(ybias, biaserrconf);
 
    // linearize for second outer loop
    biaserrconf.set("iteration", 1);
    EXPECT_THROWS(ybias_cov.linearize(ybias, biaserrconf));
 
    // mimic QC flags from first outer loop
    const std::vector<int> qc_flags(odb.nlocs(), 50);
    const std::vector<std::string> vars = odb.obsvariables().variables();
    for ( const auto & var : vars)
     odb.put_db("EffectiveQC0", var , qc_flags);
 
    // mimic effective errors
    const std::vector<float> errs(odb.nlocs(), 1.0);
    for ( const auto & var : vars)
     odb.put_db("EffectiveError0", var , errs);
 
    // mimic predictors
    ioda::ObsVector predx(odb);
    for (std::size_t jj = 0; jj < predx.size(); ++jj)
      predx[jj] = 1.0;
    for (const auto & pred : ybias_cov.predictorNames()) {
      predx.save(pred + "Predictor");
    }
 
    // Randomize increments again
    ybias_cov.randomize(ybias_inc);
 
    // linearize for second outer loop
    ybias_cov.linearize(ybias, biaserrconf);
 
    // delta_bias * B
    ybias_cov.multiply(ybias_inc, ybias_inc_2);
 
    EXPECT(ybias_inc.norm() != ybias_inc_2.norm());
    oops::Log::test() << "ufo::testObsBiasCovarianceDetails multiply is verified" << std::endl;
 
    // delta_bias / B
    ybias_cov.inverseMultiply(ybias_inc_2, ybias_inc_3);
 
    // Verifing the reading is right
    const double tolerance = oconf.getDouble("tolerance");
    EXPECT(ybias_inc.norm() - ybias_inc_3.norm() < tolerance);
    oops::Log::test() << "ufo::testObsBiasCovarianceDetails inverseMultiply is verified"
                      << std::endl;
  }
}
 
// -----------------------------------------------------------------------------
 
class ObsBiasCovarianceDetails : public oops::Test {
 public:
  ObsBiasCovarianceDetails() {}
  virtual ~ObsBiasCovarianceDetails() {}
 private:
  std::string testid() const override {return "ufo::test::ObsBiasCovarianceDetails";}
 
  void register_tests() const override {
    std::vector<eckit::testing::Test>& ts = eckit::testing::specification();
 
    ts.emplace_back(CASE("ufo/ObsBias/testObsBiasCovarianceDetails")
      { testObsBiasCovarianceDetails(); });
  }
 
  void clear() const override {}
};
 
// -----------------------------------------------------------------------------
 
}  // namespace test
}  // namespace ufo
 
#endif  // TEST_UFO_OBSBIASCOVARIANCEDETAILS_H_