Mantid
Loading...
Searching...
No Matches
WeightedMeanOfWorkspace.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2012 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
10#include "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13namespace Algorithms {
14
19class MANTID_ALGORITHMS_DLL WeightedMeanOfWorkspace final : public API::Algorithm {
20public:
21 const std::string name() const override;
23 const std::string summary() const override {
24 return "This algorithm calculates the weighted mean for an entire "
25 "workspace.";
26 }
27
28 int version() const override;
29 const std::vector<std::string> seeAlso() const override { return {"Mean", "WeightedMean"}; }
30 const std::string category() const override;
31
32private:
33 void init() override;
34 void exec() override;
35};
36
37} // namespace Algorithms
38} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
WeightedMeanOfWorkspace This algorithm calculates the weighted mean for a single workspace from all t...
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string summary() const override
Summary of algorithms purpose.
Helper class which provides the Collimation Length for SANS instruments.