Deformably register two images using the demons algorithm. More...

#include <itkSymmetricForcesDemonsRegistrationFilter.h>

Inheritance diagram for itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >:

Collaboration diagram for itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >:

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef Superclass::DeformationFieldPointer	DeformationFieldPointer

typedef Superclass::DeformationFieldType	DeformationFieldType

typedef SymmetricForcesDemonsRegistrationFunction < FixedImageType, MovingImageType, DeformationFieldType >	DemonsRegistrationFunctionType

enum	FilterStateType

typedef Superclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType

typedef FixedImageType::ConstPointer	FixedImageConstPointer

typedef Superclass::FixedImagePointer	FixedImagePointer

typedef Superclass::FixedImageType	FixedImageType

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef Superclass::InputImageType	InputImageType

typedef TDeformationField::PixelType	InputPixelType

typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType

typedef MovingImageType::ConstPointer	MovingImageConstPointer

typedef Superclass::MovingImagePointer	MovingImagePointer

typedef Superclass::MovingImageType	MovingImageType

typedef FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImagePointer	OutputImagePointer

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef Superclass::OutputImageType	OutputImageType

typedef TDeformationField::PixelType	OutputPixelType

typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType

typedef PDEDeformableRegistrationFunction < FixedImageType, MovingImageType, DeformationFieldType >	PDEDeformableRegistrationFunctionType

typedef Superclass::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef FiniteDifferenceFunctionType::RadiusType	RadiusType

typedef SymmetricForcesDemonsRegistrationFilter	Self

typedef PDEDeformableRegistrationFilter < TFixedImage, TMovingImage, TDeformationField >	Superclass

typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType

typedef OutputImageType	UpdateBufferType

Public Member Functions
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual bool	CanRunInPlace () const

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual void	DebugOff () const

virtual void	DebugOn () const

virtual void	Delete ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData ()

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

DeformationFieldType *	GetDeformationField ()

virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const

virtual const unsigned int &	GetElapsedIterations ()

const FixedImageType *	GetFixedImage (void) const

virtual bool	GetInPlace () const

const InputImageType *	GetInput (void)

const InputImageType *	GetInput (unsigned int idx)

DataObjectPointerArray &	GetInputs ()

virtual double	GetIntensityDifferenceThreshold () const

virtual const bool &	GetManualReinitialization ()

virtual double	GetMaximumError () const

virtual unsigned int	GetMaximumKernelWidth () const

virtual const double &	GetMaximumRMSError ()

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual double	GetMetric () const

const MovingImageType *	GetMovingImage (void) const

virtual unsigned long	GetMTime () const

MultiThreader *	GetMultiThreader ()

virtual const char *	GetNameOfClass () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

virtual const unsigned int &	GetNumberOfIterations ()

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual const int &	GetNumberOfThreads ()

virtual std::vector < SmartPointer< DataObject > >::size_type	GetNumberOfValidRequiredInputs () const

OutputImageType *	GetOutput (void)

OutputImageType *	GetOutput (unsigned int idx)

DataObjectPointerArray &	GetOutputs ()

virtual const float &	GetProgress ()

virtual int	GetReferenceCount () const

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()

virtual bool	GetReleaseDataFlag () const

virtual const double &	GetRMSChange () const

virtual const double &	GetRMSChange ()

virtual bool	GetSmoothDeformationField () const

virtual bool	GetSmoothUpdateField () const

const double *	GetStandardDeviations (void)

virtual const FilterStateType &	GetState ()

const double *	GetUpdateFieldStandardDeviations (void)

virtual const bool &	GetUseImageSpacing ()

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (DataObject *output)

bool	HasObserver (const EventObject &event) const

virtual void	InPlaceOff ()

virtual void	InPlaceOn ()

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual DataObjectPointer	MakeOutput (unsigned int idx)

virtual void	ManualReinitializationOff ()

virtual void	ManualReinitializationOn ()

virtual void	Modified () const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PrepareOutputs ()

void	Print (std::ostream &os, Indent indent=0) const

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	Register () const

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	ReleaseDataBeforeUpdateFlagOn ()

void	ReleaseDataFlagOff ()

void	ReleaseDataFlagOn ()

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetDebug (bool debugFlag) const

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

void	SetFixedImage (const FixedImageType *ptr)

void	SetInitialDeformationField (const DeformationFieldType *ptr)

virtual void	SetInPlace (bool _arg)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TDeformationField *image)

virtual void	SetIntensityDifferenceThreshold (double)

virtual void	SetManualReinitialization (bool _arg)

virtual void	SetMaximumError (double _arg)

virtual void	SetMaximumKernelWidth (unsigned int _arg)

virtual void	SetMaximumRMSError (double _arg)

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMovingImage (const MovingImageType *ptr)

virtual void	SetNumberOfIterations (unsigned int _arg)

virtual void	SetNumberOfThreads (int _arg)

virtual void	SetProgress (float _arg)

virtual void	SetReferenceCount (int)

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual void	SetReleaseDataFlag (bool flag)

virtual void	SetRMSChange (double _arg)

virtual void	SetSmoothDeformationField (bool _arg)

virtual void	SetSmoothUpdateField (bool _arg)

virtual void	SetStandardDeviations (double data[])

virtual void	SetStandardDeviations (double value)

virtual void	SetState (FilterStateType _arg)

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetUpdateFieldStandardDeviations (double data[])

virtual void	SetUpdateFieldStandardDeviations (double value)

virtual void	SetUseImageSpacing (bool _arg)

virtual void	SmoothDeformationFieldOff ()

virtual void	SmoothDeformationFieldOn ()

virtual void	SmoothUpdateFieldOff ()

virtual void	SmoothUpdateFieldOn ()

virtual void	StopRegistration ()

	typedef (Concept::MultiplyOperator< PixelType, double >) OutputTimesDoubleCheck

	typedef (Concept::AdditiveOperators< PixelType >) OutputAdditiveOperatorsCheck

	typedef (Concept::Convertible< typename TDeformationField::PixelType, PixelType >) InputConvertibleToOutputCheck

virtual void	UnRegister () const

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float amount)

virtual void	UseImageSpacingOff ()

virtual void	UseImageSpacingOn ()

Static Public Member Functions
static void	BreakOnError ()

static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension

static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)>	InputToOutputRegionCopierType

typedef int	InternalReferenceCountType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	OutputToInputRegionCopierType

typedef UpdateBufferType::RegionType	ThreadRegionType

Protected Member Functions
	SymmetricForcesDemonsRegistrationFilter ()

	~SymmetricForcesDemonsRegistrationFilter ()

virtual void	AddInput (DataObject *input)

virtual void	AddOutput (DataObject *output)

virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	AllocateUpdateBuffer ()

virtual void	ApplyUpdate (TimeStepType dt)

virtual void	ApplyUpdate (TimeStepType dt)

virtual void	ApplyUpdate (TimeStepType dt)=0

virtual void	BeforeThreadedGenerateData ()

virtual void	CacheInputReleaseDataFlags ()

virtual TimeStepType	CalculateChange ()

virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	CopyInputToOutput ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

const DataObject *	GetInput (unsigned int idx) const

virtual const unsigned int &	GetNumberOfRequiredInputs ()

virtual const unsigned int &	GetNumberOfRequiredOutputs ()

const DataObject *	GetOutput (unsigned int idx) const

virtual UpdateBufferType *	GetUpdateBuffer ()

virtual bool	Halt ()

virtual void	Initialize ()

virtual void	InitializeIteration ()

virtual void	PostProcessOutput ()

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

bool	PrintObservers (std::ostream &os, Indent indent) const

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

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

virtual void	PropagateResetPipeline ()

void	PushBackInput (const DataObject *input)

void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (DataObject *input)

virtual void	RemoveOutput (DataObject *output)

virtual TimeStepType	ResolveTimeStep (const TimeStepType timeStepList, const bool valid, int size)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetElapsedIterations (unsigned int _arg)

virtual void	SetNthInput (unsigned int num, DataObject *input)

virtual void	SetNthOutput (unsigned int num, DataObject *output)

void	SetNumberOfInputs (unsigned int num)

void	SetNumberOfOutputs (unsigned int num)

virtual void	SetNumberOfRequiredInputs (unsigned int _arg)

virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

virtual void	SmoothDeformationField ()

virtual void	SmoothUpdateField ()

virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)

virtual void	ThreadedApplyUpdate (TimeStepType dt, const ThreadRegionType &regionToProcess, int threadId)

virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, int threadId)

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

virtual bool	ThreadedHalt (void *)

Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes
unsigned int	m_ElapsedIterations

bool	m_ManualReinitialization

double	m_MaximumRMSError

unsigned int	m_NumberOfIterations

TimeStamp	m_OutputInformationMTime

InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

double	m_RMSChange

bool	m_Updating

Private Member Functions
	SymmetricForcesDemonsRegistrationFilter (const Self &)

void	operator= (const Self &)

Detailed Description

template<class TFixedImage, class TMovingImage, class TDeformationField>
class itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >

Deformably register two images using the demons algorithm.

This class was contributed by Corinne Mattmann, ETH Zurich, Switzerland. based on a variation of the DemonsRegistrationFilter. The basic modification is to use equation (5) from Thirion's paper along with the modification for avoiding large deformations when gradients have small values.

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

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 SetInitialDeformationField 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 GetDeformationField.

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 deformation field type all have the same number of dimensions.

See Also: SymmetricForcesDemonsRegistrationFunction; DemonsRegistrationFilter; DemonsRegistrationFunction

Definition at line 68 of file itkSymmetricForcesDemonsRegistrationFilter.h.

Member Typedef Documentation

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef SmartPointer<const Self> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::ConstPointer

Definition at line 78 of file itkSymmetricForcesDemonsRegistrationFilter.h.

typedef DataObject::Pointer itk::ImageSource< TDeformationField >::DataObjectPointer

inherited

Smart Pointer type to a DataObject.

Definition at line 62 of file itkImageSource.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray

inherited

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType

inherited

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef Superclass::DeformationFieldPointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::DeformationFieldPointer

Definition at line 99 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef Superclass::DeformationFieldType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::DeformationFieldType

Deformation field type.

Definition at line 97 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef SymmetricForcesDemonsRegistrationFunction<FixedImageType,MovingImageType, DeformationFieldType> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::DemonsRegistrationFunctionType

DemonsRegistrationFilterFunction type.

Definition at line 111 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef Superclass::FiniteDifferenceFunctionType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::FiniteDifferenceFunctionType

FiniteDifferenceFunction type.

Definition at line 103 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef FixedImageType::ConstPointer itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::FixedImageConstPointer

inherited

Definition at line 92 of file itkPDEDeformableRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef Superclass::FixedImagePointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::FixedImagePointer

Definition at line 89 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef Superclass::FixedImageType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::FixedImageType

FixedImage image type.

Definition at line 85 of file itkSymmetricForcesDemonsRegistrationFilter.h.

typedef InputImageType::ConstPointer itk::InPlaceImageFilter< TDeformationField , TDeformationField >::InputImageConstPointer

inherited

Definition at line 84 of file itkInPlaceImageFilter.h.

typedef InputImageType::PixelType itk::InPlaceImageFilter< TDeformationField , TDeformationField >::InputImagePixelType

inherited

Definition at line 86 of file itkInPlaceImageFilter.h.

typedef InputImageType::Pointer itk::InPlaceImageFilter< TDeformationField , TDeformationField >::InputImagePointer

inherited

Definition at line 83 of file itkInPlaceImageFilter.h.

typedef InputImageType::RegionType itk::InPlaceImageFilter< TDeformationField , TDeformationField >::InputImageRegionType

inherited

Definition at line 85 of file itkInPlaceImageFilter.h.

typedef Superclass::InputImageType itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::InputImageType

inherited

Convenient typedefs

Definition at line 78 of file itkDenseFiniteDifferenceImageFilter.h.

typedef TDeformationField ::PixelType itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::InputPixelType

inherited

Definition at line 144 of file itkFiniteDifferenceImageFilter.h.

typedef NumericTraits< InputPixelType >::ValueType itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::InputPixelValueType

inherited

Definition at line 149 of file itkFiniteDifferenceImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TDeformationField , TDeformationField >::InputToOutputRegionCopierType

protectedinherited

Typedef for the region copier function object that converts an input region to an output region.

Definition at line 161 of file itkImageToImageFilter.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef MovingImageType::ConstPointer itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::MovingImageConstPointer

inherited

Definition at line 97 of file itkPDEDeformableRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef Superclass::MovingImagePointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::MovingImagePointer

Definition at line 93 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef Superclass::MovingImageType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::MovingImageType

MovingImage image type.

Definition at line 92 of file itkSymmetricForcesDemonsRegistrationFilter.h.

typedef FiniteDifferenceFunctionType::NeighborhoodScalesType itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::NeighborhoodScalesType

inherited

Definition at line 158 of file itkFiniteDifferenceImageFilter.h.

typedef Superclass::OutputImagePixelType itk::InPlaceImageFilter< TDeformationField , TDeformationField >::OutputImagePixelType

inherited

Definition at line 79 of file itkInPlaceImageFilter.h.

typedef Superclass::OutputImagePointer itk::InPlaceImageFilter< TDeformationField , TDeformationField >::OutputImagePointer

inherited

Definition at line 77 of file itkInPlaceImageFilter.h.

typedef Superclass::OutputImageRegionType itk::InPlaceImageFilter< TDeformationField , TDeformationField >::OutputImageRegionType

inherited

Definition at line 78 of file itkInPlaceImageFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef Superclass::OutputImageType itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::OutputImageType

inherited

Types inherithed from the superclass

Definition at line 104 of file itkPDEDeformableRegistrationFilter.h.

typedef TDeformationField ::PixelType itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::OutputPixelType

inherited

The pixel type of the output image will be used in computations.

Definition at line 143 of file itkFiniteDifferenceImageFilter.h.

typedef NumericTraits< OutputPixelType >::ValueType itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::OutputPixelValueType

inherited

Extract value type in case the pixel is of vector type

Definition at line 148 of file itkFiniteDifferenceImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TDeformationField , TDeformationField >::OutputToInputRegionCopierType

protectedinherited

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 166 of file itkImageToImageFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef PDEDeformableRegistrationFunction<FixedImageType,MovingImageType, DeformationFieldType> itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::PDEDeformableRegistrationFunctionType

inherited

PDEDeformableRegistrationFilterFunction type.

Definition at line 112 of file itkPDEDeformableRegistrationFilter.h.

typedef Superclass::PixelType itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::PixelType

inherited

The pixel type of the output image will be used in computations. Inherited from the superclass.

Definition at line 92 of file itkDenseFiniteDifferenceImageFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef SmartPointer<Self> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Pointer

Definition at line 77 of file itkSymmetricForcesDemonsRegistrationFilter.h.

typedef FiniteDifferenceFunctionType::RadiusType itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::RadiusType

inherited

Definition at line 157 of file itkFiniteDifferenceImageFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef SymmetricForcesDemonsRegistrationFilter itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Self

Standard class typedefs.

Definition at line 74 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef PDEDeformableRegistrationFilter< TFixedImage, TMovingImage,TDeformationField> itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Superclass

Definition at line 76 of file itkSymmetricForcesDemonsRegistrationFilter.h.

typedef UpdateBufferType::RegionType itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ThreadRegionType

protectedinherited

The type of region used for multithreading

Definition at line 142 of file itkDenseFiniteDifferenceImageFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

typedef FiniteDifferenceFunctionType::TimeStepType itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::TimeStepType

Take timestep type from the FiniteDifferenceFunction.

Definition at line 106 of file itkSymmetricForcesDemonsRegistrationFilter.h.

typedef OutputImageType itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::UpdateBufferType

inherited

The container type for the update buffer.

Definition at line 98 of file itkDenseFiniteDifferenceImageFilter.h.

Member Enumeration Documentation

enum itk::FiniteDifferenceImageFilter::FilterStateType

inherited

Definition at line 160 of file itkFiniteDifferenceImageFilter.h.

Constructor & Destructor Documentation

template<class TFixedImage , class TMovingImage , class TDeformationField >

itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SymmetricForcesDemonsRegistrationFilter ( )

protected

Default constructor

Definition at line 28 of file itkSymmetricForcesDemonsRegistrationFilter.txx.

References itk::SmartPointer< TObjectType >::GetPointer().

template<class TFixedImage , class TMovingImage , class TDeformationField >

itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::~SymmetricForcesDemonsRegistrationFilter ( )

inlineprotected

Definition at line 129 of file itkSymmetricForcesDemonsRegistrationFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SymmetricForcesDemonsRegistrationFilter ( const Self & )

private

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( )

virtualinherited

virtual void itk::ProcessObject::AbortGenerateDataOn ( )

virtualinherited

Turn on and off the AbortGenerateData flag.

void itk::ProcessObject::AddInput ( DataObject * input )

protectedvirtualinherited

Adds an input to the first null position in the input list. Expands the list memory if necessary

Reimplemented in otb::ObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionPrecision, TCoordRep >, otb::DescriptorsListSampleGenerator< TInputImage, TVectorData, TListSample, TLabelListSample, TOutputPrecision, TCoordRep >, otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >, and otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >.

Definition at line 144 of file itkProcessObject.cxx.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::ProcessObject::AddOutput ( DataObject * output )

protectedvirtualinherited

Adds an output to the first null position in the output list. Expands the list memory if necessary

Definition at line 390 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

virtual void itk::ImageSource< TDeformationField >::AfterThreadedGenerateData ( void )

inlineprotectedvirtualinherited

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 264 of file itkImageSource.h.

virtual void itk::InPlaceImageFilter< TDeformationField , TDeformationField >::AllocateOutputs ( )

protectedvirtualinherited

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceImageFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

Reimplemented from itk::ImageSource< TDeformationField >.

virtual void itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::AllocateUpdateBuffer ( )

protectedvirtualinherited

This method allocates storage in m_UpdateBuffer. It is called from Superclass::GenerateData().

Implements itk::FiniteDifferenceImageFilter< TDeformationField, TDeformationField >.

Reimplemented in itk::DiffeomorphicDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, and itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

virtual void itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ApplyUpdate ( TimeStepType dt )

protectedvirtualinherited

This method applies changes from the m_UpdateBuffer to the output using the ThreadedApplyUpdate() method and a multithreading mechanism. "dt" is the time step to use for the update of each pixel.

Reimplemented in itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, itk::CurvatureRegistrationFilter< TFixedImage, TMovingImage, TDeformationField, TImageForceFunction >, otb::NCCRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, and itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::ApplyUpdate ( TimeStepType dt )

protectedvirtual

Apply update.

Definition at line 176 of file itkSymmetricForcesDemonsRegistrationFilter.txx.

References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetRMSChange().

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ApplyUpdate ( TimeStepType dt )

protectedpure virtualinherited

This method is defined by a subclass to apply changes to the output from an update buffer and a time step value "dt".

Parameters

dt	Time step value.

virtual void itk::ImageSource< TDeformationField >::BeforeThreadedGenerateData ( void )

inlineprotectedvirtualinherited

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 252 of file itkImageSource.h.

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

void itk::ProcessObject::CacheInputReleaseDataFlags ( )

protectedvirtualinherited

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

Definition at line 1050 of file itkProcessObject.cxx.

virtual TimeStepType itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::CalculateChange ( )

protectedvirtualinherited

This method populates an update buffer with changes for each pixel in the output using the ThreadedCalculateChange() method and a multithreading mechanism. Returns value is a time step to be used for the update.

Implements itk::FiniteDifferenceImageFilter< TDeformationField, TDeformationField >.

virtual void itk::ImageToImageFilter< TDeformationField , TDeformationField >::CallCopyInputRegionToOutputRegion	(	OutputImageRegionType &	destRegion,
		const InputImageRegionType &	srcRegion
	)

protectedvirtualinherited

This function calls the actual region copier to do the mapping from input image space to output image space. It uses a Function object used for dispatching to various routines to copy an input region (start index and size) to an output region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::UnaryFunctorImageFilter can support output images of a higher dimension that the input.

This function object is used by the default implementation of GenerateOutputInformation(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map an input region to an output region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the first portion of the input region is copied to the output region. If the input region is a lower dimension than the output, the input region information is copied into the first portion of the output region and the rest of the output region is set to zero.

If a filter needs a different default behavior, it can override this method.

virtual void itk::ImageToImageFilter< TDeformationField , TDeformationField >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)

protectedvirtualinherited

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

This function object can be used by GenerateOutputInformation() to copy the input LargestPossibleRegion to the output LargestPossibleRegion and can also be used in GenerateData or ThreadedGenerateData() where a filter may need to map an output region to an input region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.

If a filter needs a different default behavior, it can override this method. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).

virtual bool itk::InPlaceImageFilter< TDeformationField , TDeformationField >::CanRunInPlace ( ) const

inlinevirtualinherited

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true. CanRunInPlace may also be overridded by InPlaceImageFilter subclasses to fine tune its behavior.

Definition at line 111 of file itkInPlaceImageFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::CopyInputToOutput ( )

protectedvirtualinherited

A simple method to copy the data from the input to the output. If the input does not exist, a zero field is written to the output.

Reimplemented from itk::DenseFiniteDifferenceImageFilter< TDeformationField, TDeformationField >.

Definition at line 280 of file itkPDEDeformableRegistrationFilter.txx.

References itk::ImageRegionIterator< TImage >::Value().

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual::itk::LightObject::Pointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::CreateAnother ( void ) const

virtual

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

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

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * )

inlinevirtualinherited

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 224 of file itkProcessObject.h.

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GenerateData ( void )

protectedvirtualinherited

This is the default, high-level algorithm for calculating finite difference solutions. It calls virtual methods in its subclasses to implement the major steps of the algorithm.

Reimplemented from itk::ImageSource< TDeformationField >.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GenerateInputRequestedRegion ( void )

protectedvirtualinherited

It is difficult to compute in advance the input moving image region required to compute the requested output region. Thus the safest thing to do is to request for the whole moving image.

For the fixed image and deformation field, the input requested region set to be the same as that of the output requested region.

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

Reimplemented in otb::NCCRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

Definition at line 347 of file itkPDEDeformableRegistrationFilter.txx.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GenerateOutputInformation ( void )

protectedvirtualinherited

By default the output deformation field has the same Spacing, Origin and LargestPossibleRegion as the input/initial deformation field. If the initial deformation field is not set, the output information is copied from the fixed image.

Reimplemented from itk::ProcessObject.

Definition at line 313 of file itkPDEDeformableRegistrationFilter.txx.

void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output )

protectedvirtualinherited

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

By default we set all the output requested regions to be the same.

Reimplemented in otb::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< TInputImage >, otb::watershed::Segmenter< InputImageType >, itk::watershed::Segmenter< InputImageType >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::SegmentTreeGenerator< ScalarType >, itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, otb::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, otb::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, otb::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, otb::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, and itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 846 of file itkProcessObject.cxx.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( )

virtualinherited

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<class TFixedImage , class TMovingImage , class TDeformationField >

DeformationFieldType* itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetDeformationField ( void )

inlineinherited

Get output deformation field.

Definition at line 135 of file itkPDEDeformableRegistrationFilter.h.

virtual const FiniteDifferenceFunctionType ::Pointer& itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetDifferenceFunction ( ) const

virtualinherited

This method returns a pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Returns: A FiniteDifferenceObject pointer.

virtual const unsigned int& itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetElapsedIterations ( )

virtualinherited

Get the number of elapsed iterations of the filter.

template<class TFixedImage , class TMovingImage , class TDeformationField >

const PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::FixedImageType * itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetFixedImage ( void ) const

inherited

Get the fixed image.

Definition at line 83 of file itkPDEDeformableRegistrationFilter.txx.

References itk::ProcessObject::GetInput().

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

virtual bool itk::InPlaceImageFilter< TDeformationField , TDeformationField >::GetInPlace ( ) const

virtualinherited

const InputImageType* itk::ImageToImageFilter< TDeformationField , TDeformationField >::GetInput ( void )

inherited

const InputImageType* itk::ImageToImageFilter< TDeformationField , TDeformationField >::GetInput ( unsigned int idx )

inherited

const DataObject * itk::ProcessObject::GetInput ( unsigned int idx ) const

protectedinherited

Definition at line 482 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( )

inlineinherited

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

template<class TFixedImage , class TMovingImage , class TDeformationField >

double itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetIntensityDifferenceThreshold ( ) const

virtual

Definition at line 106 of file itkSymmetricForcesDemonsRegistrationFilter.txx.

References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetIntensityDifferenceThreshold().

virtual const bool& itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetManualReinitialization ( )

virtualinherited

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual double itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetMaximumError ( ) const

virtualinherited

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual unsigned int itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetMaximumKernelWidth ( ) const

virtualinherited

virtual const double& itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetMaximumRMSError ( )

virtualinherited

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns: A reference to this objects MetaDataDictionary.

Warning: This reference may be changed.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns: A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References NULL.

template<class TFixedImage , class TMovingImage , class TDeformationField >

double itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::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 value is calculated for the current iteration

Get the metric value from the difference function

Definition at line 84 of file itkSymmetricForcesDemonsRegistrationFilter.txx.

References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetMetric().

template<class TFixedImage , class TMovingImage , class TDeformationField >

const PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::MovingImageType * itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetMovingImage ( void ) const

inherited

Get the moving image.

Definition at line 110 of file itkPDEDeformableRegistrationFilter.txx.

References itk::ProcessObject::GetInput().

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), otb::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

MultiThreader* itk::ProcessObject::GetMultiThreader ( )

inlineinherited

Return the multithreader used by this class.

Definition at line 280 of file itkProcessObject.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual const char* itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const

inlineinherited

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const unsigned int& itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetNumberOfIterations ( void )

virtualinherited

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const

inlineinherited

Definition at line 135 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( )

protectedvirtualinherited

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( )

protectedvirtualinherited

virtual const int& itk::ProcessObject::GetNumberOfThreads ( )

virtualinherited

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().

template<class TFixedImage , class TMovingImage , class TDeformationField >

std::vector< SmartPointer< DataObject > >::size_type itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetNumberOfValidRequiredInputs ( ) const

virtualinherited

Get the number of valid inputs. For PDEDeformableRegistration, this checks whether the fixed and moving images have been set. While PDEDeformableRegistration can take a third input as an initial deformation field, this input is not a required input.

Reimplemented from itk::ProcessObject.

Definition at line 123 of file itkPDEDeformableRegistrationFilter.txx.

OutputImageType* itk::ImageSource< TDeformationField >::GetOutput ( void )

inherited

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

anotherFilter->SetInput( someFilter->GetOutput() );

anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

image = someFilter->GetOutput();

image->Update();

someFilter->Update();

image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

OutputImageType* itk::ImageSource< TDeformationField >::GetOutput ( unsigned int idx )

inherited

const DataObject * itk::ProcessObject::GetOutput ( unsigned int idx ) const

protectedinherited

Definition at line 454 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( )

inlineinherited

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const float& itk::ProcessObject::GetProgress ( )

virtualinherited

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), otb::StreamingImageVirtualWriter< TInputImage >::ObserveSourceFilterProgress(), otb::ImageFileWriter< TInputImage >::ObserveSourceFilterProgress(), itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ReportProgress(), and itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( )

virtualinherited

bool itk::ProcessObject::GetReleaseDataFlag ( ) const

virtualinherited

Definition at line 512 of file itkProcessObject.cxx.

template<class TFixedImage , class TMovingImage , class TDeformationField >

const double & itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetRMSChange ( ) const

virtual

Definition at line 152 of file itkSymmetricForcesDemonsRegistrationFilter.txx.

References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::GetRMSChange().

virtual const double& itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetRMSChange ( )

virtualinherited

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual bool itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetSmoothDeformationField ( ) const

virtualinherited

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual bool itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetSmoothUpdateField ( ) const

virtualinherited

template<class TFixedImage , class TMovingImage , class TDeformationField >

const double* itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetStandardDeviations ( void )

inlineinherited

Get the Gaussian smoothing standard deviations use for smoothing the deformation field.

Definition at line 162 of file itkPDEDeformableRegistrationFilter.h.

virtual const FilterStateType& itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetState ( )

virtualinherited

virtual UpdateBufferType* itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetUpdateBuffer ( )

inlineprotectedvirtualinherited

Method to allow subclasses to get direct access to the update buffer

Definition at line 129 of file itkDenseFiniteDifferenceImageFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

const double* itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::GetUpdateFieldStandardDeviations ( void )

inlineinherited

Get the Gaussian smoothing standard deviations used for smoothing the update field.

Definition at line 181 of file itkPDEDeformableRegistrationFilter.h.

virtual const bool& itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::GetUseImageSpacing ( )

virtualinherited

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::ImageSource< TDeformationField >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)

virtualinherited

Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfOutputs()). See the GraftOutput for general usage information.

virtual void itk::ImageSource< TDeformationField >::GraftOutput ( DataObject * output )

virtualinherited

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

// setup the mini-pipeline to process the input to this filter
firstFilterInMiniPipeline->SetInput( this->GetInput() );
// setup the mini-pipeline to calculate the correct regions
// and write to the appropriate bulk data block
lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );
// execute the mini-pipeline
lastFilterInMiniPipeline->Update();
// graft the mini-pipeline output back onto this filter's output.
// this is needed to get the appropriate regions passed back.
this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual bool itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Halt ( )

inlineprotectedvirtualinherited

Supplies the halting criteria for this class of filters. The algorithm will stop after a user-specified number of iterations.

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

Reimplemented in itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

Definition at line 208 of file itkPDEDeformableRegistrationFilter.h.

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::Initialize ( void )

protectedvirtualinherited

This method is called before iterating the solution.

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

Reimplemented in itk::CurvatureRegistrationFilter< TFixedImage, TMovingImage, TDeformationField, TImageForceFunction >.

Definition at line 401 of file itkPDEDeformableRegistrationFilter.txx.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::InitializeIteration ( )

protectedvirtual

Initialize the state of filter and equation before each iteration.

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

Definition at line 46 of file itkSymmetricForcesDemonsRegistrationFilter.txx.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SetDeformationField().

virtual void itk::InPlaceImageFilter< TDeformationField , TDeformationField >::InPlaceOff ( )

virtualinherited

virtual void itk::InPlaceImageFilter< TDeformationField , TDeformationField >::InPlaceOn ( )

virtualinherited

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

virtual DataObjectPointer itk::ImageSource< TDeformationField >::MakeOutput ( unsigned int idx )

virtualinherited

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ManualReinitializationOff ( )

virtualinherited

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ManualReinitializationOn ( )

virtualinherited

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TFixedImage , class TMovingImage , class TDeformationField >

static Pointer itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::New ( )

static

Method for creation through the object factory.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::operator= ( const Self & )

private

virtual void itk::ImageToImageFilter< TDeformationField , TDeformationField >::PopBackInput ( )

virtualinherited

Model a stack on the input list by providing a pop back

Reimplemented from itk::ProcessObject.

virtual void itk::ImageToImageFilter< TDeformationField , TDeformationField >::PopFrontInput ( )

virtualinherited

Reimplemented from itk::ProcessObject.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::PostProcessOutput ( )

protectedvirtualinherited

This method is called after the solution has been generated. In this case, the filter release the memory of the internal buffers.

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

Definition at line 388 of file itkPDEDeformableRegistrationFilter.txx.

void itk::ProcessObject::PrepareOutputs ( )

virtualinherited

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >, otb::WatershedImageFilter< TInputImage >, and otb::GeometriesSource.

Definition at line 864 of file itkProcessObject.cxx.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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

Chaining method to print an object's instance variables, as well as its superclasses.

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

Definition at line 204 of file itkSymmetricForcesDemonsRegistrationFilter.txx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output )

virtualinherited

Send the requested region information back up the pipeline (to the filters that preceed this one).

check flag to avoid executing forever if there is a loop

Give the subclass a chance to indicate that it will provide more data then required for the output. This can happen, for example, when a source can only produce the whole output. Although this is being called for a specific output, the source may need to enlarge all outputs.

Give the subclass a chance to define how to set the requested regions for each of its outputs, given this output's requested region. The default implementation is to make all the output requested regions the same. A subclass may need to override this method if each output is a different resolution.

Give the subclass a chance to request a larger requested region on the inputs. This is necessary when, for example, a filter requires more data at the "internal" boundaries to produce the boundary values - such as an image filter that derives a new pixel value by applying some operation to a neighborhood of surrounding original values.

Now that we know the input requested region, propagate this through all the inputs.

Reimplemented in itk::VTKImageImport< TOutputImage >, and itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 766 of file itkProcessObject.cxx.

void itk::ProcessObject::PropagateResetPipeline ( )

protectedvirtualinherited

Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

Propagate the ResetPipeline call

Definition at line 631 of file itkProcessObject.cxx.

virtual void itk::ImageToImageFilter< TDeformationField , TDeformationField >::PushBackInput ( const InputImageType * image )

virtualinherited

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

void itk::ImageToImageFilter< TDeformationField , TDeformationField >::PushBackInput ( const DataObject * input )

inlineprotectedvirtualinherited

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

Definition at line 248 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TDeformationField , TDeformationField >::PushFrontInput ( const InputImageType * image )

virtualinherited

void itk::ImageToImageFilter< TDeformationField , TDeformationField >::PushFrontInput ( const DataObject * input )

inlineprotectedvirtualinherited

Reimplemented from itk::ProcessObject.

Definition at line 250 of file itkImageToImageFilter.h.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( )

virtualinherited

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( )

virtualinherited

void itk::ProcessObject::ReleaseDataFlagOff ( )

inlineinherited

Definition at line 256 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( )

inlineinherited

Definition at line 255 of file itkProcessObject.h.

virtual void itk::InPlaceImageFilter< TDeformationField , TDeformationField >::ReleaseInputs ( )

protectedvirtualinherited

InPlaceImageFilter may transfer ownership of the input bulk data to the output object. Once the output object owns the bulk data (done in AllocateOutputs()), the input object must release its hold on the bulk data. ProcessObject::ReleaseInputs() only releases the input bulk data when the user has set the ReleaseDataFlag. InPlaceImageFilter::ReleaseInputs() also releases the input that it has overwritten.

See Also: ProcessObject::ReleaseInputs()

Reimplemented from itk::ProcessObject.

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::ProcessObject::RemoveInput ( DataObject * input )

protectedvirtualinherited

Remove an input.

Removes the first occurence of the given OutputObject from the inputs to this ProcessObject. If it's the last object on the list, shortens the list.

Definition at line 173 of file itkProcessObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::ProcessObject::RemoveOutput ( DataObject * output )

protectedvirtualinherited

Definition at line 294 of file itkProcessObject.cxx.

void itk::ProcessObject::ResetPipeline ( )

virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 621 of file itkProcessObject.cxx.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

virtual TimeStepType itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ResolveTimeStep	(	const TimeStepType *	timeStepList,
		const bool *	valid,
		int	size
	)

protectedvirtualinherited

Virtual method for resolving a single time step from a set of time steps returned from processing threads.

Returns: Time step (dt) for the iteration update based on a list of time steps generated from the threaded calculated change method (one for each region processed).

Parameters

timeStepList	The set of time changes compiled from all the threaded calls to ThreadedGenerateData.
valid	The set of flags indicating which of "list" elements are valid
size	The size of "list" and "valid"

The default is to return the minimum value in the list.

void itk::ProcessObject::RestoreInputReleaseDataFlags ( )

protectedvirtualinherited

Restore the cached input ReleaseDataFlags.

Definition at line 1075 of file itkProcessObject.cxx.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg )

virtualinherited

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetDifferenceFunction ( FiniteDifferenceFunctionType * _arg )

virtualinherited

This method sets the pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Returns: A FiniteDifferenceObject pointer.

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetElapsedIterations ( unsigned int _arg )

protectedvirtualinherited

Set the number of elapsed iterations of the filter.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetFixedImage ( const FixedImageType * ptr )

inherited

Set the fixed image.

Definition at line 69 of file itkPDEDeformableRegistrationFilter.txx.

References itk::ProcessObject::SetNthInput().

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetInitialDeformationField ( const DeformationFieldType * ptr )

inlineinherited

Set initial deformation field.

Definition at line 131 of file itkPDEDeformableRegistrationFilter.h.

virtual void itk::InPlaceImageFilter< TDeformationField , TDeformationField >::SetInPlace ( bool _arg )

virtualinherited

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

virtual void itk::ImageToImageFilter< TDeformationField , TDeformationField >::SetInput ( const InputImageType * image )

virtualinherited

Set/Get the image input of this process object.

virtual void itk::ImageToImageFilter< TDeformationField , TDeformationField >::SetInput	(	unsigned	int,
		const TDeformationField *	image
	)

virtualinherited

Connect one of the operands for pixel-wise addition

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetIntensityDifferenceThreshold ( double threshold )

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.

Definition at line 129 of file itkSymmetricForcesDemonsRegistrationFilter.txx.

References itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::SetIntensityDifferenceThreshold().

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetManualReinitialization ( bool _arg )

virtualinherited

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetMaximumError ( double _arg )

virtualinherited

Set/Get the desired maximum error of the Guassian kernel approximate.

See Also: GaussianOperator.

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetMaximumKernelWidth ( unsigned int _arg )

virtualinherited

Set/Get the desired limits of the Gaussian kernel width.

See Also: GaussianOperator.

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetMaximumRMSError ( double _arg )

virtualinherited

Set/Get the maximum error allowed in the solution. This may not be defined for all solvers and its meaning may change with the application.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns: Set the MetaDataDictionary

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetMovingImage ( const MovingImageType * ptr )

inherited

Set the moving image.

Definition at line 96 of file itkPDEDeformableRegistrationFilter.txx.

References itk::ProcessObject::SetNthInput().

void itk::ProcessObject::SetNthInput	(	unsigned int	idx,
		DataObject *	input
	)

protectedvirtualinherited

Protected methods for setting inputs. Subclasses make use of them for setting input.

Set an Input of this filter. This method does Register()/UnRegister() manually to deal with the fact that smart pointers aren't around to do the reference counting.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Definition at line 210 of file itkProcessObject.cxx.

void itk::ProcessObject::SetNthOutput	(	unsigned int	idx,
		DataObject *	output
	)

protectedvirtualinherited

Protected methods for setting outputs. Subclasses make use of them for getting output.

Set an output of this filter. This method specifically does not do a Register()/UnRegister() because of the desire to break the reference counting loop.

Definition at line 333 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num )

protectedinherited

Called to allocate the input array. Copies old inputs.

Called by constructor to set up input array.

Definition at line 96 of file itkProcessObject.cxx.

Referenced by otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetNumberOfIterations ( unsigned int _arg )

virtualinherited

Set/Get the number of iterations that the filter will run.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num )

protectedinherited

Called to allocate the output array. Copies old outputs.

Called by constructor to set up output array.

Definition at line 424 of file itkProcessObject.cxx.

Referenced by otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::FastMarchingImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::ImageToLabelMapWithAttributesFilter< TInputImage, TLabeledImage, TLabel, TLabelObject >::ImageToLabelMapWithAttributesFilter(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::PasteImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::AutomaticTopologyMeshSource< TOutputMesh >::AutomaticTopologyMeshSource(), itk::BalloonForceFilter< TInputMesh, TOutputMesh >::BalloonForceFilter(), itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), itk::DeformableMesh3DFilter< TInputMesh, TOutputMesh >::DeformableMesh3DFilter(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::FastMarchingExtensionImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::GeometriesSource::GeometriesSource(), itk::ImageSource< TOutputImage >::ImageSource(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MeshSource< TOutputMesh >::MeshSource(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), otb::OSMDataToVectorDataGenerator::OSMDataToVectorDataGenerator(), itk::PathSource< TOutputPath >::PathSource(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), otb::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::SimplexMeshAdaptTopologyFilter(), itk::SphereMeshSource< TOutputMesh >::SphereMeshSource(), itk::TriangleMeshToSimplexMeshFilter< TInputMesh, TOutputMesh >::TriangleMeshToSimplexMeshFilter(), itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter(), and itk::VTKPolyDataReader< TOutputMesh >::VTKPolyDataReader().

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg )

virtualinherited

Get/Set the number of threads to create when executing.

Referenced by itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivative(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivativePos(), and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChange().

virtual void itk::ProcessObject::SetProgress ( float _arg )

virtualinherited

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg )

virtualinherited

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

void itk::ProcessObject::SetReleaseDataFlag ( bool flag )

virtualinherited

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 528 of file itkProcessObject.cxx.

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetRMSChange ( double _arg )

virtualinherited

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetSmoothDeformationField ( bool _arg )

virtualinherited

Set/Get whether the deformation field is smoothed (regularized). Smoothing the deformation yields a solution elastic in nature. If SmoothDeformationField is on, then the deformation field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetSmoothUpdateField ( bool _arg )

virtualinherited

Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetStandardDeviations ( double data[] )

virtualinherited

Set the Gaussian smoothing standard deviations for the deformation field. The values are set with respect to pixel coordinates.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetStandardDeviations ( double value )

virtualinherited

Set the standard deviations.

Definition at line 147 of file itkPDEDeformableRegistrationFilter.txx.

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetState ( FilterStateType _arg )

virtualinherited

Set/Get the state of the filter.

void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetStateToInitialized ( )

inlineinherited

Set the state of the filter to INITIALIZED

Definition at line 198 of file itkFiniteDifferenceImageFilter.h.

void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetStateToUninitialized ( )

inlineinherited

Set the state of the filter to UNINITIALIZED

Definition at line 204 of file itkFiniteDifferenceImageFilter.h.

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetUpdateFieldStandardDeviations ( double data[] )

virtualinherited

Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SetUpdateFieldStandardDeviations ( double value )

virtualinherited

Definition at line 176 of file itkPDEDeformableRegistrationFilter.txx.

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::SetUseImageSpacing ( bool _arg )

virtualinherited

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOff.

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SmoothDeformationField ( )

protectedvirtualinherited

Utility to smooth the deformation field (represented in the Output) using a Guassian operator. The amount of smoothing can be specified by setting the StandardDeviations.

Definition at line 414 of file itkPDEDeformableRegistrationFilter.txx.

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SmoothDeformationFieldOff ( )

virtualinherited

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SmoothDeformationFieldOn ( )

virtualinherited

template<class TFixedImage , class TMovingImage , class TDeformationField >

void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SmoothUpdateField ( )

protectedvirtualinherited

Utility to smooth the UpdateBuffer using a Gaussian operator. The amount of smoothing can be specified by setting the UpdateFieldStandardDeviations.

Definition at line 487 of file itkPDEDeformableRegistrationFilter.txx.

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SmoothUpdateFieldOff ( )

virtualinherited

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::SmoothUpdateFieldOn ( )

virtualinherited

virtual int itk::ImageSource< TDeformationField >::SplitRequestedRegion	(	int	i,
		int	num,
		OutputImageRegionType &	splitRegion
	)

protectedvirtualinherited

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num".

template<class TFixedImage , class TMovingImage , class TDeformationField >

virtual void itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::StopRegistration ( void )

inlinevirtualinherited

Stop the registration after the current iteration.

Definition at line 187 of file itkPDEDeformableRegistrationFilter.h.

virtual void itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ThreadedApplyUpdate	(	TimeStepType	dt,
		const ThreadRegionType &	regionToProcess,
		int	threadId
	)

protectedvirtualinherited

Does the actual work of updating the output from the UpdateContainer over an output region supplied by the multithreading mechanism.

See Also: ApplyUpdate; ApplyUpdateThreaderCallback

virtual TimeStepType itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ThreadedCalculateChange	(	const ThreadRegionType &	regionToProcess,
		int	threadId
	)

protectedvirtualinherited

Does the actual work of calculating change over a region supplied by the multithreading mechanism.

See Also: CalculateChange; CalculateChangeThreaderCallback

virtual void itk::ImageSource< TDeformationField >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		int	threadId
	)

protectedvirtualinherited

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See Also: GenerateData(), SplitRequestedRegion()

virtual bool itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::ThreadedHalt ( void * )

inlineprotectedvirtualinherited

This method is similar to Halt(), and its default implementation in this class is simply to call Halt(). However, this method takes as a parameter a void pointer to the MultiThreader::ThreadInfoStruct structure. If you override this method instead of overriding Halt, you will be able to get the current thread ID and handle the Halt method accordingly. This is useful if you are doing a lot of processing in Halt that you don't want parallelized. Notice that ThreadedHalt is only called by the multithreaded filters, so you still should implement Halt, just in case a non-threaded filter is used.

Definition at line 284 of file itkFiniteDifferenceImageFilter.h.

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TDeformationField >::ThreaderCallback ( void * arg )

staticprotectedinherited

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::typedef ( Concept::MultiplyOperator< PixelType, double > )

inherited

Begin concept checking This class requires OutputTimesDoubleCheck in the form of (Concept::MultiplyOperator<PixelType, double>)

itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::typedef ( Concept::AdditiveOperators< PixelType > )

inherited

This class requires OutputAdditiveOperatorsCheck in the form of (Concept::AdditiveOperators<PixelType>)

itk::DenseFiniteDifferenceImageFilter< TDeformationField , TDeformationField >::typedef ( Concept::Convertible< typename TDeformationField ::PixelType, PixelType > )

inherited

This class requires InputConvertibleToOutputCheck in the form of (Concept::Convertible<typename TInputImage::PixelType, PixelType>)

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::ProcessObject::Update ( void )

virtualinherited

Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

The following methods are used to coordinate the execution of the data processing pipeline.

Definition at line 611 of file itkProcessObject.cxx.

Referenced by otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), itk::AutoCropLabelMapFilter< TInputImage >::GenerateOutputInformation(), itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation(), and itk::VoronoiSegmentationImageFilterBase< TInputImage, TOutputImage, TBinaryPriorImage >::RunSegmentOneStep().

void itk::ProcessObject::UpdateLargestPossibleRegion ( )

virtualinherited

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

Definition at line 1120 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputData ( DataObject * output )

virtualinherited

Actually generate new output

prevent chasing our tail

Prepare all the outputs. This may deallocate previous bulk data.

Propagate the update call - make sure everything we might rely on is up-to-date Must call PropagateRequestedRegion before UpdateOutputData if multiple inputs since they may lead back to the same data object.

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

Tell all Observers that the filter is starting

GenerateData this object - we have not aborted yet, and our progress before we start to execute is 0.0.

Count the number of required inputs which have been assigned

If we ended due to aborting, push the progress up to 1.0 (since it probably didn't end there)

Notify end event observers

Now we have to mark the data as up to date.

Restore the state of any input ReleaseDataFlags

Release any inputs if marked for release

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 908 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputInformation ( void )

virtualinherited

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Watch out for loops in the pipeline

Since we are in a loop, we will want to update. But if we don't modify this filter, then we will not execute because our OutputInformationMTime will be more recent than the MTime of our output.

We now wish to set the PipelineMTime of each output DataObject to the largest of this ProcessObject's MTime, all input DataObject's PipelineMTime, and all input's MTime. We begin with the MTime of this ProcessObject.

Loop through the inputs

Propagate the UpdateOutputInformation call

What is the PipelineMTime of this input? Compare this against our current computation to find the largest one.

Pipeline MTime of the input does not include the MTime of the data object itself. Factor these mtimes into the next PipelineMTime

Call GenerateOutputInformation for subclass specific information. Since UpdateOutputInformation propagates all the way up the pipeline, we need to be careful here to call GenerateOutputInformation only if necessary. Otherwise, we may cause this source to be modified which will cause it to execute again on the next update.

Keep track of the last time GenerateOutputInformation() was called

Reimplemented in otb::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< TInputImage >, otb::watershed::Segmenter< InputImageType >, itk::watershed::Segmenter< InputImageType >, and itk::VTKImageImport< TOutputImage >.

Definition at line 664 of file itkProcessObject.cxx.

References itk::Object::GetMTime(), itk::DataObject::GetPipelineMTime(), itk::DataObject::SetPipelineMTime(), and itk::DataObject::UpdateOutputInformation().

Referenced by itk::VTKImageExportBase::UpdateInformationCallback().

void itk::ProcessObject::UpdateProgress ( float amount )

inherited

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

Update the progress of the process object. If a ProgressMethod exists, execute it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Definition at line 500 of file itkProcessObject.cxx.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), otb::otb_UpdateGDALProgress(), itk::ProgressReporter::ProgressReporter(), and itk::ProgressReporter::~ProgressReporter().

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::UseImageSpacingOff ( )

virtualinherited

virtual void itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::UseImageSpacingOn ( )

virtualinherited

Member Data Documentation

template<class TFixedImage , class TMovingImage , class TDeformationField >

const unsigned int itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >::ImageDimension = Superclass::ImageDimension

staticinherited

Inherit some enums and typedefs from the superclass.

Definition at line 116 of file itkPDEDeformableRegistrationFilter.h.

const unsigned int itk::InPlaceImageFilter< TDeformationField , TDeformationField >::InputImageDimension

staticinherited

ImageDimension constants

Definition at line 90 of file itkInPlaceImageFilter.h.

unsigned int itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::m_ElapsedIterations

protectedinherited

A counter for keeping track of the number of elapsed iterations during filtering.

Definition at line 330 of file itkFiniteDifferenceImageFilter.h.

bool itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::m_ManualReinitialization

protectedinherited

Indicates whether the filter automatically resets to UNINITIALIZED state after completing, or whether filter must be manually reset

Definition at line 334 of file itkFiniteDifferenceImageFilter.h.

double itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::m_MaximumRMSError

protectedinherited

Definition at line 337 of file itkFiniteDifferenceImageFilter.h.

unsigned int itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::m_NumberOfIterations

protectedinherited

The maximum number of iterations this filter will run

Definition at line 326 of file itkFiniteDifferenceImageFilter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime

protectedinherited

Time when GenerateOutputInformation was last called.

Definition at line 421 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

double itk::FiniteDifferenceImageFilter< TDeformationField , TDeformationField >::m_RMSChange

protectedinherited

Definition at line 336 of file itkFiniteDifferenceImageFilter.h.

bool itk::ProcessObject::m_Updating

protectedinherited

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 418 of file itkProcessObject.h.

const unsigned int itk::InPlaceImageFilter< TDeformationField , TDeformationField >::OutputImageDimension

staticinherited

Definition at line 92 of file itkInPlaceImageFilter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

template<class TFixedImage, class TMovingImage, class TDeformationField> class itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TFixedImage, class TMovingImage, class TDeformationField>
class itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >