ConvertToMD.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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/BoxControllerSettingsAlgorithm.h"
#include "MantidMDAlgorithms/ConvertToMDParent.h"
#include "MantidMDAlgorithms/MDWSDescription.h"
 
#include "MantidKernel/DeltaEMode.h"
 
namespace Mantid {
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL ConvertToMD : public ConvertToMDParent {
public:
  const std::string name() const override;
  const std::string summary() const override {
    return "Create a MDEventWorkspace with selected dimensions, e.g. the "
           "reciprocal space of momentums (Qx, Qy, Qz) or momentums modules "
           "mod(Q), energy transfer dE if available and any other user "
           "specified log values which can be treated as dimensions.";
  }
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override {
    return {"ConvertToDiffractionMDWorkspace", "ConvertToMDMinMaxGlobal", "ConvertToMDMinMaxLocal", "CreateMDWorkspace",
            "SetSpecialCoordinates"};
  }
 
private:
  std::map<std::string, std::string> validateInputs() override;
  void exec() override;
  void init() override;
  std::unique_ptr<API::Progress> m_Progress;
 
  void setupFileBackend(const std::string &filebackPath, const API::IMDEventWorkspace_sptr &outputWS);
 
  //------------------------------------------------------------------------------------------------------------------------------------------
protected: // for testing, otherwise private:
  Mantid::API::MatrixWorkspace_sptr m_InWS2D;
  // TODO: This will eventually go. ///The pointer to class which keeps output
  // MD workspace and is responsible for adding data to N-dimensional workspace;
  std::shared_ptr<MDAlgorithms::MDEventWSWrapper> m_OutWSWrapper;
 
  // Workflow helpers:
  bool doWeNeedNewTargetWorkspace(const API::IMDEventWorkspace_sptr &spws);
  API::IMDEventWorkspace_sptr createNewMDWorkspace(const MDAlgorithms::MDWSDescription &targWSDescr,
                                                   const bool filebackend, const std::string &filename);
 
  bool buildTargetWSDescription(const API::IMDEventWorkspace_sptr &spws, const std::string &QModReq,
                                const std::string &dEModReq, const std::vector<std::string> &otherDimNames,
                                std::vector<double> &dimMin, std::vector<double> &dimMax, const std::string &QFrame,
                                const std::string &convertTo_, MDAlgorithms::MDWSDescription &targWSDescr);
 
  void addExperimentInfo(API::IMDEventWorkspace_sptr &mdEventWS, MDAlgorithms::MDWSDescription &targWSDescr) const;
 
  void copyMetaData(API::IMDEventWorkspace_sptr &mdEventWS) const;
 
  void findMinMax(const Mantid::API::MatrixWorkspace_sptr &inWS, const std::string &QMode, const std::string &dEMode,
                  const std::string &QFrame, const std::string &ConvertTo, const std::vector<std::string> &otherDim,
                  std::vector<double> &minVal, std::vector<double> &maxVal);
 
  void setupTopLevelSplitting(const Mantid::API::BoxController_sptr &bc);
};
 
} // namespace MDAlgorithms
} // namespace Mantid