-
Notifications
You must be signed in to change notification settings - Fork 121
/
ConvertFromDistribution.h
51 lines (45 loc) · 1.7 KB
/
ConvertFromDistribution.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
namespace Mantid {
namespace Algorithms {
/** Converts a histogram workspace from a distribution. i.e. multiplies by the
bin width
Required Properties:
<UL>
<LI> Workspace - The name of the Workspace to convert.</LI>
</UL>
@author Russell Taylor, Tessella Support Services plc
@date 17/11/2008
*/
class MANTID_ALGORITHMS_DLL ConvertFromDistribution : public API::Algorithm {
public:
/// Algorithm's name
const std::string name() const override { return "ConvertFromDistribution"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Converts a histogram workspace from a distribution i.e. multiplies "
"by the bin width.";
}
/// Algorithm's version
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override { return {"ConvertToDistribution"}; }
/// Algorithm's category for identification
const std::string category() const override { return "Transforms\\Distribution"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid