Base class for Image Registration Methods. More...

#include <itkImageRegistrationMethod.h>

Inheritance diagram for itk::ImageRegistrationMethod< TFixedImage, TMovingImage >:

Collaboration diagram for itk::ImageRegistrationMethod< TFixedImage, TMovingImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef FixedImageType::ConstPointer	FixedImageConstPointer
typedef MetricType::FixedImageRegionType	FixedImageRegionType
typedef TFixedImage	FixedImageType
typedef InterpolatorType::Pointer	InterpolatorPointer
typedef MetricType::InterpolatorType	InterpolatorType
typedef MetricType::Pointer	MetricPointer
typedef ImageToImageMetric < FixedImageType, MovingImageType >	MetricType
typedef MovingImageType::ConstPointer	MovingImageConstPointer
typedef TMovingImage	MovingImageType
typedef SingleValuedNonLinearOptimizer	OptimizerType
typedef MetricType::TransformParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef ImageRegistrationMethod	Self
typedef ProcessObject	Superclass
typedef TransformOutputType::ConstPointer	TransformOutputConstPointer
typedef TransformOutputType::Pointer	TransformOutputPointer
typedef DataObjectDecorator < TransformType >	TransformOutputType
typedef TransformType::Pointer	TransformPointer
typedef MetricType::TransformType	TransformType
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () 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
virtual const FixedImageRegionType &	GetFixedImageRegion ()
virtual bool	GetFixedImageRegionDefined () const
DataObjectPointerArray &	GetInputs ()
virtual const ParametersType &	GetLastTransformParameters ()
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
const TransformOutputType *	GetOutput () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
virtual void	Initialize () throw (ExceptionObject)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetFixedImageRegion (const FixedImageRegionType &region)
virtual void	SetFixedImageRegionDefined (bool _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
void	StartOptimization (void)
void	StartRegistration (void)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)


void	SetFixedImage (const FixedImageType *fixedImage)
virtual const FixedImageType *	GetFixedImage ()


void	SetMovingImage (const MovingImageType *movingImage)
virtual const MovingImageType *	GetMovingImage ()


virtual void	SetOptimizer (OptimizerType *_arg)
virtual OptimizerType *	GetOptimizer ()


virtual void	SetMetric (MetricType *_arg)
virtual MetricType *	GetMetric ()


virtual void	SetTransform (TransformType *_arg)
virtual TransformType *	GetTransform ()


virtual void	SetInterpolator (InterpolatorType *_arg)
virtual InterpolatorType *	GetInterpolator ()


virtual void	SetInitialTransformParameters (const ParametersType &param)
virtual const ParametersType &	GetInitialTransformParameters ()


DataObjectPointerArray &	GetOutputs ()
DataObjectPointerArraySizeType	GetNumberOfOutputs () const


virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()


virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()


virtual void	SetNumberOfThreads (int _arg)
virtual const int &	GetNumberOfThreads ()


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	CacheInputReleaseDataFlags ()
void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
	ImageRegistrationMethod ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetLastTransformParameters (ParametersType _arg)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual	~ImageRegistrationMethod ()


virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	AddInput (DataObject *input)
virtual void	RemoveInput (DataObject *input)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual const unsigned int &	GetNumberOfRequiredInputs ()


virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()


DataObject *	GetInput (unsigned int idx)
const DataObject *	GetInput (unsigned int idx) const


virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	AddOutput (DataObject *output)
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)
virtual const unsigned int &	GetNumberOfRequiredOutputs ()


DataObject *	GetOutput (unsigned int idx)
const DataObject *	GetOutput (unsigned int idx) const


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::ImageRegistrationMethod< TFixedImage, TMovingImage >

Base class for Image Registration Methods.

This Class define the generic interface for a registration method.

This class is templated over the type of the two image to be registered. A generic Transform is used by this class. That allows to select at run time the particular type of transformation that is to be applied for registering the images.

This method use a generic Metric in order to compare the two images. the final goal of the registration method is to find the set of parameters of the Transformation that optimizes the metric.

The registration method also support a generic optimizer that can be selected at run-time. The only restriction for the optimizer is that it should be able to operate in single-valued cost functions given that the metrics used to compare images provide a single value as output.

The terms : Fixed image and Moving image are used in this class to indicate what image is being mapped by the transform.

This class uses the coordinate system of the Fixed image as a reference and searchs for a Transform that will map points from the space of the Fixed image to the space of the Moving image.

For doing so, a Metric will be continously applied to compare the Fixed image with the Transformed Moving image. This process also requires to interpolate values from the Moving image.

Definition at line 63 of file itkImageRegistrationMethod.h.

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage >

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

Reimplemented from itk::ProcessObject.

Definition at line 70 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef DataObject::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 114 of file itkImageRegistrationMethod.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<typename TFixedImage , typename TMovingImage >

typedef FixedImageType::ConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageConstPointer

Definition at line 80 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef MetricType::FixedImageRegionType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageRegionType

Definition at line 90 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef TFixedImage itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageType

Type of the Fixed image.

Definition at line 76 of file itkImageRegistrationMethod.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

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

Definition at line 139 of file itkLightObject.h.

template<typename TFixedImage , typename TMovingImage >

typedef InterpolatorType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::InterpolatorPointer

Definition at line 104 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef MetricType::InterpolatorType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::InterpolatorType

Type of the Interpolator.

Definition at line 103 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef MetricType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MetricPointer

Definition at line 89 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef ImageToImageMetric< FixedImageType, MovingImageType > itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MetricType

Type of the metric.

Definition at line 88 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef MovingImageType::ConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImageConstPointer

Definition at line 84 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef TMovingImage itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImageType

Type of the Moving image.

Definition at line 83 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef SingleValuedNonLinearOptimizer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::OptimizerType

Type of the optimizer.

Definition at line 107 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef MetricType::TransformParametersType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ParametersType

Type of the Transformation parameters This is the same type used to represent the search space of the optimization algorithm

Definition at line 111 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef SmartPointer<Self> itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Pointer

Reimplemented from itk::ProcessObject.

Definition at line 69 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef ImageRegistrationMethod itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Definition at line 67 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef ProcessObject itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 68 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef TransformOutputType::ConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputConstPointer

Definition at line 100 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef TransformOutputType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputPointer

Definition at line 99 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef DataObjectDecorator< TransformType > itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputType

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

Definition at line 98 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef TransformType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformPointer

Definition at line 94 of file itkImageRegistrationMethod.h.

template<typename TFixedImage , typename TMovingImage >

typedef MetricType::TransformType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformType

Type of the Transform .

Definition at line 93 of file itkImageRegistrationMethod.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage >

itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ImageRegistrationMethod ( ) [protected]

template<typename TFixedImage , typename TMovingImage >

virtual itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::~ImageRegistrationMethod ( ) [inline, protected, virtual]

Definition at line 209 of file itkImageRegistrationMethod.h.

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

virtual void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[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

virtual void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

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

static void itk::LightObject::BreakOnError ( ) [static, inherited]

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

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

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().

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

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.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

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 225 of file itkProcessObject.h.

template<typename TFixedImage , typename TMovingImage >

void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GenerateData ( ) [protected, virtual]

Method invoked by the pipeline in order to trigger the computation of the registration.

Reimplemented from itk::ProcessObject.

virtual void itk::ProcessObject::GenerateInputRequestedRegion ( ) [protected, virtual, inherited]

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

virtual void itk::ProcessObject::GenerateOutputInformation ( ) [protected, virtual, inherited]

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

virtual void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output ) [protected, virtual, inherited]

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.

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

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

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

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.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<typename TFixedImage , typename TMovingImage >

virtual const FixedImageType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImage ( ) [virtual]

Set/Get the Fixed image.

template<typename TFixedImage , typename TMovingImage >

virtual const FixedImageRegionType& itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImageRegion ( ) [virtual]

Get the region of the fixed image to be considered as region of interest during the registration. This region will be passed to the ImageMetric in order to restrict the metric computation to consider only this region.

template<typename TFixedImage , typename TMovingImage >

virtual bool itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImageRegionDefined ( ) const [virtual]

True if a region has been defined for the fixed image to which the ImageMetric will limit its computation

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

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

template<typename TFixedImage , typename TMovingImage >

virtual const ParametersType& itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetInitialTransformParameters ( ) [virtual]

Set/Get the initial transformation parameters.

const DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an input.

Reimplemented in itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) [protected, inherited]

Method used internally for getting an input.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( ) [inline, inherited]

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.

template<typename TFixedImage , typename TMovingImage >

virtual InterpolatorType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetInterpolator ( ) [virtual]

Set/Get the Interpolator.

template<typename TFixedImage , typename TMovingImage >

virtual const ParametersType& itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetLastTransformParameters ( ) [virtual]

Get the last transformation parameters visited by the optimizer.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

template<typename TFixedImage , typename TMovingImage >

virtual MetricType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetMetric ( ) [virtual]

Set/Get the Metric.

template<typename TFixedImage , typename TMovingImage >

virtual const MovingImageType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetMovingImage ( ) [virtual]

Set/Get the Moving image.

template<typename TFixedImage , typename TMovingImage >

unsigned long itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetMTime ( ) const [virtual]

Method to return the latest modified time of this object or any of its cached ivars

Reimplemented from itk::Object.

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) [inline, inherited]

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.h.

template<typename TFixedImage , typename TMovingImage >

virtual const char* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const [inline, inherited]

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.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const [inline, inherited]

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 135 of file itkProcessObject.h.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, inherited]

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

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, inherited]

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

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, inherited]

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

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

virtual DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<typename TFixedImage , typename TMovingImage >

virtual OptimizerType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetOptimizer ( ) [virtual]

Set/Get the Optimizer.

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an output.

DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) [protected, inherited]

Method used internally for getting an output.

Referenced by itk::watershed::Segmenter< InputImageType >::GetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetEquivalencyTable(), itk::TwoOutputExampleImageFilter< TImage >::GetInverseOutput(), itk::watershed::Segmenter< InputImageType >::GetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::GetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetOutputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::GetOutputSegmentTree(), and itk::watershed::Segmenter< InputImageType >::GetSegmentTable().

template<typename TFixedImage , typename TMovingImage >

const TransformOutputType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetOutput ( ) const

Returns the transform resulting from the registration process

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

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.

virtual const float& itk::ProcessObject::GetProgress ( ) [virtual, inherited]

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::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual, inherited]

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.

virtual bool itk::ProcessObject::GetReleaseDataFlag ( ) const [virtual, inherited]

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.

template<typename TFixedImage , typename TMovingImage >

virtual TransformType* itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetTransform ( ) [virtual]

Set/Get the Transfrom.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<typename TFixedImage , typename TMovingImage >

virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Initialize ( ) throw (ExceptionObject) [virtual]

Initialize by setting the interconnects between the components.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

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

template<typename TFixedImage , typename TMovingImage >

virtual DataObjectPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MakeOutput ( unsigned int idx ) [virtual]

Make a DataObject of the correct type to be used as the specified output.

Reimplemented from itk::ProcessObject.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

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

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<typename TFixedImage , typename TMovingImage >

static Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

virtual void itk::ProcessObject::PopBackInput ( ) [protected, virtual, inherited]

Push/Pop an 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.

virtual void itk::ProcessObject::PopFrontInput ( ) [protected, virtual, inherited]

Push/Pop an 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.

virtual void itk::ProcessObject::PrepareOutputs ( ) [virtual, inherited]

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

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

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<typename TFixedImage , typename TMovingImage >

void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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

Reimplemented from itk::ProcessObject.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output ) [virtual, inherited]

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

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

virtual void itk::ProcessObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

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

virtual void itk::ProcessObject::PushBackInput ( const DataObject * input ) [protected, virtual, inherited]

Push/Pop an 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.

virtual void itk::ProcessObject::PushFrontInput ( const DataObject * input ) [protected, virtual, inherited]

Push/Pop an 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.

virtual void itk::Object::Register ( ) const [virtual, inherited]

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

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( ) [virtual, inherited]

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.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( ) [virtual, inherited]

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::ReleaseDataFlagOff ( ) [inline, inherited]

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 257 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( ) [inline, inherited]

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 256 of file itkProcessObject.h.

virtual void itk::ProcessObject::ReleaseInputs ( ) [protected, virtual, inherited]

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See also:: InPlaceImageFilter::ReleaseInputs()

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

virtual void itk::ProcessObject::RemoveInput ( DataObject * input ) [protected, virtual, inherited]

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

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::ProcessObject::RemoveOutput ( DataObject * output ) [protected, virtual, inherited]

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

virtual void itk::ProcessObject::ResetPipeline ( ) [virtual, inherited]

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.

virtual void itk::ProcessObject::RestoreInputReleaseDataFlags ( ) [protected, virtual, inherited]

Restore the cached input ReleaseDataFlags.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

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.

template<typename TFixedImage , typename TMovingImage >

void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImage ( const FixedImageType * fixedImage )

Set/Get the Fixed image.

template<typename TFixedImage , typename TMovingImage >

void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImageRegion ( const FixedImageRegionType & region )

Set the region of the fixed image to be considered as region of interest during the registration. This region will be passed to the ImageMetric in order to restrict the metric computation to consider only this region.

Warning:: The same region can also be set directly into the metric. please avoid to set the region in both places since this can lead to inconsistent configurations.

template<typename TFixedImage , typename TMovingImage >

virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImageRegionDefined ( bool _arg ) [virtual]

Turn on/off the use of a fixed image region to which the ImageMetric will limit its computation.

Warning:: The region must have been previously defined using the SetFixedImageRegion member function

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

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

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

template<typename TFixedImage , typename TMovingImage >

virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetInitialTransformParameters ( const ParametersType & param ) [virtual]

Set/Get the initial transformation parameters.

template<typename TFixedImage , typename TMovingImage >

virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetInterpolator ( InterpolatorType * _arg ) [virtual]

Set/Get the Interpolator.

template<typename TFixedImage , typename TMovingImage >

virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetLastTransformParameters ( ParametersType _arg ) [protected, virtual]

Provides derived classes with the ability to set this private var

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

template<typename TFixedImage , typename TMovingImage >

virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetMetric ( MetricType * _arg ) [virtual]

Set/Get the Metric.

template<typename TFixedImage , typename TMovingImage >

void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetMovingImage ( const MovingImageType * movingImage )

Set/Get the Moving image.

virtual void itk::ProcessObject::SetNthInput	(	unsigned int	num,
		DataObject *	input
	)			`[protected, virtual, inherited]`

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

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

virtual void itk::ProcessObject::SetNthOutput	(	unsigned int	num,
		DataObject *	output
	)			`[protected, virtual, inherited]`

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

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< InputImageType >::SetSegmentTable().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num ) [protected, inherited]

Called to allocate the input array. Copies old inputs.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num ) [protected, inherited]

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg ) [protected, virtual, inherited]

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

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, inherited]

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

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

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

template<typename TFixedImage , typename TMovingImage >

virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetOptimizer ( OptimizerType * _arg ) [virtual]

Set/Get the Optimizer.

virtual void itk::ProcessObject::SetProgress ( float _arg ) [virtual, inherited]

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.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual, inherited]

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.

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

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.

template<typename TFixedImage , typename TMovingImage >

virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetTransform ( TransformType * _arg ) [virtual]

Set/Get the Transfrom.

template<typename TFixedImage , typename TMovingImage >

void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::StartOptimization ( void )

Method that initiates the optimization process. This method should not be called directly by the users. Instead, this method is intended to be invoked internally by the StartRegistration() which is in turn invoked by the Update() method. FIXME: This method should be declared protected.

template<typename TFixedImage , typename TMovingImage >

void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::StartRegistration ( void )

Method that initiates the registration. This will Initialize and ensure that all inputs the registration needs are in place, via a call to Initialize() will then start the optimization process via a call to StartOptimization()

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::Update ( ) [virtual, inherited]

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.

Reimplemented in itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, and itk::ImageSeriesWriter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateLargestPossibleRegion ( ) [virtual, inherited]

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().

virtual void itk::ProcessObject::UpdateOutputData ( DataObject * output ) [virtual, inherited]

Actually generate new output

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

virtual void itk::ProcessObject::UpdateOutputInformation ( ) [virtual, inherited]

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.

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

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.

Member Data Documentation

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

bool itk::ProcessObject::m_Updating [protected, inherited]

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 428 of file itkProcessObject.h.

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

itkImageRegistrationMethod.h

itk::ImageRegistrationMethod< TFixedImage, TMovingImage > Class Template Reference [Registration Filters]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<typename TFixedImage, typename TMovingImage> class itk::ImageRegistrationMethod< TFixedImage, TMovingImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ImageRegistrationMethod< TFixedImage, TMovingImage > Class Template Reference
[Registration Filters]

template<typename TFixedImage, typename TMovingImage>
class itk::ImageRegistrationMethod< TFixedImage, TMovingImage >