mitkLandmarkProjector.h

Go to the documentation of this file.

/*=========================================================================

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.

=========================================================================*/


#ifndef MITKLANDMARKPROJECTOR_H_HEADER_INCLUDED_C1C68A2C
#define MITKLANDMARKPROJECTOR_H_HEADER_INCLUDED_C1C68A2C

#include "mitkCommon.h"
#include "itkObject.h"

#include "mitkPlaneGeometry.h"
#include "mitkPointSet.h"

class vtkAbstractTransform;

namespace mitk {

//##Documentation
//## @brief Base-class of landmark-projectors, which project the target landmarks
//## to create source landmarks.
//## 
//## @ingroup Geometry
class MITK_CORE_EXPORT LandmarkProjector : public itk::Object
{
public:
  mitkClassMacro(LandmarkProjector, itk::Object);
  
  //##Documentation
  //## @brief Set the interpolating (world-space-to-world-space) transform, 
  //## which uses the landmarks.
  //##
  //## \sa GetCompleteAbstractTransform
  virtual void SetInterpolatingAbstractTransform(vtkAbstractTransform* anInterpolatingAbstractTransform);
  //##Documentation
  //## @brief Get the interpolating (world-space-to-world-space) transform, 
  //## which uses the landmarks.
  //##
  //## \sa GetCompleteAbstractTransform
  //## \sa ComputeCompleteAbstractTransform
  itkGetConstMacro(InterpolatingAbstractTransform, vtkAbstractTransform*);

  //##Documentation
  //## @brief Set frame geometry within which the interpolation shall occur.
  //##
  //## Used as a hint, may be ignored depending on the concrete sub-classes.
  itkSetConstObjectMacro(FrameGeometry, mitk::Geometry3D);
  //##Documentation
  //## @brief Get frame geometry within which the interpolation shall occur.
  //##
  //## Used as a hint, may be ignored depending on the concrete sub-classes.
  itkGetConstObjectMacro(FrameGeometry, mitk::Geometry3D);

  //##Documentation
  //## @brief Get the parameter plane for use in AbstractTransformGeometry::SetPlane.
  //##
  itkGetConstObjectMacro(ParameterPlane, mitk::PlaneGeometry);

  //##Documentation
  //## @brief Get the projected landmarks.
  //##
  //## @note Valid only after calling ProjectLandmarks.
  itkGetConstObjectMacro(ProjectedLandmarks, mitk::PointSet::DataType::PointsContainer);
  //##Documentation
  //## @brief Get the final target landmarks to use for the interpolating transform.
  //##
  //## @note Valid only after calling ProjectLandmarks.
  itkGetConstObjectMacro(FinalTargetLandmarks, mitk::PointSet::DataType::PointsContainer);

  //##Documentation
  //## @brief Get the transform from parameter space to world space incorporating
  //## the given interpolating transform, which uses the landmarks.
  //##
  //## \sa ComputeCompleteAbstractTransform
  //## \sa SetInterpolatingAbstractTransform
  virtual vtkAbstractTransform* GetCompleteAbstractTransform() const;

  virtual void ProjectLandmarks(const mitk::PointSet::DataType::PointsContainer* targetLandmarks) = 0;

protected:
  LandmarkProjector();
  virtual ~LandmarkProjector();

  //##Documentation
  //## @brief Compute the transform from parameter space to world space incorporating
  //## the given interpolating transform, which uses the landmarks.
  //##
  //## Called after a new interpolating transform is set via 
  //## SetInterpolatingAbstractTransform().
  //## \sa SetInterpolatingAbstractTransform
  //## \sa GetCompleteAbstractTransform
  virtual void ComputeCompleteAbstractTransform() = 0;

  vtkAbstractTransform* m_InterpolatingAbstractTransform;
  vtkAbstractTransform* m_CompleteAbstractTransform;
  mitk::Geometry3D::ConstPointer m_FrameGeometry;
  mutable mitk::PlaneGeometry::ConstPointer m_ParameterPlane;
  mitk::PointSet::DataType::PointsContainer::Pointer m_WritableFinalTargetLandmarks;
  mitk::PointSet::DataType::PointsContainer::ConstPointer m_FinalTargetLandmarks;
  mitk::PointSet::DataType::PointsContainer::Pointer m_ProjectedLandmarks;
};

} // namespace mitk

#endif /* MITKLANDMARKPROJECTOR_H_HEADER_INCLUDED_C1C68A2C */