Stitch1D.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/MatrixWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
 
#include <boost/tuple/tuple.hpp>
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL Stitch1D final : public API::Algorithm {
public:
  const std::string name() const override { return "Stitch1D"; }
  int version() const override { return 3; }
  const std::string category() const override { return "Reflectometry"; }
  const std::string summary() const override { return "Stitches single histogram matrix workspaces together"; }
  const std::vector<std::string> seeAlso() const override { return {"Rebin", "Stitch1DMany"}; }
  bool hasNonzeroErrors(Mantid::API::MatrixWorkspace_sptr &ws);
  std::map<std::string, std::string> validateInputs() override;
 
  using SpecialTypeIndexes = std::vector<std::vector<size_t>>;
  struct SpecialValueIndexes {
    SpecialTypeIndexes nanE;
    SpecialTypeIndexes nanY;
    SpecialTypeIndexes infE;
    SpecialTypeIndexes infY;
 
    void resize(size_t histogramCount) {
      nanE.resize(histogramCount);
      nanY.resize(histogramCount);
      infE.resize(histogramCount);
      infY.resize(histogramCount);
    }
  };
 
  struct overlapBounds {
    int a1 = -1;
    int a2 = -1;
  };
 
private:
  void init() override;
  void exec() override;
  double getStartOverlap(const double intesectionMin, const double intesectionMax) const;
  double getEndOverlap(const double intesectionMin, const double intesectionMax) const;
 
  std::vector<double> getRebinParams(Mantid::API::MatrixWorkspace_const_sptr &lhsWS,
                                     Mantid::API::MatrixWorkspace_const_sptr &rhsWS, const bool scaleRHS) const;
  Mantid::API::MatrixWorkspace_sptr rebin(Mantid::API::MatrixWorkspace_sptr &input, const std::vector<double> &params,
                                          SpecialValueIndexes &specialValues);
  Mantid::API::MatrixWorkspace_sptr integration(Mantid::API::MatrixWorkspace_sptr const &input, const double start,
                                                const double stop);
  Mantid::API::MatrixWorkspace_sptr singleValueWS(const double val);
  Mantid::API::MatrixWorkspace_sptr weightedMean(Mantid::API::MatrixWorkspace_sptr const &inOne,
                                                 Mantid::API::MatrixWorkspace_sptr const &inTwo);
  Mantid::API::MatrixWorkspace_sptr conjoinXAxis(Mantid::API::MatrixWorkspace_sptr const &inOne,
                                                 Mantid::API::MatrixWorkspace_sptr const &inTwo);
  boost::tuple<int, int> findStartEndIndexes(double startOverlap, double endOverlap,
                                             Mantid::API::MatrixWorkspace_sptr &workspace);
  Mantid::API::MatrixWorkspace_sptr maskAllBut(int a1, int a2, Mantid::API::MatrixWorkspace_sptr &source);
  void maskInPlace(int a1, int a2, Mantid::API::MatrixWorkspace_sptr &source);
  void reinsertSpecialValues(const Mantid::API::MatrixWorkspace_sptr &ws, const SpecialValueIndexes &lhsSpecialValues,
                             const SpecialValueIndexes &rhsSpecialValues, overlapBounds bounds);
  void useValidOverlapData(const Mantid::API::MatrixWorkspace_sptr &overlap,
                           const Mantid::API::MatrixWorkspace_sptr &lhs, const Mantid::API::MatrixWorkspace_sptr &rhs,
                           const SpecialValueIndexes &lhsSpecialValues, const SpecialValueIndexes &rhsSpecialValues,
                           const overlapBounds bounds);
  static const double range_tolerance;
  double m_scaleFactor;
  double m_errorScaleFactor;
  bool m_useValidDataOnly;
  void scaleWorkspace(API::MatrixWorkspace_sptr &ws, API::MatrixWorkspace_sptr &scaleFactorWS,
                      API::MatrixWorkspace_const_sptr &dxWS);
  SpecialValueIndexes m_lhsSpecialValues;
  SpecialValueIndexes m_rhsSpecialValues;
};
 
} // namespace Algorithms
} // namespace Mantid