InterpolatingRebin.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAlgorithms/Rebin.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
namespace HistogramData {
class HistogramE;
class Histogram;
class BinEdges;
class Points;
} // namespace HistogramData
namespace Algorithms {
class MANTID_ALGORITHMS_DLL InterpolatingRebin : public Rebin {
public:
  const std::string name() const override { return "InterpolatingRebin"; }
  const std::string summary() const override {
    return "Creates a workspace with different x-value bin boundaries where "
           "the new y-values are estimated using cubic splines.";
  }
 
  // cppcheck-suppress uselessOverride
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Rebin"}; }
  // cppcheck-suppress uselessOverride
  const std::string category() const override { return "Transforms\\Rebin"; }
  const std::string alias() const override { return ""; }
 
protected:
  const std::string workspaceMethodName() const override { return ""; }
  // Overridden Algorithm methods
  void init() override;
  std::map<std::string, std::string> validateInputs() override;
  void exec() override;
 
  void outputYandEValues(const API::MatrixWorkspace_const_sptr &inputW, const HistogramData::BinEdges &XValues_new,
                         const API::MatrixWorkspace_sptr &outputW);
  HistogramData::Histogram cubicInterpolation(const HistogramData::Histogram &oldHistogram,
                                              const HistogramData::BinEdges &xNew) const;
 
  HistogramData::Histogram noInterpolation(const HistogramData::Histogram &oldHistogram,
                                           const HistogramData::BinEdges &xNew) const;
 
  double estimateError(const HistogramData::Points &xsOld, const HistogramData::HistogramE &esOld,
                       const double xNew) const;
};
 
} // namespace Algorithms
} // namespace Mantid