Mantid
Loading...
Searching...
No Matches
TransformHKL.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 "MantidCrystal/DllConfig.h"
11
12namespace Mantid {
13namespace Crystal {
21class MANTID_CRYSTAL_DLL TransformHKL final : public API::Algorithm {
22public:
24 const std::string name() const override;
25
27 int version() const override;
28 const std::vector<std::string> seeAlso() const override { return {"SortHKL"}; }
29
31 const std::string category() const override;
32
34 const std::string summary() const override {
35 return "Specify a 3x3 matrix to apply to (HKL) vectors as a list of 9 "
36 "comma separated numbers. Both the UB and HKL values will be "
37 "updated";
38 }
39
40private:
42 void init() override;
43
45 void exec() override;
46};
47
48} // namespace Crystal
49} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
TransformHKL : Algorithm to adjust the UB saved in the sample associated with the specified PeaksWork...
Definition: TransformHKL.h:21
const std::string summary() const override
Summary of algorithms purpose.
Definition: TransformHKL.h:34
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Definition: TransformHKL.h:28
Helper class which provides the Collimation Length for SANS instruments.