Mantid
Loading...
Searching...
No Matches
SaveCalFile.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2018 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"
15
16namespace Mantid {
17namespace DataHandling {
18
25class MANTID_DATAHANDLING_DLL SaveCalFile final : public API::Algorithm {
26public:
28 const std::string name() const override { return "SaveCalFile"; };
30 const std::string summary() const override {
31 return "Saves a 5-column ASCII .cal file from up to 3 workspaces: a "
32 "GroupingWorkspace, OffsetsWorkspace and/or MaskWorkspace.";
33 }
34
36 int version() const override { return 1; };
37 const std::vector<std::string> seeAlso() const override {
38 return {"SaveDiffCal", "ReadGroupsFromFile", "CreateDummyCalFile", "CreateCalFileByNames",
39 "AlignDetectors", "DiffractionFocussing", "LoadCalFile", "MergeCalFiles"};
40 }
42 const std::string category() const override { return R"(DataHandling\Text;Diffraction\DataHandling\CalFiles)"; }
43
44 void saveCalFile(const std::string &calFileName, const Mantid::DataObjects::GroupingWorkspace_sptr &groupWS,
47
48private:
50 void init() override;
52 void exec() override;
53
55 int m_precision{7};
56};
57
58} // namespace DataHandling
59} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Algorithm to save a 5-column ascii .cal file from to 3 workspaces: a GroupingWorkspace,...
Definition: SaveCalFile.h:25
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: SaveCalFile.h:37
const std::string category() const override
Algorithm's category for identification.
Definition: SaveCalFile.h:42
const std::string name() const override
Algorithm's name for identification.
Definition: SaveCalFile.h:28
int version() const override
Algorithm's version for identification.
Definition: SaveCalFile.h:36
const std::string summary() const override
Summary of algorithms purpose.
Definition: SaveCalFile.h:30
std::shared_ptr< GroupingWorkspace > GroupingWorkspace_sptr
shared pointer to the GroupingWorkspace class
std::shared_ptr< MaskWorkspace > MaskWorkspace_sptr
shared pointer to the MaskWorkspace class
Definition: MaskWorkspace.h:64
std::shared_ptr< OffsetsWorkspace > OffsetsWorkspace_sptr
shared pointer to the OffsetsWorkspace class
Helper class which provides the Collimation Length for SANS instruments.