MergeMDFiles.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/Algorithm.h"
#include "MantidAPI/IMDEventWorkspace_fwd.h"
#include "MantidDataObjects/MDBoxFlatTree.h"
#include "MantidMDAlgorithms/DllConfig.h"
#include <mutex>
 
namespace Mantid {
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL MergeMDFiles final : public API::Algorithm {
public:
  MergeMDFiles();
  ~MergeMDFiles() override;
 
  const std::string name() const override { return "MergeMDFiles"; };
  const std::string summary() const override {
    return "Merge multiple MDEventWorkspaces from files that obey a common box "
           "format.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"MergeMD"}; }
  const std::string category() const override { return "MDAlgorithms\\Creation"; }
 
private:
  void init() override;
  void exec() override;
 
  void loadBoxData();
 
  void doExecByCloning(const Mantid::API::IMDEventWorkspace_sptr &ws, const std::string &outputFile);
 
  void finalizeOutput(const std::string &outputFile);
 
  uint64_t loadEventsFromSubBoxes(API::IMDNode *TargetBox);
 
  // the class which flatten the box structure and deal with it
  DataObjects::MDBoxFlatTree m_BoxStruct;
  // the vector of box structures for contributing files components
  std::vector<DataObjects::MDBoxFlatTree> m_fileComponentsStructure;
 
protected:
  // bool clonedFirst;
  void clearEventLoaders();
 
  int m_nDims;
  std::string m_MDEventType;
 
  bool m_fileBasedTargetWS;
  std::vector<std::string> m_Filenames;
 
  std::vector<API::IBoxControllerIO *> m_EventLoader;
 
  Mantid::API::IMDEventWorkspace_sptr m_OutIWS;
 
  uint64_t m_totalEvents;
 
  uint64_t m_totalLoaded;
 
  std::mutex m_fileMutex;
 
  std::mutex m_statsMutex;
 
  std::unique_ptr<Mantid::API::Progress> m_progress = nullptr;
};
 
} // namespace MDAlgorithms
} // namespace Mantid