Mantid
Loading...
Searching...
No Matches
StatisticsOfPeaksWorkspace.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
10#include "MantidCrystal/DllConfig.h"
13
14namespace Mantid {
15namespace Crystal {
16
22class MANTID_CRYSTAL_DLL StatisticsOfPeaksWorkspace final : public API::Algorithm {
23public:
26 const std::string name() const override { return "StatisticsOfPeaksWorkspace"; };
28 const std::string summary() const override { return "Statistics of a PeaksWorkspace."; }
29
31 int version() const override { return 1; };
32 const std::vector<std::string> seeAlso() const override { return {"ShowPeakHKLOffsets"}; }
34 const std::string category() const override { return "Crystal\\Peaks;DataHandling\\Text"; }
35
36private:
38 std::vector<Mantid::Geometry::PointGroup_sptr> m_pointGroups;
40 void init() override;
42 void exec() override;
44 void doSortHKL(const Mantid::API::Workspace_sptr &ws, const std::string &runName);
45
47};
48
49} // namespace Crystal
50} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
std::vector< Mantid::Geometry::PointGroup_sptr > m_pointGroups
Point Groups possible.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
int version() const override
Algorithm's version for identification.
const std::string name() const override
Algorithm's name for identification.
const std::string category() const override
Algorithm's category for identification.
const std::string summary() const override
Summary of algorithms purpose.
std::shared_ptr< Workspace > Workspace_sptr
shared pointer to Mantid::API::Workspace
Definition: Workspace_fwd.h:20
std::shared_ptr< PeaksWorkspace > PeaksWorkspace_sptr
Typedef for a shared pointer to a peaks workspace.
Helper class which provides the Collimation Length for SANS instruments.