TrackCheckUtilsParameters.h

Go to the documentation of this file.

/*
 * (C) Copyright 2019 Met Office UK
 *
 * 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_FILTERS_TRACKCHECKUTILSPARAMETERS_H_
#define UFO_FILTERS_TRACKCHECKUTILSPARAMETERS_H_
 
#include "oops/util/parameters/OptionalParameter.h"
#include "oops/util/parameters/Parameters.h"
#include "ufo/utils/parameters/ParameterTraitsVariable.h"
 
namespace eckit {
class Configuration;
}
 
namespace ufo {
 
/// \brief Options controlling the operation of the track check filter.
class TrackCheckUtilsParameters : public oops::Parameters {
  // TODO(wsmigaj/aweinbren): Refactor TrackCheckUtils::groupObservationsByStation to avoid creating
  // a TrackCheckUtilsParameters object and then replace OOPS_CONCRETE_PARAMETERS with
  // OOPS_ABSTRACT_PARAMETERS.
  OOPS_CONCRETE_PARAMETERS(TrackCheckUtilsParameters, Parameters)
 
 public:
  /// Variable storing integer-valued or string-valued station IDs.
  /// Observations taken by each station are checked separately.
  ///
  /// If not set and observations were grouped into records when the observation space was
  /// constructed, each record is assumed to consist of observations taken by a separate
  /// station. If not set and observations were not grouped into records, all observations are
  /// assumed to have been taken by a single station.
  ///
  /// Note: the variable used to group observations into records can be set with the
  /// \c obs space.obsdatain.obsgrouping.group_variable YAML option.
  oops::OptionalParameter<Variable> stationIdVariable{
    "station_id_variable", this};
};
 
}  // namespace ufo
 
#endif  // UFO_FILTERS_TRACKCHECKUTILSPARAMETERS_H_