SimpleITK  1.0.1
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::LandmarkBasedTransformInitializerFilter Class Reference

#include <sitkLandmarkBasedTransformInitializerFilter.h>

+ Inheritance diagram for itk::simple::LandmarkBasedTransformInitializerFilter:
+ Collaboration diagram for itk::simple::LandmarkBasedTransformInitializerFilter:

Public Types

typedef typelist::MakeTypeList< BasicPixelID< float > >::Type PixelIDTypeList
typedef LandmarkBasedTransformInitializerFilter Self
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self

Public Member Functions

Transform Execute (const Transform &transform)
Transform Execute (const Transform &transform, const std::vector< double > &fixedLandmarks, const std::vector< double > &movingLandmarks, const std::vector< double > &landmarkWeight, const Image &referenceImage, unsigned int numberOfControlPoints)
unsigned int GetBSplineNumberOfControlPoints () const
std::vector< double > GetFixedLandmarks () const
std::vector< double > GetLandmarkWeight () const
std::vector< double > GetMovingLandmarks () const
std::string GetName () const
Image GetReferenceImage () const
 LandmarkBasedTransformInitializerFilter ()
SelfSetBSplineNumberOfControlPoints (unsigned int BSplineNumberOfControlPoints)
SelfSetFixedLandmarks (const std::vector< double > &FixedLandmarks)
SelfSetLandmarkWeight (const std::vector< double > &LandmarkWeight)
SelfSetMovingLandmarks (const std::vector< double > &MovingLandmarks)
SelfSetReferenceImage (const Image &ReferenceImage)
std::string ToString () const
 ~LandmarkBasedTransformInitializerFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 ImageFilter ()
virtual ~ImageFilter ()=0
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 ProcessObject ()
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
virtual ~ProcessObject ()
virtual void DebugOn ()
virtual void DebugOff ()
virtual bool GetDebug () const
virtual void SetDebug (bool debugFlag)
virtual void SetNumberOfThreads (unsigned int n)
virtual unsigned int GetNumberOfThreads () const

Private Types

typedef Transform(Self::* MemberFunctionType) (const Transform *transform)

Private Member Functions

template<class TImageType >
Transform ExecuteInternal (const Transform *transform)

Private Attributes

unsigned int m_BSplineNumberOfControlPoints
std::vector< double > m_FixedLandmarks
std::vector< double > m_LandmarkWeight
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
std::vector< double > m_MovingLandmarks
Image m_ReferenceImage


struct detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
static void GlobalDefaultDebugOff ()
static void GlobalDefaultDebugOn ()
static void SetGlobalDefaultDebug (bool debugFlag)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static void SetGlobalWarningDisplay (bool flag)
static bool GetGlobalWarningDisplay ()
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObjectGetActiveProcess ()
virtual void OnActiveProcessDelete ()
virtual void onCommandDelete (const itk::simple::Command *cmd) throw ()
virtual void PreUpdate (itk::ProcessObject *p)
virtual void RemoveITKObserver (EventCommand &e)
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
static void FixNonZeroIndex (TImageType *img)
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
template<class TImageType >
static Image CastITKToImage (TImageType *img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
static const itk::EventObjectGetITKEventObject (EventEnum e)
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

This class computes the transform that aligns the fixed and moving images given a set of pair landmarks. The class is templated over the Transform type as well as fixed image and moving image types. The transform computed gives the best fit transform that maps the fixed and moving images in a least squares sense. The indices are taken to correspond, so point 1 in the first set will get mapped close to point 1 in the second set, etc.

Currently, the following transforms are supported by the class: VersorRigid3DTransform Rigid2DTransform AffineTransform BSplineTransform

An equal number of fixed and moving landmarks need to be specified using SetFixedLandmarks() and SetMovingLandmarks() . Any number of landmarks may be specified. In the case of using Affine or BSpline transforms, each landmark pair can contribute in the final transform based on its defined weight. Number of weights should be equal to the number of landmarks and can be specified using SetLandmarkWeight() . By defaults are weights are set to one. Call InitializeTransform() to initialize the transform.

The class is based in part on Hybrid/vtkLandmarkTransform originally implemented in python by David G. Gobbi.

The solution is based on Berthold K. P. Horn (1987), "Closed-form solution of absolute orientation using unit quaternions,"

The Affine Transform initializer is based on an algorithm by H Spaeth, and is described in the Insight Journal Article "Affine Transformation for Landmark Based Registration Initializer in ITK" by Kim E.Y., Johnson H., Williams N. available at

Wiki Examples:

Definition at line 60 of file sitkLandmarkBasedTransformInitializerFilter.h.

Member Typedef Documentation

typedef Transform(Self::* itk::simple::LandmarkBasedTransformInitializerFilter::MemberFunctionType) (const Transform *transform)

Setup for member function dispatching

Definition at line 143 of file sitkLandmarkBasedTransformInitializerFilter.h.

Define the pixels types supported by this filter

Definition at line 72 of file sitkLandmarkBasedTransformInitializerFilter.h.

Constructor & Destructor Documentation

itk::simple::LandmarkBasedTransformInitializerFilter::LandmarkBasedTransformInitializerFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::LandmarkBasedTransformInitializerFilter::~LandmarkBasedTransformInitializerFilter ( )


Member Function Documentation

Transform itk::simple::LandmarkBasedTransformInitializerFilter::Execute ( const Transform transform)

Execute the filter on the input image

Transform itk::simple::LandmarkBasedTransformInitializerFilter::Execute ( const Transform transform,
const std::vector< double > &  fixedLandmarks,
const std::vector< double > &  movingLandmarks,
const std::vector< double > &  landmarkWeight,
const Image referenceImage,
unsigned int  numberOfControlPoints 

Execute the filter on the input image with the given parameters

template<class TImageType >
Transform itk::simple::LandmarkBasedTransformInitializerFilter::ExecuteInternal ( const Transform transform)
unsigned int itk::simple::LandmarkBasedTransformInitializerFilter::GetBSplineNumberOfControlPoints ( ) const

Set/Get the number of control points

Definition at line 123 of file sitkLandmarkBasedTransformInitializerFilter.h.

std::vector<double> itk::simple::LandmarkBasedTransformInitializerFilter::GetFixedLandmarks ( ) const
std::vector<double> itk::simple::LandmarkBasedTransformInitializerFilter::GetLandmarkWeight ( ) const
std::vector<double> itk::simple::LandmarkBasedTransformInitializerFilter::GetMovingLandmarks ( ) const

Get the shrink factors.

Definition at line 94 of file sitkLandmarkBasedTransformInitializerFilter.h.

std::string itk::simple::LandmarkBasedTransformInitializerFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 125 of file sitkLandmarkBasedTransformInitializerFilter.h.

Image itk::simple::LandmarkBasedTransformInitializerFilter::GetReferenceImage ( ) const
Self& itk::simple::LandmarkBasedTransformInitializerFilter::SetBSplineNumberOfControlPoints ( unsigned int  BSplineNumberOfControlPoints)

Set/Get the number of control points

Definition at line 118 of file sitkLandmarkBasedTransformInitializerFilter.h.

Self& itk::simple::LandmarkBasedTransformInitializerFilter::SetFixedLandmarks ( const std::vector< double > &  FixedLandmarks)

Set the Fixed landmark point containers

Definition at line 79 of file sitkLandmarkBasedTransformInitializerFilter.h.

Self& itk::simple::LandmarkBasedTransformInitializerFilter::SetLandmarkWeight ( const std::vector< double > &  LandmarkWeight)

Set the landmark weight point containers Weight includes diagonal elements of weight matrix

Definition at line 99 of file sitkLandmarkBasedTransformInitializerFilter.h.

Self& itk::simple::LandmarkBasedTransformInitializerFilter::SetMovingLandmarks ( const std::vector< double > &  MovingLandmarks)

Set the Moving landmark point containers

Definition at line 89 of file sitkLandmarkBasedTransformInitializerFilter.h.

Self& itk::simple::LandmarkBasedTransformInitializerFilter::SetReferenceImage ( const Image ReferenceImage)

Set the reference image to define the parametric domain for the BSpline transform

Definition at line 109 of file sitkLandmarkBasedTransformInitializerFilter.h.

std::string itk::simple::LandmarkBasedTransformInitializerFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Member Data Documentation

unsigned int itk::simple::LandmarkBasedTransformInitializerFilter::m_BSplineNumberOfControlPoints
std::vector<double> itk::simple::LandmarkBasedTransformInitializerFilter::m_FixedLandmarks
std::vector<double> itk::simple::LandmarkBasedTransformInitializerFilter::m_LandmarkWeight
nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::LandmarkBasedTransformInitializerFilter::m_MemberFactory
std::vector<double> itk::simple::LandmarkBasedTransformInitializerFilter::m_MovingLandmarks
Image itk::simple::LandmarkBasedTransformInitializerFilter::m_ReferenceImage

The documentation for this class was generated from the following file: