Mantid
Loading...
Searching...
No Matches
Max.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2007 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 "MantidAlgorithms/DllConfig.h"
14namespace Mantid {
15namespace Algorithms {
40class MANTID_ALGORITHMS_DLL Max final : public API::Algorithm {
41public:
43 const std::string name() const override { return "Max"; }
45 int version() const override { return (1); }
46 const std::vector<std::string> seeAlso() const override { return {"Min", "MaxMin"}; }
48 const std::string category() const override { return "Arithmetic"; }
50 const std::string summary() const override {
51 return "Takes a 2D workspace as input and find the maximum in each 1D "
52 "spectrum.";
53 }
54
55private:
56 // Overridden Algorithm methods
57 void init() override;
58 void exec() override;
59};
60
61} // namespace Algorithms
62} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Takes a 2D workspace as input and find the maximum in each 1D spectrum.
Definition: Max.h:40
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: Max.h:48
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: Max.h:43
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: Max.h:45
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: Max.h:46
const std::string summary() const override
Summary of algorithms purpose.
Definition: Max.h:50
Helper class which provides the Collimation Length for SANS instruments.