Rebunch.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace HistogramData {
class HistogramX;
class HistogramY;
class HistogramE;
} // namespace HistogramData
namespace Algorithms {
class MANTID_ALGORITHMS_DLL Rebunch final : public API::Algorithm {
public:
  const std::string name() const override { return "Rebunch"; }
  const std::string summary() const override { return "Rebins data by adding together 'n_bunch' successive bins."; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Rebin"}; }
  const std::string category() const override { return "Transforms\\Rebin"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
  void rebunch_hist_counts(const HistogramData::HistogramX &xold, const HistogramData::HistogramY &yold,
                           const HistogramData::HistogramE &eold, HistogramData::HistogramX &xnew,
                           HistogramData::HistogramY &ynew, HistogramData::HistogramE &enew, const size_t n_bunch);
  void rebunch_hist_frequencies(const HistogramData::HistogramX &xold, const HistogramData::HistogramY &yold,
                                const HistogramData::HistogramE &eold, HistogramData::HistogramX &xnew,
                                HistogramData::HistogramY &ynew, HistogramData::HistogramE &enew, const size_t n_bunch);
  void rebunch_point(const HistogramData::HistogramX &xold, const HistogramData::HistogramY &yold,
                     const HistogramData::HistogramE &eold, HistogramData::HistogramX &xnew,
                     HistogramData::HistogramY &ynew, HistogramData::HistogramE &enew, const size_t n_bunch);
};
 
} // namespace Algorithms
} // namespace Mantid