CoordTransform.h

#ifndef MANTID_MDEVENTS_COORDTRANSFORM_H_
#define MANTID_MDEVENTS_COORDTRANSFORM_H_

#include "MantidAPI/SingleValueParameter.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDTypes.h"
#include "MantidKernel/Matrix.h"
#include "MantidKernel/System.h"
#include "MantidKernel/VMD.h"
#include <boost/shared_ptr.hpp>

namespace Mantid {
namespace API {
/// Unique SingleValueParameter Declaration for InputNDimensions
DECLARE_SINGLE_VALUE_PARAMETER(InDimParameter, size_t)
/// Unique SingleValueParaemter Declaration for OutputNDimensions
DECLARE_SINGLE_VALUE_PARAMETER(OutDimParameter, size_t)

/** Abstract class for transforming coordinate systems.
 * This will be subclassed by e.g. CoordTransformAffine to perform
 * rotations, etc.
 *
 * @author Janik Zikovsky
 * @date 2011-04-14
 */
class DLLExport CoordTransform {
public:
  CoordTransform(const size_t inD, const size_t outD);
  virtual ~CoordTransform() = default;

  /// Pure abstract methods to be implemented
  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;

  /// Wrapper for VMD
  Mantid::Kernel::VMD applyVMD(const Mantid::Kernel::VMD &inputVector) const;

  /// @return the number of input dimensions
  size_t getInD() const { return inD; };

  /// @return the number of output dimensions
  size_t getOutD() const { return outD; };

  /// @return the affine matrix equivalent to this transformation, if possible
  /// @throw std::runtime_error if there is no possible affine matrix
  virtual Mantid::Kernel::Matrix<coord_t> makeAffineMatrix() const {
    throw std::runtime_error("This coordinate transformation does not have an "
                             "equivalent affine matrix.");
  }

protected:
  /// Input number of dimensions
  size_t inD;

  /// Output number of dimensions
  size_t outD;
};

// Helper typedef for a shared pointer of this type.
typedef boost::shared_ptr<CoordTransform> CoordTransform_sptr;

// Helper typdef for a const shared pointer of this type.
typedef boost::shared_ptr<const CoordTransform> CoordTransform_const_sptr;

} // namespace Mantid
} // namespace API

#endif /* MANTID_MDEVENTS_COORDTRANSFORM_H_ */