ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet > Class Template Reference

#include <itkSyNImageRegistrationMethod.h>

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

Public Types

using CompositeTransformType = typename Superclass::CompositeTransformType
 
using ConstPointer = SmartPointer< const Self >
 
using DecoratedOutputTransformPointer = typename DecoratedOutputTransformType::Pointer
 
using DecoratedOutputTransformType = typename Superclass::DecoratedOutputTransformType
 
using DerivativeType = typename OutputTransformType::DerivativeType
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using DisplacementFieldPointer = typename DisplacementFieldType::Pointer
 
using DisplacementFieldTransformPointer = typename DisplacementFieldTransformType::Pointer
 
using DisplacementFieldTransformType = DisplacementFieldTransform< RealType, ImageDimension >
 
using DisplacementFieldType = typename OutputTransformType::DisplacementFieldType
 
using DisplacementVectorType = typename DisplacementFieldType::PixelType
 
using FixedImageMasksContainerType = typename Superclass::FixedImageMasksContainerType
 
using FixedImageMaskType = typename Superclass::FixedImageMaskType
 
using FixedImagePointer = typename FixedImageType::Pointer
 
using FixedImagesContainerType = typename Superclass::FixedImagesContainerType
 
using FixedImageType = TFixedImage
 
using FixedMaskImageType = typename ImageMaskSpatialObjectType::ImageType
 
using ImageMaskSpatialObjectType = ImageMaskSpatialObject< ImageDimension >
 
using ImageMetricPointer = typename ImageMetricType::Pointer
 
using ImageMetricType = typename Superclass::ImageMetricType
 
using InitialTransformType = typename Superclass::InitialTransformType
 
using MeasureType = typename ImageMetricType::MeasureType
 
using MetricPointer = typename MetricType::Pointer
 
using MetricType = typename Superclass::MetricType
 
using MovingImageMasksContainerType = typename Superclass::MovingImageMasksContainerType
 
using MovingImageMaskType = typename Superclass::MovingImageMaskType
 
using MovingImagePointer = typename MovingImageType::Pointer
 
using MovingImagesContainerType = typename Superclass::MovingImagesContainerType
 
using MovingImageType = TMovingImage
 
using MovingMaskImageType = typename ImageMaskSpatialObjectType::ImageType
 
using MultiMetricType = typename Superclass::MultiMetricType
 
using NumberOfIterationsArrayType = Array< SizeValueType >
 
using OutputTransformPointer = typename OutputTransformType::Pointer
 
using OutputTransformType = TOutputTransform
 
using Pointer = SmartPointer< Self >
 
using PointSetMetricType = typename Superclass::PointSetMetricType
 
using PointSetPointer = typename PointSetType::Pointer
 
using PointSetsContainerType = typename Superclass::PointSetsContainerType
 
using PointSetType = typename Superclass::PointSetType
 
using RealType = typename OutputTransformType::ScalarType
 
using Self = SyNImageRegistrationMethod
 
using Superclass = ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
 
using TransformBaseType = typename CompositeTransformType::TransformType
 
using VirtualImageBaseConstPointer = typename Superclass::VirtualImageBaseConstPointer
 
using VirtualImageBaseType = typename Superclass::VirtualImageBaseType
 
using VirtualImageType = typename Superclass::VirtualImageType
 
- Public Types inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
using CompositeTransformPointer = typename CompositeTransformType::Pointer
 
using CompositeTransformType = CompositeTransform< RealType, ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using DecoratedInitialTransformPointer = typename DecoratedInitialTransformType::Pointer
 
using DecoratedInitialTransformType = DataObjectDecorator< InitialTransformType >
 
using DecoratedOutputTransformPointer = typename DecoratedOutputTransformType::Pointer
 
using DecoratedOutputTransformType = DataObjectDecorator< OutputTransformType >
 
using DerivativeType = typename OutputTransformType::DerivativeType
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using FixedImageConstPointer = typename FixedImageType::ConstPointer
 
using FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer
 
using FixedImageMasksContainerType = std::vector< FixedImageMaskConstPointer >
 
using FixedImageMaskType = typename ImageMetricType::FixedImageMaskType
 
using FixedImagePointer = typename FixedImageType::Pointer
 
using FixedImagesContainerType = std::vector< FixedImageConstPointer >
 
using FixedImageType = TFixedImage
 
using ImageMetricType = ImageToImageMetricv4< FixedImageType, MovingImageType, VirtualImageType, RealType >
 
using InitialTransformPointer = typename InitialTransformType::Pointer
 
using InitialTransformType = Transform< RealType, ImageDimension, ImageDimension >
 
using MetricPointer = typename MetricType::Pointer
 
using MetricSamplePointSetType = typename ImageMetricType::FixedSampledPointSetType
 
using MetricSamplingPercentageArrayType = Array< RealType >
 
using MetricSamplingStrategyEnum = ImageRegistrationMethodv4Enums::MetricSamplingStrategy
 
using MetricType = ObjectToObjectMetricBaseTemplate< RealType >
 
using MovingImageConstPointer = typename MovingImageType::ConstPointer
 
using MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer
 
using MovingImageMasksContainerType = std::vector< MovingImageMaskConstPointer >
 
using MovingImageMaskType = typename ImageMetricType::MovingImageMaskType
 
using MovingImagePointer = typename MovingImageType::Pointer
 
using MovingImagesContainerType = std::vector< MovingImageConstPointer >
 
using MovingImageType = TMovingImage
 
using MultiMetricType = ObjectToObjectMultiMetricv4< ImageDimension, ImageDimension, VirtualImageType, RealType >
 
using OptimizerPointer = typename OptimizerType::Pointer
 
using OptimizerType = ObjectToObjectOptimizerBaseTemplate< RealType >
 
using OptimizerWeightsType = typename OptimizerType::ScalesType
 
using OutputTransformPointer = typename OutputTransformType::Pointer
 
using OutputTransformType = TOutputTransform
 
using Pointer = SmartPointer< Self >
 
using PointSetConstPointer = typename PointSetType::ConstPointer
 
using PointSetMetricType = PointSetToPointSetMetricv4< PointSetType, PointSetType, RealType >
 
using PointSetsContainerType = std::vector< PointSetConstPointer >
 
using PointSetType = TPointSet
 
using RealType = typename OutputTransformType::ScalarType
 
using Self = ImageRegistrationMethodv4
 
using ShrinkFactorsArrayType = Array< SizeValueType >
 
using ShrinkFactorsPerDimensionContainerType = typename ShrinkFilterType::ShrinkFactorsType
 
using ShrinkFilterType = ShrinkImageFilter< FixedImageType, VirtualImageType >
 
using SmoothingSigmasArrayType = Array< RealType >
 
using Superclass = ProcessObject
 
using TransformParametersAdaptorPointer = typename TransformParametersAdaptorType::Pointer
 
using TransformParametersAdaptorsContainerType = std::vector< TransformParametersAdaptorPointer >
 
using TransformParametersAdaptorType = TransformParametersAdaptorBase< InitialTransformType >
 
using VectorType = Vector< RealType, ImageDimension >
 
using VirtualImageBaseConstPointer = typename VirtualImageBaseType::ConstPointer
 
using VirtualImageBaseType = ImageBase< ImageDimension >
 
using VirtualImagePointer = typename VirtualImageType::Pointer
 
using VirtualImageType = TVirtualImage
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
virtual void SetFixedImage (const FixedImageType *image)
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual void SetFixedImage (SizeValueType, const FixedImageType *)
 
virtual const FixedImageTypeGetFixedImage (SizeValueType) const
 
virtual void SetMovingImage (const MovingImageType *image)
 
virtual const MovingImageTypeGetMovingImage () const
 
virtual void SetMovingImage (SizeValueType, const MovingImageType *)
 
virtual const MovingImageTypeGetMovingImage (SizeValueType) const
 
virtual void SetFixedPointSet (const PointSetType *pointSet)
 
virtual const PointSetTypeGetFixedPointSet () const
 
virtual void SetFixedPointSet (SizeValueType, const PointSetType *)
 
virtual const PointSetTypeGetFixedPointSet (SizeValueType) const
 
virtual void SetMovingPointSet (const PointSetType *pointSet)
 
virtual const PointSetTypeGetMovingPointSet () const
 
virtual void SetMovingPointSet (SizeValueType, const PointSetType *)
 
virtual const PointSetTypeGetMovingPointSet (SizeValueType) const
 
virtual void SetOptimizer (OptimizerType *_arg)
 
virtual OptimizerTypeGetModifiableOptimizer ()
 
virtual const OptimizerTypeGetOptimizer () const
 
void SetOptimizerWeights (OptimizerWeightsType &)
 
virtual OptimizerWeightsType GetOptimizerWeights () const
 
virtual void SetMetric (MetricType *_arg)
 
virtual MetricTypeGetModifiableMetric ()
 
virtual const MetricTypeGetMetric () const
 
virtual void SetMetricSamplingStrategy (const MetricSamplingStrategyEnum _arg)
 
virtual MetricSamplingStrategyEnum GetMetricSamplingStrategy () const
 
void MetricSamplingReinitializeSeed ()
 
void MetricSamplingReinitializeSeed (int seed)
 
void SetMetricSamplingPercentage (const RealType)
 
virtual void SetMetricSamplingPercentagePerLevel (const MetricSamplingPercentageArrayType &samplingPercentages)
 
virtual MetricSamplingPercentageArrayType GetMetricSamplingPercentagePerLevel () const
 
virtual void SetFixedInitialTransformInput (const DataObjectDecorator< InitialTransformType > *_arg)
 
virtual void SetInputnumber (const DataObjectDecorator< InitialTransformType > *_arg)
 
virtual const DataObjectDecorator< InitialTransformType > * GetFixedInitialTransformInput () const
 
virtual const DataObjectDecorator< InitialTransformType > * GetInputnumber () const
 
virtual void SetFixedInitialTransform (const InitialTransformType *_arg)
 
virtual const DataObjectDecorator< InitialTransformType > * GetFixedInitialTransformInput () const
 
virtual const InitialTransformTypeGetFixedInitialTransform () const
 
virtual void SetMovingInitialTransformInput (const DataObjectDecorator< InitialTransformType > *_arg)
 
virtual void SetInputnumber (const DataObjectDecorator< InitialTransformType > *_arg)
 
virtual const DataObjectDecorator< InitialTransformType > * GetMovingInitialTransformInput () const
 
virtual const DataObjectDecorator< InitialTransformType > * GetInputnumber () const
 
virtual void SetMovingInitialTransform (const InitialTransformType *_arg)
 
virtual const DataObjectDecorator< InitialTransformType > * GetMovingInitialTransformInput () const
 
virtual const InitialTransformTypeGetMovingInitialTransform () const
 
virtual void SetInitialTransformInput (const DataObjectDecorator< InitialTransformType > *_arg)
 
virtual void SetInputnumber (const DataObjectDecorator< InitialTransformType > *_arg)
 
virtual const DataObjectDecorator< InitialTransformType > * GetInitialTransformInput () const
 
virtual const DataObjectDecorator< InitialTransformType > * GetInputnumber () const
 
virtual void SetInitialTransform (const InitialTransformType *_arg)
 
virtual const DataObjectDecorator< InitialTransformType > * GetInitialTransformInput () const
 
virtual const InitialTransformTypeGetInitialTransform () const
 
void SetTransformParametersAdaptorsPerLevel (TransformParametersAdaptorsContainerType &)
 
const TransformParametersAdaptorsContainerTypeGetTransformParametersAdaptorsPerLevel () const
 
void SetNumberOfLevels (const SizeValueType)
 
virtual SizeValueType GetNumberOfLevels () const
 
void SetShrinkFactorsPerLevel (ShrinkFactorsArrayType factors)
 
ShrinkFactorsPerDimensionContainerType GetShrinkFactorsPerDimension (const unsigned int level) const
 
void SetShrinkFactorsPerDimension (unsigned int level, ShrinkFactorsPerDimensionContainerType factors)
 
virtual void SetSmoothingSigmasPerLevel (SmoothingSigmasArrayType _arg)
 
virtual SmoothingSigmasArrayType GetSmoothingSigmasPerLevel () const
 
virtual void SetSmoothingSigmasAreSpecifiedInPhysicalUnits (bool _arg)
 
virtual bool GetSmoothingSigmasAreSpecifiedInPhysicalUnits () const
 
virtual void SmoothingSigmasAreSpecifiedInPhysicalUnitsOn ()
 
virtual void SmoothingSigmasAreSpecifiedInPhysicalUnitsOff ()
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType) override
 
virtual DecoratedOutputTransformTypeGetOutput ()
 
virtual const DecoratedOutputTransformTypeGetOutput () const
 
virtual DecoratedOutputTransformTypeGetTransformOutput ()
 
virtual const DecoratedOutputTransformTypeGetTransformOutput () const
 
virtual OutputTransformTypeGetModifiableTransform ()
 
virtual const OutputTransformTypeGetTransform () const
 
virtual SizeValueType GetCurrentLevel () const
 
virtual const SizeValueTypeGetCurrentIteration () const
 
virtual const RealTypeGetCurrentMetricValue () const
 
virtual const RealTypeGetCurrentConvergenceValue () const
 
virtual const bool & GetIsConverged () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
virtual void InitializeCenterOfLinearOutputTransformOn ()
 
virtual void InitializeCenterOfLinearOutputTransformOff ()
 
virtual void SetInitializeCenterOfLinearOutputTransform (bool _arg)
 
virtual bool GetInitializeCenterOfLinearOutputTransform () const
 
void InitializeCenterOfLinearOutputTransform ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TFixedImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
static constexpr unsigned int ImageDimension = TFixedImage::ImageDimension
 
RealType m_LearningRate { 0.25 }
 
OutputTransformPointer m_MovingToMiddleTransform { nullptr }
 
OutputTransformPointer m_FixedToMiddleTransform { nullptr }
 
RealType m_ConvergenceThreshold { static_cast<RealType>(1.0e-6) }
 
unsigned int m_ConvergenceWindowSize { 10 }
 
NumberOfIterationsArrayType m_NumberOfIterationsPerLevel
 
bool m_DownsampleImagesForMetricDerivatives { true }
 
bool m_AverageMidPointGradients { false }
 
RealType m_GaussianSmoothingVarianceForTheUpdateField { 3.0 }
 
RealType m_GaussianSmoothingVarianceForTheTotalField { 0.5 }
 
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 () const
 
virtual void SetGaussianSmoothingVarianceForTheTotalField (RealType _arg)
 
virtual const RealTypeGetGaussianSmoothingVarianceForTheTotalField () const
 
virtual OutputTransformTypeGetModifiableFixedToMiddleTransform ()
 
virtual const OutputTransformTypeGetFixedToMiddleTransform () const
 
virtual OutputTransformTypeGetModifiableMovingToMiddleTransform ()
 
virtual const OutputTransformTypeGetMovingToMiddleTransform () const
 
virtual void SetFixedToMiddleTransform (OutputTransformType *_arg)
 
virtual void SetMovingToMiddleTransform (OutputTransformType *_arg)
 
 SyNImageRegistrationMethod ()
 
 ~SyNImageRegistrationMethod () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateData () override
 
virtual void StartOptimization ()
 
void InitializeRegistrationAtEachLevel (const SizeValueType) override
 
virtual DisplacementFieldPointer ComputeUpdateField (const FixedImagesContainerType, const PointSetsContainerType, const TransformBaseType *, const MovingImagesContainerType, const PointSetsContainerType, const TransformBaseType *, const FixedImageMasksContainerType, const MovingImageMasksContainerType, MeasureType &)
 
virtual DisplacementFieldPointer ComputeMetricGradientField (const FixedImagesContainerType, const PointSetsContainerType, const TransformBaseType *, const MovingImagesContainerType, const PointSetsContainerType, const TransformBaseType *, const FixedImageMasksContainerType, const MovingImageMasksContainerType, MeasureType &)
 
virtual DisplacementFieldPointer ScaleUpdateField (const DisplacementFieldType *)
 
virtual DisplacementFieldPointer GaussianSmoothDisplacementField (const DisplacementFieldType *, const RealType)
 
virtual DisplacementFieldPointer InvertDisplacementField (const DisplacementFieldType *, const DisplacementFieldType *=nullptr)
 

Additional Inherited Members

- Protected Member Functions inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
 ImageRegistrationMethodv4 ()
 
 ~ImageRegistrationMethodv4 () override=default
 
virtual void AllocateOutputs ()
 
virtual VirtualImageBaseConstPointer GetCurrentLevelVirtualDomainImage ()
 
virtual void SetMetricSamplePoints ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >
SizeValueType m_CurrentLevel
 
SizeValueType m_NumberOfLevels
 
SizeValueType m_CurrentIteration
 
RealType m_CurrentMetricValue
 
RealType m_CurrentConvergenceValue
 
bool m_IsConverged
 
FixedImagesContainerType m_FixedSmoothImages
 
MovingImagesContainerType m_MovingSmoothImages
 
FixedImageMasksContainerType m_FixedImageMasks
 
MovingImageMasksContainerType m_MovingImageMasks
 
VirtualImagePointer m_VirtualDomainImage
 
PointSetsContainerType m_FixedPointSets
 
PointSetsContainerType m_MovingPointSets
 
SizeValueType m_NumberOfFixedObjects
 
SizeValueType m_NumberOfMovingObjects
 
OptimizerPointer m_Optimizer
 
OptimizerWeightsType m_OptimizerWeights
 
bool m_OptimizerWeightsAreIdentity
 
MetricPointer m_Metric
 
MetricSamplingStrategyEnum m_MetricSamplingStrategy
 
MetricSamplingPercentageArrayType m_MetricSamplingPercentagePerLevel
 
SizeValueType m_NumberOfMetrics
 
int m_FirstImageMetricIndex
 
std::vector< ShrinkFactorsPerDimensionContainerTypem_ShrinkFactorsPerLevel
 
SmoothingSigmasArrayType m_SmoothingSigmasPerLevel
 
bool m_SmoothingSigmasAreSpecifiedInPhysicalUnits
 
bool m_ReseedIterator
 
int m_RandomSeed
 
int m_CurrentRandomSeed
 
TransformParametersAdaptorsContainerType m_TransformParametersAdaptorsPerLevel
 
CompositeTransformPointer m_CompositeTransform
 
OutputTransformPointer m_OutputTransform
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
class itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >

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 71 of file itkSyNImageRegistrationMethod.h.

Member Typedef Documentation

◆ CompositeTransformType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::CompositeTransformType = typename Superclass::CompositeTransformType

Definition at line 136 of file itkSyNImageRegistrationMethod.h.

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::ConstPointer = SmartPointer<const Self>

Definition at line 81 of file itkSyNImageRegistrationMethod.h.

◆ DecoratedOutputTransformPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DecoratedOutputTransformPointer = typename DecoratedOutputTransformType::Pointer

Definition at line 140 of file itkSyNImageRegistrationMethod.h.

◆ DecoratedOutputTransformType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DecoratedOutputTransformType = typename Superclass::DecoratedOutputTransformType

Definition at line 139 of file itkSyNImageRegistrationMethod.h.

◆ DerivativeType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DerivativeType = typename OutputTransformType::DerivativeType

Definition at line 130 of file itkSyNImageRegistrationMethod.h.

◆ DerivativeValueType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DerivativeValueType = typename DerivativeType::ValueType

Definition at line 131 of file itkSyNImageRegistrationMethod.h.

◆ DisplacementFieldPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DisplacementFieldPointer = typename DisplacementFieldType::Pointer

Definition at line 133 of file itkSyNImageRegistrationMethod.h.

◆ DisplacementFieldTransformPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DisplacementFieldTransformPointer = typename DisplacementFieldTransformType::Pointer

Definition at line 143 of file itkSyNImageRegistrationMethod.h.

◆ DisplacementFieldTransformType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DisplacementFieldTransformType = DisplacementFieldTransform<RealType, ImageDimension>

Definition at line 142 of file itkSyNImageRegistrationMethod.h.

◆ DisplacementFieldType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DisplacementFieldType = typename OutputTransformType::DisplacementFieldType

Definition at line 132 of file itkSyNImageRegistrationMethod.h.

◆ DisplacementVectorType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::DisplacementVectorType = typename DisplacementFieldType::PixelType

Definition at line 134 of file itkSyNImageRegistrationMethod.h.

◆ FixedImageMasksContainerType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::FixedImageMasksContainerType = typename Superclass::FixedImageMasksContainerType

Definition at line 112 of file itkSyNImageRegistrationMethod.h.

◆ FixedImageMaskType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::FixedImageMaskType = typename Superclass::FixedImageMaskType

Definition at line 110 of file itkSyNImageRegistrationMethod.h.

◆ FixedImagePointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::FixedImagePointer = typename FixedImageType::Pointer

Definition at line 94 of file itkSyNImageRegistrationMethod.h.

◆ FixedImagesContainerType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::FixedImagesContainerType = typename Superclass::FixedImagesContainerType

Definition at line 95 of file itkSyNImageRegistrationMethod.h.

◆ FixedImageType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::FixedImageType = TFixedImage

Input type alias for the images.

Definition at line 93 of file itkSyNImageRegistrationMethod.h.

◆ FixedMaskImageType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::FixedMaskImageType = typename ImageMaskSpatialObjectType::ImageType

Definition at line 111 of file itkSyNImageRegistrationMethod.h.

◆ ImageMaskSpatialObjectType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::ImageMaskSpatialObjectType = ImageMaskSpatialObject<ImageDimension>

Definition at line 109 of file itkSyNImageRegistrationMethod.h.

◆ ImageMetricPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::ImageMetricPointer = typename ImageMetricType::Pointer

Definition at line 106 of file itkSyNImageRegistrationMethod.h.

◆ ImageMetricType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::ImageMetricType = typename Superclass::ImageMetricType

Metric and transform type alias

Definition at line 105 of file itkSyNImageRegistrationMethod.h.

◆ InitialTransformType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::InitialTransformType = typename Superclass::InitialTransformType

Definition at line 126 of file itkSyNImageRegistrationMethod.h.

◆ MeasureType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MeasureType = typename ImageMetricType::MeasureType

Definition at line 107 of file itkSyNImageRegistrationMethod.h.

◆ MetricPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MetricPointer = typename MetricType::Pointer

Definition at line 123 of file itkSyNImageRegistrationMethod.h.

◆ MetricType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MetricType = typename Superclass::MetricType

Definition at line 122 of file itkSyNImageRegistrationMethod.h.

◆ MovingImageMasksContainerType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MovingImageMasksContainerType = typename Superclass::MovingImageMasksContainerType

Definition at line 115 of file itkSyNImageRegistrationMethod.h.

◆ MovingImageMaskType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MovingImageMaskType = typename Superclass::MovingImageMaskType

Definition at line 113 of file itkSyNImageRegistrationMethod.h.

◆ MovingImagePointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MovingImagePointer = typename MovingImageType::Pointer

Definition at line 97 of file itkSyNImageRegistrationMethod.h.

◆ MovingImagesContainerType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MovingImagesContainerType = typename Superclass::MovingImagesContainerType

Definition at line 98 of file itkSyNImageRegistrationMethod.h.

◆ MovingImageType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MovingImageType = TMovingImage

Definition at line 96 of file itkSyNImageRegistrationMethod.h.

◆ MovingMaskImageType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MovingMaskImageType = typename ImageMaskSpatialObjectType::ImageType

Definition at line 114 of file itkSyNImageRegistrationMethod.h.

◆ MultiMetricType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::MultiMetricType = typename Superclass::MultiMetricType

Definition at line 121 of file itkSyNImageRegistrationMethod.h.

◆ NumberOfIterationsArrayType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::NumberOfIterationsArrayType = Array<SizeValueType>

Definition at line 145 of file itkSyNImageRegistrationMethod.h.

◆ OutputTransformPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::OutputTransformPointer = typename OutputTransformType::Pointer

Definition at line 128 of file itkSyNImageRegistrationMethod.h.

◆ OutputTransformType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::OutputTransformType = TOutputTransform

Definition at line 127 of file itkSyNImageRegistrationMethod.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::Pointer = SmartPointer<Self>

Definition at line 80 of file itkSyNImageRegistrationMethod.h.

◆ PointSetMetricType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::PointSetMetricType = typename Superclass::PointSetMetricType

Definition at line 124 of file itkSyNImageRegistrationMethod.h.

◆ PointSetPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::PointSetPointer = typename PointSetType::Pointer

Definition at line 101 of file itkSyNImageRegistrationMethod.h.

◆ PointSetsContainerType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::PointSetsContainerType = typename Superclass::PointSetsContainerType

Definition at line 102 of file itkSyNImageRegistrationMethod.h.

◆ PointSetType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::PointSetType = typename Superclass::PointSetType

Definition at line 100 of file itkSyNImageRegistrationMethod.h.

◆ RealType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::RealType = typename OutputTransformType::ScalarType

Definition at line 129 of file itkSyNImageRegistrationMethod.h.

◆ Self

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::Self = SyNImageRegistrationMethod

Standard class type aliases.

Definition at line 78 of file itkSyNImageRegistrationMethod.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::Superclass = ImageRegistrationMethodv4<TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet>

Definition at line 79 of file itkSyNImageRegistrationMethod.h.

◆ TransformBaseType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::TransformBaseType = typename CompositeTransformType::TransformType

Definition at line 137 of file itkSyNImageRegistrationMethod.h.

◆ VirtualImageBaseConstPointer

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::VirtualImageBaseConstPointer = typename Superclass::VirtualImageBaseConstPointer

Definition at line 119 of file itkSyNImageRegistrationMethod.h.

◆ VirtualImageBaseType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::VirtualImageBaseType = typename Superclass::VirtualImageBaseType

Definition at line 118 of file itkSyNImageRegistrationMethod.h.

◆ VirtualImageType

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
using itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::VirtualImageType = typename Superclass::VirtualImageType

Definition at line 117 of file itkSyNImageRegistrationMethod.h.

Constructor & Destructor Documentation

◆ SyNImageRegistrationMethod()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SyNImageRegistrationMethod ( )
protected

Set/Get the learning rate.

◆ ~SyNImageRegistrationMethod()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::~SyNImageRegistrationMethod ( )
overrideprotecteddefault

Set/Get the learning rate.

Member Function Documentation

◆ ComputeMetricGradientField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual DisplacementFieldPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::ComputeMetricGradientField ( const  FixedImagesContainerType,
const  PointSetsContainerType,
const TransformBaseType ,
const  MovingImagesContainerType,
const  PointSetsContainerType,
const TransformBaseType ,
const  FixedImageMasksContainerType,
const  MovingImageMasksContainerType,
MeasureType  
)
protectedvirtual

Set/Get the learning rate.

◆ ComputeUpdateField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual DisplacementFieldPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::ComputeUpdateField ( const  FixedImagesContainerType,
const  PointSetsContainerType,
const TransformBaseType ,
const  MovingImagesContainerType,
const  PointSetsContainerType,
const TransformBaseType ,
const  FixedImageMasksContainerType,
const  MovingImageMasksContainerType,
MeasureType  
)
protectedvirtual

Set/Get the learning rate.

◆ CreateAnother()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::CreateAnother ( ) 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, TVirtualImage, TPointSet >.

◆ GaussianSmoothDisplacementField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual DisplacementFieldPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GaussianSmoothDisplacementField ( const DisplacementFieldType ,
const  RealType 
)
protectedvirtual

Set/Get the learning rate.

◆ GenerateData()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GenerateData ( )
overrideprotectedvirtual

◆ GetAverageMidPointGradients()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual bool itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetAverageMidPointGradients ( ) const
virtual

Set/Get the learning rate.

◆ GetConvergenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual RealType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetConvergenceThreshold ( ) const
virtual

Set/Get the learning rate.

◆ GetConvergenceWindowSize()

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

Set/Get the learning rate.

◆ GetDownsampleImagesForMetricDerivatives()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual bool itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetDownsampleImagesForMetricDerivatives ( ) const
virtual

Set/Get the learning rate.

◆ GetFixedToMiddleTransform()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual const OutputTransformType* itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetFixedToMiddleTransform ( ) const
virtual

Set/Get the learning rate.

◆ GetGaussianSmoothingVarianceForTheTotalField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual const RealType& itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetGaussianSmoothingVarianceForTheTotalField ( ) const
virtual

Set/Get the learning rate.

◆ GetGaussianSmoothingVarianceForTheUpdateField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual const RealType& itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetGaussianSmoothingVarianceForTheUpdateField ( ) const
virtual

Set/Get the learning rate.

◆ GetLearningRate()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual RealType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetLearningRate ( ) const
virtual

Set/Get the learning rate.

◆ GetModifiableFixedToMiddleTransform()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual OutputTransformType* itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetModifiableFixedToMiddleTransform ( )
virtual

Get modifiable FixedToMiddle and MovingToMidle transforms to save the current state of the registration.

◆ GetModifiableMovingToMiddleTransform()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual OutputTransformType* itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetModifiableMovingToMiddleTransform ( )
virtual

Set/Get the learning rate.

◆ GetMovingToMiddleTransform()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual const OutputTransformType* itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetMovingToMiddleTransform ( ) const
virtual

Set/Get the learning rate.

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual const char* itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetNameOfClass ( ) const
virtual

◆ GetNumberOfIterationsPerLevel()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual NumberOfIterationsArrayType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::GetNumberOfIterationsPerLevel ( ) const
virtual

Set/Get the learning rate.

◆ InitializeRegistrationAtEachLevel()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::InitializeRegistrationAtEachLevel ( const  SizeValueType)
overrideprotectedvirtual

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, TVirtualImage, TPointSet >.

◆ InvertDisplacementField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual DisplacementFieldPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::InvertDisplacementField ( const DisplacementFieldType ,
const DisplacementFieldType = nullptr 
)
protectedvirtual

Set/Get the learning rate.

◆ New()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
static Pointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

◆ ScaleUpdateField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual DisplacementFieldPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::ScaleUpdateField ( const DisplacementFieldType )
protectedvirtual

Set/Get the learning rate.

◆ SetAverageMidPointGradients()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::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.

◆ SetConvergenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetConvergenceThreshold ( RealType  _arg)
virtual

Set/Get the convergence threshold

◆ SetConvergenceWindowSize()

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

Set/Get the convergence window size

◆ SetDownsampleImagesForMetricDerivatives()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::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.

◆ SetFixedToMiddleTransform()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetFixedToMiddleTransform ( OutputTransformType _arg)
virtual

Set FixedToMiddle and MovingToMidle transforms to restore the registration from a saved state.

◆ SetGaussianSmoothingVarianceForTheTotalField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetGaussianSmoothingVarianceForTheTotalField ( RealType  _arg)
virtual

Get/Set the Gaussian smoothing variance for the total field.

◆ SetGaussianSmoothingVarianceForTheUpdateField()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetGaussianSmoothingVarianceForTheUpdateField ( RealType  _arg)
virtual

Get/Set the Gaussian smoothing variance for the update field.

◆ SetLearningRate()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetLearningRate ( RealType  _arg)
virtual

Set/Get the learning rate.

◆ SetMovingToMiddleTransform()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetMovingToMiddleTransform ( OutputTransformType _arg)
virtual

Set/Get the learning rate.

◆ SetNumberOfIterationsPerLevel()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetNumberOfIterationsPerLevel ( NumberOfIterationsArrayType  _arg)
virtual

Set/Get the number of iterations per level.

◆ StartOptimization()

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
virtual void itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::StartOptimization ( )
protectedvirtual

Member Data Documentation

◆ ImageDimension

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
constexpr unsigned int itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::ImageDimension = TFixedImage::ImageDimension
staticconstexpr

ImageDimension constants

Definition at line 87 of file itkSyNImageRegistrationMethod.h.

◆ m_AverageMidPointGradients

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
bool itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_AverageMidPointGradients { false }
protected

Set/Get the learning rate.

Definition at line 265 of file itkSyNImageRegistrationMethod.h.

◆ m_ConvergenceThreshold

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
RealType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_ConvergenceThreshold { static_cast<RealType>(1.0e-6) }
protected

Set/Get the learning rate.

Definition at line 260 of file itkSyNImageRegistrationMethod.h.

◆ m_ConvergenceWindowSize

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
unsigned int itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_ConvergenceWindowSize { 10 }
protected

Set/Get the learning rate.

Definition at line 261 of file itkSyNImageRegistrationMethod.h.

◆ m_DownsampleImagesForMetricDerivatives

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
bool itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_DownsampleImagesForMetricDerivatives { true }
protected

Set/Get the learning rate.

Definition at line 264 of file itkSyNImageRegistrationMethod.h.

◆ m_FixedToMiddleTransform

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
OutputTransformPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_FixedToMiddleTransform { nullptr }
protected

Set/Get the learning rate.

Definition at line 258 of file itkSyNImageRegistrationMethod.h.

◆ m_GaussianSmoothingVarianceForTheTotalField

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
RealType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_GaussianSmoothingVarianceForTheTotalField { 0.5 }
private

Set/Get the learning rate.

Definition at line 269 of file itkSyNImageRegistrationMethod.h.

◆ m_GaussianSmoothingVarianceForTheUpdateField

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
RealType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_GaussianSmoothingVarianceForTheUpdateField { 3.0 }
private

Set/Get the learning rate.

Definition at line 268 of file itkSyNImageRegistrationMethod.h.

◆ m_LearningRate

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
RealType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_LearningRate { 0.25 }
protected

Set/Get the learning rate.

Definition at line 255 of file itkSyNImageRegistrationMethod.h.

◆ m_MovingToMiddleTransform

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
OutputTransformPointer itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_MovingToMiddleTransform { nullptr }
protected

Set/Get the learning rate.

Definition at line 257 of file itkSyNImageRegistrationMethod.h.

◆ m_NumberOfIterationsPerLevel

template<typename TFixedImage , typename TMovingImage , typename TOutputTransform = DisplacementFieldTransform<double, TFixedImage::ImageDimension>, typename TVirtualImage = TFixedImage, typename TPointSet = PointSet<unsigned int, TFixedImage::ImageDimension>>
NumberOfIterationsArrayType itk::SyNImageRegistrationMethod< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::m_NumberOfIterationsPerLevel
protected

Set/Get the learning rate.

Definition at line 263 of file itkSyNImageRegistrationMethod.h.


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