CoordTransform.h

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 +
#pragma once
 
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/SingleValueParameter.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDTypes.h"
#include "MantidKernel/Matrix.h"
#include "MantidKernel/VMD.h"
#include <memory>
 
namespace Mantid {
namespace API {
DECLARE_SINGLE_VALUE_PARAMETER(InDimParameter, size_t)
DECLARE_SINGLE_VALUE_PARAMETER(OutDimParameter, size_t)
 
 
class MANTID_API_DLL CoordTransform {
public:
  CoordTransform(const size_t inD, const size_t outD);
  virtual ~CoordTransform() = default;
 
  virtual std::string toXMLString() const = 0;
  virtual void apply(const coord_t *inputVector, coord_t *outVector) const = 0;
  virtual CoordTransform *clone() const = 0;
  virtual std::string id() const = 0;
 
  Mantid::Kernel::VMD applyVMD(const Mantid::Kernel::VMD &inputVector) const;
 
  size_t getInD() const { return inD; };
 
  size_t getOutD() const { return outD; };
 
  virtual Mantid::Kernel::Matrix<coord_t> makeAffineMatrix() const {
    throw std::runtime_error("This coordinate transformation does not have an "
                             "equivalent affine matrix.");
  }
 
protected:
  size_t inD;
 
  size_t outD;
};
 
// Helper typedef for a shared pointer of this type.
using CoordTransform_sptr = std::shared_ptr<CoordTransform>;
 
// Helper typdef for a const shared pointer of this type.
using CoordTransform_const_sptr = std::shared_ptr<const CoordTransform>;
 
} // namespace API
} // namespace Mantid