Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::ProcessObject Class Reference
[ITK System Objects, Data Processing Objects]

#include <itkProcessObject.h>

Inheritance diagram for itk::ProcessObject:

[legend]Collaboration diagram for itk::ProcessObject:

[legend]List of all members.

Detailed Description

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

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

Public Types

typedef SmartPointer< const
Self > ConstPointer

typedef DataObject::Pointer DataObjectPointer

typedef std::vector< DataObjectPointer > DataObjectPointerArray

typedef SmartPointer< Self > Pointer

typedef ProcessObject Self

typedef Object Superclass

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

DataObjectPointerArray & GetInputs ()

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

virtual unsigned long GetMTime () const

MultiThreader * GetMultiThreader ()

virtual const char * GetNameOfClass () const

std::vector< DataObjectPointer
>::size_type GetNumberOfInputs () const

std::vector< DataObjectPointer
>::size_type GetNumberOfOutputs () const

virtual const int & GetNumberOfThreads ()

virtual std::vector< DataObjectPointer
>::size_type GetNumberOfValidRequiredInputs () 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 *DataObjectPointerArray & GetOutputs ()

virtual const float & GetProgress ()

virtual int GetReferenceCount () const

virtual const bool & GetReleaseDataBeforeUpdateFlag ()

virtual bool GetReleaseDataFlag () const

bool HasObserver (const EventObject &event) const

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

virtual void ReleaseDataBeforeUpdateFlagOff ()

virtual void ReleaseDataBeforeUpdateFlagOn ()

void ReleaseDataFlagOff ()

void ReleaseDataFlagOn ()

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

virtual void ResetPipeline ()

virtual void SetAbortGenerateData (bool _arg)

void SetDebug (bool debugFlag) const

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

Get Set the number of threads
to create when executing
*virtual void SetNumberOfThreads (int _arg)

virtual void SetProgress (float _arg)

virtual void SetReferenceCount (int)

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 SetReleaseDataFlag (bool flag)

virtual void UnRegister () const

Turn on off the flags to control
whether the bulk data belonging
*to the outputs of this ProcessObject
are released reallocated
*during an 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 SetReleaseDataBeforeUpdateFlag(bool _arg)

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

virtual void Update ()

virtual void UpdateLargestPossibleRegion ()

virtual void UpdateOutputData (DataObject *output)

virtual void UpdateOutputInformation ()

void UpdateProgress (float amount)

Static Public Member Functions

static void BreakOnError ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static Pointer New ()

This is a global flag that
controls whether any warning
*or error messages are displayed
*static void SetGlobalWarningDisplay (bool flag)

Public Attributes

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 unsigned lon AddObserver )(const EventObject &event, Command *) const

This is a global flag that
controls whether any debug

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)

const DataObject * GetInput (unsigned int idx) const

Method used internally for
getting an input *DataObject * GetInput (unsigned int idx)

virtual const unsigned int & GetNumberOfRequiredInputs ()

virtual const unsigned int & GetNumberOfRequiredOutputs ()

const DataObject * GetOutput (unsigned int idx) const

Method used internally for
getting an output *DataObject * GetOutput (unsigned int idx)

virtual void PopBackInput ()

virtual void PopFrontInput ()

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

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

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

ProcessObject ()

virtual void PropagateResetPipeline ()

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
especially *filters with different
types of inputs These routines
follow *the semantics of STL
*virtual void PushBackInput (const DataObject *input)

virtual void PushFrontInput (const DataObject *input)

virtual void ReleaseInputs ()

virtual void RemoveInput (DataObject *input)

virtual void RemoveOutput (DataObject *output)

virtual void RestoreInputReleaseDataFlags ()

Protected methods for setting
inputs *Subclasses make use
of them for setting input
*virtual void SetNthInput (unsigned int num, DataObject *input)

Protected methods for setting
outputs *Subclasses make use
of them for getting output
*virtual void SetNthOutput (unsigned int num, DataObject *output)

void SetNumberOfInputs (unsigned int num)

void SetNumberOfOutputs (unsigned int num)

virtual void SetNumberOfRequiredInputs (unsigned int _arg)

virtual void SetNumberOfRequiredOutputs (unsigned int _arg)

~ProcessObject ()

Protected Attributes

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

TimeStamp m_OutputInformationMTime

int m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

bool m_Updating

Methods invoked by virtual
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 PrintSelf(std voi PrintHeader )(std::ostream &os, Indent indent) const

Friends

class DataObject

Member Typedef Documentation

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

STL Array of SmartPointers to DataObjects
Definition at line 103 of file itkProcessObject.h.

Constructor & Destructor Documentation

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

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

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]

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]

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::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::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, 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.

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.

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

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

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

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.

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

Returns:
A constant reference to this objects MetaDataDictionary.

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

Returns:
A reference to this objects MetaDataDictionary.

Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.
Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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

Return the multithreader used by this class.
Definition at line 281 of file itkProcessObject.h.

std::vector<DataObjectPointer>::size_type itk::ProcessObject::GetNumberOfInputs ( ) const [inline]

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

std::vector<DataObjectPointer>::size_type itk::ProcessObject::GetNumberOfOutputs ( ) const [inline]

Definition at line 132 of file itkProcessObject.h.

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

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

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

virtual std::vector<DataObjectPointer>::size_type 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, TDeformationField >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

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

Return an array with all the outputs of this process object* This is useful for tracing forward in the pipeline to contruct* graphs etc* DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline]

Definition at line 130 of file itkProcessObject.h.

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.

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

Gets the reference count on this object.
Definition at line 98 of file itkLightObject.h.

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

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

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

Definition at line 100 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

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

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.

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.

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

Call Execute on all the Commands observing this event id.

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::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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::LightObject::Print ( std::ostream & os,

Indent indent = 0

) const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers ( std::ostream & os,

Indent indent

) const [protected, inherited]

virtual void itk::LightObject::PrintTrailer ( std::ostream & os,

Indent indent

) const [protected, virtual, inherited]

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::VTKImageImport< TOutputImage >.

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

Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

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]

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

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

Definition at line 254 of file itkProcessObject.h.

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

Definition at line 253 of file itkProcessObject.h.

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

Remove all observers .

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

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

Remove the observer with this tag value.

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

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.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

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

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

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

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

Returns:
Set the MetaDataDictionary

Protected methods for setting outputs* Subclasses make use of them for getting output* virtual void itk::ProcessObject::SetNthOutput ( unsigned int num,

DataObject * output

) [protected, virtual]

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

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

Called to allocate the input array. Copies old inputs.

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

Called to allocate the output array. Copies old outputs.

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

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

Get Set the number of threads to create when executing* virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual]

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::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)
Reimplemented from itk::LightObject.

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::SetReleaseDataFlag ( bool flag ) [virtual]

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

Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.

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

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

Actually generate new output
Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

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::watershed::Segmenter< TInputImage >, and itk::VTKImageImport< TOutputImage >.

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.

Friends And Related Function Documentation

friend class DataObject [friend]

Friends of ProcessObject
Definition at line 458 of file itkProcessObject.h.

Member Data Documentation

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

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected]

Time when GenerateOutputInformation was last called.
Definition at line 428 of file itkProcessObject.h.

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

Number of uses of this object by other objects.
Definition at line 119 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count
Definition at line 122 of file itkLightObject.h.

bool itk::ProcessObject::m_Updating [protected]

This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.
Definition at line 425 of file itkProcessObject.h.

Methods invoked by virtual 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 PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

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

itkProcessObject.h

Generated at Sun Jul 9 21:11:08 2006 for ITK by


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
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
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
std::vector< DataObjectPointer >::size_type	GetNumberOfInputs () const
std::vector< DataObjectPointer >::size_type	GetNumberOfOutputs () const
virtual const int &	GetNumberOfThreads ()
virtual std::vector< DataObjectPointer >::size_type	GetNumberOfValidRequiredInputs () 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 *DataObjectPointerArray &	GetOutputs ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
bool	HasObserver (const EventObject &event) const
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
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
Get Set the number of threads to create when executing *virtual void	SetNumberOfThreads (int _arg)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
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	SetReleaseDataFlag (bool flag)
virtual void	UnRegister () const
Turn on off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released reallocated during an 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 SetReleaseDataBeforeUpdateFlag(bool _arg)
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
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning or error messages are displayed static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
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)
const DataObject *	GetInput (unsigned int idx) const
Method used internally for getting an input DataObject	GetInput (unsigned int idx)
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
const DataObject *	GetOutput (unsigned int idx) const
Method used internally for getting an output DataObject	GetOutput (unsigned int idx)
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
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 especially filters with different types of inputs These routines follow the semantics of STL *virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveOutput (DataObject *output)
virtual void	RestoreInputReleaseDataFlags ()
Protected methods for setting inputs Subclasses make use of them for setting input virtual void	SetNthInput (unsigned int num, DataObject *input)
Protected methods for setting outputs Subclasses make use of them for getting output virtual void	SetNthOutput (unsigned int num, DataObject *output)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)
	~ProcessObject ()
Protected Attributes
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
TimeStamp	m_OutputInformationMTime
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating
Methods invoked by virtual 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 PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const
Friends
class	DataObject

itk::ProcessObject Class Reference [ITK System Objects, Data Processing Objects]

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions