ExtractSpectra.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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 "MantidDataObjects/EventWorkspace.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL ExtractSpectra : public API::Algorithm {
public:
  const std::string name() const override;
  int version() const override;
  const std::vector<std::string> seeAlso() const override {
    return {"CropWorkspace", "ExtractSingleSpectrum", "ExtractUnmaskedSpectra", "PerformIndexOperations"};
  }
  const std::string category() const override;
  const std::string summary() const override;
  std::map<std::string, std::string> validateInputs() override;
 
private:
  void init() override;
  void exec() override;
  void execHistogram();
  void execEvent();
 
  void propagateBinMasking(API::MatrixWorkspace &workspace, const int i) const;
  void checkProperties();
  std::size_t getXMinIndex(const size_t wsIndex = 0);
  std::size_t getXMaxIndex(const size_t wsIndex = 0);
  std::size_t histXMaxIndex() const;
  const Kernel::cow_ptr<Mantid::HistogramData::HistogramX> getCroppedXHistogram(const API::MatrixWorkspace &workspace);
  void cropCommon(API::MatrixWorkspace &workspace, Kernel::cow_ptr<Mantid::HistogramData::HistogramX> XHistogram,
                  int index);
  void cropRagged(API::MatrixWorkspace &workspace, int index);
 
  API::MatrixWorkspace_sptr m_inputWorkspace;
  DataObjects::EventWorkspace_sptr eventW;
  std::size_t m_minXIndex = 0;
  std::size_t m_maxXIndex = 0;
  bool m_commonBoundaries = false;
  bool m_isHistogramData = false;
  bool m_croppingInX = false;
  std::vector<size_t> m_workspaceIndexList;
};
 
} // namespace Algorithms
} // namespace Mantid