MaskBins.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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/DistributedAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventList.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidIndexing/SpectrumIndexSet.h"
 
namespace Mantid {
 
namespace Histogram {
class BinEdges;
}
namespace Algorithms {
class MANTID_ALGORITHMS_DLL MaskBins : public API::DistributedAlgorithm {
public:
  const std::string name() const override { return "MaskBins"; }
  const std::string summary() const override { return "Marks bins in a workspace as being masked."; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override {
    return {"MaskBinsIf", "MaskBinsFromTable", "MaskNonOverlappingBins"};
  }
  const std::string category() const override { return "Transforms\\Masking"; }
 
private:
  void init() override;
  void exec() override;
  void execEvent();
 
  void findIndices(const HistogramData::BinEdges &X, MantidVec::difference_type &startBin,
                   MantidVec::difference_type &endBin);
 
  double m_startX{0.0};                
  double m_endX{0.0};                  
  Indexing::SpectrumIndexSet indexSet; 
};
 
} // namespace Algorithms
} // namespace Mantid