SumNeighbours.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL SumNeighbours final : public API::Algorithm {
public:
  const std::string name() const override { return "SumNeighbours"; }
  const std::string summary() const override {
    return "Sum event lists from neighboring pixels in rectangular area "
           "detectors - e.g. to reduce the signal-to-noise of individual "
           "spectra. Each spectrum in the output workspace is a sum of a block "
           "of SumX*SumY pixels. Only works on EventWorkspaces and for "
           "instruments with RectangularDetector's.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"SumSpectra", "SumRowColumn"}; }
  const std::string category() const override { return "Transforms\\Grouping"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
};
 
} // namespace Algorithms
} // namespace Mantid