MDGeometry.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/DllConfig.h"
#include "MantidGeometry/MDGeometry/MDTypes.h"
#include "MantidKernel/Matrix.h"
#include "MantidKernel/VMD.h"
#include <memory>
 
#include <memory>
 
namespace Mantid {
namespace Geometry {
class IMDDimension;
}
namespace API {
class CoordTransform;
class IMDWorkspace;
class MDGeometryNotificationHelper;
class Workspace;
 
class MANTID_API_DLL MDGeometry {
public:
  MDGeometry();
  MDGeometry(const MDGeometry &other);
  MDGeometry &operator=(const MDGeometry &other);
  virtual ~MDGeometry();
  void initGeometry(const std::vector<std::shared_ptr<Geometry::IMDDimension>> &dimensions);
 
  // --------------------------------------------------------------------------------------------
  // These are the main methods for dimensions, that CAN be overridden (e.g. by
  // MatrixWorkspace)
  virtual size_t getNumDims() const;
  virtual size_t getNumNonIntegratedDims() const;
  virtual std::shared_ptr<const Mantid::Geometry::IMDDimension> getDimension(size_t index) const;
  virtual std::shared_ptr<const Mantid::Geometry::IMDDimension> getDimensionWithId(std::string id) const;
  size_t getDimensionIndexByName(const std::string &name) const;
  size_t getDimensionIndexById(const std::string &id) const;
  std::vector<std::shared_ptr<const Geometry::IMDDimension>> getNonIntegratedDimensions() const;
  virtual std::vector<coord_t> estimateResolution() const;
 
  // --------------------------------------------------------------------------------------------
  std::shared_ptr<const Mantid::Geometry::IMDDimension> getXDimension() const;
  std::shared_ptr<const Mantid::Geometry::IMDDimension> getYDimension() const;
  std::shared_ptr<const Mantid::Geometry::IMDDimension> getZDimension() const;
  std::shared_ptr<const Mantid::Geometry::IMDDimension> getTDimension() const;
 
  std::string getGeometryXML() const;
 
  void addDimension(const std::shared_ptr<Mantid::Geometry::IMDDimension> &dim);
  void addDimension(Mantid::Geometry::IMDDimension *dim);
 
  // --------------------------------------------------------------------------------------------
  Mantid::Kernel::VMD &getBasisVector(size_t index);
  const Mantid::Kernel::VMD &getBasisVector(size_t index) const;
  void setBasisVector(size_t index, const Mantid::Kernel::VMD &vec);
  bool allBasisNormalized() const;
 
  // --------------------------------------------------------------------------------------------
  bool hasOriginalWorkspace(size_t index = 0) const;
  size_t numOriginalWorkspaces() const;
  std::shared_ptr<Workspace> getOriginalWorkspace(size_t index = 0) const;
  void setOriginalWorkspace(std::shared_ptr<Workspace> ws, size_t index = 0);
  Mantid::API::CoordTransform const *getTransformFromOriginal(size_t index = 0) const;
  void setTransformFromOriginal(Mantid::API::CoordTransform *transform, size_t index = 0);
  Mantid::API::CoordTransform const *getTransformToOriginal(size_t index = 0) const;
  void setTransformToOriginal(Mantid::API::CoordTransform *transform, size_t index = 0);
 
  void transformDimensions(std::vector<double> const &scaling, std::vector<double> const &offset);
 
  size_t getNumberTransformsToOriginal() const;
  size_t getNumberTransformsFromOriginal() const;
 
  // --------------------------------------------------------------------------------------------
  Mantid::Kernel::VMD &getOrigin() { return m_origin; }
 
  const Mantid::Kernel::VMD &getOrigin() const { return m_origin; }
 
  void setOrigin(const Mantid::Kernel::VMD &orig) { m_origin = orig; }
  void setWTransf(const Kernel::DblMatrix &WTransf) { m_Wtransf = WTransf; }
  const Kernel::DblMatrix &getWTransf() const { return m_Wtransf; }
 
  void clearTransforms();
  void clearOriginalWorkspaces();
 
  friend class MDGeometryNotificationHelper;
 
protected:
  void deleteNotificationReceived(const std::shared_ptr<const Workspace> &replaced);
 
  void replaceNotificationReceived(const std::shared_ptr<const Workspace> &deleted);
 
  std::vector<std::shared_ptr<Geometry::IMDDimension>> m_dimensions;
 
  std::vector<std::shared_ptr<Workspace>> m_originalWorkspaces;
 
  Mantid::Kernel::VMD m_origin;
 
  std::vector<std::shared_ptr<const Mantid::API::CoordTransform>> m_transforms_FromOriginal;
 
  std::vector<std::shared_ptr<const Mantid::API::CoordTransform>> m_transforms_ToOriginal;
 
  std::unique_ptr<MDGeometryNotificationHelper> m_notificationHelper;
 
  Kernel::DblMatrix m_Wtransf; // TODO: should be reconciled with the vectors
                               // below and be either always synchroneous or
                               // only one set remains
  std::vector<Mantid::Kernel::VMD> m_basisVectors;
};
 
} // namespace API
} // namespace Mantid