Mantid
Loading...
Searching...
No Matches
CalculateTransmissionBeamSpreader.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2009 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"
14
15namespace Mantid {
16namespace Algorithms {
58class MANTID_ALGORITHMS_DLL CalculateTransmissionBeamSpreader final : public API::Algorithm {
59public:
61 const std::string name() const override { return "CalculateTransmissionBeamSpreader"; }
63 const std::string summary() const override {
64 return "Calculates the sample transmission using the beam spreader (aka "
65 "glass carbon) method.";
66 }
67
69 int version() const override { return (1); }
70 const std::vector<std::string> seeAlso() const override {
71 return {"CalculateTransmission", "ApplyTransmissionCorrection"};
72 }
74 const std::string category() const override { return "SANS;CorrectionFunctions\\TransmissionCorrections"; }
75
76private:
78 void init() override;
80 void exec() override;
81
83 API::MatrixWorkspace_sptr extractSpectrum(const API::MatrixWorkspace_sptr &WS, const size_t index);
88
89 bool logFit = false;
90};
91
92} // namespace Algorithms
93} // namespace Mantid
std::map< DeltaEMode::Type, std::string > index
Definition: DeltaEMode.cpp:19
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Calculates the transmission correction, as a function of wavelength, for a SANS instrument.
const std::string summary() const override
Summary of algorithms purpose.
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.
const std::string name() const override
Algorithm's name.
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.