Mantid
Loading...
Searching...
No Matches
SofQWPolygon.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2011 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// Includes
10//----------------------------------------------------------------------
14#include <list>
15
16namespace Mantid {
17namespace Algorithms {
18
42class MANTID_ALGORITHMS_DLL SofQWPolygon : public Rebin2D, public API::DeprecatedAlgorithm {
43public:
47 const std::string name() const override { return "SofQWPolygon"; }
48 const std::string alias() const override { return "SofQW2"; }
50 const std::string summary() const override {
51 return "Calculate the intensity as a function of momentum transfer and "
52 "energy.";
53 }
54
56 int version() const override { return 1; }
57 const std::vector<std::string> seeAlso() const override { return {"SofQW", "SofQWNormalisedPolygon", "Rebin2D"}; }
59 const std::string category() const override { return "Inelastic\\SofQW"; }
60
61private:
63 void init() override;
65 void exec() override;
67 void initCachedValues(const API::MatrixWorkspace_const_sptr &workspace);
69 void initThetaCache(const API::MatrixWorkspace &workspace);
70
73 std::vector<double> m_Qout;
75 std::vector<double> m_thetaPts;
78};
79
80} // namespace Algorithms
81} // namespace Mantid
IPeaksWorkspace_sptr workspace
Class for marking algorithms as deprecated.
Base MatrixWorkspace Abstract Class.
Rebins both axes of a two-dimensional workspace to the given parameters.
Definition Rebin2D.h:24
Converts a 2D workspace that has axes of energy transfer against spectrum number to one that gives in...
const std::string name() const override
Algorithm's name for identification.
int version() const override
Algorithm's version for identification.
double m_thetaWidth
Theta width.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string alias() const override
function to return any aliases of the algorithm.
const std::string summary() const override
Summary of algorithms purpose.
std::vector< double > m_thetaPts
Input theta points.
const std::string category() const override
Algorithm's category for identification.
std::vector< double > m_Qout
Output Q axis.
std::shared_ptr< const MatrixWorkspace > MatrixWorkspace_const_sptr
shared pointer to the matrix workspace base class (const version)
Helper class which provides the Collimation Length for SANS instruments.