Mantid
Loading...
Searching...
No Matches
SolidAngle.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"
14#include "MantidAlgorithms/DllConfig.h"
15
16namespace Mantid {
17namespace Algorithms {
24class MANTID_ALGORITHMS_DLL SolidAngle final : public API::Algorithm {
25public:
27 const std::string name() const override { return "SolidAngle"; }
29 const std::string summary() const override {
30 return "The SolidAngle algorithm calculates the solid angle in steradians "
31 "for each of the detectors in an instrument and outputs the data in "
32 "a workspace. This can then be used to normalize a data workspace "
33 "using the divide algorithm should you wish.";
34 }
35
37 int version() const override { return 1; }
38 const std::vector<std::string> seeAlso() const override { return {"Divide"}; }
40 const std::string category() const override { return "CorrectionFunctions\\InstrumentCorrections"; }
41
42private:
43 // Overridden Algorithm methods
44 void init() override;
45 void exec() override;
46 void initSpectrum(const API::MatrixWorkspace &input, API::MatrixWorkspace &output, const size_t j);
47};
48
49} // namespace Algorithms
50} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Base MatrixWorkspace Abstract Class.
Calculates and outputs the solid angles for each detector in the instrument.
Definition: SolidAngle.h:24
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: SolidAngle.h:37
const std::string summary() const override
Summary of algorithms purpose.
Definition: SolidAngle.h:29
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: SolidAngle.h:38
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: SolidAngle.h:27
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: SolidAngle.h:40
Helper class which provides the Collimation Length for SANS instruments.