The base class for all process objects (source, filters, mappers) in the Insight data processing pipeline. More...

#include <itkProcessObject.h>

Collaboration diagram for itk::ProcessObject:

List of all members.

Classes
struct	NameComparator
class	ProcessObjectDomainThreader
	Multi-threaded processing on a domain by processing sub-domains per thread. More...
Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)

DataObjectPointerArray	GetInputs ()

DataObjectPointerArray	GetOutputs ()

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () 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 (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Protected Member Functions
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
void	PrintSelf (std::ostream &os, Indent indent) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObject *output)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
void	SetNumberOfInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType _arg)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()

DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const

virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Attributes
bool	m_Updating
Private Types
typedef std::map < DataObjectIdentifierType, DataObjectPointer, NameComparator >	DataObjectPointerMap
Private Attributes
bool	m_AbortGenerateData
std::map < DataObjectIdentifierType, bool >	m_CachedInputReleaseDataFlags
DataObjectPointerMap	m_Inputs
DataObjectPointerArraySizeType	m_NumberOfIndexedInputs
DataObjectPointerArraySizeType	m_NumberOfIndexedOutputs
DataObjectPointerArraySizeType	m_NumberOfRequiredInputs
DataObjectPointerArraySizeType	m_NumberOfRequiredOutputs
ThreadIdType	m_NumberOfThreads
DataObjectPointerMap	m_Outputs
float	m_Progress
bool	m_ReleaseDataBeforeUpdateFlag
MultiThreader::Pointer	m_Threader
Friends
class	DataObject
class	DataObjectConstIterator
class	DataObjectIterator
class	InputDataObjectConstIterator
class	InputDataObjectIterator
class	OutputDataObjectConstIterator
class	OutputDataObjectIterator
class	TestProcessObject
TimeStamp	m_OutputInformationMTime
	ProcessObject (const Self &)
void	operator= (const Self &)

Detailed Description

The base class for all process objects (source, filters, mappers) in the Insight data processing pipeline.

ProcessObject is an abstract object that specifies behavior and interface of network process objects (sources, filters, mappers). Source objects are creators of visualization data; filters input, process, and output image data; and mappers transform data into another form (like transforming coordinates or writing data to a file).

A major role of ProcessObject is to define the inputs and outputs of a filter. More than one input and/or output may exist for a given filter. Some classes (e.g., source objects or mapper objects) will not use inputs (the source) or outputs (mappers). In this case, the inputs or outputs is just ignored.

The inputs and outputs are referenced by name. The Primary input and the Primary output play a special role: they drive the pipeline.

In addition to the reference by name, it is possible to access the inputs and outputs with an index. The index is mapped internally to a name built as "IndexedDataObject" followed by the index. The indexed input or output 0 is mapped to the Primary input or output.

The inputs and outputs shouldn't be accessed by index in most cases. Using the name is most of the time a better solution. The access by index should be used only when the number of input or output of a filter is decided at run time.

ProcessObject invokes the following events: Command::StartEvent, Command::EndEvent These are convenience events you can use for any purpose (e.g., debugging info, highlighting/notifying user interface, etc.) See Command and LightObject for information on using AddObserver.

Another event Command::ProgressEvent can be observed. Some filters invoke this event periodically during their execution (with the progress, parameter, the fraction of work done). The use is similar to that of StartEvent and EndEvent. Filters may also check their AbortGenerateData flag to determine whether to prematurally end their execution.

An important feature of subclasses of ProcessObject is that it is possible to control the memory-management model (i.e., retain output versus delete output data). The ReleaseDataFlag enables the deletion of the output data once the downstream process object finishes processing the data (please see text). The ReleaseDataBeforeUpdateFlag enables the deletion of the ProcessObject's output data from a previous update if that output data is slated to be regenerated by the pipeline process. Setting this flag can control peak memory usage during a subsequent pipeline update. For a ProcessObject, the ReleaseDataFlag defaults to false and the ReleaseDataBeforeUpdateFlag defaults to true. Some subclasses of ProcessObject, for example ImageSource, use a default setting of false for the ReleaseDataBeforeUpdateFlag.

Subclasses of ProcessObject may override 4 of the methods of this class to control how a given filter may interact with the pipeline (dataflow). These methods are: GenerateOutputInformation(), EnlargeOutputRequestedRegion(), GenerateInputRequestedRegion(), and GenerateOutputRequestedRegion(). By overriding these methods, a filter can deviate from the base assumptions of the pipeline execution model.

Definition at line 109 of file itkProcessObject.h.

Member Typedef Documentation

typedef SmartPointer< const Self > itk::ProcessObject::ConstPointer

Reimplemented from itk::Object.

Definition at line 116 of file itkProcessObject.h.

typedef DataObject::DataObjectIdentifierType itk::ProcessObject::DataObjectIdentifierType

Definition at line 130 of file itkProcessObject.h.

typedef DataObject::Pointer itk::ProcessObject::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 119 of file itkProcessObject.h.

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

STL array of const pointer to the data objects STL array of pointer to the data objects

Definition at line 128 of file itkProcessObject.h.

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

Definition at line 152 of file itkProcessObject.h.

typedef std::map< DataObjectIdentifierType, DataObjectPointer, NameComparator > itk::ProcessObject::DataObjectPointerMap [private]

STL map to store the named inputs and outputs

Definition at line 666 of file itkProcessObject.h.

typedef std::vector< DataObjectIdentifierType > itk::ProcessObject::NameArray

STL array of data object names

Definition at line 133 of file itkProcessObject.h.

typedef SmartPointer< Self > itk::ProcessObject::Pointer

Reimplemented from itk::Object.

Definition at line 115 of file itkProcessObject.h.

typedef ProcessObject itk::ProcessObject::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 113 of file itkProcessObject.h.

typedef Object itk::ProcessObject::Superclass

Reimplemented from itk::Object.

Definition at line 114 of file itkProcessObject.h.

Constructor & Destructor Documentation

itk::ProcessObject::ProcessObject ( ) [protected]

itk::ProcessObject::~ProcessObject ( ) [protected]

itk::ProcessObject::ProcessObject ( const Self & ) [private]

Time when GenerateOutputInformation was last called.

Member Function Documentation

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

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

Turn on and off the AbortGenerateData flag.

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

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

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

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 void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual]

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

virtual void itk::ProcessObject::GenerateData ( void ) [inline, protected, virtual]

This method causes the filter to generate its output.

Definition at line 599 of file itkProcessObject.h.

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

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]

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]

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::TemporalProcessObject, itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension) >, itk::watershed::Segmenter< InputImageType >, and itk::watershed::SegmentTreeGenerator< ScalarType >.

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

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

DataObjectPointerArray itk::ProcessObject::GetIndexedInputs ( )

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

DataObjectPointerArray itk::ProcessObject::GetIndexedOutputs ( )

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

DataObject* itk::ProcessObject::GetInput ( const DataObjectIdentifierType & key ) [protected]

Return an input

const DataObject* itk::ProcessObject::GetInput ( const DataObjectIdentifierType & key ) const [protected]

Return an input

DataObject* itk::ProcessObject::GetInput ( DataObjectPointerArraySizeType ) [protected]

Method used internally for getting an indexed input.

const DataObject* itk::ProcessObject::GetInput ( DataObjectPointerArraySizeType idx ) const [protected]

Method used internally for getting an indexed input.

NameArray itk::ProcessObject::GetInputNames ( ) const

Return a array with the names of the inputs of this process object. The names are ordered lexicographically, and match the order of the data object produced by GetInputs()

DataObjectPointerArray itk::ProcessObject::GetInputs ( )

Return a array with the named inputs of this process object. The order of the inputs match the order of the input names produced by GetInputNames()

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) const [inline]

Return the multithreader used by this class.

Definition at line 369 of file itkProcessObject.h.

virtual const char* itk::ProcessObject::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

Referenced by itk::XMLFilterWatcher::EndFilter(), and itk::XMLFilterWatcher::StartFilter().

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfIndexedInputs ( ) const

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.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfIndexedOutputs ( ) const

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

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

Get the size of the input container. 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 158 of file itkProcessObject.h.

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

Definition at line 161 of file itkProcessObject.h.

virtual const DataObjectPointerArraySizeType& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual]

virtual const DataObjectPointerArraySizeType& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual]

virtual const ThreadIdType& itk::ProcessObject::GetNumberOfThreads ( ) [virtual]

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

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

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, TDisplacementField, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

DataObject* itk::ProcessObject::GetOutput ( const DataObjectIdentifierType & key ) [protected]

Return an output

Referenced by itk::watershed::Segmenter< InputImageType >::GetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetEquivalencyTable(), itk::Testing::HashImageFilter< TImageType >::GetHashOutput(), itk::TwoOutputExampleImageFilter< TImage >::GetInverseOutput(), itk::HistogramThresholdCalculator< THistogram, TOutput >::GetOutput(), itk::watershed::Segmenter< InputImageType >::GetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension) >::GetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetOutputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::GetOutputSegmentTree(), itk::watershed::Segmenter< InputImageType >::GetSegmentTable(), and itk::HistogramThresholdCalculator< THistogram, TOutput >::GetThreshold().

const DataObject* itk::ProcessObject::GetOutput ( const DataObjectIdentifierType & key ) const [protected]

Return an output

DataObject* itk::ProcessObject::GetOutput ( DataObjectPointerArraySizeType idx ) [protected]

Method used internally for getting an indexed output.

const DataObject* itk::ProcessObject::GetOutput ( DataObjectPointerArraySizeType idx ) const [protected]

Method used internally for getting an indexed output.

NameArray itk::ProcessObject::GetOutputNames ( ) const

Return a array with the names of the outputs of this process object. The names are ordered lexicographically, and match the order of the data object produced by GetOutputs()

DataObjectPointerArray itk::ProcessObject::GetOutputs ( )

Return a array with the named outputs of this process object. The order of the outputs match the order of the input names produced by GetOutputNames()

DataObject* itk::ProcessObject::GetPrimaryInput ( ) [protected]

Return the main input

const DataObject* itk::ProcessObject::GetPrimaryInput ( ) const [protected]

Return the main input

const DataObject* itk::ProcessObject::GetPrimaryOutput ( ) const [protected]

Return the main output

DataObject* itk::ProcessObject::GetPrimaryOutput ( ) [protected]

Return the main output

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

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 const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual]

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]

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.

bool itk::ProcessObject::HasInput ( const DataObjectIdentifierType & key ) const

Return true if the input with this name exists

bool itk::ProcessObject::HasOutput ( const DataObjectIdentifierType & key ) const

Return true if the output with this name exists

bool itk::ProcessObject::IsIndexedName ( const DataObjectIdentifierType & ) const [protected]

DataObjectPointerArraySizeType itk::ProcessObject::MakeIndexFromName ( const DataObjectIdentifierType & ) const [protected]

DataObjectIdentifierType itk::ProcessObject::MakeNameFromIndex ( DataObjectPointerArraySizeType ) const [protected]

virtual DataObjectPointer itk::ProcessObject::MakeOutput ( const DataObjectIdentifierType & ) [virtual]

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 itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

virtual DataObjectPointer itk::ProcessObject::MakeOutput ( DataObjectPointerArraySizeType idx ) [virtual]

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 itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

void itk::ProcessObject::operator= ( const Self & ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::Object.

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

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

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

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::ProcessObject::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::Object.

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

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

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

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

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]

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

Push/Pop an indexed 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::ReleaseDataBeforeUpdateFlagOff ( ) [virtual]

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]

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]

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

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

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

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

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

virtual void itk::ProcessObject::RemoveInput ( DataObjectPointerArraySizeType ) [protected, virtual]

Remove an indexed input

virtual void itk::ProcessObject::RemoveInput ( const DataObjectIdentifierType & key ) [protected, virtual]

Remove an input

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

Remove an indexed input.

Deprecated:: use RemoveOutput(unsigned int) instead

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

Deprecated:: use RemoveOutput(unsigned int) instead

virtual void itk::ProcessObject::RemoveOutput ( DataObjectPointerArraySizeType idx ) [protected, virtual]

virtual void itk::ProcessObject::RemoveOutput ( const DataObjectIdentifierType & key ) [protected, virtual]

Remove an output

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

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]

Restore the cached input ReleaseDataFlags.

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

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

virtual void itk::ProcessObject::SetInput	(	const DataObjectIdentifierType &	key,
		DataObject *	input
	)		`[protected, virtual]`

Set an input

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

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

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

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::HistogramThresholdCalculator< THistogram, TOutput >::HistogramThresholdCalculator(), 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::SetNumberOfIndexedInputs ( DataObjectPointerArraySizeType num ) [protected]

Define the number of indexed inputs defined for this process. The new indexed inputs are considered to be NULL.

void itk::ProcessObject::SetNumberOfIndexedOutputs ( DataObjectPointerArraySizeType num ) [protected]

Called to allocate the output array. Copies old outputs.

void itk::ProcessObject::SetNumberOfInputs ( DataObjectPointerArraySizeType num ) [protected]

Deprecated:: use SetNumberOfIndexedInputs() instead

void itk::ProcessObject::SetNumberOfOutputs ( DataObjectPointerArraySizeType num ) [protected]

Deprecated:: use SetNumberOfIndexedInputs() instead

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( DataObjectPointerArraySizeType _arg ) [protected, virtual]

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( DataObjectPointerArraySizeType _arg ) [protected, virtual]

Referenced by itk::HistogramThresholdCalculator< THistogram, TOutput >::HistogramThresholdCalculator().

virtual void itk::ProcessObject::SetNumberOfThreads ( ThreadIdType _arg ) [virtual]

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

virtual void itk::ProcessObject::SetOutput	(	const DataObjectIdentifierType &	key,
		DataObject *	output
	)		`[protected, virtual]`

Set an output

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

Set the main input

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

Set the main output

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

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::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual]

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]

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.

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

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::ImageFileWriter< TInputImage >, itk::ImageSeriesWriter< TInputImage, TOutputImage >, itk::MeshFileWriter< TInputMesh >, and itk::VideoFileWriter< TInputVideoStream >.

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

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

Reimplemented in itk::ImageFileWriter< TInputImage >, and itk::VideoFileWriter< TInputVideoStream >.

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

Actually generate new output

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >, itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >, itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >, itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >, itk::FFTWComplexToComplexImageFilter< TImage >, and itk::TemporalProcessObject.

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

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::VTKImageImport< TOutputImage >, itk::watershed::Segmenter< TInputImage >, itk::TemporalProcessObject, itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoFileReader< TOutputVideoStream >, and itk::watershed::Segmenter< InputImageType >.

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

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.

virtual void itk::ProcessObject::VerifyInputInformation ( ) [protected, virtual]

Verifies that the inputs meta-data is consistent and valid for continued execution of the pipeline, throws an exception if not valid.

This method is called imediately before GenerateOutputInformation().

The ProcessObject implementation does nothing. Subclasses might check if all the inputs are in the same coordinate frame.

virtual void itk::ProcessObject::VerifyPreconditions ( ) [protected, virtual]

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation is propagated to the inputs.

The ProcessObject's implementation verifies that the NumberOfRequiredInputs are set and not null.

Friends And Related Function Documentation

friend class DataObject [friend]

Friends of ProcessObject

Definition at line 694 of file itkProcessObject.h.

friend class DataObjectConstIterator [friend]

Definition at line 696 of file itkProcessObject.h.

friend class DataObjectIterator [friend]

Definition at line 700 of file itkProcessObject.h.

friend class InputDataObjectConstIterator [friend]

Definition at line 697 of file itkProcessObject.h.

friend class InputDataObjectIterator [friend]

Definition at line 701 of file itkProcessObject.h.

friend class OutputDataObjectConstIterator [friend]

Definition at line 698 of file itkProcessObject.h.

friend class OutputDataObjectIterator [friend]

Definition at line 702 of file itkProcessObject.h.

friend class TestProcessObject [friend]

Definition at line 704 of file itkProcessObject.h.

Member Data Documentation

bool itk::ProcessObject::m_AbortGenerateData [private]

These support the progress method and aborting filter execution.

Definition at line 682 of file itkProcessObject.h.

std::map< DataObjectIdentifierType, bool > itk::ProcessObject::m_CachedInputReleaseDataFlags [private]

An array that caches the ReleaseDataFlags of the inputs

Definition at line 673 of file itkProcessObject.h.

DataObjectPointerMap itk::ProcessObject::m_Inputs [private]

Named input and outputs containers

Definition at line 669 of file itkProcessObject.h.

Referenced by itk::InputDataObjectConstIterator::InputDataObjectConstIterator(), and itk::InputDataObjectIterator::InputDataObjectIterator().

DataObjectPointerArraySizeType itk::ProcessObject::m_NumberOfIndexedInputs [private]

Definition at line 675 of file itkProcessObject.h.

DataObjectPointerArraySizeType itk::ProcessObject::m_NumberOfIndexedOutputs [private]

Definition at line 676 of file itkProcessObject.h.

DataObjectPointerArraySizeType itk::ProcessObject::m_NumberOfRequiredInputs [private]

Definition at line 678 of file itkProcessObject.h.

DataObjectPointerArraySizeType itk::ProcessObject::m_NumberOfRequiredOutputs [private]

Definition at line 679 of file itkProcessObject.h.

ThreadIdType itk::ProcessObject::m_NumberOfThreads [private]

Reimplemented in itk::BinaryContourImageFilter< TInputImage, TOutputImage >, and itk::LabelContourImageFilter< TInputImage, TOutputImage >.

Definition at line 688 of file itkProcessObject.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected]

Time when GenerateOutputInformation was last called.

Definition at line 643 of file itkProcessObject.h.

DataObjectPointerMap itk::ProcessObject::m_Outputs [private]

Definition at line 670 of file itkProcessObject.h.

Referenced by itk::OutputDataObjectConstIterator::OutputDataObjectConstIterator(), and itk::OutputDataObjectIterator::OutputDataObjectIterator().

float itk::ProcessObject::m_Progress [private]

Reimplemented in itk::LabelMapFilter< TInputImage, TOutputImage >, itk::LabelMapFilter< TInputImage, TInputImage >, itk::LabelMapFilter< TLabelMap, TOutputImage >, and itk::LabelMapFilter< TImage, TImage >.

Definition at line 683 of file itkProcessObject.h.

bool itk::ProcessObject::m_ReleaseDataBeforeUpdateFlag [private]

Memory management ivars

Definition at line 691 of file itkProcessObject.h.

MultiThreader::Pointer itk::ProcessObject::m_Threader [private]

Support processing data in multiple threads. Used by subclasses (e.g., ImageSource).

Definition at line 687 of file itkProcessObject.h.

bool itk::ProcessObject::m_Updating [protected]

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

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

itkProcessObject.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation