LoadNXcanSAS.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/IFileLoader.h"
#include "MantidAPI/Progress.h"
#include "MantidAPI/Sample.h"
#include "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataHandling/NXcanSASUtil.h"
#include "MantidNexus/NexusDescriptor.h"
 
namespace H5 {
class Group;
class DataSet;
} // namespace H5
 
namespace Mantid::DataHandling::NXcanSAS {
class MANTID_DATAHANDLING_DLL LoadNXcanSAS : public API::IFileLoader<Nexus::NexusDescriptor> {
public:
  LoadNXcanSAS();
  ~LoadNXcanSAS() override = default;
  const std::string name() const override { return "LoadNXcanSAS"; }
  const std::string summary() const override { return "Loads an HDF5 NXcanSAS file into a MatrixWorkspace."; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"LoadCanSAS1D", "SaveNXcanSAS"}; }
  const std::string category() const override { return "DataHandling\\Nexus"; }
 
  int confidence(Nexus::NexusDescriptor &descriptor) const override;
 
private:
  void loadTransmission(const H5::Group &entry, const std::string &name, const InstrumentNameInfo &instrumentInfo);
  void loadData(const H5::Group &dataGroup, const Mantid::API::MatrixWorkspace_sptr &workspace,
                const std::pair<size_t, size_t> &spinIndexPair) const;
  void loadMetadata(const H5::Group &group, const Mantid::API::MatrixWorkspace_sptr &workspace,
                    const InstrumentNameInfo &instrumentInfo, const std::optional<API::Sample> &sample,
                    bool hasPolarizedData = false) const;
 
  Mantid::API::WorkspaceGroup_sptr transferFileDataIntoWorkspace(const H5::Group &group,
                                                                 const DataSpaceInformation &dataInfo,
                                                                 const InstrumentNameInfo &instrumentInfo);
  std::vector<SpinState> prepareDataDimensions(const H5::Group &group, const DataSpaceInformation &dataInfo);
 
  void init() override;
  void exec() override;
 
  std::unique_ptr<API::Progress> m_progress;
  std::unique_ptr<NXcanSAS::DataDimensions> m_dataDims;
};
} // namespace Mantid::DataHandling::NXcanSAS