PoissonErrors.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/BinaryOperation.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL PoissonErrors : public BinaryOperation {
public:
  const std::string name() const override { return "PoissonErrors"; }
  const std::string summary() const override {
    return "Calculates the gaussian approxiamtion of Poisson error based on a "
           "matching workspace containing the original counts.";
  }
 
  int version() const override { return (1); }
  const std::string category() const override { return "SANS;Arithmetic\\Errors"; }
 
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;
  std::string checkSizeCompatibility(const API::MatrixWorkspace_const_sptr lhs,
                                     const API::MatrixWorkspace_const_sptr rhs) const override;
 
  std::string inputPropName1() const override { return "InputWorkspace"; }
  std::string inputPropName2() const override { return "CountsWorkspace"; }
  std::string outputPropName() const override { return "OutputWorkspace"; }
};
 
} // namespace Algorithms
} // namespace Mantid