Mantid
Loading...
Searching...
No Matches
GroupDetectors.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2008 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
9//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
12#include "MantidAPI/Algorithm.h"
13#include "MantidDataHandling/DllConfig.h"
14
15namespace Mantid {
16namespace DataHandling {
46class MANTID_DATAHANDLING_DLL GroupDetectors final : public API::Algorithm {
47public:
49 const std::string name() const override { return "GroupDetectors"; };
51 const std::string summary() const override {
52 return "Sums spectra bin-by-bin, equivalent to grouping the data from a "
53 "set of detectors. Individual groups can be specified by passing "
54 "the algorithm a list of spectrum numbers, detector IDs or "
55 "workspace indices. Many spectra groups can be created in one "
56 "execution via an input file.";
57 }
58
60 int version() const override { return 1; };
62 const std::string category() const override { return "Transforms\\Grouping"; }
63
64private:
65 // Implement abstract Algorithm methods
66 void init() override;
67 void exec() override;
68};
69
70} // namespace DataHandling
71} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
An algorithm for grouping detectors and the spectra associated with them into a single DetectorGroup ...
const std::string summary() const override
Summary of algorithms purpose.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Helper class which provides the Collimation Length for SANS instruments.