Mantid
Loading...
Searching...
No Matches
LoadIDFFromNexus.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2013 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//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
12#include "MantidAPI/Algorithm.h"
13#include "MantidDataHandling/DllConfig.h"
14
15namespace Mantid {
16namespace DataHandling {
38class MANTID_DATAHANDLING_DLL LoadIDFFromNexus final : public API::Algorithm {
39public:
43 const std::string name() const override { return "LoadIDFFromNexus"; }
45 const std::string summary() const override {
46 return "Load an IDF from a Nexus file, if found there. You may need to "
47 "tell this algorithm where to find the Instrument folder in the "
48 "Nexus file";
49 }
50
52 std::string getParameterCorrectionFile(const std::string &instName);
53
56 void readParameterCorrectionFile(const std::string &correction_file, const std::string &date,
57 std::string &parameter_file, bool &append);
58
61 void LoadParameters(::NeXus::File *nxfile, const API::MatrixWorkspace_sptr &localWorkspace);
62
64 int version() const override { return 1; }
65
67 const std::string category() const override { return "DataHandling\\Instrument"; }
68
69private:
71 void init() override;
73 void exec() override;
76 bool loadParameterFile(const std::string &fullPathName, const API::MatrixWorkspace_sptr &localWorkspace);
77};
78
79} // namespace DataHandling
80} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
DataHandling/LoadIDFFromNexus.h.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
const std::string summary() const override
Summary of algorithms purpose.
LoadIDFFromNexus()
Default constructor.
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.