Mantid
Loading...
Searching...
No Matches
SofQWCentre.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"
14#include "MantidAlgorithms/DllConfig.h"
16
17namespace Mantid {
18namespace Algorithms {
37class MANTID_ALGORITHMS_DLL SofQWCentre final : public API::Algorithm, public API::DeprecatedAlgorithm {
38public:
42 const std::string name() const override { return "SofQWCentre"; }
44 const std::string summary() const override {
45 return "Converts a 2D workspace that has axes in *units* of **DeltaE** "
46 "(energy transfer) against spectrum number to one "
47 "that gives intensity as a function of **DeltaE** against "
48 "**momentum transfer** ";
49 }
50
52 int version() const override { return (1); }
53 const std::vector<std::string> seeAlso() const override { return {"SofQW", "Rebin2D"}; }
55 const std::string category() const override { return "Inelastic\\SofQW"; }
56
57private:
59 static void makeDistribution(API::MatrixWorkspace &outputWS, const std::vector<double> &qAxis);
61 void init() override;
63 void exec() override;
64
66};
67
68} // namespace Algorithms
69} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
Class for marking algorithms as deprecated.
Base MatrixWorkspace Abstract Class.
Converts a 2D workspace that has axes of energy transfer against spectrum number to one that gives in...
Definition SofQWCentre.h:37
int version() const override
Algorithm's version.
Definition SofQWCentre.h:52
const std::string summary() const override
Summary of algorithms purpose.
Definition SofQWCentre.h:44
const std::string category() const override
Algorithm's category for identification.
Definition SofQWCentre.h:55
const std::string name() const override
Algorithm's name.
Definition SofQWCentre.h:42
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition SofQWCentre.h:53
Helper class which provides the Collimation Length for SANS instruments.