Mantid
Loading...
Searching...
No Matches
LoadNXcanSAS.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2016 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 "MantidDataHandling/DllConfig.h"
12
13namespace H5 {
14class Group;
15}
16
17namespace Mantid {
18namespace DataHandling {
19
23class MANTID_DATAHANDLING_DLL LoadNXcanSAS : public API::IFileLoader<Kernel::NexusDescriptor> {
24public:
28 ~LoadNXcanSAS() override = default;
29 const std::string name() const override { return "LoadNXcanSAS"; }
31 const std::string summary() const override { return "Loads an HDF5 NXcanSAS file into a MatrixWorkspace."; }
32
34 int version() const override { return (1); }
35 const std::vector<std::string> seeAlso() const override { return {"LoadCanSAS1D", "SaveNXcanSAS"}; }
37 const std::string category() const override { return "DataHandling\\Nexus"; }
38
40 int confidence(Kernel::NexusDescriptor &descriptor) const override;
41
42private:
44 void loadTransmission(H5::Group &entry, const std::string &name);
46 void init() override;
48 void exec() override;
49};
50
51} // namespace DataHandling
52} // namespace Mantid
Defines an interface to an algorithm that loads a file so that it can take part in the automatic sele...
Definition: IFileLoader.h:19
LoadNXcanSAS : Tries to load an NXcanSAS file type into a Workspace2D.
Definition: LoadNXcanSAS.h:23
~LoadNXcanSAS() override=default
Virtual dtor.
const std::string category() const override
Algorithm's category for identification.
Definition: LoadNXcanSAS.h:37
int version() const override
Algorithm's version.
Definition: LoadNXcanSAS.h:34
const std::string summary() const override
Summary of algorithms purpose.
Definition: LoadNXcanSAS.h:31
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: LoadNXcanSAS.h:35
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
Definition: LoadNXcanSAS.h:29
Defines a wrapper around a file whose internal structure can be accessed using the NeXus API.
Definition: H5Util.h:16
Helper class which provides the Collimation Length for SANS instruments.