WeightedMean.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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 "MantidAlgorithms/CommutativeBinaryOperation.h"
#include "MantidHistogramData/Histogram.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL WeightedMean : public CommutativeBinaryOperation {
public:
  const std::string name() const override { return "WeightedMean"; }
  const std::string summary() const override {
    return "An algorithm to calculate the weighted mean of two workspaces.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"Mean"}; }
  const std::string category() const override { return "Arithmetic"; }
 
private:
  // Overridden BinaryOperation methods
  void performBinaryOperation(const HistogramData::Histogram &lhs, const HistogramData::Histogram &rhs,
                              HistogramData::HistogramY &YOut, HistogramData::HistogramE &EOut) override;
  void performBinaryOperation(const HistogramData::Histogram &lhs, const double rhsY, const double rhsE,
                              HistogramData::HistogramY &YOut, HistogramData::HistogramE &EOut) override;
  bool checkCompatibility(const API::MatrixWorkspace_const_sptr lhs,
                          const API::MatrixWorkspace_const_sptr rhs) const override;
  std::string checkSizeCompatibility(const API::MatrixWorkspace_const_sptr lhs,
                                     const API::MatrixWorkspace_const_sptr rhs) const override;
 
  std::string inputPropName1() const override { return "InputWorkspace1"; }
  std::string inputPropName2() const override { return "InputWorkspace2"; }
};
 
} // namespace Algorithms
} // namespace Mantid