Mantid
Loading...
Searching...
No Matches
ElasticWindow.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 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"
14
15namespace Mantid {
16namespace Algorithms {
24class MANTID_ALGORITHMS_DLL ElasticWindow final : public API::Algorithm {
25public:
27 const std::string name() const override { return "ElasticWindow"; }
29 const std::string summary() const override {
30 return "This algorithm performs an integration over an energy range, with "
31 "the option to subtract a background over a second range, then "
32 "transposes the result into a single-spectrum workspace with units "
33 "in Q and Q^2.";
34 }
35
37 int version() const override { return (1); }
38 const std::vector<std::string> seeAlso() const override { return {"Integration"}; }
40 const std::string category() const override { return "Inelastic\\Indirect"; }
41
42private:
44 void init() override;
46 void exec() override;
47};
48
49} // namespace Algorithms
50} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
const std::string category() const override
Algorithm's category for identification.
Definition: ElasticWindow.h:40
const std::string name() const override
Algorithm's name.
Definition: ElasticWindow.h:27
int version() const override
Algorithm's version.
Definition: ElasticWindow.h:37
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: ElasticWindow.h:38
const std::string summary() const override
Summary of algorithms purpose.
Definition: ElasticWindow.h:29
Helper class which provides the Collimation Length for SANS instruments.