Mantid
Loading...
Searching...
No Matches
ShowPeakHKLOffsets.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2009 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/*
8
9
10namespace Crystal * PeakHKLOffsets.h
11*
12* Created on: May 13, 2013
13* Author: ruth
14*/
22#pragma once
23
24#include "MantidAPI/Algorithm.h"
25#include "MantidCrystal/DllConfig.h"
26
27namespace Mantid {
28namespace Crystal {
29class MANTID_CRYSTAL_DLL ShowPeakHKLOffsets final : public API::Algorithm {
30public:
31 const std::string name() const override { return "ShowPeakHKLOffsets"; };
32
34 const std::string summary() const override {
35 return " Histograms, scatter plots, etc. of this data could be useful to "
36 "detect calibration problems";
37 }
38
39 int version() const override { return 1; };
40 const std::vector<std::string> seeAlso() const override { return {"StatisticsOfPeaksWorkspace"}; }
41
42 const std::string category() const override { return "Crystal\\Peaks"; };
43
44private:
45 void init() override;
46
47 void exec() override;
48};
49} // namespace Crystal
50} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
const std::string summary() const override
Summary of algorithms purpose.
const std::string category() const override
function to return a category of the algorithm.
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Helper class which provides the Collimation Length for SANS instruments.