ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members

#include <itkDemonsRegistrationFilter.h>

+ Inheritance diagram for itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >:
+ Collaboration diagram for itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DemonsRegistrationFunctionType = DemonsRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType >
 
using DisplacementFieldPointer = typename Superclass::DisplacementFieldPointer
 
using DisplacementFieldType = typename Superclass::DisplacementFieldType
 
using FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType
 
using FixedImagePointer = typename Superclass::FixedImagePointer
 
using FixedImageType = typename Superclass::FixedImageType
 
using MovingImagePointer = typename Superclass::MovingImagePointer
 
using MovingImageType = typename Superclass::MovingImageType
 
using Pointer = SmartPointer< Self >
 
using Self = DemonsRegistrationFilter
 
using Superclass = PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
 
using TimeStepType = typename Superclass::TimeStepType
 
- Public Types inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using DisplacementFieldPointer = typename DisplacementFieldType::Pointer
 
using DisplacementFieldType = TDisplacementField
 
using FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType
 
using FixedImageConstPointer = typename FixedImageType::ConstPointer
 
using FixedImagePointer = typename FixedImageType::Pointer
 
using FixedImageType = TFixedImage
 
using MovingImageConstPointer = typename MovingImageType::ConstPointer
 
using MovingImagePointer = typename MovingImageType::Pointer
 
using MovingImageType = TMovingImage
 
using OutputImageType = typename Superclass::OutputImageType
 
using PDEDeformableRegistrationFunctionType = PDEDeformableRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType >
 
using Pointer = SmartPointer< Self >
 
using Self = PDEDeformableRegistrationFilter
 
using Superclass = DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
 
using StandardDeviationsType = FixedArray< double, ImageDimension >
 
- Public Types inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType
 
using InputImageType = typename Superclass::InputImageType
 
using OutputImageType = typename Superclass::OutputImageType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = DenseFiniteDifferenceImageFilter
 
using Superclass = FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
 
using TimeStepType = typename Superclass::TimeStepType
 
using UpdateBufferType = OutputImageType
 
- Public Types inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using FiniteDifferenceFunctionType = FiniteDifferenceFunction< TDisplacementField >
 
using InputImageType = TDisplacementField
 
using InputPixelType = typename TDisplacementField ::PixelType
 
using InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType
 
using NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType
 
using OutputImageType = TDisplacementField
 
using OutputPixelType = typename TDisplacementField ::PixelType
 
using OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType
 
using PixelType = OutputPixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename FiniteDifferenceFunctionType::RadiusType
 
using Self = FiniteDifferenceImageFilter
 
using Superclass = InPlaceImageFilter< TDisplacementField, TDisplacementField >
 
using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType
 
- Public Types inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TDisplacementField
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImagePointer = typename Superclass::OutputImagePointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = typename Superclass::OutputImageType
 
using Pointer = SmartPointer< Self >
 
using Self = InPlaceImageFilter
 
using Superclass = ImageToImageFilter< TDisplacementField, TDisplacementField >
 
- Public Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TDisplacementField
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TDisplacementField >
 
- Public Types inherited from itk::ImageSource< TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TDisplacementField
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- 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 double GetMetric () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
DisplacementFieldTypeGetDisplacementField ()
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual const DisplacementFieldTypeGetInitialDisplacementField () const
 
virtual const MovingImageTypeGetMovingImage () const
 
std::vector< SmartPointer< DataObject > >::size_type GetNumberOfValidRequiredInputs () const override
 
virtual void SetFixedImage (const FixedImageType *input)
 
virtual void SetInitialDisplacementField (const DisplacementFieldType *input)
 
virtual void SetMovingImage (const MovingImageType *input)
 
virtual void SetSmoothDisplacementField (bool _arg)
 
virtual bool GetSmoothDisplacementField () const
 
virtual void SmoothDisplacementFieldOn ()
 
virtual void SmoothDisplacementFieldOff ()
 
virtual void SetStandardDeviations (StandardDeviationsType _arg)
 
virtual void SetStandardDeviations (double value)
 
virtual const StandardDeviationsTypeGetStandardDeviations () const
 
virtual void SetSmoothUpdateField (bool _arg)
 
virtual bool GetSmoothUpdateField () const
 
virtual void SmoothUpdateFieldOn ()
 
virtual void SmoothUpdateFieldOff ()
 
virtual void SetUpdateFieldStandardDeviations (StandardDeviationsType _arg)
 
virtual void SetUpdateFieldStandardDeviations (double value)
 
virtual const StandardDeviationsTypeGetUpdateFieldStandardDeviations () const
 
virtual void StopRegistration ()
 
virtual void SetMaximumError (double _arg)
 
virtual double GetMaximumError () const
 
virtual void SetMaximumKernelWidth (unsigned int _arg)
 
virtual unsigned int GetMaximumKernelWidth () const
 
- Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
virtual const FiniteDifferenceFunctionType ::PointerGetDifferenceFunction () const
 
virtual const IdentifierTypeGetElapsedIterations () const
 
virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
 
virtual void SetNumberOfIterations (IdentifierType _arg)
 
virtual const IdentifierTypeGetNumberOfIterations () const
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual void UseImageSpacingOn ()
 
virtual void UseImageSpacingOff ()
 
virtual const bool & GetUseImageSpacing () const
 
virtual void SetMaximumRMSError (double _arg)
 
virtual const double & GetMaximumRMSError () const
 
virtual void SetRMSChange (double _arg)
 
virtual const double & GetRMSChange () const
 
virtual void SetManualReinitialization (bool _arg)
 
virtual const bool & GetManualReinitialization () const
 
virtual void ManualReinitializationOn ()
 
virtual void ManualReinitializationOff ()
 
virtual void SetIsInitialized (bool _arg)
 
virtual bool GetIsInitialized ()
 
void SetStateToUninitialized ()
 
void SetStateToInitialized ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
virtual bool CanRunInPlace () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TDisplacementField *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TDisplacementField >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- 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
 
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 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::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- 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 ()
 
bool m_UseMovingImageGradient
 
virtual void SetUseMovingImageGradient (bool _arg)
 
virtual bool GetUseMovingImageGradient () const
 
virtual void UseMovingImageGradientOn ()
 
virtual void UseMovingImageGradientOff ()
 
virtual void SetIntensityDifferenceThreshold (double)
 
virtual double GetIntensityDifferenceThreshold () const
 
 DemonsRegistrationFilter ()
 
 ~DemonsRegistrationFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void InitializeIteration () override
 
void ApplyUpdate (const TimeStepType &dt) override
 
void VerifyInputInformation () ITKv5_CONST override
 

Additional Inherited Members

- Static Public Attributes inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TDisplacementField >
static constexpr unsigned int OutputImageDimension
 
- Protected Types inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
using ThreadRegionType = typename UpdateBufferType::RegionType
 
- Protected Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
 PDEDeformableRegistrationFilter ()
 
 ~PDEDeformableRegistrationFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool Halt () override
 
void CopyInputToOutput () override
 
void InitializeIteration () override
 
virtual void SmoothDisplacementField ()
 
virtual void SmoothUpdateField ()
 
void PostProcessOutput () override
 
void Initialize () override
 
void GenerateOutputInformation () override
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
void AllocateUpdateBuffer () override
 
void ApplyUpdate (const TimeStepType &dt) override
 
TimeStepType CalculateChange () override
 
void CopyInputToOutput () override
 
 DenseFiniteDifferenceImageFilter ()
 
virtual UpdateBufferTypeGetUpdateBuffer ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)
 
virtual TimeStepType ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)
 
 ~DenseFiniteDifferenceImageFilter () override=default
 
- Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
 FiniteDifferenceImageFilter ()
 
 ~FiniteDifferenceImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void ApplyUpdate (const TimeStepType &dt)=0
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
virtual bool ThreadedHalt (void *)
 
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
 
virtual void SetElapsedIterations (IdentifierType _arg)
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
 InPlaceImageFilter ()=default
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
void ReleaseInputs () override
 
virtual bool GetRunningInPlace () const
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
- Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- 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 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 GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
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::ImageSource< TDisplacementField >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- 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::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
bool m_IsInitialized
 
IdentifierType m_NumberOfIterations
 
IdentifierType m_ElapsedIterations
 
bool m_ManualReinitialization
 
double m_RMSChange
 
double m_MaximumRMSError
 
- Protected Attributes inherited from itk::ImageSource< TDisplacementField >
bool m_DynamicMultiThreading
 
- 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 TDisplacementField>
class itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

Deformably register two images using the demons algorithm.

DemonsRegistrationFilter implements the demons deformable algorithm that register two images by computing the displacement field which will map a moving image onto a fixed image.

A displacement field is represented as a image whose pixel type is some vector type with at least N elements, where N is the dimension of the fixed image. The vector type must support element access via operator []. It is assumed that the vector elements behave like floating point scalars.

This class is templated over the fixed image type, moving image type and the displacement field type.

The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial displacement field maybe set via SetInitialDisplacementField or SetInput. If no initial field is set, a zero field is used as the initial condition.

The algorithm has one parameters: the number of iteration to be performed.

The output displacement field can be obtained via methods GetOutput or GetDisplacementField.

This class make use of the finite difference solver hierarchy. Update for each iteration is computed in DemonsRegistrationFunction.

Warning
This filter assumes that the fixed image type, moving image type and displacement field type all have the same number of dimensions.
See also
DemonsRegistrationFunction
Examples
Examples/RegistrationITKv4/DeformableRegistration16.cxx, and Examples/RegistrationITKv4/DeformableRegistration2.cxx.

Definition at line 63 of file itkDemonsRegistrationFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer = SmartPointer<const Self>

Definition at line 73 of file itkDemonsRegistrationFilter.h.

◆ DemonsRegistrationFunctionType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DemonsRegistrationFunctionType = DemonsRegistrationFunction<FixedImageType, MovingImageType, DisplacementFieldType>

DemonsRegistrationFilterFunction type.

Definition at line 101 of file itkDemonsRegistrationFilter.h.

◆ DisplacementFieldPointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldPointer = typename Superclass::DisplacementFieldPointer

Definition at line 94 of file itkDemonsRegistrationFilter.h.

◆ DisplacementFieldType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType = typename Superclass::DisplacementFieldType

displacement field type.

Definition at line 93 of file itkDemonsRegistrationFilter.h.

◆ FiniteDifferenceFunctionType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType

FiniteDifferenceFunction type.

Definition at line 97 of file itkDemonsRegistrationFilter.h.

◆ FixedImagePointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer = typename Superclass::FixedImagePointer

Definition at line 86 of file itkDemonsRegistrationFilter.h.

◆ FixedImageType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType = typename Superclass::FixedImageType

FixedImage image type.

Definition at line 85 of file itkDemonsRegistrationFilter.h.

◆ MovingImagePointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer = typename Superclass::MovingImagePointer

Definition at line 90 of file itkDemonsRegistrationFilter.h.

◆ MovingImageType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType = typename Superclass::MovingImageType

MovingImage image type.

Definition at line 89 of file itkDemonsRegistrationFilter.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Pointer = SmartPointer<Self>

Definition at line 72 of file itkDemonsRegistrationFilter.h.

◆ Self

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Self = DemonsRegistrationFilter

Standard class type aliases.

Definition at line 70 of file itkDemonsRegistrationFilter.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Superclass = PDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>

Definition at line 71 of file itkDemonsRegistrationFilter.h.

◆ TimeStepType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::TimeStepType = typename Superclass::TimeStepType

Inherit types from superclass.

Definition at line 82 of file itkDemonsRegistrationFilter.h.

Constructor & Destructor Documentation

◆ DemonsRegistrationFilter()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DemonsRegistrationFilter ( )
protected

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

◆ ~DemonsRegistrationFilter()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::~DemonsRegistrationFilter ( )
overrideprotecteddefault

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

Member Function Documentation

◆ ApplyUpdate()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ApplyUpdate ( const TimeStepType dt)
overrideprotected

Apply update.

◆ CreateAnother()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual::itk::LightObject::Pointer itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::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::Object.

◆ GetIntensityDifferenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetIntensityDifferenceThreshold ( ) const
virtual

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

◆ GetMetric()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetMetric ( ) const
virtual

Get the metric value. The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images. This is value is only available for the previous iteration and NOT the current iteration.

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual const char* itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

◆ GetUseMovingImageGradient()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual bool itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetUseMovingImageGradient ( ) const
virtual

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

◆ InitializeIteration()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::InitializeIteration ( )
overrideprotectedvirtual

Initialize the state of filter and equation before each iteration.

Reimplemented from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.

◆ New()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
static Pointer itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

Reimplemented from itk::ProcessObject.

◆ SetIntensityDifferenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetIntensityDifferenceThreshold ( double  )
virtual

Set/Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001.

◆ SetUseMovingImageGradient()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetUseMovingImageGradient ( bool  _arg)
virtual

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

◆ UseMovingImageGradientOff()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::UseMovingImageGradientOff ( )
virtual

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

◆ UseMovingImageGradientOn()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::UseMovingImageGradientOn ( )
virtual

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

◆ VerifyInputInformation()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::VerifyInputInformation ( )
inlineoverrideprotectedvirtual

Override VerifyInputInformation() since this filter's inputs do not need to occupy the same physical space.

See also
ProcessObject::VerifyInputInformation

Reimplemented from itk::ProcessObject.

Definition at line 148 of file itkDemonsRegistrationFilter.h.

Member Data Documentation

◆ m_UseMovingImageGradient

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
bool itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_UseMovingImageGradient
private

Switch between using the fixed image and moving image gradient for computing the displacement field updates.

Definition at line 152 of file itkDemonsRegistrationFilter.h.


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