#include <itkStreamingProcessObject.h>

Detailed Description

Base class interface to process data on multiple requested input chunks.

Streaming allows the data to be split into chunks and processed separately. The StreamingProcessObject class extends functionally to execute the primary input's pipeline multiple times over different requested regions. After each requested region is generated by the upstream pipeline the StreamedGenerateData method is called.

Definition at line 40 of file itkStreamingProcessObject.h.

Inheritance diagram for itk::StreamingProcessObject:

Collaboration diagram for itk::StreamingProcessObject:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = StreamingProcessObject

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
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
void	GenerateData () override

virtual int	GetCurrentRequestNumber () const

const char *	GetNameOfClass () const override

void	PropagateRequestedRegion (DataObject *output) override

void	ResetPipeline () override

void	UpdateOutputData (DataObject *output) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

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	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

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

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

virtual int	GetReferenceCount () const

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

Protected Member Functions
virtual void	AfterStreamedGenerateData ()

virtual void	BeforeStreamedGenerateData ()

virtual void	GenerateNthInputRequestedRegion (unsigned int inputRequestedRegionNumber)=0

virtual unsigned int	GetNumberOfInputRequestedRegions ()=0

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

virtual void	StreamedGenerateData (unsigned int inputRequestedRegionNumber)=0

	StreamingProcessObject ()

	~StreamingProcessObject () override

Protected Member Functions inherited from itk::ProcessObject
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	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 ()

	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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
int	m_CurrentRequestNumber { -1 }

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

Static Protected Member Functions inherited from itk::ProcessObject
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 inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 49 of file itkStreamingProcessObject.h.

◆ Pointer

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

Definition at line 48 of file itkStreamingProcessObject.h.

◆ Self

using itk::StreamingProcessObject::Self = StreamingProcessObject

Standard class types.

Definition at line 46 of file itkStreamingProcessObject.h.

◆ Superclass

using itk::StreamingProcessObject::Superclass = ProcessObject

Definition at line 47 of file itkStreamingProcessObject.h.

Constructor & Destructor Documentation

◆ StreamingProcessObject()

itk::StreamingProcessObject::StreamingProcessObject ( )

protected

◆ ~StreamingProcessObject()

itk::StreamingProcessObject::~StreamingProcessObject ( )

overrideprotected

Member Function Documentation

◆ AfterStreamedGenerateData()

virtual void itk::StreamingProcessObject::AfterStreamedGenerateData ( )

protectedvirtual

Called after all requested regions have been process.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::Statistics::ImageToHistogramFilter< TImage >, itk::StatisticsImageFilter< TInputImage >, and itk::MinimumMaximumImageFilter< TInputImage >.

◆ BeforeStreamedGenerateData()

virtual void itk::StreamingProcessObject::BeforeStreamedGenerateData ( )

protectedvirtual

Called before the input's first requested region is set or updated.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::LabelOverlapMeasuresImageFilter< TLabelImage >, itk::ImageSink< TInputImage >, itk::ImageSink< TImage >, itk::ImageSink< TLabelImage >, itk::StatisticsImageFilter< TInputImage >, and itk::MinimumMaximumImageFilter< TInputImage >.

◆ GenerateData()

void itk::StreamingProcessObject::GenerateData ( )

overridevirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GenerateNthInputRequestedRegion()

virtual void itk::StreamingProcessObject::GenerateNthInputRequestedRegion ( unsigned int inputRequestedRegionNumber )

protectedpure virtual

For each streamed region, propagate request to all inputs.

Derived classes should overload this method to compute regions splits and propagate to the particular DataObject types used for the input.

Implemented in itk::ImageSink< TInputImage >, itk::ImageSink< TImage >, and itk::ImageSink< TLabelImage >.

◆ GetCurrentRequestNumber()

virtual int itk::StreamingProcessObject::GetCurrentRequestNumber ( ) const

virtual

The current requested region number during execution. The value -1, is used when the pipeline is not currently being updated.

◆ GetNameOfClass()

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::StatisticsImageFilter< TInputImage >, itk::ImageSink< TImage >, itk::ImageSink< TLabelImage >, itk::Statistics::ImageToHistogramFilter< TImage >, itk::LabelOverlapMeasuresImageFilter< TLabelImage >, and itk::Statistics::MaskedImageToHistogramFilter< TImage, TMaskImage >.

◆ GetNumberOfInputRequestedRegions()

virtual unsigned int itk::StreamingProcessObject::GetNumberOfInputRequestedRegions ( )

protectedpure virtual

Return the actual number of regions to request upstream.

This method can be overloaded to return one, when a derived filter is unable stream.

Implemented in itk::Statistics::ImageToHistogramFilter< TImage >, itk::ImageSink< TInputImage >, itk::ImageSink< TImage >, and itk::ImageSink< TLabelImage >.

◆ PrintSelf()

void itk::StreamingProcessObject::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::ProcessObject.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::LabelOverlapMeasuresImageFilter< TLabelImage >, itk::Statistics::ImageToHistogramFilter< TImage >, itk::ImageSink< TImage >, itk::ImageSink< TLabelImage >, itk::StatisticsImageFilter< TInputImage >, and itk::MinimumMaximumImageFilter< TInputImage >.

◆ PropagateRequestedRegion()

void itk::StreamingProcessObject::PropagateRequestedRegion ( DataObject * output )

overridevirtual

Override PropagateRequestedRegion from ProcessObject Since inside UpdateOutputData we iterate over streaming pieces we don't need to propagate up the pipeline

Reimplemented from itk::ProcessObject.

◆ ResetPipeline()

void itk::StreamingProcessObject::ResetPipeline ( )

overridevirtual

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

◆ StreamedGenerateData()

virtual void itk::StreamingProcessObject::StreamedGenerateData ( unsigned int inputRequestedRegionNumber )

protectedpure virtual

This method will be called multiple times for each requested region generated by the input.

Implemented in itk::ImageSink< TInputImage >, itk::ImageSink< TImage >, itk::ImageSink< TLabelImage >, and itk::Statistics::ImageToHistogramFilter< TImage >.

◆ UpdateOutputData()

void itk::StreamingProcessObject::UpdateOutputData ( DataObject * output )

overridevirtual

Override UpdateOutputData() from ProcessObject to divide upstream updates into pieces.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ m_CurrentRequestNumber

int itk::StreamingProcessObject::m_CurrentRequestNumber { -1 }

private

Definition at line 119 of file itkStreamingProcessObject.h.

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

itkStreamingProcessObject.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ StreamingProcessObject()

◆ ~StreamingProcessObject()

Member Function Documentation

◆ AfterStreamedGenerateData()

◆ BeforeStreamedGenerateData()

◆ GenerateData()

◆ GenerateNthInputRequestedRegion()

◆ GetCurrentRequestNumber()

◆ GetNameOfClass()

◆ GetNumberOfInputRequestedRegions()

◆ PrintSelf()

◆ PropagateRequestedRegion()

◆ ResetPipeline()

◆ StreamedGenerateData()

◆ UpdateOutputData()

Member Data Documentation

◆ m_CurrentRequestNumber