PerformIndexOperations.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/PerformIndexOperations.h"
#include "MantidAPI/AlgorithmManager.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidKernel/Strings.h"
#include <boost/algorithm/string.hpp>
#include <boost/regex.hpp>
#include <utility>
 
using namespace Mantid::Kernel;
using namespace Mantid::API;
 
namespace {
class Command {
public:
  virtual bool isValid() const { return true; }
 
  virtual MatrixWorkspace_sptr execute(MatrixWorkspace_sptr input) const = 0;
 
  virtual MatrixWorkspace_sptr executeAndAppend(MatrixWorkspace_sptr inputWS, MatrixWorkspace_sptr toAppend) const {
    if (!this->isValid()) {
      return toAppend;
    } else {
      MatrixWorkspace_sptr current = this->execute(std::move(inputWS));
      Mantid::API::AlgorithmManagerImpl &factory = Mantid::API::AlgorithmManager::Instance();
      auto conjoinWorkspaceAlg = factory.create("ConjoinWorkspaces");
      conjoinWorkspaceAlg->setChild(true);
      conjoinWorkspaceAlg->initialize();
      conjoinWorkspaceAlg->setProperty("InputWorkspace1", toAppend);
      conjoinWorkspaceAlg->setProperty("InputWorkspace2", current);
      conjoinWorkspaceAlg->setProperty("CheckMatchingBins", false);
      conjoinWorkspaceAlg->execute();
      MatrixWorkspace_sptr outWS = conjoinWorkspaceAlg->getProperty("InputWorkspace1");
      return outWS;
    }
  }
 
  virtual ~Command() = default;
};
 
using VecCommands = std::vector<std::shared_ptr<Command>>;
 
class NullCommand : public Command {
  bool isValid() const override { return false; }
  MatrixWorkspace_sptr execute(MatrixWorkspace_sptr /*input*/) const override {
    throw std::runtime_error("Should not be attempting ::execute on a NullCommand");
  }
};
 
class AdditionCommand : public Command {
private:
  std::vector<int> m_indexes;
 
public:
  explicit AdditionCommand(std::vector<int> indexes) : m_indexes(std::move(indexes)) {}
 
  MatrixWorkspace_sptr execute(MatrixWorkspace_sptr inputWS) const override {
    MatrixWorkspace_sptr outWS;
    if (!m_indexes.empty()) {
      Mantid::API::AlgorithmManagerImpl &factory = Mantid::API::AlgorithmManager::Instance();
      auto sumSpectraAlg = factory.create("SumSpectra");
      sumSpectraAlg->setChild(true);
      sumSpectraAlg->initialize();
      sumSpectraAlg->setProperty("InputWorkspace", inputWS);
      sumSpectraAlg->setProperty("ListOfWorkspaceIndices", m_indexes);
      sumSpectraAlg->setPropertyValue("OutputWorkspace", "outWS");
      sumSpectraAlg->execute();
      outWS = sumSpectraAlg->getProperty("OutputWorkspace");
    }
    return outWS;
  }
};
 
class CropCommand : public Command {
private:
  std::vector<int> m_indexes;
 
public:
  explicit CropCommand(std::vector<int> indexes) : m_indexes(std::move(indexes)) {}
 
  MatrixWorkspace_sptr execute(MatrixWorkspace_sptr inputWS) const override {
 
    MatrixWorkspace_sptr outWS;
    for (size_t i = 0; i < m_indexes.size(); ++i) {
      Mantid::API::AlgorithmManagerImpl &factory = Mantid::API::AlgorithmManager::Instance();
      auto cropWorkspaceAlg = factory.create("CropWorkspace");
      cropWorkspaceAlg->setChild(true);
      cropWorkspaceAlg->initialize();
      cropWorkspaceAlg->setProperty("InputWorkspace", inputWS);
      cropWorkspaceAlg->setProperty("StartWorkspaceIndex", m_indexes[i]);
      cropWorkspaceAlg->setProperty("EndWorkspaceIndex", m_indexes[i]);
      cropWorkspaceAlg->setPropertyValue("OutputWorkspace", "outWS");
      cropWorkspaceAlg->execute();
      MatrixWorkspace_sptr subRange = cropWorkspaceAlg->getProperty("OutputWorkspace");
      if (i == 0) {
        outWS = subRange;
      } else {
        auto conjoinWorkspaceAlg = factory.create("ConjoinWorkspaces");
        conjoinWorkspaceAlg->setChild(true);
        conjoinWorkspaceAlg->initialize();
        conjoinWorkspaceAlg->setProperty("InputWorkspace1", outWS);
        conjoinWorkspaceAlg->setProperty("InputWorkspace2", subRange);
        conjoinWorkspaceAlg->setProperty("CheckMatchingBins", false);
        conjoinWorkspaceAlg->execute();
        outWS = conjoinWorkspaceAlg->getProperty("InputWorkspace1");
      }
    }
    return outWS;
  }
};
 
class CommandParser {
public:
  virtual Command *interpret(const std::string &instruction) const = 0;
 
  virtual ~CommandParser() = default;
};
 
using VecCommandParsers = std::vector<std::shared_ptr<CommandParser>>;
 
template <typename ProductType> class CommandParserBase : public CommandParser {
public:
  Command *interpret(const std::string &instruction) const override {
    Command *command = nullptr;
    boost::regex ex = getRegex();
    if (boost::regex_match(instruction, ex)) {
      auto indexes = Mantid::Kernel::Strings::parseRange(instruction, ",", getSeparator());
      command = new ProductType(indexes);
    } else {
      command = new NullCommand;
    }
    return command;
  }
 
private:
  virtual std::string getSeparator() const = 0;
  virtual boost::regex getRegex() const = 0;
};
 
class AdditionParserRange : public CommandParserBase<AdditionCommand> {
public:
private:
  boost::regex getRegex() const override {
    static const boost::regex r(R"(^\s*[0-9]+\s*\-\s*[0-9]+\s*$)");
    return r;
  }
  std::string getSeparator() const override { return "-"; }
};
 
class AdditionParser : public CommandParser {
public:
  Command *interpret(const std::string &instruction) const override {
    Command *command = nullptr;
    static const boost::regex ex(R"(^\s*[0-9]+\s*\+\s*[0-9]+\s*$)");
    if (boost::regex_match(instruction, ex)) {
      std::vector<std::string> arguments;
      boost::split(arguments, instruction, boost::is_any_of("+"));
      int minIndex = -1;
      int maxIndex = -1;
      Mantid::Kernel::Strings::convert<int>(arguments.front(), minIndex);
      Mantid::Kernel::Strings::convert<int>(arguments.back(), maxIndex);
      std::vector<int> indexes;
      indexes.emplace_back(minIndex);
      indexes.emplace_back(maxIndex);
      command = new AdditionCommand(indexes);
    } else {
      command = new NullCommand;
    }
    return command;
  }
};
 
class CropParserRange : public CommandParserBase<CropCommand> {
public:
private:
  boost::regex getRegex() const override {
    static const boost::regex r(R"(^\s*[0-9]+\s*:\s*[0-9]+\s*$)");
    return r;
  }
  std::string getSeparator() const override { return ":"; }
};
 
class CropParserIndex : public CommandParser {
public:
  Command *interpret(const std::string &instruction) const override {
    Command *command = nullptr;
    static const boost::regex ex("^\\s*[0-9]+\\s*$");
    if (boost::regex_match(instruction, ex)) {
      int index = -1;
      Mantid::Kernel::Strings::convert<int>(instruction, index);
      std::vector<int> indexes(1, index);
      command = new CropCommand(indexes);
    } else {
      command = new NullCommand;
    }
    return command;
  }
};
} // namespace
 
namespace Mantid::Algorithms {
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(PerformIndexOperations)
 
//------------------------------------------------------------------------------
const std::string PerformIndexOperations::name() const { return "PerformIndexOperations"; }
 
int PerformIndexOperations::version() const { return 1; }
 
const std::string PerformIndexOperations::category() const { return "Transforms\\Grouping"; }
 
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
void PerformIndexOperations::init() {
  declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>("InputWorkspace", "", Direction::Input),
                  "Input to processes workspace.");
  declareProperty(std::make_unique<PropertyWithValue<std::string>>("ProcessingInstructions", "", Direction::Input),
                  "Processing instructions. See full instruction list.");
  declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>("OutputWorkspace", "", Direction::Output),
                  "Output processed workspace");
}
 
VecCommands interpret(const std::string &processingInstructions) {
  std::vector<std::string> processingInstructionsSplit;
  boost::split(processingInstructionsSplit, processingInstructions, boost::is_any_of(","));
 
  VecCommandParsers commandParsers{std::make_shared<AdditionParserRange>(), std::make_shared<CropParserRange>(),
                                   std::make_shared<CropParserIndex>(), std::make_shared<AdditionParser>()};
 
  VecCommands commands;
  for (const auto &candidate : processingInstructionsSplit) {
    bool parserFound = false;
    for (const auto &commandParser : commandParsers) {
      Command *command = commandParser->interpret(candidate);
      std::shared_ptr<Command> commandSptr(command);
      if (commandSptr->isValid()) // Do not record invalid commands.
      {
        parserFound = true;
        commands.emplace_back(commandSptr);
      }
    }
    if (!parserFound) {
      throw std::invalid_argument("Cannot interpret " + candidate);
    }
  }
  return commands;
}
 
//------------------------------------------------------------------------------
void PerformIndexOperations::exec() {
  MatrixWorkspace_sptr inputWorkspace = this->getProperty("InputWorkspace");
  const std::string processingInstructions = this->getProperty("ProcessingInstructions");
 
  boost::regex re(R"(^\s*[0-9]+\s*$|^(\s*,*[0-9]+(\s*(,|:|\+|\-)\s*)*[0-9]*)*$)");
  if (!boost::regex_match(processingInstructions, re)) {
    throw std::invalid_argument("ProcessingInstructions are not well formed: " + processingInstructions);
  }
 
  if (processingInstructions.empty()) {
    auto cloneWS = this->createChildAlgorithm("CloneWorkspace");
    cloneWS->initialize();
    cloneWS->setProperty("InputWorkspace", inputWorkspace);
    cloneWS->execute();
    Workspace_sptr tmp = cloneWS->getProperty("OutputWorkspace");
    MatrixWorkspace_sptr outWS = std::dynamic_pointer_cast<MatrixWorkspace>(tmp);
    this->setProperty("OutputWorkspace", outWS);
  } else {
    // Interpret the instructions.
    VecCommands commands = interpret(processingInstructions);
 
    // Execute the commands.
    auto command = commands[0];
    MatrixWorkspace_sptr outWS = command->execute(inputWorkspace);
    for (size_t j = 1; j < commands.size(); ++j) {
      outWS = commands[j]->executeAndAppend(inputWorkspace, outWS);
    }
 
    this->setProperty("OutputWorkspace", outWS);
  }
}
 
} // namespace Mantid::Algorithms