LoadMD.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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/DataProcessorAlgorithm.h"
#include "MantidAPI/IFileLoader.h"
#include "MantidAPI/IMDEventWorkspace_fwd.h"
#include "MantidAPI/NexusFileLoader.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include "MantidKernel/NexusDescriptor.h"
#include "MantidMDAlgorithms/DllConfig.h"
 
#include <boost/optional.hpp>
#include <boost/scoped_ptr.hpp>
 
namespace Mantid {
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL LoadMD : public API::NexusFileLoader {
public:
  LoadMD();
 
  const std::string name() const override { return "LoadMD"; };
  const std::string summary() const override { return "Load a MDEventWorkspace in .nxs format."; }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"SaveMD"}; }
  const std::string category() const override { return "MDAlgorithms\\DataHandling"; }
 
  int confidence(Kernel::NexusHDF5Descriptor &descriptor) const override;
 
private:
  void init() override;
  void execLoader() override;
 
  // ki-kf for Inelastic convention; kf-ki for Crystallography convention
  std::string convention;
 
  template <typename MDE, size_t nd> void doLoad(typename DataObjects::MDEventWorkspace<MDE, nd>::sptr ws);
 
  void loadExperimentInfos(std::shared_ptr<Mantid::API::MultipleExperimentInfos> ws);
 
  void loadSlab(const std::string &name, void *data, const DataObjects::MDHistoWorkspace_sptr &ws,
                ::NeXus::NXnumtype dataType);
  void loadHisto();
 
  void loadDimensions();
 
  void loadDimensions2();
 
  void loadCoordinateSystem();
 
  void loadQConvention();
 
  void loadVisualNormalization(const std::string &key, boost::optional<Mantid::API::MDNormalization> &normalization);
 
  void loadAffineMatricies(const API::IMDWorkspace_sptr &ws);
  API::CoordTransform *loadAffineMatrix(const std::string &entry_name);
 
  void setMDFrameOnWorkspaceFromLegacyFile(const API::IMDWorkspace_sptr &ws);
 
  void checkForRequiredLegacyFixup(const API::IMDWorkspace_sptr &ws);
 
  std::vector<double> qDimensions(const API::IMDWorkspace_sptr &ws);
 
  // clang-format off
  boost::scoped_ptr< ::NeXus::File> m_file;
  // clang-format on
 
  std::string m_filename;
 
  size_t m_numDims;
 
  std::vector<Mantid::Geometry::IMDDimension_sptr> m_dims;
  Kernel::SpecialCoordinateSystem m_coordSystem;
  std::string m_QConvention;
  bool m_BoxStructureAndMethadata;
 
  int m_saveMDVersion;
 
  boost::optional<Mantid::API::MDNormalization> m_visualNormalization;
  boost::optional<Mantid::API::MDNormalization> m_visualNormalizationHisto;
 
  static const std::string VISUAL_NORMALIZATION_KEY;
  static const std::string VISUAL_NORMALIZATION_KEY_HISTO;
 
  bool m_requiresMDFrameCorrection;
};
 
} // namespace MDAlgorithms
} // namespace Mantid