Class to perform FFD specific optimization using conjugate gradient descent. More...

Inheritance diagram for itk::FFDConjugateGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >:

[legend]

Collaboration diagram for itk::FFDConjugateGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >:

[legend]

Public Types
typedef FFDConjugateGradientDescentOptimizer	Self

typedef FFDGradientDescentOptimizer < TFixedImage, TMovingImage, TScalarType, TDeformationScalar >	Superclass

typedef SmartPointer< Self >	Pointer

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::SimilarityMeasureType	SimilarityMeasureType

typedef SimilarityMeasureType::TransformParametersType	ParametersType

typedef Superclass::UCLBSplineTransformPointer	UCLBSplineTransformPointer

typedef Superclass::GridImagePointer	GridImagePointer

typedef Superclass::OutputImageSizeType	OutputImageSizeType

Public Types inherited from itk::FFDGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >
typedef FFDGradientDescentOptimizer	Self

typedef LocalSimilarityMeasureGradientDescentOptimizer < TFixedImage, TMovingImage, TScalarType, TDeformationScalar >	Superclass

typedef SmartPointer< Self >	Pointer

typedef SmartPointer< const Self >	ConstPointer

typedef DeformableTransform < TFixedImage, TScalarType, Dimension, TDeformationScalar >	DeformableTransformType

typedef DeformableTransformType::Pointer	DeformableTransformPointer

typedef UCLBSplineTransform < TFixedImage, TScalarType, Dimension, TDeformationScalar >	UCLBSplineTransformType

typedef UCLBSplineTransformType *	UCLBSplineTransformPointer

typedef TScalarType	MeasureType

typedef ImageToImageMetricWithConstraint < TFixedImage, TMovingImage >	SimilarityMeasureType

typedef SimilarityMeasureType::ConstPointer	SimilarityMeasurePointer

typedef SimilarityMeasureType::TransformParametersType	ParametersType

typedef SimilarityMeasureType::DerivativeType	DerivativeType

typedef UCLBSplineTransformType::GridImageType	GridImageType

typedef GridImageType *	GridImagePointer

typedef Vector < TDeformationScalar, itkGetStaticConstMacro(Dimension) >	VectorPixelType

typedef Image< VectorPixelType, itkGetStaticConstMacro(Dimension) >	VectorImageType

typedef RegistrationForceFilter < TFixedImage, TMovingImage, TDeformationScalar >	ForceFilterType

typedef ForceFilterType::Pointer	ForceFilterPointer

typedef ForceFilterType::OutputImageType	ForceOutputImageType

typedef BSplineSmoothVectorFieldFilter < TDeformationScalar, Dimension >	SmoothFilterType

typedef SmoothFilterType::Pointer	SmoothFilterPointer

typedef InterpolateVectorFieldFilter < TDeformationScalar, Dimension >	InterpolateFilterType

typedef InterpolateFilterType::Pointer	InterpolateFilterPointer

typedef ScaleVectorFieldFilter < TDeformationScalar, Dimension >	ScaleFieldType

typedef ScaleFieldType::Pointer	ScaleFieldPointer

typedef ScalarImageToNormalizedGradientVectorImageFilter < TFixedImage, TDeformationScalar >	GradientFilterType

typedef GradientFilterType::Pointer	GradientFilterPointer

typedef InterpolateFilterType::OutputImageType	OutputImageType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef ImageRegionIterator < OutputImageType >	OutputImageIteratorType

typedef OutputImageType::SizeType	OutputImageSizeType

typedef OutputImageType::SpacingType	OutputImageSpacingType

Public Types inherited from itk::LocalSimilarityMeasureGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >
typedef LocalSimilarityMeasureGradientDescentOptimizer	Self

typedef SingleValuedNonLinearOptimizer	Superclass

typedef SmartPointer< Self >	Pointer

typedef SmartPointer< const Self >	ConstPointer

typedef SimilarityMeasure < TFixedImage, TMovingImage >	ImageToImageMetricType

typedef const ImageToImageMetricType *	ImageToImageMetricPointer

typedef TFixedImage	FixedImageType

typedef FixedImageType::PixelType	FixedImagePixelType

typedef FixedImageType *	FixedImagePointer

typedef FixedImageType::Pointer	FixedImageSmartPointer

typedef TMovingImage	MovingImageType

typedef MovingImageType::PixelType	MovingImagePixelType

typedef MovingImageType *	MovingImagePointer

typedef DeformableTransform < TFixedImage, TScalarType, Dimension, TDeformationScalar >	DeformableTransformType

typedef DeformableTransformType::Pointer	DeformableTransformPointer

typedef double	MeasureType

typedef InterpolateImageFunction < TFixedImage, TScalarType >	RegriddingInterpolatorType

typedef RegriddingInterpolatorType::Pointer	RegriddingInterpolatorPointer

typedef ResampleImageFilter < TFixedImage, TFixedImage >	ResampleFilterType

typedef ResampleFilterType::Pointer	ResampleFilterPointer

typedef DeformableTransformType::JacobianDeterminantFilterType::OutputImageType	JacobianImageType

Public Member Functions
virtual const char *	GetClassName () const

	itkStaticConstMacro (Dimension, unsigned int, TFixedImage::ImageDimension)

Public Member Functions inherited from itk::FFDGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >
	itkStaticConstMacro (Dimension, unsigned int, TFixedImage::ImageDimension)

virtual void	SetForceFilter (ForceFilterType *_arg)

virtual const ForceFilterType *	GetForceFilter ()

virtual void	SetSmoothFilter (SmoothFilterType *_arg)

virtual const SmoothFilterType *	GetSmoothFilter ()

virtual void	SetInterpolatorFilter (InterpolateFilterType *_arg)

virtual const InterpolateFilterType *	GetInterpolatorFilter ()

virtual void	SetMinimumGradientVectorMagnitudeThreshold (TScalarType _arg)

virtual TScalarType	GetMinimumGradientVectorMagnitudeThreshold ()

virtual void	SetScaleForceVectorsByGradientImage (bool _arg)

virtual bool	GetScaleForceVectorsByGradientImage ()

virtual void	SetScaleByComponents (bool _arg)

virtual bool	GetScaleByComponents ()

virtual void	SetSmoothGradientVectorsBeforeInterpolatingToControlPointLevel (bool _arg)

virtual bool	GetSmoothGradientVectorsBeforeInterpolatingToControlPointLevel ()

virtual void	SetWriteForceImage (bool _arg)

virtual bool	GetWriteForceImage ()

virtual void	SetForceImageFileName (std::string _arg)

virtual std::string	GetForceImageFileName ()

virtual void	SetForceImageFileExt (std::string _arg)

virtual std::string	GetForceImageFileExt ()

Public Member Functions inherited from itk::LocalSimilarityMeasureGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >
	itkStaticConstMacro (Dimension, unsigned int, TFixedImage::ImageDimension)

virtual void	StartOptimization (void) override

virtual void	ResumeOptimization (void)

virtual void	StopOptimization (void)

virtual const bool &	GetMaximize ()

virtual void	SetMaximize (bool _arg)

virtual void	MaximizeOn ()

virtual void	MaximizeOff ()

virtual double	GetValue () const

virtual bool	GetStop () const

virtual void	SetMaximumNumberOfIterations (unsigned long int _arg)

virtual unsigned long int	GetMaximumNumberOfIterations ()

virtual unsigned long int	GetCurrentIteration ()

virtual void	SetStepSize (double _arg)

virtual double	GetStepSize ()

virtual void	SetMinimumStepSize (double _arg)

virtual double	GetMinimumStepSize ()

virtual void	SetIteratingStepSizeReductionFactor (double _arg)

virtual double	GetIteratingStepSizeReductionFactor ()

virtual void	SetRegriddingStepSizeReductionFactor (double _arg)

virtual double	GetRegriddingStepSizeReductionFactor ()

virtual void	SetJacobianBelowZeroStepSizeReductionFactor (double _arg)

virtual double	GetJacobianBelowZeroStepSizeReductionFactor ()

virtual void	SetMinimumDeformationMagnitudeThreshold (double _arg)

virtual double	GetMinimumDeformationMagnitudeThreshold ()

virtual void	SetMinimumJacobianThreshold (double _arg)

virtual double	GetMinimumJacobianThreshold ()

virtual void	SetRegriddingInterpolator (RegriddingInterpolatorType *_arg)

virtual const RegriddingInterpolatorType *	GetRegriddingInterpolator ()

virtual void	SetDeformableTransform (DeformableTransformType *_arg)

virtual const DeformableTransformType *	GetDeformableTransform ()

virtual void	SetMinimumSimilarityChangeThreshold (double _arg)

virtual double	GetMinimumSimilarityChangeThreshold ()

virtual void	SetCheckSimilarityMeasure (bool _arg)

virtual bool	GetCheckSimilarityMeasure ()

virtual void	SetCheckMinDeformationMagnitudeThreshold (bool _arg)

virtual bool	GetCheckMinDeformationMagnitudeThreshold ()

virtual void	SetCheckJacobianBelowZero (bool _arg)

virtual bool	GetCheckJacobianBelowZero ()

virtual void	SetWriteNextParameters (bool _arg)

virtual bool	GetWriteNextParameters ()

virtual void	SetNextParametersFileName (std::string _arg)

virtual std::string	GetNextParametersFileName ()

virtual void	SetNextParametersFileExt (std::string _arg)

virtual std::string	GetNextParametersFileExt ()

virtual void	SetWriteDeformationField (bool _arg)

virtual bool	GetWriteDeformationField ()

virtual void	SetDeformationFieldFileName (std::string _arg)

virtual std::string	GetDeformationFieldFileName ()

virtual void	SetDeformationFieldFileExt (std::string _arg)

virtual std::string	GetDeformationFieldFileExt ()

virtual void	SetWriteRegriddedImage (bool _arg)

virtual bool	GetWriteRegriddedImage ()

virtual void	SetRegriddedImageFileName (std::string _arg)

virtual std::string	GetRegriddedImageFileName ()

virtual void	SetRegriddedImageFileExt (std::string _arg)

virtual std::string	GetRegriddedImageFileExt ()

virtual void	SetRegriddedMovingImagePadValue (MovingImagePixelType _arg)

virtual MovingImagePixelType	GetRegriddedMovingImagePadValue ()

virtual void	SetIsAbsRegriddedImage (bool _arg)

virtual bool	GetIsAbsRegriddedImage ()

virtual void	SetIsPropagateRegriddedMovingImage (bool _arg)

virtual bool	GetIsPropagateRegriddedMovingImage ()

virtual const JacobianImageType *	GetComposedJacobian () const

virtual const FixedImageType *	GetRegriddedMovingImage () const

virtual const FixedImageType *	GetRegriddedFixedImage () const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	FFDConjugateGradientDescentOptimizer ()

virtual	~FFDConjugateGradientDescentOptimizer ()

void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	OptimizeNextStep (int iterationNumber, int numberOfGridVoxels, const ParametersType &current, ParametersType &next)

Protected Member Functions inherited from itk::FFDGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >
	FFDGradientDescentOptimizer ()

virtual	~FFDGradientDescentOptimizer ()

void	PrintSelf (std::ostream &os, Indent indent) const

virtual double	CalculateNextStep (int iterationNumber, double currentSimilarity, const ParametersType &current, ParametersType &next)

virtual void	GetGradient (int iterationNumber, const ParametersType &current, ParametersType &next)

virtual bool	LineAscent (int iterationNumber, int numberOfGridVoxels, const ParametersType &current, ParametersType &next)

virtual void	OptimizeNextStep (int iterationNumber, int numberOfGridVoxels, const ParametersType &current, ParametersType &next)

Protected Member Functions inherited from itk::LocalSimilarityMeasureGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >
	LocalSimilarityMeasureGradientDescentOptimizer ()

virtual	~LocalSimilarityMeasureGradientDescentOptimizer ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual double	CalculateNextStep (int iterationNumber, double currentSimilarity, const ParametersType &current, ParametersType &next)=0

virtual void	ReGrid (bool isResetCurrentPosition)

virtual void	ComposeJacobian ()

Additional Inherited Members
Protected Attributes inherited from itk::FFDGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >
ForceFilterPointer	m_ForceFilter

SmoothFilterPointer	m_SmoothFilter

InterpolateFilterPointer	m_InterpolatorFilter

ScaleFieldPointer	m_ScaleVectorFieldFilter

GradientFilterPointer	m_GradientImageFilter

unsigned int	m_CalculateNextStepCounter

Protected Attributes inherited from itk::LocalSimilarityMeasureGradientDescentOptimizer< TFixedImage, TMovingImage, TScalarType, TDeformationScalar >
bool	m_Maximize

double	m_Value

bool	m_Stop

unsigned long int	m_MaximumNumberOfIterations

unsigned int	m_CurrentIteration

unsigned int	m_RegriddingNumber

double	m_StepSize

double	m_MinimumStepSize

double	m_IteratingStepSizeReductionFactor

double	m_RegriddingStepSizeReductionFactor

double	m_JacobianBelowZeroStepSizeReductionFactor

double	m_MinimumDeformationMagnitudeThreshold

double	m_MinimumSimilarityChangeThreshold

double	m_MinimumJacobianThreshold

bool	m_CheckSimilarityMeasure

bool	m_CheckMinDeformationMagnitudeThreshold

bool	m_CheckJacobianBelowZero

bool	m_IsAbsRegriddedImage

RegriddingInterpolatorPointer	m_RegriddingInterpolator

ResampleFilterPointer	m_RegriddingResampler

FixedImageSmartPointer	m_RegriddedMovingImage

FixedImageSmartPointer	m_RegriddedFixedImage

DeformableTransformPointer	m_DeformableTransform

ParametersType	m_NextParameters

ParametersType	m_RegriddedParameters

ImageToImageMetricPointer	m_ImageToImageMetric

FixedImagePointer	m_FixedImage

MovingImagePointer	m_MovingImage

bool	m_WriteNextParameters

std::string	m_NextParametersFileName

std::string	m_NextParametersFileExt

bool	m_WriteDeformationField

std::string	m_DeformationFieldFileName

std::string	m_DeformationFieldFileExt

bool	m_WriteRegriddedImage

std::string	m_RegriddedImageFileName

std::string	m_RegriddedImageFileExt

MovingImagePixelType	m_RegriddedMovingImagePadValue

JacobianImageType::Pointer	m_ComposedJacobian

bool	m_IsPropagateRegriddedMovingImage