InterpolationOption.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAlgorithms/DllConfig.h"
#include <memory>
#include <string>
 
namespace Mantid {
namespace HistogramData {
class Histogram;
}
namespace Kernel {
class Property;
}
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL InterpolationOption {
public:
  // Indices must match the order in static string array
  enum class Value : uint8_t { Linear, CSpline };
 
  void set(const Value &kind, const bool calculateErrors, const bool independentErrors);
  void set(const std::string &kind, const bool calculateErrors, const bool independentErrors);
 
  std::unique_ptr<Kernel::Property> property() const;
  std::string propertyDoc() const;
  std::string validateInputSize(const size_t size) const;
 
  void applyInplace(HistogramData::Histogram &inOut, size_t stepSize) const;
  void applyInPlace(const HistogramData::Histogram &in, HistogramData::Histogram &out) const;
 
private:
  Value m_value = Value::Linear;
  bool m_calculateErrors;
  bool m_independentErrors;
};
 
} // namespace Algorithms
} // namespace Mantid