RemoveBins.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"
#include "MantidKernel/Unit.h"
 
namespace Mantid {
namespace HistogramData {
class HistogramX;
class HistogramY;
class HistogramE;
} // namespace HistogramData
namespace API {
class SpectrumInfo;
}
namespace Algorithms {
class MANTID_ALGORITHMS_DLL RemoveBins final : public API::Algorithm {
public:
  RemoveBins();
  const std::string name() const override { return "RemoveBins"; }
  const std::string summary() const override { return "Used to remove data from a range of bins in a workspace."; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"CropWorkspace"}; }
  const std::string category() const override { return "Transforms\\Splitting"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  std::map<std::string, std::string> validateInputs() override;
  void exec() override;
 
  void crop(const double &start, const double &end);
  void transformRangeUnit(const int index, double &startX, double &endX);
  int findIndex(const double &value, const HistogramData::HistogramX &vec);
  void RemoveFromEnds(int start, int end, HistogramData::HistogramY &Y, HistogramData::HistogramE &E);
  void RemoveFromMiddle(const int &start, const int &end, const double &startFrac, const double &endFrac,
                        HistogramData::HistogramY &Y, HistogramData::HistogramE &E);
 
  API::MatrixWorkspace_const_sptr m_inputWorkspace; 
  const API::SpectrumInfo *m_spectrumInfo;
  double m_startX;               
  double m_endX;                 
  Kernel::Unit_sptr m_rangeUnit; 
  bool m_interpolate;            
};
 
} // namespace Algorithms
} // namespace Mantid