Mantid
Loading...
Searching...
No Matches
RotateSampleShape.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2024 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
11#include "MantidDataHandling/DllConfig.h"
12
13namespace Mantid {
14namespace Geometry {
15class Goniometer;
16}
17} // namespace Mantid
18
19namespace Mantid {
20namespace DataHandling {
21
23
27class MANTID_DATAHANDLING_DLL RotateSampleShape final : public API::Algorithm {
28public:
30 const std::string name() const override { return "RotateSampleShape"; };
32 const std::string summary() const override {
33 return "Define the initial orientation of the sample with respect to the beam and instrument "
34 "by giving the axes, angle and directions of rotations.";
35 }
36
38 int version() const override { return 1; };
39 const std::vector<std::string> seeAlso() const override { return {"SetGoniometer"}; }
41 const std::string category() const override { return "DataHandling\\Instrument"; }
42
43private:
45 void init() override;
47 void exec() override;
48 void prepareGoniometerAxes(Goniometer &gon);
49 bool checkIsValidShape(const API::ExperimentInfo_sptr &ei, std::string &shapeXML, bool &isMeshShape);
50};
51
52} // namespace DataHandling
53} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
Define the initial orientation of the sample with respect to the beam and instrument by giving the ax...
const std::string summary() const override
Summary of algorithms purpose.
int version() const override
Algorithm's version 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 category() const override
Algorithm's category for identification.
const std::string name() const override
Algorithm's name for identification.
Class to represent a particular goniometer setting, which is described by the rotation matrix.
Definition Goniometer.h:55
std::shared_ptr< ExperimentInfo > ExperimentInfo_sptr
Shared pointer to ExperimentInfo.
Helper class which provides the Collimation Length for SANS instruments.