#include <itkImageSource.h>

Detailed Description

template<typename TOutputImage>
class itk::ImageSource< TOutputImage >

Base class for all process objects that output image data.

ImageSource is the base class for all process objects that output image data. Specifically, this class defines the GetOutput() method that returns a pointer to the output image. The class also defines some internal private data members that are used to manage streaming of data.

Memory management in an ImageSource is slightly different than a standard ProcessObject. ProcessObject's always release the bulk data associated with their output prior to GenerateData() being called. ImageSources default to not releasing the bulk data incase that particular memory block is large enough to hold the new output values. This avoids unnecessary deallocation/allocation sequences. ImageSource's can be forced to use a memory management model similar to the default ProcessObject behaviour by calling ProcessObject::ReleaseDataBeforeUpdateFlagOn(). A user may want to set this flag to limit peak memory usage during a pipeline update.

ITK Sphinx Examples:

<a href=
<a href=

Definition at line 67 of file itkImageSource.h.

Inheritance diagram for itk::ImageSource< TOutputImage >:

Collaboration diagram for itk::ImageSource< TOutputImage >:

Classes
struct	ThreadStruct

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

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
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)


OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const


virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) 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

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

Static Public Attributes
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default


virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)


virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

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	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
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

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
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

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

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 Private Member Functions inherited from itk::ImageSourceCommon
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

Member Typedef Documentation

◆ ConstPointer

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 78 of file itkImageSource.h.

◆ DataObjectIdentifierType

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::DataObjectIdentifierType = Superclass::DataObjectIdentifierType

Definition at line 83 of file itkImageSource.h.

◆ DataObjectPointer

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::DataObjectPointer = DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 81 of file itkImageSource.h.

◆ DataObjectPointerArraySizeType

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

Definition at line 84 of file itkImageSource.h.

◆ OutputImagePixelType

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 93 of file itkImageSource.h.

◆ OutputImagePointer

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 91 of file itkImageSource.h.

◆ OutputImageRegionType

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 92 of file itkImageSource.h.

◆ OutputImageType

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::OutputImageType = TOutputImage

Some convenient type alias.

Definition at line 90 of file itkImageSource.h.

◆ Pointer

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 77 of file itkImageSource.h.

◆ Self

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::Self = ImageSource

Standard class type aliases.

Definition at line 75 of file itkImageSource.h.

◆ Superclass

template<typename TOutputImage >

using itk::ImageSource< TOutputImage >::Superclass = ProcessObject

Definition at line 76 of file itkImageSource.h.

Constructor & Destructor Documentation

◆ ImageSource()

template<typename TOutputImage >

itk::ImageSource< TOutputImage >::ImageSource ( )

protected

◆ ~ImageSource()

template<typename TOutputImage >

itk::ImageSource< TOutputImage >::~ImageSource ( )

overrideprotecteddefault

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::AfterThreadedGenerateData ( )

inlineprotectedvirtual

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 340 of file itkImageSource.h.

◆ AllocateOutputs()

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::AllocateOutputs ( )

protectedvirtual

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Some filters may want to override this default behavior. For example, a filter may have multiple outputs with varying resolution. Or a filter may want to process data in place by grafting its input to its output.

◆ BeforeThreadedGenerateData()

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::BeforeThreadedGenerateData ( )

inlineprotectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 326 of file itkImageSource.h.

◆ ClassicMultiThread()

template<typename TOutputImage >

void itk::ImageSource< TOutputImage >::ClassicMultiThread ( ThreadFunctionType callbackFunction )

protected

Many filters do special management of image buffer and threading, so this method provides just the multi-threaded invocation part of GenerateData() method.

◆ DynamicMultiThreadingOn()

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::DynamicMultiThreadingOn ( )

protectedvirtual

Whether to use classic multi-threading infrastructure (OFF by default). Classic multi-threading uses derived class' ImageRegionSplitter, thus enabling custom region splitting methods.

◆ DynamicThreadedGenerateData()

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

protectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also: GenerateData(), SplitRequestedRegion()

◆ GenerateData()

template<typename TOutputImage >

void itk::ImageSource< TOutputImage >::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from itk::ProcessObject.

Referenced by itk::BinaryNotImageFilter< TImage >::GenerateData().

◆ GetDynamicMultiThreading()

template<typename TOutputImage >

virtual bool itk::ImageSource< TOutputImage >::GetDynamicMultiThreading ( ) const

protectedvirtual

Whether to use classic multi-threading infrastructure (OFF by default). Classic multi-threading uses derived class' ImageRegionSplitter, thus enabling custom region splitting methods.

◆ GetGlobalDefaultSplitter()

template<typename TOutputImage >

static const ImageRegionSplitterBase * itk::ImageSource< TOutputImage >::GetGlobalDefaultSplitter ( )

inlinestaticprotected

Returns the default image region splitter.

This is an adapter function from the private common base class to the interface of this class.

Definition at line 349 of file itkImageSource.h.

References itk::ImageSourceCommon::GetGlobalDefaultSplitter().

◆ GetImageRegionSplitter()

template<typename TOutputImage >

virtual const ImageRegionSplitterBase * itk::ImageSource< TOutputImage >::GetImageRegionSplitter ( ) const

protectedvirtual

Get the image splitter to split the image for multi-threading.

The Splitter object divides the image into regions for threading or streaming. The algorithms on how to split an images are separated into class so that they can be easily be reused. When deriving from this class to write a filter consideration to the algorithm used to divide the image should be made. If a change is desired this method should be overridden to return the appropriate object.

Reimplemented in itk::FFTWComplexToComplex1DFFTImageFilter< TInputImage, TOutputImage >, itk::FFTWForward1DFFTImageFilter< TInputImage, TOutputImage >, and itk::FFTWInverse1DFFTImageFilter< TInputImage, TOutputImage >.

◆ GetNameOfClass()

template<typename TOutputImage >

const char * itk::ImageSource< TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ GetOutput() [1/3]

template<typename TOutputImage >

OutputImageType * itk::ImageSource< TOutputImage >::GetOutput ( )

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

anotherFilter->SetInput( someFilter->GetOutput() );

anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

image = someFilter->GetOutput();

image->Update();

someFilter->Update();

image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

◆ GetOutput() [2/3]

template<typename TOutputImage >

const OutputImageType * itk::ImageSource< TOutputImage >::GetOutput ( ) const

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

anotherFilter->SetInput( someFilter->GetOutput() );

anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

image = someFilter->GetOutput();

image->Update();

someFilter->Update();

image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

◆ GetOutput() [3/3]

template<typename TOutputImage >

OutputImageType * itk::ImageSource< TOutputImage >::GetOutput ( unsigned int idx )

◆ GraftNthOutput()

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	graft
	)

virtual

Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfIndexedOutputs()). See the GraftOutput for general usage information.

◆ GraftOutput() [1/2]

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::GraftOutput	(	const DataObjectIdentifierType &	key,
		DataObject *	graft
	)

virtual

Graft the specified data object onto this ProcessObject's named output. This is similar to the GraftOutput method except it allows you to specify which output is affected. See the GraftOutput for general usage information.

◆ GraftOutput() [2/2]

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::GraftOutput ( DataObject * graft )

virtual

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to use as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin, Direction) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

      // Setup the mini-pipeline to process the input to this filter
      // The input is not connected to the pipeline.
      auto input = InputImageType::New();
      input->Graft( const_cast< InputImageType * >( this->GetInput() );
      firstFilterInMiniPipeline->SetInput( input );
      // setup the mini-pipeline to calculate the correct regions
      // and write to the appropriate bulk data block
      lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );
 
      // execute the mini-pipeline
      lastFilterInMiniPipeline->Update();
 
      // graft the mini-pipeline output back onto this filter's output.
      // this is needed to get the appropriate regions passed back.
      this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

◆ MakeOutput() [1/2]

template<typename TOutputImage >

ProcessObject::DataObjectPointer itk::ImageSource< TOutputImage >::MakeOutput ( const ProcessObject::DataObjectIdentifierType & )

overridevirtual

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to use as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin, Direction) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

      // Setup the mini-pipeline to process the input to this filter
      // The input is not connected to the pipeline.
      auto input = InputImageType::New();
      input->Graft( const_cast< InputImageType * >( this->GetInput() );
      firstFilterInMiniPipeline->SetInput( input );
      // setup the mini-pipeline to calculate the correct regions
      // and write to the appropriate bulk data block
      lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );
 
      // execute the mini-pipeline
      lastFilterInMiniPipeline->Update();
 
      // graft the mini-pipeline output back onto this filter's output.
      // this is needed to get the appropriate regions passed back.
      this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

Reimplemented from itk::ProcessObject.

Reimplemented in itk::DanielssonDistanceMapImageFilter< TInputImage, TOutputImage, TVoronoiImage >, itk::DanielssonDistanceMapImageFilter< ImageType, ImageType >, itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage, TVoronoiImage >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, THistogram >, and itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, FlatStructuringElement< TInputImage::ImageDimension >, Function::RankHistogram< TInputImage::PixelType > >.

◆ MakeOutput() [2/2]

template<typename TOutputImage >

ProcessObject::DataObjectPointer itk::ImageSource< TOutputImage >::MakeOutput ( ProcessObject::DataObjectPointerArraySizeType idx )

overridevirtual

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 SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

◆ PrintSelf()

template<typename TOutputImage >

void itk::ImageSource< TOutputImage >::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::LightObject.

◆ SetDynamicMultiThreading()

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::SetDynamicMultiThreading ( bool _arg )

protectedvirtual

Whether to use classic multi-threading infrastructure (OFF by default). Classic multi-threading uses derived class' ImageRegionSplitter, thus enabling custom region splitting methods.

◆ SplitRequestedRegion()

template<typename TOutputImage >

virtual unsigned int itk::ImageSource< TOutputImage >::SplitRequestedRegion	(	unsigned int	i,
		unsigned int	pieces,
		OutputImageRegionType &	splitRegion
	)

protectedvirtual

Split the output's RequestedRegion into "pieces" pieces, returning region "i" as "splitRegion". This method is called concurrently "pieces" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "pieces".

To override the algorithm used split the image this method should no longer be overridden. Instead, the algorithm should be implemented in a ImageRegionSplitterBase class, and the GetImageRegionSplitter should overridden to return the splitter object with the desired algorithm.

See also: GetImageRegionSplitter

Reimplemented in itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >, and itk::BSplineControlPointImageFilter< TInputImage, TOutputImage >.

◆ ThreadedGenerateData()

template<typename TOutputImage >

virtual void itk::ImageSource< TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	region,
		ThreadIdType	threadId
	)

protectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also: GenerateData(), SplitRequestedRegion()

◆ ThreaderCallback()

template<typename TOutputImage >

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION itk::ImageSource< TOutputImage >::ThreaderCallback ( void * arg )

staticprotected

Static function used as a "callback" by the classic MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

Member Data Documentation

◆ m_DynamicMultiThreading

template<typename TOutputImage >

bool itk::ImageSource< TOutputImage >::m_DynamicMultiThreading { true }

protected

Definition at line 407 of file itkImageSource.h.

◆ OutputImageDimension

template<typename TOutputImage >

constexpr unsigned int itk::ImageSource< TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

ImageDimension constant

Definition at line 96 of file itkImageSource.h.

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

itkImageSource.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectIdentifierType

◆ DataObjectPointer

◆ DataObjectPointerArraySizeType

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ImageSource()

◆ ~ImageSource()

Member Function Documentation

◆ AfterThreadedGenerateData()

◆ AllocateOutputs()

◆ BeforeThreadedGenerateData()

◆ ClassicMultiThread()

◆ DynamicMultiThreadingOn()

◆ DynamicThreadedGenerateData()

◆ GenerateData()

◆ GetDynamicMultiThreading()

◆ GetGlobalDefaultSplitter()

◆ GetImageRegionSplitter()

◆ GetNameOfClass()

◆ GetOutput() [1/3]

◆ GetOutput() [2/3]

◆ GetOutput() [3/3]

◆ GraftNthOutput()

◆ GraftOutput() [1/2]

◆ GraftOutput() [2/2]

◆ MakeOutput() [1/2]

◆ MakeOutput() [2/2]

◆ PrintSelf()

◆ SetDynamicMultiThreading()

◆ SplitRequestedRegion()

◆ ThreadedGenerateData()

◆ ThreaderCallback()

Member Data Documentation

◆ m_DynamicMultiThreading

◆ OutputImageDimension