Mantid
Loading...
Searching...
No Matches
SavePolarizedNXcanSAS.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2025 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
9#include "MantidDataHandling/DllConfig.h"
11
12namespace Mantid {
13namespace DataHandling {
14
17class MANTID_DATAHANDLING_DLL SavePolarizedNXcanSAS final : public SaveNXcanSASBase {
18public:
22 ~SavePolarizedNXcanSAS() override = default;
23 const std::string name() const override { return "SavePolarizedNXcanSAS"; }
24 const std::string summary() const override {
25 return "Save a Group Workspace with reduced SANS polarized data in NXcanSAS Format.";
26 }
27
30 bool checkGroups() override { return false; }
31
33 int version() const override { return (1); }
34 const std::vector<std::string> seeAlso() const override { return {"SaveNXcanSAS", "LoadNXcanSAS"}; }
36 const std::string category() const override { return "DataHandling\\Nexus"; }
37
38 std::map<std::string, std::string> validateInputs() override;
39
40private:
42 void init() override;
44 void exec() override;
45};
46
47} // namespace DataHandling
48} // namespace Mantid
SaveNXcanSASBase : Base class to save a reduced workspace in the NXcanSAS format.
SavePolarizedNXcanSAS : Extends SaveNXcanSAS adding metadata for polarized SANS measurements.
bool checkGroups() override
InputWorkspace property only accepts workspace groups so we don't want the base algorithm class to pr...
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
int version() const override
Algorithm's version.
const std::string category() const override
Algorithm's category for identification.
~SavePolarizedNXcanSAS() override=default
Virtual dtor.
const std::string name() const override
function to return a name 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.