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

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

#include <itkProcessObject.h>

Inherits itk::Object.

Collaboration diagram for itk::ProcessObject:

[legend]

List of all members.

Public Types

typedef ProcessObject Self

typedef Object Superclass

typedef SmartPointer< Self > Pointer

typedef SmartPointer< const Self > ConstPointer

typedef DataObject::Pointer DataObjectPointer

typedef std::vector
< DataObjectPointer > DataObjectPointerArray

typedef
DataObjectPointerArray::size_type DataObjectPointerArraySizeType

Public Member Functions

virtual const char * GetNameOfClass () const

DataObjectPointerArray & GetInputs ()

DataObjectPointerArraySizeType GetNumberOfInputs () const

virtual
DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const

DataObjectPointerArray & GetOutputs ()

DataObjectPointerArraySizeType GetNumberOfOutputs () const

virtual void SetAbortGenerateData (bool _arg)

virtual const bool & GetAbortGenerateData ()

virtual void AbortGenerateDataOn ()

virtual void AbortGenerateDataOff ()

virtual void SetProgress (float _arg)

virtual const float & GetProgress ()

void UpdateProgress (float amount)

virtual void Update ()

virtual void UpdateLargestPossibleRegion ()

virtual void UpdateOutputInformation ()

virtual void PropagateRequestedRegion (DataObject *output)

virtual void UpdateOutputData (DataObject *output)

virtual void EnlargeOutputRequestedRegion (DataObject *)

virtual void ResetPipeline ()

virtual DataObjectPointer MakeOutput (unsigned int idx)

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

MultiThreader * GetMultiThreader ()

virtual void PrepareOutputs ()

virtual LightObject::Pointer CreateAnother () const

virtual void DebugOn () const

virtual void DebugOff () const

bool GetDebug () const

void SetDebug (bool debugFlag) const

virtual unsigned long GetMTime () const

virtual void Modified () const

virtual void Register () const

virtual void UnRegister () const

virtual void SetReferenceCount (int)

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

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

Command * GetCommand (unsigned long tag)

void InvokeEvent (const EventObject &)

void InvokeEvent (const EventObject &) const

void RemoveObserver (unsigned long tag)

void RemoveAllObservers ()

bool HasObserver (const EventObject &event) const

MetaDataDictionary & GetMetaDataDictionary (void)

const MetaDataDictionary & GetMetaDataDictionary (void) const

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void Delete ()

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

virtual int GetReferenceCount () const

Static Public Member Functions

static Pointer New ()

static void SetGlobalWarningDisplay (bool flag)

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOn ()

static void GlobalWarningDisplayOff ()

static void BreakOnError ()

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

ProcessObject ()

~ProcessObject ()

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

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

void SetNumberOfInputs (unsigned int num)

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

void SetNumberOfOutputs (unsigned int num)

DataObject * GetOutput (unsigned int idx)

const DataObject * GetOutput (unsigned int idx) const

virtual void GenerateInputRequestedRegion ()

virtual void GenerateOutputRequestedRegion (DataObject *output)

virtual void GenerateOutputInformation ()

virtual void GenerateData ()

virtual void PropagateResetPipeline ()

virtual void ReleaseInputs ()

virtual void CacheInputReleaseDataFlags ()

virtual void RestoreInputReleaseDataFlags ()

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

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

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

Protected Attributes

bool m_Updating

TimeStamp m_OutputInformationMTime

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

Private Member Functions

ProcessObject (const Self &)

void operator= (const Self &)

Private Attributes

DataObjectPointerArray m_Inputs

unsigned int m_NumberOfRequiredInputs

std::vector< bool > m_CachedInputReleaseDataFlags

DataObjectPointerArray m_Outputs

unsigned int m_NumberOfRequiredOutputs

bool m_AbortGenerateData

float m_Progress

MultiThreader::Pointer m_Threader

int m_NumberOfThreads

bool m_ReleaseDataBeforeUpdateFlag

Friends

class DataObject

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.

Member Typedef Documentation

typedef ProcessObject itk::ProcessObject::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 91 of file itkProcessObject.h.

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

Smart Pointer type to a DataObject.

Definition at line 97 of file itkProcessObject.h.

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

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

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

Size type of an std::vector

Definition at line 112 of file itkProcessObject.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 137 of file itkLightObject.h.

Constructor & Destructor Documentation

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

Instantiate object with no start, end, or progress methods.

Definition at line 35 of file itkProcessObject.cxx.

References itk::MultiThreader::New().

00036 {
00037   m_NumberOfRequiredInputs = 0;
00038 
00039   m_NumberOfRequiredOutputs = 0;
00040 
00041   m_AbortGenerateData = false;
00042   m_Progress = 0.0f;
00043   m_Updating = false;
00044   
00045   m_Threader = MultiThreader::New();
00046   m_NumberOfThreads = m_Threader->GetNumberOfThreads();
00047 
00048   m_ReleaseDataBeforeUpdateFlag = true;
00049 }

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

Destructor for the ProcessObject class. We've got to UnRegister() the use of any input classes.

Definition at line 69 of file itkProcessObject.cxx.

00070 {
00071   // Tell each output that we are going away.  If other objects have a 
00072   // reference to one of these outputs, the data object will not be deleted
00073   // when the process object is deleted.  However, the data object's source
00074   // will still point back to the now nonexistent process object if we do not
00075   // clean things up now.
00076   unsigned int idx;
00077   for (idx = 0; idx < m_Outputs.size(); ++idx)
00078     {
00079     if (m_Outputs[idx])
00080       {
00081       // let the output know we no longer want to associate with the object
00082       m_Outputs[idx]->DisconnectSource(this, idx);
00083       // let go of our reference to the data object
00084       m_Outputs[idx] = 0;
00085       }
00086     }
00087 }

Member Function Documentation

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

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.

00109     {return m_Inputs;}

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

Referenced by otb::ModulusAndDirectionImageToImageFilter< TInputImage, TInputImageDirection, TOutputImage >::GetInput(), and otb::ModulusAndDirectionImageToImageFilter< TInputImage, TInputImageDirection, TOutputImage >::GetInputDirection().

00119     {return m_Inputs.size();}

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

Get the number of specified inputs

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

Definition at line 112 of file itkProcessObject.cxx.

00113 {
00114   DataObjectPointerArraySizeType num;
00115   if (m_NumberOfRequiredInputs < m_Inputs.size())
00116     {
00117     num = m_NumberOfRequiredInputs;
00118     }
00119   else
00120     {
00121     num = m_Inputs.size();
00122     }
00123   // count the number of non-null inputs
00124   // this used to use std::count_if, but that function object
00125   // did not work correctly with SunPro CC 5.6.
00126   int count = 0;
00127   for(std::vector<DataObjectPointer>::const_iterator i = m_Inputs.begin();
00128       i < (m_Inputs.begin() + num); ++i)
00129     {
00130     if((*i).IsNotNull())
00131       {
00132       count++;
00133       }
00134     }
00135   return count;
00136 }

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

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

Definition at line 133 of file itkProcessObject.h.

Referenced by itk::watershed::Segmenter< TInputImage >::GenerateOutputRequestedRegion().

00134     { return m_Outputs; }

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

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

Turn on and off the AbortGenerateData flag.

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 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::WatershedMiniPipelineProgressCommand::Execute(), itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ReportProgress(), and itk::XMLFilterWatcher::ShowProgress().

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.

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

Definition at line 500 of file itkProcessObject.cxx.

Referenced by itk::watershed::Segmenter< TInputImage >::GenerateData(), itk::ProgressReporter::ProgressReporter(), and itk::ProgressReporter::~ProgressReporter().

00501 {
00502   m_Progress = amount;
00503   this->InvokeEvent( ProgressEvent() );
00504 }

void itk::ProcessObject::Update ( void ) [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.

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

Reimplemented in otb::PersistentFilterStreamingDecorator< TFilter >, otb::ImageSeriesFileReaderBase< TImage, TInternalImage >, otb::SpatialObjectDXFReader< TSpatialObject >, otb::VectorDataFileWriter< TInputVectorData >, otb::ConfusionMatrixCalculator< TRefListLabel, TProdListLabel >, otb::ListSampleGenerator< TImage, TVectorData >, otb::RCC8GraphFileWriter< TInputGraph >, otb::ImageViewer< TPixel, TLabel >, otb::ImageViewerBase< TPixel, TLabel >, itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, itk::ImageSeriesWriter< TInputImage, TOutputImage >, otb::PersistentFilterStreamingDecorator< otb::PersistentMatrixTransposeMatrixImageFilter< TInputImage1, TInputImage2 > >, otb::PersistentFilterStreamingDecorator< otb::PersistentStatisticsImageFilter< TInputImage > >, otb::PersistentFilterStreamingDecorator< otb::PersistentInnerProductVectorImageFilter< TInputImage > >, otb::PersistentFilterStreamingDecorator< otb::PersistentLineSegmentDetector< TInputImage, TPrecision > >, otb::PersistentFilterStreamingDecorator< otb::PersistentStatisticsVectorImageFilter< TInputImage > >, otb::ImageSeriesFileReaderBase< otb::VectorImage< TPixel, 2 >, otb::VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReaderBase< otb::Image< TPixel, 2 >, otb::VectorImage< TInternalPixel, 2 > >, and otb::ImageSeriesFileReaderBase< otb::Image< TPixel, 2 >, otb::Image< TInternalPixel, 2 > >.

Definition at line 611 of file itkProcessObject.cxx.

00612 {
00613   if (this->GetOutput(0))
00614     {
00615     this->GetOutput(0)->Update();
00616     }
00617 }

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

Definition at line 1120 of file itkProcessObject.cxx.

01121 {
01122   this->UpdateOutputInformation();
01123 
01124   if (this->GetOutput(0))
01125     {
01126     this->GetOutput(0)->SetRequestedRegionToLargestPossibleRegion();
01127     this->GetOutput(0)->Update();
01128     }
01129 }

void itk::ProcessObject::UpdateOutputInformation ( void ) [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.

Watch out for loops in the pipeline

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

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

Loop through the inputs

Propagate the UpdateOutputInformation call

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

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

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

Keep track of the last time GenerateOutputInformation() was called

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

Definition at line 664 of file itkProcessObject.cxx.

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

Referenced by itk::VTKImageExportBase::UpdateInformationCallback(), and itk::watershed::Segmenter< TInputImage >::UpdateOutputInformation().

00665 {
00666   unsigned long t1, t2;
00667   DataObjectPointerArraySizeType idx;
00668   DataObject *input;
00669   DataObject *output;
00670 
00674   if ( m_Updating )
00675     {
00682     this->Modified();
00683     return;
00684     }
00685 
00692   t1 = this->GetMTime();
00693 
00697   for (idx = 0; idx < m_Inputs.size(); ++idx)
00698     {
00699     if (m_Inputs[idx])
00700       {
00701       input = m_Inputs[idx];
00702 
00706       m_Updating = true;
00707       input->UpdateOutputInformation();
00708       m_Updating = false;
00709       
00714       t2 = input->GetPipelineMTime();
00715 
00716       if (t2 > t1)
00717         {
00718         t1 = t2;
00719         }
00720 
00725       t2 = input->GetMTime();
00726       if (t2 > t1)
00727         {
00728         t1 = t2;
00729         }
00730       }
00731     }
00732 
00740   if (t1 > m_OutputInformationMTime.GetMTime())
00741     {
00742     for (idx = 0; idx < m_Outputs.size(); ++idx)
00743       {
00744       output = this->GetOutput( static_cast<int>( idx ) );
00745       if (output)
00746         {
00747         output->SetPipelineMTime(t1);
00748         }  
00749       }
00750     
00751     this->GenerateOutputInformation();
00752 
00756     m_OutputInformationMTime.Modified();
00757     }
00758 }

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

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

check flag to avoid executing forever if there is a loop

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

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

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

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

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

Definition at line 766 of file itkProcessObject.cxx.

00767 {
00771   if (m_Updating)
00772     {
00773     return;
00774     }
00775 
00783   this->EnlargeOutputRequestedRegion( output );
00784 
00792   this->GenerateOutputRequestedRegion( output );
00793   
00802   this->GenerateInputRequestedRegion();
00803 
00808   m_Updating = true;
00809   DataObjectPointerArraySizeType idx;
00810   for (idx = 0; idx < m_Inputs.size(); ++idx)
00811     {
00812     if (m_Inputs[idx])
00813       {
00814       m_Inputs[idx]->PropagateRequestedRegion();
00815       }
00816     }
00817   m_Updating = false;
00818 }

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

Actually generate new output

prevent chasing our tail

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

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

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

Tell all Observers that the filter is starting

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

Count the number of required inputs which have been assigned

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

Notify end event observers

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

Restore the state of any input ReleaseDataFlags

Release any inputs if marked for release

Reimplemented in otb::StreamingShrinkImageFilter< TInputImage, TOutputImage >, otb::StreamingImageFileWriter< TInputImage >, and itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 908 of file itkProcessObject.cxx.

00909 {
00910   DataObjectPointerArraySizeType idx;
00911 
00915   if (m_Updating)
00916     {
00917     return;
00918     }
00919 
00923   this->PrepareOutputs();
00924 
00931   m_Updating = true;
00932   if ( m_Inputs.size() == 1 )
00933     {
00934     if (m_Inputs[0])
00935       {
00936       m_Inputs[0]->UpdateOutputData();
00937       }
00938     }
00939   else
00940     {
00941     for (idx = 0; idx < m_Inputs.size(); ++idx)
00942       {
00943       if (m_Inputs[idx])
00944         {
00945         m_Inputs[idx]->PropagateRequestedRegion();
00946         m_Inputs[idx]->UpdateOutputData();
00947         }
00948       }
00949     }
00950 
00959   this->CacheInputReleaseDataFlags();
00960   
00964   this->InvokeEvent( StartEvent() );
00965 
00970   m_AbortGenerateData = false;
00971   m_Progress = 0.0f;
00972 
00976   DataObjectPointerArraySizeType ninputs = this->GetNumberOfValidRequiredInputs();
00977   if (ninputs < m_NumberOfRequiredInputs)
00978     {
00979     itkExceptionMacro(<< "At least " << m_NumberOfRequiredInputs 
00980                       << " inputs are required but only " << ninputs 
00981                       << " are specified.");
00982     }
00983   else
00984     {
00985     try
00986       {
00987       this->GenerateData();
00988       }
00989     catch( ProcessAborted & excp )
00990       {
00991       this->InvokeEvent( AbortEvent() );
00992       this->ResetPipeline();
00993       this->RestoreInputReleaseDataFlags();
00994       throw excp;
00995       }
00996     catch( ExceptionObject& excp )
00997       {
00998       this->ResetPipeline();
00999       this->RestoreInputReleaseDataFlags();
01000       throw excp;
01001       }
01002     }
01003 
01009   if ( m_AbortGenerateData )
01010     {
01011     this->UpdateProgress(1.0f);
01012     }
01013 
01017   this->InvokeEvent( EndEvent() );
01018 
01022   for (idx = 0; idx < m_Outputs.size(); ++idx)
01023     {
01024     if (m_Outputs[idx])
01025       {
01026       m_Outputs[idx]->DataHasBeenGenerated();
01027       }
01028     }
01029   
01033   this->RestoreInputReleaseDataFlags();
01034   
01038   this->ReleaseInputs();
01039   
01040   // Mark that we are no longer updating the data in this filter
01041   m_Updating = false;
01042 }

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

00224 {};

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.

Definition at line 621 of file itkProcessObject.cxx.

00622 {
00623   if (this->GetOutput(0))
00624     {
00625     this->GetOutput(0)->ResetPipeline();
00626     }
00627 }

DataObject::Pointer itk::ProcessObject::MakeOutput ( unsigned int 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().

This is a default implementation to make sure we have something. Once all the subclasses of ProcessObject provide an appopriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

Definition at line 59 of file itkProcessObject.cxx.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::Object::New().

00060 {
00061   return static_cast<DataObject*>(DataObject::New().GetPointer());
00062 }

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.

Definition at line 528 of file itkProcessObject.cxx.

00529 {
00530   unsigned int idx;
00531   
00532   for (idx = 0; idx < m_Outputs.size(); idx++)
00533     {
00534     if (m_Outputs[idx])
00535       {
00536       m_Outputs[idx]->SetReleaseDataFlag(val);
00537       }
00538     }
00539 }

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::SetNumberOfThreads ( int _arg ) [virtual]

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

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

Return the multithreader used by this class.

Definition at line 280 of file itkProcessObject.h.

00281     {return m_Threader;}

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

Definition at line 864 of file itkProcessObject.cxx.

00865 {  
00866   unsigned int idx;
00867   
00868   if (this->GetReleaseDataBeforeUpdateFlag())
00869     {
00870     for (idx = 0; idx < m_Outputs.size(); idx++)
00871       {
00872       if (m_Outputs[idx])
00873         {
00874         m_Outputs[idx]->PrepareForNewData(); 
00875         }
00876       }
00877     }
00878 }

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.

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

Reimplemented from itk::Object.

Definition at line 547 of file itkProcessObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::watershed::Segmenter< TInputImage >::PrintSelf(), otb::DEMToImageGenerator< TDEMImage >::PrintSelf(), and itk::VTKImageExportBase::PrintSelf().

00548 {
00549   Superclass::PrintSelf(os,indent);
00550 
00551   os << indent << "Number Of Required Inputs: "
00552      << m_NumberOfRequiredInputs << std::endl;
00553 
00554   os << indent << "Number Of Required Outputs: "
00555      << m_NumberOfRequiredOutputs << std::endl;
00556 
00557   os << indent << "Number Of Threads: "
00558      << m_NumberOfThreads << std::endl;
00559 
00560   os << indent << "ReleaseDataFlag: " 
00561      << (this->GetReleaseDataFlag() ? "On" : "Off") << std::endl;
00562 
00563   os << indent << "ReleaseDataBeforeUpdateFlag: "
00564      << (m_ReleaseDataBeforeUpdateFlag ? "On" : "Off") << std::endl;
00565   
00566   if ( m_Inputs.size())
00567     {
00568     DataObjectPointerArraySizeType idx;
00569     for (idx = 0; idx < m_Inputs.size(); ++idx)
00570       {
00571       os << indent << "Input " << static_cast<int>( idx );
00572       os << ": (" << m_Inputs[idx].GetPointer() << ")\n";
00573       }
00574     }
00575   else
00576     {
00577     os << indent <<"No Inputs\n";
00578     }
00579   if ( m_Outputs.size())
00580     {
00581     DataObjectPointerArraySizeType idx;
00582     for (idx = 0; idx < m_Outputs.size(); ++idx)
00583       {
00584       os << indent << "Output " << static_cast<int>( idx );
00585       os << ": (" << m_Outputs[idx].GetPointer() << ")\n";
00586       }
00587     }
00588   else
00589     {
00590     os << indent <<"No Output\n";
00591     }
00592 
00593   os << indent << "AbortGenerateData: " << (m_AbortGenerateData ? "On\n" : "Off\n");
00594   os << indent << "Progress: " << m_Progress << "\n";
00595 
00596   os << indent << "Multithreader: " << std::endl;
00597   m_Threader->PrintSelf(os, indent.GetNextIndent());
00598 }

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

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

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

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Definition at line 210 of file itkProcessObject.cxx.

00211 {
00212   // does this change anything?
00213   if ( idx < m_Inputs.size() && m_Inputs[idx] == input )
00214     {
00215     return;
00216     }
00217   
00218   // Expand array if necessary.
00219   if (idx >= m_Inputs.size())
00220     {
00221     this->SetNumberOfInputs(idx + 1);
00222     }
00223   
00224   m_Inputs[idx] = input;
00225 
00226   this->Modified();
00227 }

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

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

Definition at line 144 of file itkProcessObject.cxx.

00145 {
00146   DataObjectPointerArraySizeType idx;
00147   
00148   this->Modified();
00149   
00150   for (idx = 0; idx < m_Inputs.size(); ++idx)
00151     {
00152     if (!m_Inputs[idx])
00153       {
00154       m_Inputs[idx] = input;
00155       return;
00156       }
00157     }
00158   
00159   this->SetNumberOfInputs( static_cast<int>( m_Inputs.size() + 1 ) );
00160   m_Inputs[ static_cast<int>( m_Inputs.size() ) - 1] = input;
00161 }

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

Remove an input.

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

Definition at line 173 of file itkProcessObject.cxx.

00174 {
00175   if (!input)
00176     {
00177     return;
00178     }
00179   
00180   // find the input in the list of inputs
00181   DataObjectPointerArray::iterator pos = 
00182     std::find(m_Inputs.begin(), m_Inputs.end(), input);
00183 
00184   if(pos == m_Inputs.end())
00185     {
00186     itkDebugMacro("tried to remove an input that was not in the list");
00187     return;
00188     }
00189 
00190   // Set the position in the m_Inputs containing input to 0
00191   *pos = 0;
00192 
00193   // if that was the last input, then shrink the list
00194   if (pos == m_Inputs.end() - 1 )
00195     {
00196     this->SetNumberOfInputs( static_cast<int>( m_Inputs.size() ) - 1);
00197     }
00198 
00199   this->Modified();
00200 }

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

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.

Model a queue on the input list by providing a push back

Definition at line 234 of file itkProcessObject.cxx.

Referenced by itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput().

00235 {
00236   m_Inputs.push_back(const_cast<DataObject*>(input));
00237   this->Modified();
00238 }

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

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

Definition at line 245 of file itkProcessObject.cxx.

Referenced by itk::ImageToImageFilter< TInputImage, TOutputImage >::PopBackInput().

00246 {
00247   if (!m_Inputs.empty())
00248     {
00249     m_Inputs.pop_back();
00250     this->Modified();
00251     }
00252 }

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

Called to allocate the input array. Copies old inputs.

Called by constructor to set up input array.

Definition at line 96 of file itkProcessObject.cxx.

00097 {
00098   // in case nothing has changed.
00099   if (num == m_Inputs.size())
00100     {
00101     return;
00102     }
00103   m_Inputs.resize(num);
00104   this->Modified();
00105 }

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

Method used internally for getting an input.

Definition at line 470 of file itkProcessObject.cxx.

00471 {
00472   if (m_Inputs.size() < i+1)
00473     {
00474     return NULL;
00475     }
00476   
00477   return m_Inputs[i].GetPointer();
00478 }

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

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

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

Definition at line 333 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

Referenced by itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), otb::FillGapsFilter::FillGapsFilter(), itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ImageRegistrationMethod(), itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectRegistrationMethod(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MultiResolutionImageRegistrationMethod(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >::PointSetToImageRegistrationMethod(), itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >::PointSetToPointSetRegistrationMethod(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::MeshSource< TOutputMesh >::SetOutput(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::SphereMeshSource< TOutputMesh >::SphereMeshSource().

00334 {
00335   // does this change anything?
00336   if ( idx < m_Outputs.size() && output == m_Outputs[idx])
00337     {
00338     return;
00339     }
00340 
00341   // Expand array if necessary.
00342   if (idx >= m_Outputs.size())
00343     {
00344     this->SetNumberOfOutputs(idx + 1);
00345     }
00346 
00347   // Keep a handle to the original output and disconnect the old output from
00348   // the pipeline
00349   DataObjectPointer oldOutput;
00350   if ( m_Outputs[idx] )
00351     {
00352     oldOutput = m_Outputs[idx];
00353     m_Outputs[idx]->DisconnectSource(this, idx);
00354     }
00355 
00356   if (output)
00357     {
00358     output->ConnectSource(this, idx);
00359     }
00360   // save the current reference (which releases the previous reference)
00361   m_Outputs[idx] = output;
00362 
00363   // if we are clearing an output, we need to create a new blank output
00364   // so we are prepared for the next Update(). this copies the requested
00365   // region ivar
00366   if (!m_Outputs[idx])
00367     {
00368     itkDebugMacro( " creating new output object." );
00369     DataObjectPointer newOutput = this->MakeOutput(idx);
00370     this->SetNthOutput(idx, newOutput);
00371 
00372     // If we had an output object before, copy the requested region
00373     // ivars and release data flag to the the new output
00374     if (oldOutput)
00375       {
00376       newOutput->SetRequestedRegion( oldOutput );
00377       newOutput->SetReleaseDataFlag( oldOutput->GetReleaseDataFlag() );
00378       }
00379     }
00380 
00381   this->Modified();
00382 }

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

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

Definition at line 390 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

00391 {
00392   unsigned int idx;
00393   
00394   for (idx = 0; idx < m_Outputs.size(); ++idx)
00395     {
00396     if ( m_Outputs[idx].IsNull() )
00397       {
00398       m_Outputs[idx] = output;
00399 
00400       if (output)
00401         {
00402         output->ConnectSource(this, idx);
00403         }
00404       this->Modified();
00405   
00406       return;
00407       }
00408     }
00409   
00410   this->SetNumberOfOutputs( static_cast<int>( m_Outputs.size() ) + 1);
00411   m_Outputs[ static_cast<int>( m_Outputs.size() ) - 1] = output;
00412   if (output)
00413     {
00414     output->ConnectSource(this, static_cast<int>( m_Outputs.size() ) - 1 );
00415     }
00416   this->Modified();
00417 }

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

Called to allocate the output array. Copies old outputs.

Called by constructor to set up output array.

Definition at line 424 of file itkProcessObject.cxx.

00425 {
00426 
00427   // in case nothing has changed.
00428   if (num == m_Outputs.size())
00429     {
00430     return;
00431     }
00432   m_Outputs.resize(num);
00433   this->Modified();
00434 }

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

Method used internally for getting an output.

Definition at line 442 of file itkProcessObject.cxx.

00443 {
00444   if (m_Outputs.size() < i+1)
00445     {
00446     return NULL;
00447     }
00448   
00449   return m_Outputs[i].GetPointer();
00450 }

void itk::ProcessObject::GenerateInputRequestedRegion ( void ) [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).

By default we require all the input to produce the output. This is overridden in the subclasses since we can often produce the output with just a portion of the input data.

Definition at line 828 of file itkProcessObject.cxx.

Referenced by itk::watershed::Segmenter< TInputImage >::GenerateInputRequestedRegion().

00829 {
00830   DataObjectPointerArraySizeType idx;
00831   for (idx = 0; idx < m_Inputs.size(); ++idx)
00832     {
00833     if (m_Inputs[idx])
00834       {
00835       m_Inputs[idx]->SetRequestedRegionToLargestPossibleRegion();
00836       }
00837     }  
00838 }

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.

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

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< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>, and itk::watershed::SegmentTreeGenerator< InputImageType::PixelType >.

Definition at line 846 of file itkProcessObject.cxx.

00847 {
00848   DataObjectPointerArraySizeType idx;
00849   for (idx = 0; idx < m_Outputs.size(); ++idx)
00850     {
00851     if (m_Outputs[idx] && m_Outputs[idx] != output)
00852       {
00853       m_Outputs[idx]->SetRequestedRegion(output);
00854       }
00855     }  
00856 }

void itk::ProcessObject::GenerateOutputInformation ( void ) [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.

Default implementation - copy information from first input to all outputs

Definition at line 1095 of file itkProcessObject.cxx.

Referenced by itk::FFTComplexToComplexImageFilter< TPixel, NDimension >::GenerateOutputInformation(), and itk::DirectFourierReconstructionImageToImageFilter< TInputPixelType, TOutputPixelType >::GenerateOutputInformation().

01096 {
01097   DataObjectPointer input, output;
01098 
01099   if (m_Inputs.size() && m_Inputs[0])
01100     {
01101     input = m_Inputs[0];
01102 
01103     for (unsigned int idx = 0; idx < m_Outputs.size(); ++idx)
01104       {
01105       output = this->GetOutput(idx);
01106       if (output)
01107         {
01108         output->CopyInformation(input);
01109         }  
01110       }
01111     }
01112 }

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

This method causes the filter to generate its output.

Definition at line 378 of file itkProcessObject.h.

00378 {}

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.

Propagate the ResetPipeline call

Definition at line 631 of file itkProcessObject.cxx.

00632 {
00633   // 
00634   // Reset this object.
00635   //
00636   // Clear the updating flag.
00637   m_Updating = 0;
00638 
00639   //
00640   // Loop through the inputs
00641   //
00642   unsigned int idx;
00643   DataObject::Pointer input;
00644   for (idx = 0; idx < m_Inputs.size(); ++idx)
00645     {
00646     if (m_Inputs[idx])
00647       {
00648       input = m_Inputs[idx];
00649 
00653       input->PropagateResetPipeline();
00654       }
00655     }
00656 }

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

Definition at line 886 of file itkProcessObject.cxx.

Referenced by itk::watershed::Segmenter< TInputImage >::GenerateData(), itk::InPlaceLabelMapFilter< TInputImage >::ReleaseInputs(), and itk::InPlaceImageFilter< TInputImage, TOutputImage >::ReleaseInputs().

00887 {  
00888   unsigned int idx;
00889 
00890   for (idx = 0; idx < m_Inputs.size(); ++idx)
00891     {
00892     if (m_Inputs[idx])
00893       {
00894       if ( m_Inputs[idx]->ShouldIReleaseData() )
00895         {
00896         m_Inputs[idx]->ReleaseData();
00897         }
00898       }  
00899     }
00900 }

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

Definition at line 1050 of file itkProcessObject.cxx.

01051 {
01052   unsigned int idx;
01053   
01054   m_CachedInputReleaseDataFlags.resize( m_Inputs.size() );
01055   for (idx = 0; idx < m_Inputs.size(); ++idx)
01056     {
01057     if (m_Inputs[idx])
01058       {
01059       m_CachedInputReleaseDataFlags[idx]=m_Inputs[idx]->GetReleaseDataFlag();
01060       m_Inputs[idx]->ReleaseDataFlagOff();
01061       }
01062     else
01063       {
01064       m_CachedInputReleaseDataFlags[idx] = false;
01065       }
01066     }
01067 }

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

Restore the cached input ReleaseDataFlags.

Definition at line 1075 of file itkProcessObject.cxx.

01076 {
01077   unsigned int idx;
01078   
01079   for (idx = 0;
01080        idx < m_Inputs.size() && idx < m_CachedInputReleaseDataFlags.size();
01081        ++idx)
01082     {
01083     if (m_Inputs[idx])
01084       {
01085       m_Inputs[idx]->SetReleaseDataFlag(m_CachedInputReleaseDataFlags[idx]);
01086       }
01087     }
01088 }

Object::Pointer itk::Object::New ( void ) [static, inherited]

Method for creation through the object factory.

Reimplemented from itk::LightObject.

Definition at line 217 of file itkObject.cxx.

References itk::Object::UnRegister().

Referenced by itk::Object::CreateAnother(), MakeOutput(), itk::MultipleValuedVnlCostFunctionAdaptor::MultipleValuedVnlCostFunctionAdaptor(), and itk::SingleValuedVnlCostFunctionAdaptor::SingleValuedVnlCostFunctionAdaptor().

00218 {
00219   Pointer smartPtr;
00220   Object *rawPtr = ::itk::ObjectFactory<Object>::Create();
00221   if(rawPtr == NULL)
00222     {
00223     rawPtr = new Object;
00224     }
00225   smartPtr = rawPtr;
00226   rawPtr->UnRegister();
00227   return smartPtr;
00228 }

LightObject::Pointer itk::Object::CreateAnother ( void ) 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.

Definition at line 231 of file itkObject.cxx.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::Object::New().

00232 {
00233   return Object::New().GetPointer();
00234 }

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

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

References itk::Object::m_Debug.

00243 {
00244   m_Debug = true;
00245 }

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

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

References itk::Object::m_Debug.

00254 {
00255   m_Debug = false;
00256 }

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

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

References itk::Object::m_Debug.

00265 {
00266   return m_Debug;
00267 }

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

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

Definition at line 275 of file itkObject.cxx.

References itk::Object::m_Debug.

00276 {
00277   m_Debug = debugFlag;
00278 }

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

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

References itk::TimeStamp::GetMTime(), and itk::Object::m_MTime.

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

00287 {
00288   return m_MTime.GetMTime();
00289 }

void itk::Object::Modified ( void ) 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.

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

Definition at line 297 of file itkObject.cxx.

References itk::Object::InvokeEvent(), itk::Object::m_MTime, and itk::TimeStamp::Modified().

00298 {
00299   m_MTime.Modified();
00300   InvokeEvent( ModifiedEvent() );
00301 }

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

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

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

References itk::LightObject::m_ReferenceCount, and itk::LightObject::Register().

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

00310 {
00311   itkDebugMacro(<< "Registered, "
00312                 << "ReferenceCount = " << (m_ReferenceCount+1));
00313 
00314   // call the parent
00315   Superclass::Register();
00316 }

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

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

References itk::Object::InvokeEvent(), itk::LightObject::m_ReferenceCount, and itk::LightObject::UnRegister().

Referenced by itk::Object::New(), itk::SmartPointer< itk::Statistics::ImageToListAdaptor >::operator=(), and itk::ObjectFactoryBase::UnRegisterFactory().

00325 {
00326   // call the parent
00327   itkDebugMacro(<< "UnRegistered, "
00328                 << "ReferenceCount = " << (m_ReferenceCount-1));
00329 
00330   if ( (m_ReferenceCount-1) <= 0)
00331     {
00335     this->InvokeEvent(DeleteEvent());
00336     }
00337 
00338   Superclass::UnRegister();
00339 }

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

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

References itk::Object::InvokeEvent(), and itk::LightObject::SetReferenceCount().

00348 {
00349   itkDebugMacro(<< "Reference Count set to " << ref);
00350 
00351   // ReferenceCount in now unlocked.  We may have a race condition to
00352   // to delete the object.
00353   if( ref <= 0 )
00354     {
00358     this->InvokeEvent(DeleteEvent());
00359     }
00360 
00361   Superclass::SetReferenceCount(ref);
00362 }

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

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

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

References itk::Object::m_GlobalWarningDisplay.

00371 {
00372   m_GlobalWarningDisplay = val;
00373 }

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

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

References itk::Object::m_GlobalWarningDisplay.

00382 {
00383   return m_GlobalWarningDisplay;
00384 }

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

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

Definition at line 389 of file itkObject.cxx.

References itk::Object::m_SubjectImplementation.

Referenced by itk::ProgressAccumulator::RegisterInternalFilter(), and otb::WriterWatcherBase::WriterWatcherBase().

00390 {
00391   if (!this->m_SubjectImplementation)
00392     {
00393     this->m_SubjectImplementation = new SubjectImplementation;
00394     }
00395   return this->m_SubjectImplementation->AddObserver(event,cmd);
00396 }

Command * itk::Object::GetCommand ( unsigned long tag ) [inherited]

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

Definition at line 414 of file itkObject.cxx.

References itk::Object::m_SubjectImplementation.

00415 {
00416   if (this->m_SubjectImplementation)
00417     {
00418     return this->m_SubjectImplementation->GetCommand(tag);
00419     }
00420   return NULL;
00421 }

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

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

References itk::Object::m_SubjectImplementation.

Referenced by itk::Object::Modified(), itk::Object::SetReferenceCount(), itk::CumulativeGaussianOptimizer::StartOptimization(), itk::Object::UnRegister(), and itk::VTKImageExportBase::UpdateDataCallback().

00447 {
00448   if (this->m_SubjectImplementation)
00449     {
00450     this->m_SubjectImplementation->InvokeEvent(event,this);
00451     }
00452 }

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

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

Definition at line 457 of file itkObject.cxx.

References itk::Object::m_SubjectImplementation.

00458 {
00459   if (this->m_SubjectImplementation)
00460     {
00461     this->m_SubjectImplementation->InvokeEvent(event,this);
00462     }
00463 }

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

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

References itk::Object::m_SubjectImplementation.

00426 {
00427   if (this->m_SubjectImplementation)
00428     {
00429     this->m_SubjectImplementation->RemoveObserver(tag);
00430     }
00431 }

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

Remove all observers .

Definition at line 435 of file itkObject.cxx.

References itk::Object::m_SubjectImplementation.

00436 {
00437   if (this->m_SubjectImplementation)
00438     {
00439     this->m_SubjectImplementation->RemoveAllObservers();
00440     }
00441 }

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

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

References itk::Object::m_SubjectImplementation.

00468 {
00469   if (this->m_SubjectImplementation)
00470     {
00471     return this->m_SubjectImplementation->HasObserver(event);
00472     }
00473   return false;
00474 }

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Definition at line 532 of file itkObject.cxx.

References itk::Object::m_MetaDataDictionary.

00533 {
00534   if(m_MetaDataDictionary==NULL)
00535     {
00536     m_MetaDataDictionary=new MetaDataDictionary;
00537     }
00538   return *m_MetaDataDictionary;
00539 }

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

Returns:: A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References itk::Object::m_MetaDataDictionary.

00544 {
00545   if(m_MetaDataDictionary==NULL)
00546     {
00547     m_MetaDataDictionary=new MetaDataDictionary;
00548     }
00549   return *m_MetaDataDictionary;
00550 }

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

Returns:: Set the MetaDataDictionary

Definition at line 554 of file itkObject.cxx.

References itk::Object::m_MetaDataDictionary.

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

00555 {
00556   if(m_MetaDataDictionary==NULL)
00557     {
00558     m_MetaDataDictionary=new MetaDataDictionary;
00559     }
00560   *m_MetaDataDictionary=rhs;
00561 }

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.

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

Definition at line 88 of file itkLightObject.cxx.

References itk::LightObject::UnRegister().

00089 {
00090   this->UnRegister();
00091 }

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

Cause the object to print itself out.

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

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent(), itk::LightObject::PrintHeader(), itk::LightObject::PrintSelf(), and itk::LightObject::PrintTrailer().

Referenced by itk::operator<<(), itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::Statistics::ImageToListAdaptor >::Print().

00136 {
00137   this->PrintHeader(os, indent); 
00138   this->PrintSelf(os, indent.GetNextIndent());
00139   this->PrintTrailer(os, indent);
00140 }

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

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

Definition at line 149 of file itkLightObject.cxx.

00150 {
00151   ;  
00152 }

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

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

00106     {return static_cast<int>(m_ReferenceCount);}

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

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

References itk::LightObject::GetNameOfClass().

Referenced by itk::LightObject::Print().

00321 {
00322   os << indent << this->GetNameOfClass() << " (" << this << ")\n";
00323 }

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

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

Referenced by itk::LightObject::Print().

00332 {
00333 }

Friends And Related Function Documentation

friend class DataObject [friend]

Friends of ProcessObject

Definition at line 451 of file itkProcessObject.h.

Member Data Documentation

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.

Reimplemented in otb::HistogramAndTransferFunctionWidget< THistogram, TPixel >, and otb::ImageViewerBase< TPixel, TLabel >.

Definition at line 418 of file itkProcessObject.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected]

Time when GenerateOutputInformation was last called.

Definition at line 421 of file itkProcessObject.h.

DataObjectPointerArray itk::ProcessObject::m_Inputs [private]

An array of the inputs to the filter.

Definition at line 428 of file itkProcessObject.h.

std::vector<bool> itk::ProcessObject::m_CachedInputReleaseDataFlags [private]

An array that caches the ReleaseDataFlags of the inputs

Definition at line 432 of file itkProcessObject.h.

DataObjectPointerArray itk::ProcessObject::m_Outputs [private]

An array of the outputs to the filter.

Definition at line 435 of file itkProcessObject.h.

bool itk::ProcessObject::m_AbortGenerateData [private]

These support the progress method and aborting filter execution.

Definition at line 439 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 444 of file itkProcessObject.h.

bool itk::ProcessObject::m_ReleaseDataBeforeUpdateFlag [private]

Memory management ivars

Definition at line 448 of file itkProcessObject.h.

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

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

Referenced by itk::LightObject::PrintSelf(), itk::LightObject::Register(), itk::Object::Register(), itk::LightObject::SetReferenceCount(), itk::LightObject::UnRegister(), itk::Object::UnRegister(), and itk::LightObject::~LightObject().

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

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

Referenced by itk::LightObject::Register(), itk::LightObject::SetReferenceCount(), and itk::LightObject::UnRegister().

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


Public Types
typedef ProcessObject	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
Public Member Functions
virtual const char *	GetNameOfClass () const
DataObjectPointerArray &	GetInputs ()
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
DataObjectPointerArray &	GetOutputs ()
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual void	SetAbortGenerateData (bool _arg)
virtual const bool &	GetAbortGenerateData ()
virtual void	AbortGenerateDataOn ()
virtual void	AbortGenerateDataOff ()
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress ()
void	UpdateProgress (float amount)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputInformation ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	UpdateOutputData (DataObject *output)
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual void	ResetPipeline ()
virtual DataObjectPointer	MakeOutput (unsigned int idx)
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 ()
MultiThreader *	GetMultiThreader ()
virtual void	PrepareOutputs ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOn () const
virtual void	DebugOff () const
bool	GetDebug () const
void	SetDebug (bool debugFlag) const
virtual unsigned long	GetMTime () const
virtual void	Modified () const
virtual void	Register () const
virtual void	UnRegister () const
virtual void	SetReferenceCount (int)
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Command *	GetCommand (unsigned long tag)
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
void	RemoveObserver (unsigned long tag)
void	RemoveAllObservers ()
bool	HasObserver (const EventObject &event) const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	Delete ()
void	Print (std::ostream &os, Indent indent=0) const
virtual int	GetReferenceCount () const
Static Public Member Functions
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	BreakOnError ()
Protected Types
typedef int	InternalReferenceCountType
Protected Member Functions
	ProcessObject ()
	~ProcessObject ()
void	PrintSelf (std::ostream &os, Indent indent) const
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 ()
void	SetNumberOfInputs (unsigned int num)
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 ()
void	SetNumberOfOutputs (unsigned int num)
DataObject *	GetOutput (unsigned int idx)
const DataObject *	GetOutput (unsigned int idx) const
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual void	GenerateOutputInformation ()
virtual void	GenerateData ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	RestoreInputReleaseDataFlags ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
bool	m_Updating
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Private Member Functions
	ProcessObject (const Self &)
void	operator= (const Self &)
Private Attributes
DataObjectPointerArray	m_Inputs
unsigned int	m_NumberOfRequiredInputs
std::vector< bool >	m_CachedInputReleaseDataFlags
DataObjectPointerArray	m_Outputs
unsigned int	m_NumberOfRequiredOutputs
bool	m_AbortGenerateData
float	m_Progress
MultiThreader::Pointer	m_Threader
int	m_NumberOfThreads
bool	m_ReleaseDataBeforeUpdateFlag
Friends
class	DataObject

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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