mitkAbstractTransformGeometry.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkAbstractTransformGeometry_h
#define mitkAbstractTransformGeometry_h
 
#include <mitkPlaneGeometry.h>
#include <MitkCoreExports.h>
 
#include <itkVtkAbstractTransform.h>
 
class vtkAbstractTransform;
 
namespace mitk
{
  class MITKCORE_EXPORT AbstractTransformGeometry : public PlaneGeometry
  {
  public:
    mitkClassMacro(AbstractTransformGeometry, PlaneGeometry);
 
    itkFactorylessNewMacro(Self);
 
    itkCloneMacro(Self);
 
      virtual vtkAbstractTransform *GetVtkAbstractTransform() const;
 
    itk::ModifiedTimeType GetMTime() const override;
 
    itkGetConstObjectMacro(Plane, PlaneGeometry);
 
    bool Project(const mitk::Point3D &pt3d_mm, mitk::Point3D &projectedPt3d_mm) const override;
 
    bool Project(const mitk::Vector3D &vec3d_mm, mitk::Vector3D &projectedVec3d_mm) const override;
 
    bool Map(const mitk::Point3D &pt3d_mm, mitk::Point2D &pt2d_mm) const override;
 
    void Map(const mitk::Point2D &pt2d_mm, mitk::Point3D &pt3d_mm) const override;
 
    bool Map(const mitk::Point3D &atPt3d_mm,
                     const mitk::Vector3D &vec3d_mm,
                     mitk::Vector2D &vec2d_mm) const override;
 
    void Map(const mitk::Point2D &atPt2d_mm,
                     const mitk::Vector2D &vec2d_mm,
                     mitk::Vector3D &vec3d_mm) const override;
 
    void IndexToWorld(const mitk::Point2D &pt_units, mitk::Point2D &pt_mm) const override;
 
    void WorldToIndex(const mitk::Point2D &pt_mm, mitk::Point2D &pt_units) const override;
 
    void IndexToWorld(const mitk::Vector2D &vec_units, mitk::Vector2D &vec_mm) const override;
 
    void WorldToIndex(const mitk::Vector2D &vec_mm, mitk::Vector2D &vec_units) const override;
 
    bool IsAbove(const Point3D &pt3d_mm, bool considerBoundingBox = false) const override;
 
    virtual mitk::ScalarType GetParametricExtentInMM(int direction) const;
 
    virtual const itk::Transform<mitk::ScalarType, 3, 3> *GetParametricTransform() const;
 
    virtual void SetOversampling(mitk::ScalarType oversampling);
 
    virtual void CalculateFrameGeometry();
 
    virtual void SetFrameGeometry(const mitk::BaseGeometry *frameGeometry);
 
    itkGetConstObjectMacro(ParametricBoundingBox, BoundingBox);
 
    const BoundingBox::BoundsArrayType &GetParametricBounds() const;
 
    mitk::ScalarType GetParametricExtent(int direction) const;
 
  protected:
    AbstractTransformGeometry();
    AbstractTransformGeometry(const AbstractTransformGeometry &other);
 
    ~AbstractTransformGeometry() override;
 
    //##Documentation
    //## @brief Set the vtkAbstractTransform (stored in m_VtkAbstractTransform)
    //##
    //## Protected in this class, made public in ExternAbstractTransformGeometry.
    virtual void SetVtkAbstractTransform(vtkAbstractTransform *aVtkAbstractTransform);
 
    //##Documentation
    //## @brief Set the rectangular area that is used for transformation by
    //## m_VtkAbstractTransform and therewith defines the 2D manifold described by
    //## ExternAbstractTransformGeometry
    //##
    //## Protected in this class, made public in ExternAbstractTransformGeometry.
    //## @note The bounds of the PlaneGeometry are used as the parametric bounds.
    //## @note The PlaneGeometry is cloned, @em not linked/referenced.
    virtual void SetPlane(const mitk::PlaneGeometry *aPlane);
 
    //##Documentation
    //## @brief The rectangular area that is used for transformation by
    //## m_VtkAbstractTransform and therewith defines the 2D manifold described by
    //## AbstractTransformGeometry.
    mitk::PlaneGeometry::Pointer m_Plane;
 
    itk::VtkAbstractTransform<ScalarType>::Pointer m_ItkVtkAbstractTransform;
 
    mitk::BaseGeometry::Pointer m_FrameGeometry;
 
    //##Documentation
    //## @brief Set the parametric bounds
    //##
    //## Protected in this class, made public in some sub-classes, e.g.,
    //## ExternAbstractTransformGeometry.
    virtual void SetParametricBounds(const BoundingBox::BoundsArrayType &bounds);
 
    mutable mitk::BoundingBox::Pointer m_ParametricBoundingBox;
 
    //##Documentation
    //## @brief PreSetSpacing
    //##
    //## These virtual function allows a different beahiour in subclasses.
    //## Do implement them in every subclass of BaseGeometry. If not needed, use
    //## {Superclass::PreSetSpacing();};
    void PreSetSpacing(const mitk::Vector3D &aSpacing) override { Superclass::PreSetSpacing(aSpacing); };
 
    mitkCloneMacro(Self);
  };
} // namespace mitk
#endif