Mantid
Loading...
Searching...
No Matches
ConvertPeaksWorkspace.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 "MantidCrystal/DllConfig.h"
12
13namespace Mantid {
14namespace Crystal {
15
30class MANTID_CRYSTAL_DLL ConvertPeaksWorkspace : public Mantid::API::Algorithm {
31public:
33 const std::string name() const override { return "ConvertPeaksWorkspace"; }
34
36 const std::string summary() const override {
37 return "Bi-directional conversion between a regular PeaksWorkspace (with instrument) and a "
38 "LeanElasticPeaksWorkspace (without instrument).";
39 }
40
42 int version() const override { return 1; }
43
45 const std::string category() const override {
46 return "Crystal\\Peaks;Utility\\Workspaces";
47 ;
48 }
49
51 const std::vector<std::string> seeAlso() const override { return {"CreatePeaksWorkspace"}; }
52
53private:
55 void init() override;
56
58 void exec() override;
59
61 std::map<std::string, std::string> validateInputs() override;
62
64 Mantid::API::IPeaksWorkspace_sptr makeLeanElasticPeaksWorkspace(const Mantid::API::IPeaksWorkspace_sptr &ipws);
65
69};
70
71} // namespace Crystal
72} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
ConvertPeaksWorkspace : Bi-directional conversion between a regular PeaksWorkspace (with instrument) ...
const std::vector< std::string > seeAlso() const override
Extra help info.
const std::string category() const override
Algorithm's category, overriding a virtual method.
int version() const override
Algorithm's version, overriding a virtual method.
const std::string summary() const override
Summary of algorithm's purpose.
const std::string name() const override
Algorithm's name for identification.
std::shared_ptr< IPeaksWorkspace > IPeaksWorkspace_sptr
shared pointer to Mantid::API::IPeaksWorkspace
std::shared_ptr< Workspace > Workspace_sptr
shared pointer to Mantid::API::Workspace
Definition: Workspace_fwd.h:20
Helper class which provides the Collimation Length for SANS instruments.