ExtractQENSMembers.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/DataProcessorAlgorithm.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/WorkspaceGroup.h"
 
namespace Mantid {
namespace Algorithms {
 
class DLLExport ExtractQENSMembers : public API::DataProcessorAlgorithm {
public:
  const std::string name() const override;
  int version() const override;
  const std::string category() const override;
  const std::string summary() const override;
 
private:
  void init() override;
  void exec() override;
  std::map<std::string, std::string> validateInputs() override;
 
  std::vector<Mantid::API::MatrixWorkspace_sptr> getInputWorkspaces() const;
 
  std::vector<double> getQValues(const std::vector<Mantid::API::MatrixWorkspace_sptr> &workspaces);
 
  std::vector<std::string> getAxisLabels(const Mantid::API::MatrixWorkspace_sptr &workspace, size_t axisIndex) const;
 
  std::vector<std::string> renameConvolvedMembers(const std::vector<std::string> &members,
                                                  const std::vector<std::string> &newNames) const;
 
  Mantid::API::MatrixWorkspace_sptr extractSpectrum(const Mantid::API::MatrixWorkspace_sptr &inputWS, size_t spectrum);
 
  Mantid::API::MatrixWorkspace_sptr appendSpectra(const Mantid::API::MatrixWorkspace_sptr &inputWS,
                                                  const Mantid::API::MatrixWorkspace_sptr &spectraWorkspace);
 
  Mantid::API::WorkspaceGroup_sptr groupWorkspaces(const std::vector<std::string> &workspaceNames);
 
  std::vector<Mantid::API::MatrixWorkspace_sptr>
  createMembersWorkspaces(const Mantid::API::MatrixWorkspace_sptr &initialWS, const std::vector<std::string> &members);
 
  void appendToMembers(const Mantid::API::MatrixWorkspace_sptr &resultWS,
                       std::vector<Mantid::API::MatrixWorkspace_sptr> &members);
 
  void setNumericAxis(const std::vector<Mantid::API::MatrixWorkspace_sptr> &workspaces,
                      const std::vector<double> &values, size_t axisIndex) const;
 
  std::vector<std::string> addMembersToADS(const std::vector<std::string> &members,
                                           const std::vector<Mantid::API::MatrixWorkspace_sptr> &memberWorkspaces,
                                           const std::string &outputWSName);
};
 
} // namespace Algorithms
} // namespace Mantid