Rebin2D.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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"
#include "MantidDataObjects/RebinnedOutput.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL Rebin2D : public API::Algorithm {
public:
  virtual ~Rebin2D() = default;
 
  const std::string name() const override { return "Rebin2D"; }
  const std::string summary() const override { return "Rebins both axes of a 2D workspace using the given parameters"; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Rebin", "SofQW"}; }
  const std::string category() const override { return "Transforms\\Rebin"; }
 
protected:
  std::unique_ptr<API::Progress> m_progress;
 
private:
  void init() override;
  void exec() override;
  API::MatrixWorkspace_sptr createOutputWorkspace(const API::MatrixWorkspace_const_sptr &parent,
                                                  HistogramData::BinEdges &newXBins, HistogramData::BinEdges &newYBins,
                                                  const bool useFractionalArea) const;
};
 
} // namespace Algorithms
} // namespace Mantid