#include <itkSyNImageRegistrationMethod.h>

Inheritance diagram for itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >:

Collaboration diagram for itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >:

Public Types
typedef Superclass::CompositeTransformType	CompositeTransformType
typedef SmartPointer< const Self >	ConstPointer
typedef DecoratedOutputTransformType::Pointer	DecoratedOutputTransformPointer
typedef Superclass::DecoratedOutputTransformType	DecoratedOutputTransformType
typedef OutputTransformType::DerivativeType	DerivativeType
typedef DerivativeType::ValueType	DerivativeValueType
typedef DisplacementFieldType::Pointer	DisplacementFieldPointer
typedef OutputTransformType::DisplacementFieldType	DisplacementFieldType
typedef DisplacementFieldType::PixelType	DisplacementVectorType
typedef FixedImageType::Pointer	FixedImagePointer
typedef TFixedImage	FixedImageType
typedef MetricType::MeasureType	MeasureType
typedef MetricType::Pointer	MetricPointer
typedef Superclass::MetricType	MetricType
typedef MovingImageType::Pointer	MovingImagePointer
typedef TMovingImage	MovingImageType
typedef Array< SizeValueType >	NumberOfIterationsArrayType
typedef OutputTransformType::Pointer	OutputTransformPointer
typedef TOutputTransform	OutputTransformType
typedef SmartPointer< Self >	Pointer
typedef OutputTransformType::ScalarType	RealType
typedef SyNImageRegistrationMethod	Self
typedef ImageRegistrationMethodv4 < TFixedImage, TMovingImage, TOutputTransform >	Superclass
typedef CompositeTransformType::TransformType	TransformBaseType
typedef MetricType::VirtualImageType	VirtualImageType
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

virtual void	SetLearningRate (RealType _arg)
virtual RealType	GetLearningRate () const

virtual void	SetNumberOfIterationsPerLevel (NumberOfIterationsArrayType _arg)
virtual NumberOfIterationsArrayType	GetNumberOfIterationsPerLevel () const

virtual void	SetConvergenceThreshold (RealType _arg)
virtual RealType	GetConvergenceThreshold () const

virtual void	SetConvergenceWindowSize (unsigned int _arg)
virtual unsigned int	GetConvergenceWindowSize () const

virtual void	SetDownsampleImagesForMetricDerivatives (bool _arg)
virtual bool	GetDownsampleImagesForMetricDerivatives () const

virtual void	SetAverageMidPointGradients (bool _arg)
virtual bool	GetAverageMidPointGradients () const

virtual void	SetGaussianSmoothingVarianceForTheUpdateField (RealType _arg)
virtual const RealType &	GetGaussianSmoothingVarianceForTheUpdateField ()

virtual void	SetGaussianSmoothingVarianceForTheTotalField (RealType _arg)
virtual const RealType &	GetGaussianSmoothingVarianceForTheTotalField ()
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = TFixedImage::ImageDimension
Protected Member Functions
virtual DisplacementFieldPointer	ComputeUpdateField (const TFixedImage , const TransformBaseType , const TMovingImage , const TransformBaseType , MeasureType &)
virtual DisplacementFieldPointer	GaussianSmoothDisplacementField (const DisplacementFieldType *, const RealType)
virtual void	GenerateData ()
virtual void	InitializeRegistrationAtEachLevel (const SizeValueType)
virtual DisplacementFieldPointer	InvertDisplacementField (const DisplacementFieldType , const DisplacementFieldType =NULL)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	StartOptimization ()
	SyNImageRegistrationMethod ()
virtual	~SyNImageRegistrationMethod ()
Protected Attributes
bool	m_AverageMidPointGradients
RealType	m_ConvergenceThreshold
unsigned int	m_ConvergenceWindowSize
bool	m_DownsampleImagesForMetricDerivatives
OutputTransformPointer	m_FixedToMiddleTransform
RealType	m_LearningRate
OutputTransformPointer	m_MovingToMiddleTransform
NumberOfIterationsArrayType	m_NumberOfIterationsPerLevel
Private Member Functions
void	operator= (const Self &)
	SyNImageRegistrationMethod (const Self &)
Private Attributes
RealType	m_GaussianSmoothingVarianceForTheTotalField
RealType	m_GaussianSmoothingVarianceForTheUpdateField

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
class itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >

Interface method for the performing greedy SyN image registration.

For greedy SyN we use m_Transform to map the time-parameterized middle image to the fixed image (and vice versa using m_Transform->GetInverseDisplacementField() ). We employ another ivar, m_InverseTransform, to map the time-parameterized middle image to the moving image.

Output: The output is the updated transform which has been added to the composite transform.

This implementation is based on the source code in Advanced Normalization Tools (ANTs)

Avants, B. B.; Tustison, N. J.; Song, G.; Cook, P. A.; Klein, A. & Gee, J. C. A reproducible evaluation of ANTs similarity metric performance in brain image registration. Neuroimage, Penn Image Computing and Science Laboratory, University of Pennsylvania, 2011, 54, 2033-2044

The original paper discussing the method is here:

Avants, B. B.; Epstein, C. L.; Grossman, M. & Gee, J. C. Symmetric diffeomorphic image registration with cross-correlation: evaluating automated labeling of elderly and neurodegenerative brain. Med Image Anal, Department of Radiology, University of Pennsylvania, 2008, 12, 26-41

The method evolved since that time with crucial contributions from Gang Song and Nick Tustison. Though similar in spirit, this implementation is not identical.

Todo:: Need to allow the fixed image to have a composite transform.

Author:: Nick Tustison; Brian Avants

Definition at line 74 of file itkSyNImageRegistrationMethod.h.