ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField > Class Template Reference

#include <itkLevelSetMotionRegistrationFilter.h>

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

Deformably register two images using level set motion.

LevelSetMotionFilter implements a deformable registration algorithm that aligns a fixed and a moving image under level set motion. The equations of motion are similar to those of the DemonsRegistrationFilter. The main differences are: (1) Gradients of the moving image are calculated on a smoothed image while intensity difference are measured on the original images (2) Magnitude of the motion vector is a function of the differences in intensity between the fixed and moving pixel. An adaptive timestep is calculated based on the maximum motion vector over the entire field to ensure stability. The timestep also implicitly converts the motion vector measured in units of intensity to a vector measured in physical units. Demons, on the other hand, defines its motion vectors as function of both the intensity differences and gradient magnitude at each respective pixel. Consider two separate pixels with the same intensity differences between the corresponding fixed and moving pixel pairs. In demons, the motion vector of the pixel over a low gradient region will be larger than the motion vector of the pixel over a large gradient region. This leads to an unstable vector field. In the levelset approach, the motion vectors will be proportional to the gradients, scaled by the maximum gradient over the entire field. The pixel with at the lower gradient position will more less than the pixel at the higher gradient position. (3) Gradients are calculated using minmod finite difference instead of using central differences.

A deformation 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 deformation field type.

The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial deformation 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 deformation 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 LevelSetMotionFunction.

Warning
This filter assumes that the fixed image type, moving image type and deformation field type all have the same number of dimensions.

Ref: B.C. Vemuri, J. Ye, Y. Chen, C.M. Leonard. "Image registration via level-set motion: applications to atlas-based segmentation". Medical Image Analysis. Vol. 7. pp. 1-20. 2003.

See also
LevelSetMotionRegistrationFunction
DemonsRegistrationFilter
Examples
Examples/RegistrationITKv4/DeformableRegistration5.cxx.

Definition at line 91 of file itkLevelSetMotionRegistrationFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using LevelSetMotionFunctionType = LevelSetMotionRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType >
 
using Pointer = SmartPointer< Self >
 
using Self = LevelSetMotionRegistrationFilter
 
using Superclass = PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
 
- Public Types inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using DisplacementFieldPointer = typename DisplacementFieldType::Pointer
 
using DisplacementFieldType = TDisplacementField
 
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 PDEDeformableRegistrationFunctionType = PDEDeformableRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType >
 
using Pointer = SmartPointer< Self >
 
using Self = PDEDeformableRegistrationFilter
 
using StandardDeviationsType = FixedArray< double, ImageDimension >
 
using Superclass = DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
 
- Public Types inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = DenseFiniteDifferenceImageFilter
 
using Superclass = FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
 
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 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 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 double GetAlpha () const
 
virtual double GetGradientMagnitudeThreshold () const
 
virtual double GetGradientSmoothingStandardDeviations () const
 
virtual double GetIntensityDifferenceThreshold () const
 
virtual double GetMetric () const
 
 itkOverrideGetNameOfClassMacro (LevelSetMotionRegistrationFilter)
 
virtual void SetAlpha (double)
 
virtual void SetGradientMagnitudeThreshold (double)
 
virtual void SetGradientSmoothingStandardDeviations (double sigma)
 
virtual void SetIntensityDifferenceThreshold (double)
 
- Public Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
DisplacementFieldTypeGetDisplacementField ()
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual const DisplacementFieldTypeGetInitialDisplacementField () const
 
virtual const MovingImageTypeGetMovingImage () const
 
std::vector< SmartPointer< DataObject > >::size_type GetNumberOfValidRequiredInputs () const override
 
virtual const StandardDeviationsTypeGetStandardDeviations () const
 
virtual const StandardDeviationsTypeGetUpdateFieldStandardDeviations () const
 
 itkOverrideGetNameOfClassMacro (PDEDeformableRegistrationFilter)
 
virtual void SetFixedImage (const FixedImageType *input)
 
virtual void SetInitialDisplacementField (const DisplacementFieldType *input)
 
virtual void SetMovingImage (const MovingImageType *input)
 
virtual void StopRegistration ()
 
virtual void SetSmoothDisplacementField (bool _arg)
 
virtual bool GetSmoothDisplacementField () const
 
virtual void SmoothDisplacementFieldOn ()
 
virtual void SetStandardDeviations (StandardDeviationsType _arg)
 
virtual void SetStandardDeviations (double value)
 
virtual void SetSmoothUpdateField (bool _arg)
 
virtual bool GetSmoothUpdateField () const
 
virtual void SmoothUpdateFieldOn ()
 
virtual void SetUpdateFieldStandardDeviations (StandardDeviationsType _arg)
 
virtual void SetUpdateFieldStandardDeviations (double value)
 
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::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
 itkOverrideGetNameOfClassMacro (DenseFiniteDifferenceImageFilter)
 
- Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
virtual const FiniteDifferenceFunctionType ::PointerGetDifferenceFunction () const
 
virtual const IdentifierTypeGetElapsedIterations () const
 
virtual bool GetIsInitialized ()
 
 itkOverrideGetNameOfClassMacro (FiniteDifferenceImageFilter)
 
virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
 
virtual void SetIsInitialized (bool _arg)
 
void SetStateToInitialized ()
 
void SetStateToUninitialized ()
 
virtual void SetNumberOfIterations (IdentifierType _arg)
 
virtual const IdentifierTypeGetNumberOfIterations () const
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual void UseImageSpacingOn ()
 
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 ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
virtual bool CanRunInPlace () const
 
 itkOverrideGetNameOfClassMacro (InPlaceImageFilter)
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
 itkOverrideGetNameOfClassMacro (ImageToImageFilter)
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
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 (unsigned int idx)
 
 itkOverrideGetNameOfClassMacro (ImageSource)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
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)
 
 itkOverrideGetNameOfClassMacro (ProcessObject)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void ApplyUpdate (const TimeStepType &dt) override
 
bool Halt () override
 
void InitializeIteration () override
 
 LevelSetMotionRegistrationFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~LevelSetMotionRegistrationFilter () override=default
 
- Protected Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
void CopyInputToOutput () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
bool Halt () override
 
void Initialize () override
 
void InitializeIteration () override
 
 PDEDeformableRegistrationFilter ()
 
void PostProcessOutput () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SmoothDisplacementField ()
 
virtual void SmoothUpdateField ()
 
 ~PDEDeformableRegistrationFilter () override=default
 
- 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 ()
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const
 
virtual void SetElapsedIterations (IdentifierType _arg)
 
virtual bool ThreadedHalt (void *)
 
 ~FiniteDifferenceImageFilter () override=default
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageToImageFilter () override=default
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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 ()
 

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 >
 
- 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 >
IdentifierType m_ElapsedIterations
 
bool m_IsInitialized
 
bool m_ManualReinitialization
 
double m_MaximumRMSError
 
IdentifierType m_NumberOfIterations
 
double m_RMSChange
 
- Protected Attributes inherited from itk::ImageSource< TDisplacementField >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 101 of file itkLevelSetMotionRegistrationFilter.h.

◆ LevelSetMotionFunctionType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
using itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::LevelSetMotionFunctionType = LevelSetMotionRegistrationFunction<FixedImageType, MovingImageType, DisplacementFieldType>

LevelSetMotionFilterFunction type.

Definition at line 129 of file itkLevelSetMotionRegistrationFilter.h.

◆ Pointer

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

Definition at line 100 of file itkLevelSetMotionRegistrationFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 98 of file itkLevelSetMotionRegistrationFilter.h.

◆ Superclass

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

Definition at line 99 of file itkLevelSetMotionRegistrationFilter.h.

Constructor & Destructor Documentation

◆ LevelSetMotionRegistrationFilter()

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

◆ ~LevelSetMotionRegistrationFilter()

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

Member Function Documentation

◆ ApplyUpdate()

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

◆ GetAlpha()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetAlpha ( ) const
virtual

◆ GetGradientMagnitudeThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetGradientMagnitudeThreshold ( ) const
virtual

◆ GetGradientSmoothingStandardDeviations()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetGradientSmoothingStandardDeviations ( ) const
virtual

◆ GetIntensityDifferenceThreshold()

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

◆ GetMetric()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual double itk::LevelSetMotionRegistrationFilter< 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.

◆ Halt()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
bool itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Halt ( )
overrideprotectedvirtual

This method returns true when the current iterative solution of the equation has met the criteria to stop solving. This version calls the superclass' version but also Halts if the RMSChange is zero.

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

◆ InitializeIteration()

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

Initialize the state of filter and equation before each iteration.

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

◆ itkOverrideGetNameOfClassMacro()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::itkOverrideGetNameOfClassMacro ( LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >  )

Run-time type information (and related methods).

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

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

Reimplemented from itk::ProcessObject.

◆ SetAlpha()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetAlpha ( double  )
virtual

Set/Get the parameter alpha. Alpha is added to the calculated gradient magnitude prior to normalizing the gradient to protect against numerical instability as the gradient magnitude approaches zero. This should be set as a small fraction of the intensity dynamic range, for instance 0.04%. Default is the absolute (not percentage) value of 0.1.

◆ SetGradientMagnitudeThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetGradientMagnitudeThreshold ( double  )
virtual

Set/Get the threshold below which the gradient magnitude is considered the zero vector. Default is 1e-9.

◆ SetGradientSmoothingStandardDeviations()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetGradientSmoothingStandardDeviations ( double  sigma)
virtual

Set/Get the standard deviation used for smoothing the moving image prior to calculating gradients. The standard deviation is measured in physical units (for instance mm). Note that this smoothing value is not to be confused with the PDEDeformableRegistrationFilter::SetStandardDeviations() method. The method in PDEDeformableRegistrationFilter is for setting the smoothing parameters for regularizing the deformation field between iterations. Those smoothing parameters are set in pixel units not physical units. Deformation field smoothing is not done by default in LevelSetMotionRegistration. This smoothing parameter is to condition the gradient calculation and parameter is specified in physical units.

◆ SetIntensityDifferenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual void itk::LevelSetMotionRegistrationFilter< 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.


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