Rebin.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
 
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
 
namespace Algorithms {
class MANTID_ALGORITHMS_DLL Rebin : public API::Algorithm {
public:
  const std::string name() const override { return "Rebin"; }
  const std::string summary() const override {
    return "Rebins data with new X bin boundaries. For EventWorkspaces, you "
           "can very quickly rebin in-place by keeping the same output name "
           "and PreserveEvents=true.";
  }
 
  int version() const override { return 1; }
  const std::string category() const override { return "Transforms\\Rebin"; }
  const std::string alias() const override { return "rebin"; }
  const std::vector<std::string> seeAlso() const override {
    return {"RebinToWorkspace", "Rebin2D", "Rebunch", "Regroup", "RebinByPulseTimes", "RebinByTimeAtSample"};
  }
  std::map<std::string, std::string> validateInputs() override;
 
  static std::vector<double> rebinParamsFromInput(const std::vector<double> &inParams,
                                                  const API::MatrixWorkspace &inputWS, Kernel::Logger &logger,
                                                  const std::string &binModeName = "Default");
 
protected:
  const std::string workspaceMethodName() const override { return "rebin"; }
  const std::string workspaceMethodOnTypes() const override { return "MatrixWorkspace"; }
  const std::string workspaceMethodInputProperty() const override { return "InputWorkspace"; }
 
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
 
  void propagateMasks(const API::MatrixWorkspace_const_sptr &inputWS, const API::MatrixWorkspace_sptr &outputWS,
                      const int hist, const bool IgnoreBinErrors = false);
};
 
} // namespace Algorithms
} // namespace Mantid