itk::StreamingImageFilter< TInputImage, TOutputImage > Class Template Reference
[ITK System Objects, Data Processing Objects]

Pipeline object to control data streaming for large data processing. More...

#include <itkStreamingImageFilter.h>

Inheritance diagram for itk::StreamingImageFilter:

[legend]Collaboration diagram for itk::StreamingImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef StreamingImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef TOutputImage	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef Superclass::DataObjectPointer	DataObjectPointer
typedef ImageRegionSplitter< itkGetStaticConstMacro(InputImageDimension)	SplitterType )
typedef SplitterType::Pointer	RegionSplitterPointer
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
virtual void	SetNumberOfStreamDivisions (unsigned int _arg)
	itkGetConstReferenceMacro (NumberOfStreamDivisions, unsigned int)
virtual void	SetRegionSplitter (SplitterType *_arg)
virtual SplitterType *	GetRegionSplitter ()
virtual void	UpdateOutputData (DataObject *output)
Static Public Methods
Pointer	New ()
Protected Methods
	StreamingImageFilter ()
	~StreamingImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::StreamingImageFilter< TInputImage, TOutputImage >

Pipeline object to control data streaming for large data processing.

StreamingImageFilter is a pipeline object that allows the user to control how data is pulled through the pipeline. To generate its OutputRequestedRegion, this filter will divide the output into several pieces (controlled by SetNumberOfStreamDivisions), and call the upstream pipeline for each piece, tiling the individual outputs into one large output. This reduces the memory footprint for the application since each filter does not have to process the entire dataset at once. This filter will produce the entire output as one image, but the upstream filters will do their processing in pieces.

Definition at line 44 of file itkStreamingImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage> typedef SmartPointer<const Self> itk::StreamingImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 51 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef Superclass::DataObjectPointer itk::StreamingImageFilter< TInputImage, TOutputImage >::DataObjectPointer

Smart Pointer type to a DataObject. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 68 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::PixelType itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 63 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::Pointer itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 61 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::RegionType itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 62 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage itk::StreamingImageFilter< TInputImage, TOutputImage >::InputImageType

Some typedefs for the input and output. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 60 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::PixelType itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 67 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::Pointer itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 65 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OutputImageType::RegionType itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 66 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage itk::StreamingImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 64 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SmartPointer<Self> itk::StreamingImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 50 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SplitterType::Pointer itk::StreamingImageFilter< TInputImage, TOutputImage >::RegionSplitterPointer

Definition at line 77 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef StreamingImageFilter itk::StreamingImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 48 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef ImageRegionSplitter<itkGetStaticConstMacro(InputImageDimension) itk::StreamingImageFilter< TInputImage, TOutputImage >::SplitterType)

SmartPointer to a region splitting object Definition at line 76 of file itkStreamingImageFilter.h.

template<class TInputImage, class TOutputImage> typedef ImageToImageFilter<TInputImage, TOutputImage> itk::StreamingImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 49 of file itkStreamingImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::StreamingImageFilter< TInputImage, TOutputImage >::StreamingImageFilter (    )  [protected]

template<class TInputImage, class TOutputImage> itk::StreamingImageFilter< TInputImage, TOutputImage >::~StreamingImageFilter (    )  [protected]

---

Member Function Documentation

template<class TInputImage, class TOutputImage> virtual const char* itk::StreamingImageFilter< TInputImage, TOutputImage >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual SplitterType* itk::StreamingImageFilter< TInputImage, TOutputImage >::GetRegionSplitter (    )  [virtual]

Get the helper class for dividing the input into chunks.

template<class TInputImage, class TOutputImage> itk::StreamingImageFilter< TInputImage, TOutputImage >::itkGetConstReferenceMacro (  NumberOfStreamDivisions   , unsigned    int )

Get the number of pieces to divide the input. The upstream pipeline will be executed this many times. Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage> itk::StreamingImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  InputImageDimension   , unsigned    int, InputImageType::ImageDimension    )

Dimension of input image.

template<class TInputImage, class TOutputImage> Pointer itk::StreamingImageFilter< TInputImage, TOutputImage >::New (    )  [static]

Method for creation through the object factory. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> void itk::StreamingImageFilter< TInputImage, TOutputImage >::PrintSelf (  std::ostream &    os, Indent    indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::StreamingImageFilter< TInputImage, TOutputImage >::SetNumberOfStreamDivisions (  unsigned int    _arg )  [virtual]

Set the number of pieces to divide the input. The upstream pipeline will be executed this many times.

template<class TInputImage, class TOutputImage> virtual void itk::StreamingImageFilter< TInputImage, TOutputImage >::SetRegionSplitter (  SplitterType *    _arg )  [virtual]

Set the helper class for dividing the input into chunks.

template<class TInputImage, class TOutputImage> virtual void itk::StreamingImageFilter< TInputImage, TOutputImage >::UpdateOutputData (  DataObject *    output )  [virtual]

Override UpdateOutputData() from ProcessObject to divide upstream updates into pieces. This filter does not have a GenerateData() or ThreadedGenerateData() method. Instead, all the work is done in UpdateOutputData() since it must update a little, execute a little, update some more, execute some more, etc. Reimplemented from itk::ProcessObject.

---

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

• itkStreamingImageFilter.h

---