MDBoxFlatTree.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/BoxController.h"
#include "MantidDataObjects/MDBox.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include "MantidDataObjects/MDGridBox.h"
#include "MantidKernel/Matrix.h"
#include "MantidKernel/NexusHDF5Descriptor.h"
 
namespace Mantid {
namespace DataObjects {
//===============================================================================================
class MANTID_DATAOBJECTS_DLL MDBoxFlatTree {
public:
  MDBoxFlatTree();
 
  const std::string &getBCXMLdescr() const { return m_bcXMLDescr; }
 
  //---------------------------------------------------------------------------------------------------------------------
  std::vector<API::IMDNode *> &getBoxes() { return m_Boxes; }
  size_t getNBoxes() const { return m_BoxType.size(); }
  std::vector<double> &getSigErrData() { return m_BoxSignalErrorsquared; }
  std::vector<uint64_t> &getEventIndex() { return m_BoxEventIndex; }
  const std::vector<int> &getBoxType() const { return m_BoxType; }
 
  //---------------------------------------------------------------------------------------------------------------------
  void initFlatStructure(const API::IMDEventWorkspace_sptr &pws, const std::string &fileName);
 
  uint64_t restoreBoxTree(std::vector<API::IMDNode *> &Boxes, API::BoxController_sptr &bc, bool FileBackEnd,
                          bool BoxStructureOnly = false);
 
  /*** this function tries to set file positions of the boxes to
        make data physically located close to each other to be as close as
     possible on the HDD */
  void setBoxesFilePositions(bool setFileBacked);
 
  void saveBoxStructure(const std::string &fileName);
  void loadBoxStructure(const std::string &fileName, int &nDim, const std::string &EventType,
                        bool onlyEventInfo = false, bool restoreExperimentInfo = false);
 
  void exportExperiment(Mantid::API::IMDEventWorkspace_sptr &targetWS);
 
  int getNDims() const { return m_nDim; }
 
protected: // for testing
private:
  void loadBoxStructure(::NeXus::File *hFile, bool onlyEventInfo = false);
  void saveBoxStructure(::NeXus::File *hFile);
  //----------------------------------------------------------------------------------------------
  int m_nDim;
  // The name of the file the class will be working with
  std::string m_FileName;
  std::vector<int> m_BoxType;
  std::vector<int> m_Depth;
  std::vector<uint64_t> m_BoxEventIndex;
  std::vector<double> m_Extents;
  std::vector<double> m_InverseVolume;
  std::vector<double> m_BoxSignalErrorsquared;
  std::vector<int> m_BoxChildren;
  std::vector<API::IMDNode *> m_Boxes;
  std::string m_bcXMLDescr;
  std::string m_eventType;
  std::shared_ptr<API::MultipleExperimentInfos> m_mEI;
 
public:
  static ::NeXus::File *createOrOpenMDWSgroup(const std::string &fileName, int &nDims, const std::string &WSEventType,
                                              bool readOnly, bool &alreadyExists);
  // save each experiment info into its own NeXus group within an existing
  // opened group
  static void saveExperimentInfos(::NeXus::File *const file, const API::IMDEventWorkspace_const_sptr &ws);
 
  // load experiment infos, previously saved through the the saveExperimentInfo
  // function. Overload version that usese NexusHDF5Descriptor for LoadMD
  static void loadExperimentInfos(::NeXus::File *const file, const std::string &filename,
                                  std::shared_ptr<API::MultipleExperimentInfos> mei,
                                  const Mantid::Kernel::NexusHDF5Descriptor &fileInfo, const std::string &currentGroup,
                                  bool lazy = false);
 
  // load experiment infos, previously saved through the the saveExperimentInfo
  // function
  static void loadExperimentInfos(::NeXus::File *const file, const std::string &filename,
                                  const std::shared_ptr<API::MultipleExperimentInfos> &mei, bool lazy = false);
 
  static void saveAffineTransformMatricies(::NeXus::File *const file, const API::IMDWorkspace_const_sptr &ws);
  static void saveAffineTransformMatrix(::NeXus::File *const file, API::CoordTransform const *transform,
                                        const std::string &entry_name);
 
  static void saveWSGenericInfo(::NeXus::File *const file, const API::IMDWorkspace_const_sptr &ws);
};
 
template <typename T>
void saveMatrix(::NeXus::File *const file, const std::string &name, Kernel::Matrix<T> &m, ::NeXus::NXnumtype type,
                const std::string &tag);
} // namespace DataObjects
} // namespace Mantid