Mantid
Loading...
Searching...
No Matches
MonitorEfficiencyCorUser.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
10#include "MantidAlgorithms/DllConfig.h"
12
13namespace Mantid {
14
15namespace HistogramData {
16class HistogramX;
17class HistogramY;
18class HistogramE;
19} // namespace HistogramData
20namespace Algorithms {
21
22class MANTID_ALGORITHMS_DLL MonitorEfficiencyCorUser final : public API::Algorithm {
23public:
25 const std::string name() const override { return "MonitorEfficiencyCorUser"; }
27 const std::string summary() const override {
28 return "This algorithm normalises the counts by the monitor counts with "
29 "additional efficiency correction according to the formula set in "
30 "the instrument parameters file.";
31 }
32
34 int version() const override { return 1; }
35 const std::vector<std::string> seeAlso() const override { return {"NormaliseToMonitor"}; }
37 const std::string category() const override { return "CorrectionFunctions\\NormalisationCorrections"; }
38
39private:
41 void init() override;
43 void exec() override;
44
45 double calculateFormulaValue(const std::string &, double);
46 std::string getValFromInstrumentDef(const std::string &);
47
53 double m_Ei = 0.0;
55 double m_monitorCounts = 0;
56};
57
58} // namespace Algorithms
59} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
API::MatrixWorkspace_const_sptr m_inputWS
The user selected (input) workspace.
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.
int version() const override
Algorithm's version.
API::MatrixWorkspace_sptr m_outputWS
The output workspace, maybe the same as the input one.
const std::string summary() const override
Summary of algorithms purpose.
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
Helper class which provides the Collimation Length for SANS instruments.