Stitch1D.h

#ifndef MANTID_ALGORITHMS_STITCH1D_H_
#define MANTID_ALGORITHMS_STITCH1D_H_

#include "MantidAPI/Algorithm.h"

#include <boost/tuple/tuple.hpp>

namespace Mantid {
namespace Algorithms {

/** Stitch1D : Stitches two Matrix Workspaces together into a single output.

 Copyright &copy; 2014 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
 National Laboratory & European Spallation Source

 This file is part of Mantid.

 Mantid is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version.

 Mantid is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

 File change history is stored at: <https://github.com/mantidproject/mantid>
 Code Documentation is available at: <http://doxygen.mantidproject.org>
 */
class DLLExport Stitch1D : public API::Algorithm {
public:
  /// Algorithm's name for identification. @see Algorithm::name
  const std::string name() const override { return "Stitch1D"; }
  /// Algorithm's version for identification. @see Algorithm::version
  int version() const override { return 3; }
  /// Algorithm's category for identification. @see Algorithm::category
  const std::string category() const override { return "Reflectometry"; }
  /// Summary of algorithm's purpose
  const std::string summary() const override {
    return "Stitches single histogram matrix workspaces together";
  }
  /// Does the x-axis have non-zero errors
  bool hasNonzeroErrors(Mantid::API::MatrixWorkspace_sptr ws);

private:
  /// Helper typedef. For storing indexes of special values per spectra per
  /// workspace.
  typedef std::vector<std::vector<size_t>> SpecialTypeIndexes;
  /// Overwrites Algorithm method.
  void init() override;
  /// Overwrites Algorithm method.
  void exec() override;
  /// Get the start overlap
  double getStartOverlap(const double &intesectionMin,
                         const double &intesectionMax) const;
  /// Get the end overlap
  double getEndOverlap(const double &intesectionMin,
                       const double &intesectionMax) const;

  /// Get the rebin parameters
  std::vector<double> getRebinParams(Mantid::API::MatrixWorkspace_sptr &lhsWS,
                                     Mantid::API::MatrixWorkspace_sptr &rhsWS,
                                     const bool scaleRHS) const;
  /// Perform rebin
  Mantid::API::MatrixWorkspace_sptr
  rebin(Mantid::API::MatrixWorkspace_sptr &input,
        const std::vector<double> &params);
  /// Perform integration
  Mantid::API::MatrixWorkspace_sptr
  integration(Mantid::API::MatrixWorkspace_sptr &input, const double &start,
              const double &stop);
  Mantid::API::MatrixWorkspace_sptr singleValueWS(double val);
  /// Calclate the weighted mean
  Mantid::API::MatrixWorkspace_sptr
  weightedMean(Mantid::API::MatrixWorkspace_sptr &inOne,
               Mantid::API::MatrixWorkspace_sptr &inTwo);
  /// Find the start and end indexes
  boost::tuple<int, int>
  findStartEndIndexes(double startOverlap, double endOverlap,
                      Mantid::API::MatrixWorkspace_sptr &workspace);
  /// Mask out everything but the data in the ranges
  Mantid::API::MatrixWorkspace_sptr
  maskAllBut(int a1, int a2, Mantid::API::MatrixWorkspace_sptr &source);
  /// Mask out everything but the data in the ranges, but do it inplace.
  void maskInPlace(int a1, int a2, Mantid::API::MatrixWorkspace_sptr source);
  /// Add back in any special values
  void reinsertSpecialValues(Mantid::API::MatrixWorkspace_sptr ws);
  /// Range tolerance
  static const double range_tolerance;
  /// Index per workspace spectra of Nans
  SpecialTypeIndexes m_nanYIndexes;
  /// Index per workspace spectra of Infs
  SpecialTypeIndexes m_infYIndexes;
  /// Index per workspace spectra of Nans
  SpecialTypeIndexes m_nanEIndexes;
  /// Index per workspace spectra of Infs
  SpecialTypeIndexes m_infEIndexes;
};

} // namespace Algorithms
} // namespace Mantid

#endif /* MANTID_ALGORITHMS_STITCH1D_H_ */