Base class for all process objects that output image data. More...

#include <itkImageSource.h>

Inheritance diagram for itk::ImageSource< TOutputImage >:

Collaboration diagram for itk::ImageSource< TOutputImage >:

Classes
struct	ThreadStruct
Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Member Functions
virtual const char *	GetNameOfClass () const
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
Static Public Attributes
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Member Functions
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	GenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Private Member Functions

	ImageSource (const Self &)
void	operator= (const Self &)

Detailed Description

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

Wiki Examples:

All Examples

Produce an image programmatically.

Definition at line 64 of file itkImageSource.h.

Member Typedef Documentation

template<class TOutputImage>

typedef SmartPointer< const Self > itk::ImageSource< TOutputImage >::ConstPointer

Reimplemented from itk::ProcessObject.

Definition at line 71 of file itkImageSource.h.

template<class TOutputImage>

typedef Superclass::DataObjectIdentifierType itk::ImageSource< TOutputImage >::DataObjectIdentifierType

Reimplemented from itk::ProcessObject.

Definition at line 76 of file itkImageSource.h.

template<class TOutputImage>

typedef DataObject::Pointer itk::ImageSource< TOutputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >, itk::Testing::HashImageFilter< TImageType >, itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::StatisticsImageFilter< TInputImage >, itk::DanielssonDistanceMapImageFilter< TInputImage, TOutputImage, TVoronoiImage >, itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage, TVoronoiImage >, itk::ParametricImageSource< TOutputImage >, itk::BayesianClassifierImageFilter< TInputVectorImage, TLabelsType, TPosteriorsPrecisionType, TPriorsPrecisionType >, itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >, itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >, and itk::DanielssonDistanceMapImageFilter< ImageType, ImageType >.

Definition at line 74 of file itkImageSource.h.

template<class TOutputImage>

typedef Superclass::DataObjectPointerArraySizeType itk::ImageSource< TOutputImage >::DataObjectPointerArraySizeType

Reimplemented from itk::ProcessObject.

Definition at line 77 of file itkImageSource.h.

template<class TOutputImage>

typedef OutputImageType::PixelType itk::ImageSource< TOutputImage >::OutputImagePixelType

Definition at line 86 of file itkImageSource.h.

template<class TOutputImage>

typedef OutputImageType::Pointer itk::ImageSource< TOutputImage >::OutputImagePointer

Definition at line 84 of file itkImageSource.h.

template<class TOutputImage>

typedef OutputImageType::RegionType itk::ImageSource< TOutputImage >::OutputImageRegionType

Definition at line 85 of file itkImageSource.h.

template<class TOutputImage>

typedef TOutputImage itk::ImageSource< TOutputImage >::OutputImageType

Some convenient typedefs.

Definition at line 80 of file itkImageSource.h.

template<class TOutputImage>

typedef SmartPointer< Self > itk::ImageSource< TOutputImage >::Pointer

Reimplemented from itk::ProcessObject.

Definition at line 70 of file itkImageSource.h.

template<class TOutputImage>

typedef ImageSource itk::ImageSource< TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Definition at line 68 of file itkImageSource.h.

template<class TOutputImage>

typedef ProcessObject itk::ImageSource< TOutputImage >::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 69 of file itkImageSource.h.

Constructor & Destructor Documentation

template<class TOutputImage>

itk::ImageSource< TOutputImage >::ImageSource ( ) [protected]

template<class TOutputImage>

virtual itk::ImageSource< TOutputImage >::~ImageSource ( ) [inline, protected, virtual]

Definition at line 216 of file itkImageSource.h.

template<class TOutputImage>

itk::ImageSource< TOutputImage >::ImageSource ( const Self & ) [private]

Member Function Documentation

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::AfterThreadedGenerateData ( ) [inline, protected, virtual]

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 290 of file itkImageSource.h.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::AllocateOutputs ( ) [protected, virtual]

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.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::BeforeThreadedGenerateData ( void ) [inline, protected, virtual]

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 278 of file itkImageSource.h.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GenerateData ( ) [protected, virtual]

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 ThreadedGenerateData(). 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 an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:: ThreadedGenerateData()

Reimplemented from itk::ProcessObject.

template<class TOutputImage>

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

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TOutputImage>

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

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.

template<class TOutputImage>

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

template<class TOutputImage>

const OutputImageType* itk::ImageSource< TOutputImage >::GetOutput ( void ) 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.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)		`[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.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftOutput ( DataObject * output ) [virtual]

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) 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
    firstFilterInMiniPipeline->SetInput( this->GetInput() );

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

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftOutput	(	const DataObjectIdentifierType &	key,
		DataObject *	output
	)		`[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.

template<class TOutputImage>

virtual DataObjectPointer itk::ImageSource< TOutputImage >::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().

Reimplemented from itk::ProcessObject.

template<class TOutputImage>

void itk::ImageSource< TOutputImage >::operator= ( const Self & ) [private]

template<class TOutputImage>

virtual unsigned int itk::ImageSource< TOutputImage >::SplitRequestedRegion	(	unsigned int	i,
		unsigned int	num,
		OutputImageRegionType &	splitRegion
	)		`[protected, virtual]`

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" 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 "num".

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

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		`[protected, virtual]`

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call 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 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 ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:: GenerateData(), SplitRequestedRegion()

template<class TOutputImage>

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TOutputImage >::ThreaderCallback ( void * arg ) [static, protected]

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

Member Data Documentation

template<class TOutputImage>

const unsigned int itk::ImageSource< TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constant

Definition at line 90 of file itkImageSource.h.

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

itkImageSource.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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