Mantid
Loading...
Searching...
No Matches
ApplyInstrumentToPeaks.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2021 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 "MantidAlgorithms/DllConfig.h"
11namespace Mantid {
12namespace Algorithms {
13
16class MANTID_ALGORITHMS_DLL ApplyInstrumentToPeaks final : public API::Algorithm {
17public:
18 const std::string name() const override { return "ApplyInstrumentToPeaks"; }
19 int version() const override { return 1; }
20 const std::vector<std::string> seeAlso() const override { return {}; }
21 const std::string category() const override { return "Crystal\\Peaks"; }
22 const std::string summary() const override {
23 return "Update the instrument attached to peaks within a PeaksWorkspace to match the one provided or the one "
24 "attached to the input workspace while keeping detectorID and TOF unchanged";
25 }
26
27private:
28 void init() override;
29 void exec() override;
30};
31
32} // namespace Algorithms
33} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
ApplyInstrumentToPeaks : TODO: DESCRIPTION.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
const std::string category() const override
function to return a category of the algorithm.
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
const std::string summary() const override
function returns a summary message that will be displayed in the default GUI, and in the help.
Helper class which provides the Collimation Length for SANS instruments.