#include <itkProcessObject.h>

Detailed Description

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

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

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

VOCABULARY:

named entry - an entry indexed by a DataObjectIdentifierType or string.
index entry - an entry indexed by an integer, which also always has a string identifier.
define an input/output - adds a named entry or a indexed entry.
required input - a precondition that the inputs is set before updating.
set the value - set the value of an input or output, and automatically define the entry if it does not exist.

Note

The Primary Input is always defined internally, and is handled as a special case for many methods.
Some inputs can be defined as required. Either explicitly by name or the older ITKv3 style where a certain number of index inputs are required.

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

In addition to the reference by name, it is possible to access the inputs and outputs with an index. The index by default is mapped internally to a name with '_' followed by the index number. This default name can be changed with the AddRequiredInputName method. The indexed input or output 0 is mapped to the Primary input or output. The name of the Primary input or output defaults to "Primary", but this can be changed with SetPrimaryInputName and SetPrimaryOutputName.

For complicated filters which have optional, or varied required inputs, named input access is preferred. However, indexed input access provides constant time access to input and output DataObjects, and so are more efficient. A name can also be associated with an indexed input. Neither type of input or output should be accessed in a tight loop.

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

Inheritance diagram for itk::ProcessObject:

Collaboration diagram for itk::ProcessObject:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)


virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()


virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()


virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Protected Member Functions
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override


DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const


DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const


virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const


DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const


virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const


DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const


DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const


virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

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

virtual	~LightObject ()

Static Protected Member Functions
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)


static uint32_t	progressFloatToFixed (float f)

Protected Attributes
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Types
using	DataObjectPointerMap = std::map< DataObjectIdentifierType, DataObjectPointer >

using	NameSet = std::set< DataObjectIdentifierType >

Private Member Functions
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const

DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const

Private Attributes
bool	m_AbortGenerateData {}

std::map< DataObjectIdentifierType, bool >	m_CachedInputReleaseDataFlags {}

std::vector< DataObjectPointerMap::iterator >	m_IndexedInputs {}

std::vector< DataObjectPointerMap::iterator >	m_IndexedOutputs {}

DataObjectPointerMap	m_Inputs {}

itk::SmartPointer< MultiThreaderType >	m_MultiThreader

DataObjectPointerArraySizeType	m_NumberOfRequiredInputs {}

DataObjectPointerArraySizeType	m_NumberOfRequiredOutputs {}

ThreadIdType	m_NumberOfWorkUnits {}

DataObjectPointerMap	m_Outputs {}

std::atomic< uint32_t >	m_Progress {}

bool	m_ReleaseDataBeforeUpdateFlag {}

NameSet	m_RequiredInputNames {}

bool	m_ThreaderUpdateProgress { true }

std::thread::id	m_UpdateThreadID {}

Friends
class	DataObject

class	DataObjectConstIterator

class	DataObjectIterator

class	InputDataObjectConstIterator

class	InputDataObjectIterator

class	OutputDataObjectConstIterator

class	OutputDataObjectIterator

class	ProgressReporter

class	TestProcessObject

class	TotalProgressReporter

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Member Typedef Documentation

◆ ConstPointer

using itk::ProcessObject::ConstPointer = SmartPointer<const Self>

Definition at line 148 of file itkProcessObject.h.

◆ DataObjectIdentifierType

using itk::ProcessObject::DataObjectIdentifierType = DataObject::DataObjectIdentifierType

Definition at line 162 of file itkProcessObject.h.

◆ DataObjectPointer

using itk::ProcessObject::DataObjectPointer = DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 154 of file itkProcessObject.h.

◆ DataObjectPointerArray

using itk::ProcessObject::DataObjectPointerArray = std::vector<DataObjectPointer>

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

Definition at line 160 of file itkProcessObject.h.

◆ DataObjectPointerArraySizeType

using itk::ProcessObject::DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

Definition at line 194 of file itkProcessObject.h.

◆ DataObjectPointerMap

using itk::ProcessObject::DataObjectPointerMap = std::map<DataObjectIdentifierType, DataObjectPointer>

private

STL map to store the named inputs and outputs

Definition at line 966 of file itkProcessObject.h.

◆ MultiThreaderType

using itk::ProcessObject::MultiThreaderType = MultiThreaderBase

Type of general multi-threader interface

Definition at line 168 of file itkProcessObject.h.

◆ NameArray

using itk::ProcessObject::NameArray = std::vector<DataObjectIdentifierType>

STL array of data object names

Definition at line 165 of file itkProcessObject.h.

◆ NameSet

using itk::ProcessObject::NameSet = std::set<DataObjectIdentifierType>

private

STL map to store the named inputs and outputs

Definition at line 983 of file itkProcessObject.h.

◆ Pointer

using itk::ProcessObject::Pointer = SmartPointer<Self>

Definition at line 147 of file itkProcessObject.h.

◆ Self

using itk::ProcessObject::Self = ProcessObject

Standard class type aliases.

Definition at line 145 of file itkProcessObject.h.

◆ Superclass

using itk::ProcessObject::Superclass = Object

Definition at line 146 of file itkProcessObject.h.

Constructor & Destructor Documentation

◆ ProcessObject()

itk::ProcessObject::ProcessObject ( )

protected

◆ ~ProcessObject()

itk::ProcessObject::~ProcessObject ( )

overrideprotected

Member Function Documentation

◆ AbortGenerateDataOn()

virtual void itk::ProcessObject::AbortGenerateDataOn ( )

virtual

Turn on and off the AbortGenerateData flag.

◆ AddInput()

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

protectedvirtual

Sets first nullptr indexed input, appends to the end otherwise

◆ AddOptionalInputName() [1/2]

void itk::ProcessObject::AddOptionalInputName ( const DataObjectIdentifierType & )

protected

Define a named input that is not required and optionally associate with a numbered index.

The previous named input associated with idx will be removed from the defined input names.

If the specified named inputs already exists with a non-null value, then that value will be used. Otherwise if the specified index has a non-null value, then that will be the value set.

◆ AddOptionalInputName() [2/2]

void itk::ProcessObject::AddOptionalInputName	(	const DataObjectIdentifierType &	,
		DataObjectPointerArraySizeType	idx
	)

protected

◆ AddOutput()

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

protectedvirtual

◆ AddRequiredInputName() [1/2]

bool itk::ProcessObject::AddRequiredInputName ( const DataObjectIdentifierType & )

protected

Define a required named input and optionally associate it with a numbered index.

The previous named input associated with idx will be removed from the defined input names.

If the specified named inputs already exists with a non-null value, then that value will be used. Otherwise if the specified index has a non-null value, then that will be the value set.

◆ AddRequiredInputName() [2/2]

bool itk::ProcessObject::AddRequiredInputName	(	const DataObjectIdentifierType &	,
		DataObjectPointerArraySizeType	idx
	)

protected

◆ CacheInputReleaseDataFlags()

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( )

protectedvirtual

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

◆ EnlargeOutputRequestedRegion()

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

inlinevirtual

Give the process object a chance to indicate 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 426 of file itkProcessObject.h.

◆ GenerateData()

virtual void itk::ProcessObject::GenerateData ( )

inlineprotectedvirtual

This method causes the filter to generate its output.

Definition at line 855 of file itkProcessObject.h.

◆ GenerateInputRequestedRegion()

virtual void itk::ProcessObject::GenerateInputRequestedRegion ( )

protectedvirtual

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

◆ GenerateOutputInformation()

virtual void itk::ProcessObject::GenerateOutputInformation ( )

protectedvirtual

Generate the information describing 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.

◆ GenerateOutputRequestedRegion()

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

protectedvirtual

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

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::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >, itk::watershed::Relabeler< TScalar, TImageDimension >, itk::watershed::Relabeler< ScalarType, Self::ImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< InputImageType >, itk::watershed::SegmentTreeGenerator< TScalar >, itk::watershed::SegmentTreeGenerator< ScalarType >, itk::TemporalProcessObject, itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoToVideoFilter< TVideoStream, TVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, and itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

◆ GetAbortGenerateData()

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

virtual

Get the AbortGenerateData flag for the process object.

◆ GetIndexedInputs()

DataObjectPointerArray itk::ProcessObject::GetIndexedInputs ( )

Return an array with all the indexed inputs.

◆ GetIndexedOutputs()

DataObjectPointerArray itk::ProcessObject::GetIndexedOutputs ( )

Return an array with the indexed outputs.

◆ GetInput() [1/4]

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

protected

Return an input.

nullptr is returned if the name or indexed input is undefined.

◆ GetInput() [2/4]

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

protected

◆ GetInput() [3/4]

DataObject * itk::ProcessObject::GetInput ( DataObjectPointerArraySizeType idx )

inlineprotected

Method used internally for getting an indexed input.

Definition at line 543 of file itkProcessObject.h.

◆ GetInput() [4/4]

const DataObject * itk::ProcessObject::GetInput ( DataObjectPointerArraySizeType idx ) const

inlineprotected

Method used internally for getting an indexed input.

Definition at line 548 of file itkProcessObject.h.

◆ GetInputNames()

NameArray itk::ProcessObject::GetInputNames ( ) const

Return an array with the names of the inputs defined.

The names are ordered lexicographically, and match the order of the data object produced by GetInputs().

◆ GetInputs()

DataObjectPointerArray itk::ProcessObject::GetInputs ( )

Return an array of DataObjects with the defined named inputs.

The order of the inputs matches the order of the input names produced by GetInputNames().

◆ GetMultiThreader()

MultiThreaderType * itk::ProcessObject::GetMultiThreader ( ) const

inline

Return the multithreader used by this class.

Definition at line 502 of file itkProcessObject.h.

◆ GetNameOfClass()

const char * itk::ProcessObject::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetNumberOfIndexedInputs()

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfIndexedInputs ( ) const

Get the number of defined Indexed inputs.

This is merely the size of the index input vector, not the number of inputs that have valid DataObject's assigned. The Primary inputs is handled as a special case. Use GetNumberOfValidRequiredInputs() to determine how many indexed inputs are non-null.

All indexed inputs up to this value are defined.

See also: GetNumberOfInputs; GetNumberOfValidRequiredInputs

◆ GetNumberOfIndexedOutputs()

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfIndexedOutputs ( ) const

The number of defined Indexed outputs.

◆ GetNumberOfInputs()

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const

Get the size of the input container.

If the Primary input is nullptr it is not counted. This is not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

See also: GetNumberOfValidRequiredInputs; GetNumberOfIndexedInputs

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

◆ GetNumberOfOutputs()

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const

Get the size of the output container.

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

◆ GetNumberOfRequiredInputs()

virtual const DataObjectPointerArraySizeType & itk::ProcessObject::GetNumberOfRequiredInputs ( ) const

protectedvirtual

◆ GetNumberOfRequiredOutputs()

virtual const DataObjectPointerArraySizeType & itk::ProcessObject::GetNumberOfRequiredOutputs ( ) const

protectedvirtual

◆ GetNumberOfValidRequiredInputs()

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

virtual

Get the number of valid indexed inputs.

Returns the number of non-null indexed inputs. This method is used to determine whether the correct number of inputs are set to valid values.

See also: GetNumberOfInputs; GetNumberOfIndexedInputs

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDisplacementField, TRealType, TFloatImageType, TRegistrationType, TDefaultRegistrationType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >.

◆ GetNumberOfWorkUnits()

virtual const ThreadIdType & itk::ProcessObject::GetNumberOfWorkUnits ( ) const

virtual

Get/Set the number of work units to create when executing.

◆ GetOutput() [1/4]

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

protected

Return an output

Referenced by itk::watershed::Segmenter< TInputImage >::GetBoundary(), itk::BlockMatchingImageFilter< TFixedImage, TMovingImage, TFeatures, TDisplacements, TSimilarities >::GetDisplacements(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetEquivalencyTable(), itk::Testing::HashImageFilter< TImageType >::GetHashOutput(), itk::HistogramThresholdCalculator< THistogram, TOutput >::GetOutput(), itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::GetOutputImage(), itk::watershed::Relabeler< TScalar, TImageDimension >::GetOutputImage(), itk::watershed::Segmenter< TInputImage >::GetOutputImage(), itk::watershed::SegmentTreeGenerator< TScalar >::GetOutputSegmentTree(), itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GetPhiLattice(), itk::watershed::Segmenter< TInputImage >::GetSegmentTable(), itk::BlockMatchingImageFilter< TFixedImage, TMovingImage, TFeatures, TDisplacements, TSimilarities >::GetSimilarities(), and itk::HistogramThresholdCalculator< THistogram, TOutput >::GetThreshold().

◆ GetOutput() [2/4]

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

protected

Return an output

◆ GetOutput() [3/4]

DataObject * itk::ProcessObject::GetOutput ( DataObjectPointerArraySizeType i )

protected

Method used internally for getting an indexed output.

◆ GetOutput() [4/4]

const DataObject * itk::ProcessObject::GetOutput ( DataObjectPointerArraySizeType i ) const

protected

Method used internally for getting an indexed output.

◆ GetOutputNames()

NameArray itk::ProcessObject::GetOutputNames ( ) const

Return an array with the defined names of the outputs.

The names are ordered lexicographically, and match the order of the data object produced by GetOutputs()

◆ GetOutputs()

DataObjectPointerArray itk::ProcessObject::GetOutputs ( )

Return an array with the defined named outputs.

The order of the outputs match the order of the input names produced by GetOutputNames().

◆ GetPrimaryInput() [1/2]

DataObject * itk::ProcessObject::GetPrimaryInput ( )

inlineprotected

Return the main input

Definition at line 598 of file itkProcessObject.h.

◆ GetPrimaryInput() [2/2]

const DataObject * itk::ProcessObject::GetPrimaryInput ( ) const

inlineprotected

Return the main input

Definition at line 603 of file itkProcessObject.h.

◆ GetPrimaryInputName()

virtual const char * itk::ProcessObject::GetPrimaryInputName ( ) const

inlineprotectedvirtual

Set/Get the name associated with the Primary input. Defaults to "Primary".

Definition at line 613 of file itkProcessObject.h.

◆ GetPrimaryOutput() [1/2]

DataObject * itk::ProcessObject::GetPrimaryOutput ( )

inlineprotected

Return the main output

Definition at line 732 of file itkProcessObject.h.

◆ GetPrimaryOutput() [2/2]

const DataObject * itk::ProcessObject::GetPrimaryOutput ( ) const

inlineprotected

Return the main output

Definition at line 737 of file itkProcessObject.h.

◆ GetPrimaryOutputName()

virtual const char * itk::ProcessObject::GetPrimaryOutputName ( ) const

inlineprotectedvirtual

Set/Get the name associated with the Primary output. Defaults to "Primary".

Definition at line 709 of file itkProcessObject.h.

◆ GetProgress()

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

inlinevirtual

Get the execution progress of a process object.

Deprecated:: 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. This method is deprecated because filters should not be calling SetProgress directly but should be using UpdateProgress or IncrementProgress instead.

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

Definition at line 326 of file itkProcessObject.h.

◆ GetReleaseDataBeforeUpdateFlag()

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

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.

◆ GetReleaseDataFlag()

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

virtual

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

◆ GetRequiredInputNames()

NameArray itk::ProcessObject::GetRequiredInputNames ( ) const

Return an array with the names of the required inputs.

◆ GetThreaderUpdateProgress()

virtual bool itk::ProcessObject::GetThreaderUpdateProgress ( ) const

protectedvirtual

When true, the MultiThreader will report course grain progress. If set to false, a progress must be explicitly updated in derived filters.

◆ HasInput()

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

Return true if the input with this name is defined

◆ HasOutput()

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

Return true if the output with this name is defined.

◆ IncrementProgress()

void itk::ProcessObject::IncrementProgress ( float increment )

Increment the progress of the process object.

Atomically add the current progress and may invoke observers of the ProgressEvent. Progress is represented in [0.0,1.0] or percentage. This method will invoke the ProgressEvent when called by the same as the pipeline.

Multiple threads may call this method and the total progress will be atomically incremented.

◆ IsIndexedInputName()

bool itk::ProcessObject::IsIndexedInputName ( const DataObjectIdentifierType & ) const

protected

◆ IsIndexedOutputName()

bool itk::ProcessObject::IsIndexedOutputName ( const DataObjectIdentifierType & ) const

protected

◆ IsRequiredInputName()

bool itk::ProcessObject::IsRequiredInputName ( const DataObjectIdentifierType & ) const

protected

Query if the named input is required by name.

◆ MakeIndexFromInputName()

DataObjectPointerArraySizeType itk::ProcessObject::MakeIndexFromInputName ( const DataObjectIdentifierType & name ) const

protected

◆ MakeIndexFromName()

DataObjectPointerArraySizeType itk::ProcessObject::MakeIndexFromName ( const DataObjectIdentifierType & ) const

private

◆ MakeIndexFromOutputName()

DataObjectPointerArraySizeType itk::ProcessObject::MakeIndexFromOutputName ( const DataObjectIdentifierType & name ) const

protected

◆ MakeNameFromIndex()

DataObjectIdentifierType itk::ProcessObject::MakeNameFromIndex ( DataObjectPointerArraySizeType ) const

private

◆ MakeNameFromInputIndex()

DataObjectIdentifierType itk::ProcessObject::MakeNameFromInputIndex ( DataObjectPointerArraySizeType idx ) const

protected

◆ MakeNameFromOutputIndex()

DataObjectIdentifierType itk::ProcessObject::MakeNameFromOutputIndex ( DataObjectPointerArraySizeType idx ) const

protected

◆ MakeOutput() [1/2]

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

virtual

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

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

◆ MakeOutput() [2/2]

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

virtual

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

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

◆ MakeRequiredOutputs()

template<typename TSourceObject >

static void itk::ProcessObject::MakeRequiredOutputs	(	TSourceObject &	sourceObject,
		const DataObjectPointerArraySizeType	numberOfRequiredOutputs
	)

inlinestaticprotected

Sets the required number of outputs, and creates each of them by MakeOutput.

Definition at line 940 of file itkProcessObject.h.

◆ PopBackInput()

virtual void itk::ProcessObject::PopBackInput ( )

protectedvirtual

◆ PopFrontInput()

virtual void itk::ProcessObject::PopFrontInput ( )

protectedvirtual

◆ PrepareOutputs()

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

◆ PrintSelf()

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

overrideprotectedvirtual

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

Reimplemented from itk::Object.

◆ progressFixedToFloat()

static constexpr float itk::ProcessObject::progressFixedToFloat ( uint32_t fixed )

inlinestaticconstexprprotected

Internal method to convert internal integer progress to float [0.0, 1.0]

Definition at line 911 of file itkProcessObject.h.

◆ progressFloatToFixed()

static uint32_t itk::ProcessObject::progressFloatToFixed ( float f )

inlinestaticprotected

Internal method convert floating point progress [0.0, 1.0] to internal integer representation. Values outside the [0.0, 1.0] range are clamped.

Definition at line 921 of file itkProcessObject.h.

◆ PropagateRequestedRegion()

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

virtual

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

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

◆ PropagateResetPipeline()

virtual void itk::ProcessObject::PropagateResetPipeline ( )

protectedvirtual

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

◆ PushBackInput()

virtual void itk::ProcessObject::PushBackInput ( const DataObject * input )

protectedvirtual

Push/Pop an indexed input of this process object.

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

◆ PushFrontInput()

virtual void itk::ProcessObject::PushFrontInput ( const DataObject * input )

protectedvirtual

◆ ReleaseDataBeforeUpdateFlagOn()

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( )

virtual

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

◆ ReleaseDataFlagOff()

void itk::ProcessObject::ReleaseDataFlagOff ( )

inline

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

Definition at line 472 of file itkProcessObject.h.

◆ ReleaseDataFlagOn()

void itk::ProcessObject::ReleaseDataFlagOn ( )

inline

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

Definition at line 467 of file itkProcessObject.h.

◆ ReleaseInputs()

virtual void itk::ProcessObject::ReleaseInputs ( )

protectedvirtual

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

◆ RemoveInput() [1/2]

virtual void itk::ProcessObject::RemoveInput ( const DataObjectIdentifierType & key )

protectedvirtual

Remove an input.

If the input is the last indexed input the number of indexed inputs will be reduced by one. Otherwise, if the input is required or indexed it will be set to nullptr.

◆ RemoveInput() [2/2]

virtual void itk::ProcessObject::RemoveInput ( DataObjectPointerArraySizeType )

protectedvirtual

◆ RemoveOutput() [1/2]

virtual void itk::ProcessObject::RemoveOutput ( const DataObjectIdentifierType & key )

protectedvirtual

Remove an output

◆ RemoveOutput() [2/2]

virtual void itk::ProcessObject::RemoveOutput ( DataObjectPointerArraySizeType idx )

protectedvirtual

◆ RemoveRequiredInputName()

bool itk::ProcessObject::RemoveRequiredInputName ( const DataObjectIdentifierType & )

protected

Remove the named input from the required inputs.

The named input remains defined or set afterwards.

◆ ResetPipeline()

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.

Reimplemented in itk::StreamingProcessObject.

◆ RestoreInputReleaseDataFlags()

virtual void itk::ProcessObject::RestoreInputReleaseDataFlags ( )

protectedvirtual

Restore the cached input ReleaseDataFlags.

◆ SetAbortGenerateData()

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.

◆ SetInput()

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

protectedvirtual

Protected method for setting indexed and named inputs.

Subclasses make use of them for setting input. As this method only used the base DataObject pointer, derived classes should expose a type check methods.

Referenced by itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage().

◆ SetMultiThreader()

void itk::ProcessObject::SetMultiThreader ( MultiThreaderType * threader )

Set the multithreader used by this class.

◆ SetNthInput()

virtual void itk::ProcessObject::SetNthInput	(	DataObjectPointerArraySizeType	idx,
		DataObject *	input
	)

protectedvirtual

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::SetEquivalencyTable(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >::SetFeatureImage(), itk::HistogramThresholdCalculator< THistogram, TOutput >::SetInput(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< TScalar >::SetInputEquivalencyTable(), itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::SetInputImage(), itk::watershed::Relabeler< TScalar, TImageDimension >::SetInputImage(), itk::watershed::Segmenter< TInputImage >::SetInputImage(), itk::watershed::SegmentTreeGenerator< TScalar >::SetInputSegmentTable(), itk::watershed::Relabeler< TScalar, TImageDimension >::SetInputSegmentTree(), itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage(), and itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType, TMaskImageType >::SetReferenceImage().

◆ SetNthOutput()

virtual void itk::ProcessObject::SetNthOutput	(	DataObjectPointerArraySizeType	idx,
		DataObject *	output
	)

protectedvirtual

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

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::EquivalenceRelabeler(), itk::HistogramThresholdCalculator< THistogram, TOutput >::HistogramThresholdCalculator(), itk::watershed::Segmenter< TInputImage >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::EquivalenceRelabeler< TScalar, TImageDimension >::SetOutputImage(), itk::watershed::Relabeler< TScalar, TImageDimension >::SetOutputImage(), itk::watershed::Segmenter< TInputImage >::SetOutputImage(), and itk::watershed::Segmenter< TInputImage >::SetSegmentTable().

◆ SetNumberOfIndexedInputs()

void itk::ProcessObject::SetNumberOfIndexedInputs ( DataObjectPointerArraySizeType num )

protected

Define the number of indexed inputs defined.

The new indexed inputs' values are set to nullptr. If the size is reduced then the input definition is removed entirely from the named input entries and index inputs.

◆ SetNumberOfIndexedOutputs()

void itk::ProcessObject::SetNumberOfIndexedOutputs ( DataObjectPointerArraySizeType num )

protected

Called to allocate the output array. Copies old outputs.

◆ SetNumberOfRequiredInputs()

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( DataObjectPointerArraySizeType )

protectedvirtual

Set the number of required indexed inputs.

If an input is not associated with an index and only a named entry, it is not considered in this count. In the method VerifyPreconditions(), GetNumberOfValidRequiredInputs() is checked to be at least this value.

Note: SetNumberOfRequiredIndexInputs maybe a better name.

◆ SetNumberOfRequiredOutputs()

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( DataObjectPointerArraySizeType _arg )

protectedvirtual

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

◆ SetNumberOfWorkUnits()

virtual void itk::ProcessObject::SetNumberOfWorkUnits ( ThreadIdType _arg )

virtual

Get/Set the number of work units to create when executing.

Reimplemented in itk::GradientMagnitudeRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< TInputImage::ImageDimension > > >.

◆ SetOutput()

virtual void itk::ProcessObject::SetOutput	(	const DataObjectIdentifierType &	name,
		DataObject *	output
	)

protectedvirtual

Set an output

◆ SetPrimaryInput()

virtual void itk::ProcessObject::SetPrimaryInput ( DataObject * object )

protectedvirtual

Set the main input

◆ SetPrimaryInputName()

virtual void itk::ProcessObject::SetPrimaryInputName ( const DataObjectIdentifierType & key )

protectedvirtual

Set/Get the name associated with the Primary input. Defaults to "Primary".

◆ SetPrimaryOutput()

virtual void itk::ProcessObject::SetPrimaryOutput ( DataObject * object )

protectedvirtual

Set the main output

◆ SetPrimaryOutputName()

virtual void itk::ProcessObject::SetPrimaryOutputName ( const DataObjectIdentifierType & key )

protectedvirtual

Set/Get the name associated with the Primary output. Defaults to "Primary".

◆ SetReleaseDataBeforeUpdateFlag()

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.

◆ SetReleaseDataFlag()

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool val )

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.

◆ SetRequiredInputNames()

void itk::ProcessObject::SetRequiredInputNames ( const NameArray & )

protected

Set all required named inputs.

All named inputs remain defined or set.

◆ SetThreaderUpdateProgress()

virtual void itk::ProcessObject::SetThreaderUpdateProgress ( bool arg )

protectedvirtual

When true, the MultiThreader will report course grain progress. If set to false, a progress must be explicitly updated in derived filters.

◆ ThreaderUpdateProgressOn()

virtual void itk::ProcessObject::ThreaderUpdateProgressOn ( )

protectedvirtual

When true, the MultiThreader will report course grain progress. If set to false, a progress must be explicitly updated in derived filters.

◆ Update()

virtual void itk::ProcessObject::Update ( )

virtual

Bring this filter up-to-date.

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

Reimplemented in itk::ImageSink< TInputImage >, itk::ImageSink< TLabelImage >, itk::ImageSink< TImage >, itk::ImageFileWriter< TInputImage >, itk::ImageSeriesWriter< TInputImage, TOutputImage >, itk::MeshFileWriter< TInputMesh >, and itk::VideoFileWriter< TInputVideoStream >.

Referenced by itk::WatershedImageFilter< TInputImage >::GetBasicSegmentation().

◆ UpdateLargestPossibleRegion()

virtual void itk::ProcessObject::UpdateLargestPossibleRegion ( )

virtual

Sets the output requested region to the largest possible region and updates.

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

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

◆ UpdateOutputData()

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

virtual

Actually generate new output

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

◆ UpdateOutputInformation()

virtual void itk::ProcessObject::UpdateOutputInformation ( )

virtual

Update the information describing the output data.

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

Reimplemented in itk::VTKImageImport< TOutputImage >, itk::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< InputImageType >, itk::TemporalProcessObject, itk::VideoToVideoFilter< TInputVideoStream, TOutputVideoStream >, itk::VideoToVideoFilter< TVideoStream, TVideoStream >, itk::VideoToVideoFilter< itk::VideoStream< TImageToImageFilter::InputImageType >, itk::VideoStream< TImageToImageFilter::OutputImageType > >, and itk::VideoFileReader< TOutputVideoStream >.

◆ UpdateProgress()

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

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.

Multiple thread should not call this method, since they may have computed different values and increments may get lost.

◆ VerifyInputInformation()

virtual void itk::ProcessObject::VerifyInputInformation ( ) const

protectedvirtual

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

This method is called immediately before GenerateOutputInformation().

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

◆ VerifyPreconditions()

virtual void itk::ProcessObject::VerifyPreconditions ( ) const

protectedvirtual

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

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

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

Friends And Related Function Documentation

◆ DataObject

friend class DataObject

friend

Friends of ProcessObject

Definition at line 1006 of file itkProcessObject.h.

◆ DataObjectConstIterator

friend class DataObjectConstIterator

friend

Definition at line 1011 of file itkProcessObject.h.

◆ DataObjectIterator

friend class DataObjectIterator

friend

Definition at line 1015 of file itkProcessObject.h.

◆ InputDataObjectConstIterator

friend class InputDataObjectConstIterator

friend

Definition at line 1012 of file itkProcessObject.h.

◆ InputDataObjectIterator

friend class InputDataObjectIterator

friend

Definition at line 1016 of file itkProcessObject.h.

◆ OutputDataObjectConstIterator

friend class OutputDataObjectConstIterator

friend

Definition at line 1013 of file itkProcessObject.h.

◆ OutputDataObjectIterator

friend class OutputDataObjectIterator

friend

Definition at line 1017 of file itkProcessObject.h.

◆ ProgressReporter

friend class ProgressReporter

friend

Definition at line 1008 of file itkProcessObject.h.

◆ TestProcessObject

friend class TestProcessObject

friend

Definition at line 1019 of file itkProcessObject.h.

◆ TotalProgressReporter

friend class TotalProgressReporter

friend

Definition at line 1009 of file itkProcessObject.h.

Member Data Documentation

◆ m_AbortGenerateData

bool itk::ProcessObject::m_AbortGenerateData {}

private

These support the progress method and aborting filter execution.

Definition at line 989 of file itkProcessObject.h.

◆ m_CachedInputReleaseDataFlags

std::map<DataObjectIdentifierType, bool> itk::ProcessObject::m_CachedInputReleaseDataFlags {}

private

An array that caches the ReleaseDataFlags of the inputs

Definition at line 977 of file itkProcessObject.h.

◆ m_IndexedInputs

std::vector<DataObjectPointerMap::iterator> itk::ProcessObject::m_IndexedInputs {}

private

Definition at line 973 of file itkProcessObject.h.

◆ m_IndexedOutputs

std::vector<DataObjectPointerMap::iterator> itk::ProcessObject::m_IndexedOutputs {}

private

Definition at line 974 of file itkProcessObject.h.

◆ m_Inputs

DataObjectPointerMap itk::ProcessObject::m_Inputs {}

private

Named input and outputs containers

Definition at line 970 of file itkProcessObject.h.

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

◆ m_MultiThreader

itk::SmartPointer<MultiThreaderType> itk::ProcessObject::m_MultiThreader

private

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

Definition at line 997 of file itkProcessObject.h.

◆ m_NumberOfRequiredInputs

DataObjectPointerArraySizeType itk::ProcessObject::m_NumberOfRequiredInputs {}

private

Definition at line 979 of file itkProcessObject.h.

◆ m_NumberOfRequiredOutputs

DataObjectPointerArraySizeType itk::ProcessObject::m_NumberOfRequiredOutputs {}

private

Definition at line 980 of file itkProcessObject.h.

◆ m_NumberOfWorkUnits

ThreadIdType itk::ProcessObject::m_NumberOfWorkUnits {}

private

Definition at line 998 of file itkProcessObject.h.

◆ m_OutputInformationMTime

TimeStamp itk::ProcessObject::m_OutputInformationMTime {}

protected

Time when GenerateOutputInformation was last called.

Definition at line 958 of file itkProcessObject.h.

◆ m_Outputs

DataObjectPointerMap itk::ProcessObject::m_Outputs {}

private

Definition at line 971 of file itkProcessObject.h.

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

◆ m_Progress

std::atomic<uint32_t> itk::ProcessObject::m_Progress {}

private

Definition at line 990 of file itkProcessObject.h.

◆ m_ReleaseDataBeforeUpdateFlag

bool itk::ProcessObject::m_ReleaseDataBeforeUpdateFlag {}

private

Memory management ivars

Definition at line 1003 of file itkProcessObject.h.

◆ m_RequiredInputNames

NameSet itk::ProcessObject::m_RequiredInputNames {}

private

The required inputs

Definition at line 986 of file itkProcessObject.h.

◆ m_ThreaderUpdateProgress

bool itk::ProcessObject::m_ThreaderUpdateProgress { true }

private

Definition at line 1000 of file itkProcessObject.h.

◆ m_UpdateThreadID

std::thread::id itk::ProcessObject::m_UpdateThreadID {}

private

Definition at line 993 of file itkProcessObject.h.

◆ m_Updating

bool itk::ProcessObject::m_Updating {}

protected

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

Definition at line 955 of file itkProcessObject.h.

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

itkProcessObject.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectIdentifierType

◆ DataObjectPointer

◆ DataObjectPointerArray

◆ DataObjectPointerArraySizeType

◆ DataObjectPointerMap

◆ MultiThreaderType

◆ NameArray

◆ NameSet

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ProcessObject()

◆ ~ProcessObject()

Member Function Documentation

◆ AbortGenerateDataOn()

◆ AddInput()

◆ AddOptionalInputName() [1/2]

◆ AddOptionalInputName() [2/2]

◆ AddOutput()

◆ AddRequiredInputName() [1/2]

◆ AddRequiredInputName() [2/2]

◆ CacheInputReleaseDataFlags()

◆ EnlargeOutputRequestedRegion()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GenerateOutputRequestedRegion()

◆ GetAbortGenerateData()

◆ GetIndexedInputs()

◆ GetIndexedOutputs()

◆ GetInput() [1/4]

◆ GetInput() [2/4]

◆ GetInput() [3/4]

◆ GetInput() [4/4]

◆ GetInputNames()

◆ GetInputs()

◆ GetMultiThreader()

◆ GetNameOfClass()

◆ GetNumberOfIndexedInputs()

◆ GetNumberOfIndexedOutputs()

◆ GetNumberOfInputs()

◆ GetNumberOfOutputs()

◆ GetNumberOfRequiredInputs()

◆ GetNumberOfRequiredOutputs()

◆ GetNumberOfValidRequiredInputs()

◆ GetNumberOfWorkUnits()

◆ GetOutput() [1/4]

◆ GetOutput() [2/4]

◆ GetOutput() [3/4]

◆ GetOutput() [4/4]

◆ GetOutputNames()

◆ GetOutputs()

◆ GetPrimaryInput() [1/2]

◆ GetPrimaryInput() [2/2]

◆ GetPrimaryInputName()

◆ GetPrimaryOutput() [1/2]

◆ GetPrimaryOutput() [2/2]

◆ GetPrimaryOutputName()

◆ GetProgress()

◆ GetReleaseDataBeforeUpdateFlag()

◆ GetReleaseDataFlag()

◆ GetRequiredInputNames()

◆ GetThreaderUpdateProgress()

◆ HasInput()

◆ HasOutput()

◆ IncrementProgress()