Mantid
Loading...
Searching...
No Matches
CentroidPeaksMD2.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2018 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
12#include "MantidMDAlgorithms/DllConfig.h"
13
14namespace Mantid {
15namespace MDAlgorithms {
16
23class MANTID_MDALGORITHMS_DLL CentroidPeaksMD2 final : public API::Algorithm {
24public:
26 const std::string name() const override { return "CentroidPeaksMD"; };
28 const std::string summary() const override {
29 return "Find the centroid of single-crystal peaks in a MDEventWorkspace, "
30 "in order to refine their positions.";
31 }
32
34 int version() const override { return 2; };
35 const std::vector<std::string> seeAlso() const override { return {"IntegratePeaksMD", "CentroidPeaks"}; }
37 const std::string category() const override { return "MDAlgorithms\\Peaks"; }
38
39private:
41 void init() override;
43 void exec() override;
44
45 template <typename MDE, size_t nd> void integrate(typename DataObjects::MDEventWorkspace<MDE, nd>::sptr ws);
46
49};
50
51} // namespace MDAlgorithms
52} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
std::shared_ptr< MDEventWorkspace< MDE, nd > > sptr
Typedef for a shared pointer of this kind of event workspace.
Find the centroid of single-crystal peaks in a MDEventWorkspace, in order to refine their positions.
const std::string category() const override
Algorithm's category for identification.
Mantid::API::IMDEventWorkspace_sptr inWS
Input MDEventWorkspace.
const std::string name() const override
Algorithm's name for identification.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
const std::string summary() const override
Summary of algorithms purpose.
int version() const override
Algorithm's version for identification.
std::shared_ptr< IMDEventWorkspace > IMDEventWorkspace_sptr
Shared pointer to Mantid::API::IMDEventWorkspace.
Helper class which provides the Collimation Length for SANS instruments.