LocalObsSpaceParameters.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 CORE_LOCALOBSSPACEPARAMETERS_H_
#define CORE_LOCALOBSSPACEPARAMETERS_H_
 
#include <string>
#include <utility>
 
#include "eckit/exception/Exceptions.h"
#include "eckit/geometry/KPoint.h"
#include "eckit/geometry/Point2.h"
#include "eckit/geometry/UnitSphere.h"
 
#include "oops/util/parameters/OptionalParameter.h"
#include "oops/util/parameters/Parameter.h"
#include "oops/util/parameters/Parameters.h"
#include "oops/util/parameters/RequiredParameter.h"
 
namespace eckit {
  class Configuration;
}
 
namespace ioda {
 
enum class DistanceType {
  GEODESIC, CARTESIAN
};
 
enum class SearchMethod {
  BRUTEFORCE, KDTREE
};
 
struct DistanceTypeParameterTraitsHelper {
  typedef DistanceType EnumType;
  static constexpr char enumTypeName[] = "DistanceType";
  static constexpr util::NamedEnumerator<DistanceType> namedValues[] = {
    { DistanceType::GEODESIC, "geodesic" },
    { DistanceType::CARTESIAN, "cartesian" }
  };
};
 
struct SearchMethodParameterTraitsHelper {
  typedef SearchMethod EnumType;
  static constexpr char enumTypeName[] = "SearchMethod";
  static constexpr util::NamedEnumerator<SearchMethod> namedValues[] = {
    { SearchMethod::BRUTEFORCE, "brute_force" },
    { SearchMethod::KDTREE, "kd_tree" }
  };
};
 
}  // namespace ioda
 
namespace oops {
 
/// Extraction of DistanceType parameters from config
template <>
struct ParameterTraits<ioda::DistanceType> :
    public EnumParameterTraits<ioda::DistanceTypeParameterTraitsHelper>
{};
 
 
/// Extraction of SearchMethod parameters from config
template <>
struct ParameterTraits<ioda::SearchMethod> :
    public EnumParameterTraits<ioda::SearchMethodParameterTraitsHelper>
{};
 
}  // namespace oops
 
namespace ioda {
 
/// \brief Options controlling local observations subsetting
class LocalObsSpaceParameters : public oops::Parameters {
  OOPS_CONCRETE_PARAMETERS(LocalObsSpaceParameters, Parameters)
 
 public:
  /// Localization lengthscale (find all obs within the distance from reference point)
  oops::RequiredParameter<double> lengthscale{"lengthscale", this};
 
  /// Method for searching for nearest points: brute force or KD-tree
  oops::Parameter<SearchMethod> searchMethod{"search method", SearchMethod::BRUTEFORCE, this};
 
  /// Maximum number of obs
  oops::OptionalParameter<int> maxnobs{"max nobs", this};
 
  /// Distance calculation type: geodesic (on sphere) or cartesian (euclidian)
  /// Default: geodesic
  oops::Parameter<DistanceType> distanceType{"distance type", DistanceType::GEODESIC, this};
 
  /// returns distance between points \p p1 and \p p2, depending on the
  /// distance calculation type distanceType
  double distance(const eckit::geometry::Point2 & p1, const eckit::geometry::Point2 & p2) {
    if (distanceType == DistanceType::GEODESIC) {
      return eckit::geometry::Sphere::distance(radius_earth, p1, p2);
    } else {
      ASSERT(distanceType == DistanceType::CARTESIAN);
      return p1.distance(p2);
    }
  }
 
  // Earth radius in m
  static constexpr double radius_earth = 6.371e6;
};
 
}  // namespace ioda
 
#endif  // CORE_LOCALOBSSPACEPARAMETERS_H_