Stitch1DMany.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2014 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 "MantidAPI/WorkspaceGroup.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL Stitch1DMany final : public API::Algorithm {
public:
  const std::string name() const override { return "Stitch1DMany"; }
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Rebin", "Stitch1D"}; }
  const std::string category() const override { return "Reflectometry"; }
  const std::string summary() const override { return "Stitches histogram matrix workspaces together"; }
  std::map<std::string, std::string> validateInputs() override;
 
  void doStitch1D(std::vector<API::MatrixWorkspace_sptr> &toStitch, const std::vector<double> &manualScaleFactors,
                  API::Workspace_sptr &outWS);
 
  void doStitch1DMany(const size_t period, const bool useManualScaleFactors, std::string &outName,
                      std::vector<double> &outScaleFactors, const int indexOfReference, const bool storeInADS = true);
 
private:
  void init() override;
  bool checkGroups() override { return false; }
  void exec() override;
  std::string createChildWorkspaceName(const std::string &groupName, const size_t periodIndex);
 
  // A 2D matrix holding workspaces obtained from each workspace list/group
  std::vector<std::vector<API::MatrixWorkspace_sptr>> m_inputWSMatrix;
 
  std::vector<double> m_startOverlaps;
  std::vector<double> m_endOverlaps;
  std::vector<double> m_params;
  std::vector<double> m_scaleFactors;
  std::vector<double> m_manualScaleFactors;
  API::Workspace_sptr m_outputWorkspace;
 
  bool m_useManualScaleFactors = false;
  size_t m_scaleFactorFromPeriod = 1;
  int m_indexOfReference = 0;
};
 
} // namespace Algorithms
} // namespace Mantid