ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform > Class Template Reference

#include <itkSyNImageRegistrationMethod.h>

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

List of all members.

Public Types

typedef
Superclass::CompositeTransformType 
CompositeTransformType
typedef SmartPointer< const SelfConstPointer
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< SizeValueTypeNumberOfIterationsArrayType
typedef
OutputTransformType::Pointer 
OutputTransformPointer
typedef TOutputTransform OutputTransformType
typedef SmartPointer< SelfPointer
typedef
OutputTransformType::ScalarType 
RealType
typedef SyNImageRegistrationMethod Self
typedef
ImageRegistrationMethodv4
< TFixedImage, TMovingImage,
TOutputTransform > 
Superclass
typedef
CompositeTransformType::TransformType 
TransformBaseType
typedef
MetricType::VirtualImageType 
VirtualImageType
- Public Types inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >
typedef
CompositeTransformType::Pointer 
CompositeTransformPointer
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
typedef
FixedInterpolatorType::Pointer 
FixedInterpolatorPointer
typedef
InterpolateImageFunction
< FixedImageType, RealType
FixedInterpolatorType
typedef
InitialTransformType::Pointer 
InitialTransformPointer
typedef Transform< RealType,
ImageDimension, ImageDimension
InitialTransformType
typedef
MetricType::FixedSampledPointSetType 
MetricSamplePointSetType
typedef Array< RealTypeMetricSamplingPercentageArrayType
enum  MetricSamplingStrategyType {
  NONE,
  REGULAR,
  RANDOM
}
typedef
MovingInterpolatorType::Pointer 
MovingInterpolatorPointer
typedef
InterpolateImageFunction
< MovingImageType, RealType
MovingInterpolatorType
typedef OptimizerType::Pointer OptimizerPointer
typedef ObjectToObjectOptimizerBase OptimizerType
typedef Array< SizeValueTypeShrinkFactorsArrayType
typedef Array< RealTypeSmoothingSigmasArrayType
typedef
TransformParametersAdaptorType::Pointer 
TransformParametersAdaptorPointer
typedef std::vector
< TransformParametersAdaptorPointer
TransformParametersAdaptorsContainerType
typedef
TransformParametersAdaptor
< OutputTransformType
TransformParametersAdaptorType
- Public Types inherited from itk::ProcessObject
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

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 RealTypeGetGaussianSmoothingVarianceForTheUpdateField ()
virtual void SetGaussianSmoothingVarianceForTheTotalField (RealType _arg)
virtual const RealTypeGetGaussianSmoothingVarianceForTheTotalField ()
- Public Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >
virtual const RealTypeGetCurrentConvergenceValue ()
virtual const SizeValueTypeGetCurrentIteration ()
virtual SizeValueType GetCurrentLevel () const
virtual const RealTypeGetCurrentMetricValue ()
virtual const bool & GetIsConverged ()
virtual const
DecoratedOutputTransformType
GetOutput () const
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType)
void SetMetricSamplingPercentage (const RealType)
void StartRegistration ()
virtual void SetFixedImage (const FixedImageType *input)
virtual const FixedImageTypeGetFixedImage () const
virtual void SetMovingImage (const MovingImageType *input)
virtual const MovingImageTypeGetMovingImage () const
virtual void SetFixedInitialTransform (InitialTransformType *_arg)
virtual const
InitialTransformType
GetFixedInitialTransform ()
virtual void SetMovingInitialTransform (InitialTransformType *_arg)
virtual const
InitialTransformType
GetMovingInitialTransform ()
virtual void SetFixedInterpolator (FixedInterpolatorType *_arg)
virtual const
FixedInterpolatorType
GetFixedInterpolator ()
virtual void SetMovingInterpolator (MovingInterpolatorType *_arg)
virtual const
MovingInterpolatorType
GetMovingInterpolator ()
virtual void SetMetric (MetricType *_arg)
virtual MetricTypeGetMetric ()
virtual void SetMetricSamplingStrategy (MetricSamplingStrategyType _arg)
virtual MetricSamplingStrategyType GetMetricSamplingStrategy () const
virtual void SetMetricSamplingPercentagePerLevel (MetricSamplingPercentageArrayType _arg)
virtual
MetricSamplingPercentageArrayType 
GetMetricSamplingPercentagePerLevel () const
virtual void SetOptimizer (OptimizerType *_arg)
virtual OptimizerTypeGetOptimizer ()
void SetTransformParametersAdaptorsPerLevel (TransformParametersAdaptorsContainerType &)
const
TransformParametersAdaptorsContainerType
GetTransformParametersAdaptorsPerLevel () const
void SetNumberOfLevels (const SizeValueType)
virtual SizeValueType GetNumberOfLevels () const
virtual void SetShrinkFactorsPerLevel (ShrinkFactorsArrayType _arg)
virtual ShrinkFactorsArrayType GetShrinkFactorsPerLevel () const
virtual void SetSmoothingSigmasPerLevel (SmoothingSigmasArrayType _arg)
virtual SmoothingSigmasArrayType GetSmoothingSigmasPerLevel () const
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TFixedImage::ImageDimension
- Static Public Attributes inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >

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 Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >
 ImageRegistrationMethodv4 ()
virtual void SetMetricSamplePoints ()
virtual ~ImageRegistrationMethodv4 ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyInputInformation ()
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
virtual void PushBackInput (const DataObject *input)
virtual void PopBackInput ()
virtual void PushFrontInput (const DataObject *input)
virtual void PopFrontInput ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

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
- Protected Attributes inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >
CompositeTransformPointer m_CompositeTransform
RealType m_CurrentConvergenceValue
SizeValueType m_CurrentIteration
SizeValueType m_CurrentLevel
RealType m_CurrentMetricValue
InitialTransformPointer m_FixedInitialTransform
FixedInterpolatorPointer m_FixedInterpolator
FixedImagePointer m_FixedSmoothImage
bool m_IsConverged
MetricPointer m_Metric
MetricSamplingPercentageArrayType m_MetricSamplingPercentagePerLevel
MetricSamplingStrategyType m_MetricSamplingStrategy
InitialTransformPointer m_MovingInitialTransform
MovingInterpolatorPointer m_MovingInterpolator
MovingImagePointer m_MovingSmoothImage
SizeValueType m_NumberOfLevels
OptimizerPointer m_Optimizer
OutputTransformPointer m_OutputTransform
ShrinkFactorsArrayType m_ShrinkFactorsPerLevel
SmoothingSigmasArrayType m_SmoothingSigmasPerLevel
TransformParametersAdaptorsContainerType m_TransformParametersAdaptorsPerLevel
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
TimeStamp m_OutputInformationMTime

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.


Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef Superclass::CompositeTransformType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::CompositeTransformType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef SmartPointer<const Self> itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::ConstPointer
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef DecoratedOutputTransformType::Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::DecoratedOutputTransformPointer
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef Superclass::DecoratedOutputTransformType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::DecoratedOutputTransformType

Type for the output: Using Decorator pattern for enabling the transform to be passed in the data pipeline

Reimplemented from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >.

Reimplemented in itk::BSplineSyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >.

Definition at line 117 of file itkSyNImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef OutputTransformType::DerivativeType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::DerivativeType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef DerivativeType::ValueType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::DerivativeValueType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef DisplacementFieldType::Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::DisplacementFieldPointer
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef OutputTransformType::DisplacementFieldType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::DisplacementFieldType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef DisplacementFieldType::PixelType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::DisplacementVectorType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef FixedImageType::Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::FixedImagePointer
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef TFixedImage itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::FixedImageType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef MetricType::MeasureType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::MeasureType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef MetricType::Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::MetricPointer
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef Superclass::MetricType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::MetricType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef MovingImageType::Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::MovingImagePointer
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef TMovingImage itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::MovingImageType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef Array<SizeValueType> itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::NumberOfIterationsArrayType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef OutputTransformType::Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::OutputTransformPointer
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef TOutputTransform itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::OutputTransformType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef SmartPointer<Self> itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::Pointer
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef OutputTransformType::ScalarType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::RealType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef SyNImageRegistrationMethod itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::Self
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef ImageRegistrationMethodv4<TFixedImage, TMovingImage, TOutputTransform> itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::Superclass
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef CompositeTransformType::TransformType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::TransformBaseType
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
typedef MetricType::VirtualImageType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::VirtualImageType

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SyNImageRegistrationMethod ( )
protected
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::~SyNImageRegistrationMethod ( )
protectedvirtual
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SyNImageRegistrationMethod ( const Self )
private

Member Function Documentation

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual DisplacementFieldPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::ComputeUpdateField ( const TFixedImage *  ,
const TransformBaseType ,
const TMovingImage *  ,
const TransformBaseType ,
MeasureType  
)
protectedvirtual
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual::itk::LightObject::Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >.

Reimplemented in itk::BSplineSyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual DisplacementFieldPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GaussianSmoothDisplacementField ( const DisplacementFieldType ,
const RealType   
)
protectedvirtual
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GenerateData ( )
protectedvirtual
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual bool itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetAverageMidPointGradients ( ) const
virtual

Allow the user to average the gradients in the mid-point domain. Default false. One might choose to do this to further reduce bias.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual RealType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetConvergenceThreshold ( ) const
virtual

Set/Get the convergence threshold

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual unsigned int itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetConvergenceWindowSize ( ) const
virtual

Set/Get the convergence window size

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual bool itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetDownsampleImagesForMetricDerivatives ( ) const
virtual

Let the user control whether we compute metric derivatives in the downsampled or full-res space. The default is 'true' — classic SyN — but there may be advantages to the other approach. Classic SyN did not have this possibility. This implementation will let us explore the question.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual const RealType& itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetGaussianSmoothingVarianceForTheTotalField ( )
virtual

Get/Set the Gaussian smoothing variance for the total field. Default = 0.5.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual const RealType& itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetGaussianSmoothingVarianceForTheUpdateField ( )
virtual

Get/Set the Gaussian smoothing variance for the update field. Default = 1.75.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual RealType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetLearningRate ( ) const
virtual

Set/Get the learning rate.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual const char* itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetNameOfClass ( ) const
virtual
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual NumberOfIterationsArrayType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::GetNumberOfIterationsPerLevel ( ) const
virtual

Set/Get the number of iterations per level.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::InitializeRegistrationAtEachLevel ( const SizeValueType  )
protectedvirtual

Initialize by setting the interconnects between the components. Need to override in the SyN class since we need to "adapt" the m_InverseTransform

Reimplemented from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >.

Reimplemented in itk::BSplineSyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual DisplacementFieldPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::InvertDisplacementField ( const DisplacementFieldType ,
const DisplacementFieldType = NULL 
)
protectedvirtual
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
static Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::New ( )
static
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::operator= ( const Self )
private
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SetAverageMidPointGradients ( bool  _arg)
virtual

Allow the user to average the gradients in the mid-point domain. Default false. One might choose to do this to further reduce bias.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SetConvergenceThreshold ( RealType  _arg)
virtual

Set/Get the convergence threshold

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SetConvergenceWindowSize ( unsigned int  _arg)
virtual

Set/Get the convergence window size

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SetDownsampleImagesForMetricDerivatives ( bool  _arg)
virtual

Let the user control whether we compute metric derivatives in the downsampled or full-res space. The default is 'true' — classic SyN — but there may be advantages to the other approach. Classic SyN did not have this possibility. This implementation will let us explore the question.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SetGaussianSmoothingVarianceForTheTotalField ( RealType  _arg)
virtual

Get/Set the Gaussian smoothing variance for the total field. Default = 0.5.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SetGaussianSmoothingVarianceForTheUpdateField ( RealType  _arg)
virtual

Get/Set the Gaussian smoothing variance for the update field. Default = 1.75.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SetLearningRate ( RealType  _arg)
virtual

Set/Get the learning rate.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::SetNumberOfIterationsPerLevel ( NumberOfIterationsArrayType  _arg)
virtual

Set/Get the number of iterations per level.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::StartOptimization ( )
protectedvirtual

Member Data Documentation

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
const unsigned int itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::ImageDimension = TFixedImage::ImageDimension
static
template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
bool itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::m_AverageMidPointGradients
protected

Definition at line 204 of file itkSyNImageRegistrationMethod.h.

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

Definition at line 199 of file itkSyNImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, GetImageDimension<TFixedImage>::ImageDimension>>
unsigned int itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform >::m_ConvergenceWindowSize
protected

Definition at line 200 of file itkSyNImageRegistrationMethod.h.

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

Definition at line 203 of file itkSyNImageRegistrationMethod.h.

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

Definition at line 197 of file itkSyNImageRegistrationMethod.h.

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

Definition at line 211 of file itkSyNImageRegistrationMethod.h.

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

Definition at line 210 of file itkSyNImageRegistrationMethod.h.

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

Definition at line 194 of file itkSyNImageRegistrationMethod.h.

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

Definition at line 196 of file itkSyNImageRegistrationMethod.h.

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

Definition at line 202 of file itkSyNImageRegistrationMethod.h.


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