-
Notifications
You must be signed in to change notification settings - Fork 122
/
WeightedMean.h
58 lines (50 loc) · 2.57 KB
/
WeightedMean.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
52
53
54
55
56
57
58
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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
#include "MantidAlgorithms/CommutativeBinaryOperation.h"
#include "MantidHistogramData/Histogram.h"
namespace Mantid {
namespace Algorithms {
/** An algorithm to calculate the weighted mean of two workspaces.
Required Properties:
<UL>
<LI> InputWorkspace1 - The name of the first input workspace.</LI>
<LI> InputWorkspace2 - The name of the second input workspace. </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the
result.</LI>
</UL>
@author Robert Dalgliesh, ISIS, RAL
@date 12/1/2010
*/
class MANTID_ALGORITHMS_DLL WeightedMean : public CommutativeBinaryOperation {
public:
const std::string name() const override { return "WeightedMean"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "An algorithm to calculate the weighted mean of two workspaces.";
}
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override { return {"Mean"}; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Arithmetic"; }
private:
// Overridden BinaryOperation methods
void performBinaryOperation(const HistogramData::Histogram &lhs, const HistogramData::Histogram &rhs,
HistogramData::HistogramY &YOut, HistogramData::HistogramE &EOut) override;
void performBinaryOperation(const HistogramData::Histogram &lhs, const double rhsY, const double rhsE,
HistogramData::HistogramY &YOut, HistogramData::HistogramE &EOut) override;
bool checkCompatibility(const API::MatrixWorkspace_const_sptr lhs,
const API::MatrixWorkspace_const_sptr rhs) const override;
std::string checkSizeCompatibility(const API::MatrixWorkspace_const_sptr lhs,
const API::MatrixWorkspace_const_sptr rhs) const override;
/// The name of the first input workspace property for BinaryOperation
std::string inputPropName1() const override { return "InputWorkspace1"; }
/// The name of the second input workspace property for BinaryOperation
std::string inputPropName2() const override { return "InputWorkspace2"; }
};
} // namespace Algorithms
} // namespace Mantid