Mantid
Loading...
Searching...
No Matches
ConvertToDistribution.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2008 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 {
27class MANTID_ALGORITHMS_DLL ConvertToDistribution : public API::Algorithm {
28public:
29 virtual ~ConvertToDistribution() = default;
31 const std::string name() const override { return "ConvertToDistribution"; }
33 const std::string summary() const override {
34 return "Makes a histogram workspace a distribution i.e. divides by the bin "
35 "width.";
36 }
38 int version() const override { return (1); }
39 const std::vector<std::string> seeAlso() const override { return {"ConvertFromDistribution"}; }
41 const std::string category() const override { return "Transforms\\Distribution"; }
42
43protected:
45 std::map<std::string, std::string> validateInputs() override;
46
47private:
49 void init() override;
51 void exec() override;
52};
53
54} // namespace Algorithms
55} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Makes a histogram workspace a distribution.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
int version() const override
Algorithm's version.
const std::string category() const override
Algorithm's category for identification.
const std::string name() const override
Algorithm's name.
const std::string summary() const override
Summary of algorithms purpose.
Helper class which provides the Collimation Length for SANS instruments.