Mantid
Loading...
Searching...
No Matches
HeliumAnalyserEfficiencyTime.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2025 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
8#pragma once
9
10//----------------------------------------------------------------------
11// Includes
12//----------------------------------------------------------------------
13#include "MantidAPI/Algorithm.h"
14
17
18#include "MantidAlgorithms/DllConfig.h"
19
20namespace Mantid {
21namespace Algorithms {
22using namespace API;
23
24class MANTID_ALGORITHMS_DLL HeliumAnalyserEfficiencyTime final : public API::Algorithm {
25public:
27 const std::string name() const override { return "HeliumAnalyserEfficiencyTime"; }
29 const std::string summary() const override {
30 return "Calculates the helium analyzer efficiency at the input workspace run time using the lifetime, initial "
31 "polarization and mean gas length of the analyzer";
32 }
34 int version() const override { return 1; }
36 const std::string category() const override { return "SANS\\PolarizationCorrections"; }
38 const std::vector<std::string> seeAlso() const override {
39 return {"HeliumAnalyserEfficiency", "DepolarizedAnalyserTransmission"};
40 };
42 std::map<std::string, std::string> validateInputs() override;
43 bool checkGroups() override { return false; }
44
45private:
46 void init() override;
47 void exec() override;
48
49 std::pair<double, double> getTimeDifference();
50 std::vector<MatrixWorkspace_sptr> calculateOutputs();
51 MatrixWorkspace_sptr retrieveWorkspaceForWavelength() const;
52};
53} // namespace Algorithms
54} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::vector< std::string > seeAlso() const override
Related algorithms.
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.
bool checkGroups() override
Check the input workspace properties for groups.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.