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