Mantid
Loading...
Searching...
No Matches
TOFSANSResolutionByPixel.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2018 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"
15
16namespace Mantid {
17namespace Algorithms {
26class MANTID_ALGORITHMS_DLL TOFSANSResolutionByPixel final : public API::Algorithm {
27public:
31 const std::string name() const override { return "TOFSANSResolutionByPixel"; }
33 const std::string summary() const override { return "Calculate the Q resolution for TOF SANS data for each pixel."; }
34
36 int version() const override { return (1); }
37 const std::vector<std::string> seeAlso() const override { return {"TOFSANSResolution"}; }
39 const std::string category() const override { return "SANS"; }
40
41private:
43 void init() override;
45 void exec() override;
47 virtual double getTOFResolution(double wl);
50 const double collimationLengthCorrection) const;
54 void checkInput(const Mantid::API::MatrixWorkspace_sptr &inWS);
56 Mantid::API::MatrixWorkspace_sptr getModeratorWorkspace(const Mantid::API::MatrixWorkspace_sptr &inputWorkspace);
58 Mantid::API::MatrixWorkspace_sptr setupOutputWorkspace(const Mantid::API::MatrixWorkspace_sptr &inputWorkspace);
61};
62
63} // namespace Algorithms
64} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Calculates the TOF-SANS Q-resolution for each wavelenght and pixel using formula by Mildner and Carpe...
const std::string category() const override
Algorithm's category for identification.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
double getCollimationLengthWithGuard(Mantid::API::MatrixWorkspace_sptr inWS, const double L1, const double collimationLengthCorrection) const
Get the collimation length when we evaluate it using 5 Guards.
int version() const override
Algorithm's version.
const std::string name() const override
Algorithm's name.
double m_wl_resolution
Wavelength resolution (constant for all wavelengths)
const std::string summary() const override
Summary of algorithms purpose.
double provideDefaultLCollimationLength(Mantid::API::MatrixWorkspace_sptr inWS) const
Return the default collimation length.
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.