Mantid
Loading...
Searching...
No Matches
ConvertToConstantL2.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2008 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
10#include "MantidAlgorithms/DllConfig.h"
12
13namespace Mantid {
14namespace Algorithms {
28class MANTID_ALGORITHMS_DLL ConvertToConstantL2 final : public API::Algorithm {
29public:
33 const std::string name() const override { return "ConvertToConstantL2"; }
35 const std::string summary() const override {
36 return "Used to convert flight paths to have a constant l2 in 2D shaped "
37 "detectors.";
38 }
40 int version() const override { return 1; }
41 const std::vector<std::string> seeAlso() const override { return {"CorrectTOFAxis"}; }
43 const std::string category() const override {
44 return "Inelastic\\Corrections;CorrectionFunctions\\InstrumentCorrections";
45 }
46
47private:
48 // Overridden Algorithm methods
49 void init() override;
50 void exec() override;
51 void initWorkspaces();
52 double getRunProperty(const std::string &);
53 double getInstrumentProperty(const std::string &);
54 double calculateTOF(double);
55
60
62
63 double m_l2;
65};
66
67} // namespace Algorithms
68} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Convert workspace to have a constant L2.
API::MatrixWorkspace_sptr m_outputWS
The output workspace, maybe the same as the input one.
API::MatrixWorkspace_const_sptr m_inputWS
The user selected (input) workspace.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string summary() const override
Summary of algorithms purpose.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Geometry::Instrument_const_sptr m_instrument
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
int version() const override
Algorithm's version for identification overriding a virtual method.
std::shared_ptr< const MatrixWorkspace > MatrixWorkspace_const_sptr
shared pointer to the matrix workspace base class (const version)
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
std::shared_ptr< const Instrument > Instrument_const_sptr
Shared pointer to an const instrument object.
Helper class which provides the Collimation Length for SANS instruments.