MDAlgorithmsTestHelper.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 +
/*********************************************************************************
 *  PLEASE READ THIS!!!!!!!
 *
 *  This collection of functions MAY ONLY be used in packages above MDAlgorithms
 *********************************************************************************/
#include "MantidFrameworkTestHelpers/MDAlgorithmsTestHelper.h"
 
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/FrameworkManager.h"
#include "MantidFrameworkTestHelpers/MDEventsTestHelper.h"
#include "MantidKernel/Strings.h"
 
namespace Mantid {
using namespace API;
using namespace DataObjects;
 
namespace MDAlgorithms::MDAlgorithmsTestHelper {
 
std::string makeUniqueId() { return Kernel::Strings::randomString(12); }
 
DataObjects::MDEventWorkspace3Lean::sptr makeFileBackedMDEW(const std::string &wsName, bool fileBacked, long numEvents,
                                                            Kernel::SpecialCoordinateSystem coord) {
  // ---------- Make a file-backed MDEventWorkspace -----------------------
  std::string snEvents = std::to_string(numEvents);
  MDEventWorkspace3Lean::sptr ws1 = MDEventsTestHelper::makeMDEW<3>(10, 0.0, 10.0, 0);
  ws1->getBoxController()->setSplitThreshold(100);
  ws1->setCoordinateSystem(coord);
  Mantid::API::AnalysisDataService::Instance().addOrReplace(
      wsName, std::dynamic_pointer_cast<Mantid::API::IMDEventWorkspace>(ws1));
  FrameworkManager::Instance().exec("FakeMDEventData", 6, "InputWorkspace", wsName.c_str(), "UniformParams",
                                    snEvents.c_str(), "RandomizeSignal", "1");
  if (fileBacked) {
    std::string filename = wsName + ".nxs";
    auto saver =
        FrameworkManager::Instance().exec("SaveMD", 4, "InputWorkspace", wsName.c_str(), "Filename", filename.c_str());
    FrameworkManager::Instance().exec("LoadMD", 8, "OutputWorkspace", wsName.c_str(), "Filename",
                                      saver->getPropertyValue("Filename").c_str(), "FileBackEnd", "1", "Memory", "0");
  }
  return std::dynamic_pointer_cast<MDEventWorkspace3Lean>(
      Mantid::API::AnalysisDataService::Instance().retrieve(wsName));
}
 
DataObjects::MDEventWorkspace3Lean::sptr makeFileBackedMDEWwithMDFrame(const std::string &wsName, bool fileBacked,
                                                                       const Mantid::Geometry::MDFrame &frame,
                                                                       long numEvents,
                                                                       Kernel::SpecialCoordinateSystem coord) {
  // ---------- Make a file-backed MDEventWorkspace -----------------------
  std::string snEvents = std::to_string(numEvents);
  MDEventWorkspace3Lean::sptr ws1 =
      MDEventsTestHelper::makeAnyMDEWWithFrames<MDLeanEvent<3>, 3>(10, 0.0, 10.0, frame, 0);
  ws1->getBoxController()->setSplitThreshold(100);
  ws1->setCoordinateSystem(coord);
  Mantid::API::AnalysisDataService::Instance().addOrReplace(
      wsName, std::dynamic_pointer_cast<Mantid::API::IMDEventWorkspace>(ws1));
  FrameworkManager::Instance().exec("FakeMDEventData", 6, "InputWorkspace", wsName.c_str(), "UniformParams",
                                    snEvents.c_str(), "RandomizeSignal", "1");
  if (fileBacked) {
    std::string filename = wsName + ".nxs";
    auto saver =
        FrameworkManager::Instance().exec("SaveMD", 4, "InputWorkspace", wsName.c_str(), "Filename", filename.c_str());
    FrameworkManager::Instance().exec("LoadMD", 8, "OutputWorkspace", wsName.c_str(), "Filename",
                                      saver->getPropertyValue("Filename").c_str(), "FileBackEnd", "1", "Memory", "0");
  }
  return std::dynamic_pointer_cast<MDEventWorkspace3Lean>(
      Mantid::API::AnalysisDataService::Instance().retrieve(wsName));
}
 
} // namespace MDAlgorithms::MDAlgorithmsTestHelper
} // namespace Mantid