ExtractSingleSpectrum.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 +
#include "MantidAlgorithms/ExtractSingleSpectrum.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/TextAxis.h"
#include "MantidKernel/BoundedValidator.h"
 
namespace Mantid::Algorithms {
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(ExtractSingleSpectrum)
 
using namespace Kernel;
using namespace API;
 
void ExtractSingleSpectrum::init() {
  declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "", Direction::Input),
                  "The name of the input workspace.");
  declareProperty(std::make_unique<WorkspaceProperty<>>("OutputWorkspace", "", Direction::Output),
                  "The name under which to store the output workspace.");
 
  auto mustBePositive = std::make_shared<BoundedValidator<int>>();
  mustBePositive->setLower(0);
  declareProperty("WorkspaceIndex", -1, mustBePositive, "The workspace index number of the spectrum to extract.");
}
 
void ExtractSingleSpectrum::exec() {
  // Get hold of the input workspace
  MatrixWorkspace_sptr inputWorkspace = getProperty("InputWorkspace");
  const int indexToExtract = getProperty("WorkspaceIndex");
  const size_t numHist = inputWorkspace->getNumberHistograms();
  if (static_cast<size_t>(indexToExtract) >= numHist) {
    throw Exception::IndexError(indexToExtract, inputWorkspace->getNumberHistograms(), this->name());
  }
 
  // Let crop do the rest
  auto cropper = this->createChildAlgorithm("CropWorkspace", 0.0, 1.0);
  cropper->setProperty("InputWorkspace", inputWorkspace);
  cropper->setProperty("StartWorkspaceIndex", indexToExtract);
  cropper->setProperty("EndWorkspaceIndex", indexToExtract);
  cropper->executeAsChildAlg();
 
  setProperty<MatrixWorkspace_sptr>("OutputWorkspace", cropper->getProperty("OutputWorkspace"));
}
 
} // namespace Mantid::Algorithms