vtkImageToImageFilter Class Reference

#include <vtkImageToImageFilter.h>

Inheritance diagram for vtkImageToImageFilter:

[legend]Collaboration diagram for vtkImageToImageFilter:

[legend]List of all members.

Detailed Description

Generic filter that has one input..

vtkImageToImageFilter is a filter superclass that hides much of the pipeline complexity. It handles breaking the pipeline execution into smaller extents so that the vtkImageData limits are observed. It also provides support for multithreading. If you don't need any of this functionality, consider using vtkSimpleImageToImageFilter instead.

See also:: vtkSimpleImageToImageFilter

Created by:

Law, Charles

CVS contributions (if > 5%):

Law, Charles (63%)
Avila, Lisa (10%)
Martin, Ken (6%)
Lorensen, Bill (5%)

CVS logs (CVSweb):

.cxx (/Filtering/vtkImageToImageFilter.cxx)
.h (/Filtering/vtkImageToImageFilter.h)

Examples:: vtkImageToImageFilter (Examples)

Definition at line 50 of file vtkImageToImageFilter.h.

Public Types

typedef vtkImageSource Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void SetInputMemoryLimit (int)

long GetInputMemoryLimit ()

virtual void SetInput (vtkImageData *input)

vtkImageData * GetInput ()

void SetBypass (int)

void BypassOn ()

void BypassOff ()

virtual int GetBypass ()

virtual void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId)

virtual void SetNumberOfThreads (int)

virtual int GetNumberOfThreads ()

virtual int SplitExtent (int splitExt[6], int startExt[6], int num, int total)

Static Public Member Functions

int IsTypeOf (const char *type)

vtkImageToImageFilter * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkImageToImageFilter ()

~vtkImageToImageFilter ()

void ExecuteInformation ()

virtual void ExecuteInformation (vtkImageData *inData, vtkImageData *outData)

void ExecuteData (vtkDataObject *output)

virtual vtkImageData * AllocateOutputData (vtkDataObject *out)

void MultiThread (vtkImageData *input, vtkImageData *output)

void ComputeInputUpdateExtents (vtkDataObject *output)

virtual void ComputeInputUpdateExtent (int inExt[6], int outExt[6])

virtual void SetInputScalarsSelection (const char *)

virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

vtkMultiThreader * Threader

int Bypass

int BypassWasOn

int NumberOfThreads

char * InputScalarsSelection

Member Typedef Documentation

typedef vtkImageSource vtkImageToImageFilter::Superclass

Reimplemented from vtkImageSource.
Reimplemented in vtkImageInPlaceFilter, vtkImageAccumulate, vtkImageAnisotropicDiffusion2D, vtkImageAnisotropicDiffusion3D, vtkImageButterworthHighPass, vtkImageButterworthLowPass, vtkImageCacheFilter, vtkImageChangeInformation, vtkImageCityBlockDistance, vtkImageClip, vtkImageContinuousDilate3D, vtkImageContinuousErode3D, vtkImageConvolve, vtkImageCursor3D, vtkImageDataStreamer, vtkImageDecomposeFilter, vtkImageDilateErode3D, vtkImageEuclideanDistance, vtkImageFFT, vtkImageFlip, vtkImageFourierCenter, vtkImageFourierFilter, vtkImageGaussianSmooth, vtkImageHybridMedian2D, vtkImageIdealHighPass, vtkImageIdealLowPass, vtkImageIslandRemoval2D, vtkImageIterateFilter, vtkImageLaplacian, vtkImageMagnify, vtkImageMapToColors, vtkImageMapToRGBA, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageOpenClose3D, vtkImagePermute, vtkImageQuantizeRGBToIndex, vtkImageRange3D, vtkImageResample, vtkImageReslice, vtkImageRFFT, vtkImageSeedConnectivity, vtkImageSeparableConvolution, vtkImageShrink3D, vtkImageSkeleton2D, vtkImageSobel2D, vtkImageSobel3D, vtkImageSpatialFilter, vtkImageStencil, vtkImageThreshold, vtkImageTranslateExtent, vtkImageVariance3D, vtkMemoryLimitImageDataStreamer, and vtkSweptSurface.
Definition at line 53 of file vtkImageToImageFilter.h.

Constructor & Destructor Documentation

vtkImageToImageFilter::vtkImageToImageFilter ( ) [protected]

vtkImageToImageFilter::~vtkImageToImageFilter ( ) [protected]

Member Function Documentation

virtual const char* vtkImageToImageFilter::GetClassName ( ) [virtual]

Reimplemented from vtkImageSource.
Reimplemented in vtkImageInPlaceFilter, vtkImageAccumulate, vtkImageAnisotropicDiffusion2D, vtkImageAnisotropicDiffusion3D, vtkImageButterworthHighPass, vtkImageButterworthLowPass, vtkImageCacheFilter, vtkImageChangeInformation, vtkImageCityBlockDistance, vtkImageClip, vtkImageContinuousDilate3D, vtkImageContinuousErode3D, vtkImageConvolve, vtkImageCursor3D, vtkImageDataStreamer, vtkImageDecomposeFilter, vtkImageDilateErode3D, vtkImageEuclideanDistance, vtkImageFFT, vtkImageFlip, vtkImageFourierCenter, vtkImageFourierFilter, vtkImageGaussianSmooth, vtkImageHybridMedian2D, vtkImageIdealHighPass, vtkImageIdealLowPass, vtkImageIslandRemoval2D, vtkImageIterateFilter, vtkImageLaplacian, vtkImageMagnify, vtkImageMapToColors, vtkImageMapToRGBA, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageOpenClose3D, vtkImagePermute, vtkImageQuantizeRGBToIndex, vtkImageRange3D, vtkImageResample, vtkImageReslice, vtkImageRFFT, vtkImageSeedConnectivity, vtkImageSeparableConvolution, vtkImageShrink3D, vtkImageSkeleton2D, vtkImageSobel2D, vtkImageSobel3D, vtkImageSpatialFilter, vtkImageStencil, vtkImageThreshold, vtkImageTranslateExtent, vtkImageVariance3D, vtkMemoryLimitImageDataStreamer, and vtkSweptSurface.

int vtkImageToImageFilter::IsTypeOf ( const char * type ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImageSource.
Reimplemented in vtkImageInPlaceFilter, vtkImageAccumulate, vtkImageAnisotropicDiffusion2D, vtkImageAnisotropicDiffusion3D, vtkImageButterworthHighPass, vtkImageButterworthLowPass, vtkImageCacheFilter, vtkImageChangeInformation, vtkImageCityBlockDistance, vtkImageClip, vtkImageContinuousDilate3D, vtkImageContinuousErode3D, vtkImageConvolve, vtkImageCursor3D, vtkImageDataStreamer, vtkImageDecomposeFilter, vtkImageDilateErode3D, vtkImageEuclideanDistance, vtkImageFFT, vtkImageFlip, vtkImageFourierCenter, vtkImageFourierFilter, vtkImageGaussianSmooth, vtkImageHybridMedian2D, vtkImageIdealHighPass, vtkImageIdealLowPass, vtkImageIslandRemoval2D, vtkImageIterateFilter, vtkImageLaplacian, vtkImageMagnify, vtkImageMapToColors, vtkImageMapToRGBA, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageOpenClose3D, vtkImagePermute, vtkImageQuantizeRGBToIndex, vtkImageRange3D, vtkImageResample, vtkImageReslice, vtkImageRFFT, vtkImageSeedConnectivity, vtkImageSeparableConvolution, vtkImageShrink3D, vtkImageSkeleton2D, vtkImageSobel2D, vtkImageSobel3D, vtkImageSpatialFilter, vtkImageStencil, vtkImageThreshold, vtkImageTranslateExtent, vtkImageVariance3D, vtkMemoryLimitImageDataStreamer, and vtkSweptSurface.

virtual int vtkImageToImageFilter::IsA ( const char * type ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImageSource.
Reimplemented in vtkImageInPlaceFilter, vtkImageAccumulate, vtkImageAnisotropicDiffusion2D, vtkImageAnisotropicDiffusion3D, vtkImageButterworthHighPass, vtkImageButterworthLowPass, vtkImageCacheFilter, vtkImageChangeInformation, vtkImageCityBlockDistance, vtkImageClip, vtkImageContinuousDilate3D, vtkImageContinuousErode3D, vtkImageConvolve, vtkImageCursor3D, vtkImageDataStreamer, vtkImageDecomposeFilter, vtkImageDilateErode3D, vtkImageEuclideanDistance, vtkImageFFT, vtkImageFlip, vtkImageFourierCenter, vtkImageFourierFilter, vtkImageGaussianSmooth, vtkImageHybridMedian2D, vtkImageIdealHighPass, vtkImageIdealLowPass, vtkImageIslandRemoval2D, vtkImageIterateFilter, vtkImageLaplacian, vtkImageMagnify, vtkImageMapToColors, vtkImageMapToRGBA, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageOpenClose3D, vtkImagePermute, vtkImageQuantizeRGBToIndex, vtkImageRange3D, vtkImageResample, vtkImageReslice, vtkImageRFFT, vtkImageSeedConnectivity, vtkImageSeparableConvolution, vtkImageShrink3D, vtkImageSkeleton2D, vtkImageSobel2D, vtkImageSobel3D, vtkImageSpatialFilter, vtkImageStencil, vtkImageThreshold, vtkImageTranslateExtent, vtkImageVariance3D, vtkMemoryLimitImageDataStreamer, and vtkSweptSurface.

vtkImageToImageFilter* vtkImageToImageFilter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkImageSource.
Reimplemented in vtkImageInPlaceFilter, vtkImageAccumulate, vtkImageAnisotropicDiffusion2D, vtkImageAnisotropicDiffusion3D, vtkImageButterworthHighPass, vtkImageButterworthLowPass, vtkImageCacheFilter, vtkImageChangeInformation, vtkImageCityBlockDistance, vtkImageClip, vtkImageContinuousDilate3D, vtkImageContinuousErode3D, vtkImageConvolve, vtkImageCursor3D, vtkImageDataStreamer, vtkImageDecomposeFilter, vtkImageDilateErode3D, vtkImageEuclideanDistance, vtkImageFFT, vtkImageFlip, vtkImageFourierCenter, vtkImageFourierFilter, vtkImageGaussianSmooth, vtkImageHybridMedian2D, vtkImageIdealHighPass, vtkImageIdealLowPass, vtkImageIslandRemoval2D, vtkImageIterateFilter, vtkImageLaplacian, vtkImageMagnify, vtkImageMapToColors, vtkImageMapToRGBA, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageOpenClose3D, vtkImagePermute, vtkImageQuantizeRGBToIndex, vtkImageRange3D, vtkImageResample, vtkImageReslice, vtkImageRFFT, vtkImageSeedConnectivity, vtkImageSeparableConvolution, vtkImageShrink3D, vtkImageSkeleton2D, vtkImageSobel2D, vtkImageSobel3D, vtkImageSpatialFilter, vtkImageStencil, vtkImageThreshold, vtkImageTranslateExtent, vtkImageVariance3D, vtkMemoryLimitImageDataStreamer, and vtkSweptSurface.

void vtkImageToImageFilter::PrintSelf ( ostream & os,

vtkIndent indent

) [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 vtkImageSource.
Reimplemented in vtkImageInPlaceFilter, vtkImageAccumulate, vtkImageAnisotropicDiffusion2D, vtkImageAnisotropicDiffusion3D, vtkImageButterworthHighPass, vtkImageButterworthLowPass, vtkImageCacheFilter, vtkImageChangeInformation, vtkImageClip, vtkImageContinuousDilate3D, vtkImageContinuousErode3D, vtkImageConvolve, vtkImageCursor3D, vtkImageDataStreamer, vtkImageDecomposeFilter, vtkImageDilateErode3D, vtkImageEuclideanDistance, vtkImageFlip, vtkImageGaussianSmooth, vtkImageIdealHighPass, vtkImageIdealLowPass, vtkImageIslandRemoval2D, vtkImageIterateFilter, vtkImageLaplacian, vtkImageMagnify, vtkImageMapToColors, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageOpenClose3D, vtkImagePermute, vtkImageQuantizeRGBToIndex, vtkImageRange3D, vtkImageResample, vtkImageReslice, vtkImageSeedConnectivity, vtkImageSeparableConvolution, vtkImageShrink3D, vtkImageSkeleton2D, vtkImageSobel2D, vtkImageSobel3D, vtkImageSpatialFilter, vtkImageStencil, vtkImageThreshold, vtkImageTranslateExtent, vtkImageVariance3D, vtkMemoryLimitImageDataStreamer, and vtkSweptSurface.

virtual void vtkImageToImageFilter::SetInput ( vtkImageData * input ) [virtual]

Set the Input of a filter.
Reimplemented in vtkImageOpenClose3D.

vtkImageData* vtkImageToImageFilter::GetInput ( )

Set the Input of a filter.

void vtkImageToImageFilter::SetBypass ( int ) [inline]

Obsolete feature - do not use.
Definition at line 64 of file vtkImageToImageFilter.h.

void vtkImageToImageFilter::BypassOn ( ) [inline]

Obsolete feature - do not use.
Definition at line 65 of file vtkImageToImageFilter.h.

void vtkImageToImageFilter::BypassOff ( ) [inline]

Obsolete feature - do not use.
Definition at line 66 of file vtkImageToImageFilter.h.

virtual int vtkImageToImageFilter::GetBypass ( ) [virtual]

Obsolete feature - do not use.

virtual void vtkImageToImageFilter::ThreadedExecute ( vtkImageData * inData,

vtkImageData * outData,

int extent[6],

int threadId

) [virtual]

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.
Reimplemented in vtkImageAnisotropicDiffusion2D, vtkImageAnisotropicDiffusion3D, vtkImageButterworthHighPass, vtkImageButterworthLowPass, vtkImageContinuousDilate3D, vtkImageContinuousErode3D, vtkImageConvolve, vtkImageDilateErode3D, vtkImageFFT, vtkImageFourierCenter, vtkImageGaussianSmooth, vtkImageHybridMedian2D, vtkImageIdealHighPass, vtkImageIdealLowPass, vtkImageLaplacian, vtkImageMagnify, vtkImageMapToColors, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageRange3D, vtkImageReslice, vtkImageRFFT, vtkImageShrink3D, vtkImageSkeleton2D, vtkImageSobel2D, vtkImageSobel3D, vtkImageStencil, vtkImageThreshold, and vtkImageVariance3D.

virtual void vtkImageToImageFilter::SetNumberOfThreads ( int ) [virtual]

Get/Set the number of threads to create when rendering

virtual int vtkImageToImageFilter::GetNumberOfThreads ( ) [virtual]

Get/Set the number of threads to create when rendering

void vtkImageToImageFilter::SetInputMemoryLimit ( int ) [inline]

Definition at line 86 of file vtkImageToImageFilter.h.

long vtkImageToImageFilter::GetInputMemoryLimit ( ) [inline]

Definition at line 88 of file vtkImageToImageFilter.h.

virtual int vtkImageToImageFilter::SplitExtent ( int splitExt[6],

int startExt[6],

int num,

int total

) [virtual]

Putting this here until I merge graphics and imaging streaming.
Reimplemented in vtkImageEuclideanDistance, vtkImageFFT, and vtkImageRFFT.

virtual void vtkImageToImageFilter::ExecuteInformation ( vtkImageData * inData,

vtkImageData * outData

) [protected, virtual]

Reimplemented in vtkImageAccumulate, vtkImageChangeInformation, vtkImageClip, vtkImageEuclideanDistance, vtkImageFFT, vtkImageFlip, vtkImageIterateFilter, vtkImageMagnify, vtkImageMapToColors, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageQuantizeRGBToIndex, vtkImageRange3D, vtkImageResample, vtkImageReslice, vtkImageRFFT, vtkImageSeparableConvolution, vtkImageShrink3D, vtkImageSobel2D, vtkImageSobel3D, vtkImageSpatialFilter, vtkImageStencil, vtkImageThreshold, vtkImageTranslateExtent, vtkImageVariance3D, and vtkSweptSurface.

void vtkImageToImageFilter::ExecuteData ( vtkDataObject * output ) [protected, virtual]

This method is the one that should be used by subclasses, right now the default implementation is to call the backwards compatibility method
Reimplemented from vtkSource.
Reimplemented in vtkImageInPlaceFilter, vtkImageAccumulate, vtkImageChangeInformation, vtkImageClip, vtkImageCursor3D, vtkImageIslandRemoval2D, vtkImageIterateFilter, vtkImageMapToColors, vtkImageMapToWindowLevelColors, vtkImageMedian3D, vtkImageQuantizeRGBToIndex, vtkImageSeedConnectivity, vtkImageTranslateExtent, and vtkSweptSurface.

virtual vtkImageData* vtkImageToImageFilter::AllocateOutputData ( vtkDataObject * out ) [protected, virtual]

Reimplemented from vtkImageSource.

void vtkImageToImageFilter::MultiThread ( vtkImageData * input,

vtkImageData * output

) [protected]

Referenced by vtkImageSkeleton2D::IterativeExecuteData(), vtkImageRFFT::IterativeExecuteData(), vtkImageFourierCenter::IterativeExecuteData(), and vtkImageFFT::IterativeExecuteData().

void vtkImageToImageFilter::ComputeInputUpdateExtents ( vtkDataObject * output ) [protected, virtual]

What is the input update extent that is required to produce the desired output? By default, the whole input is always required but this is overridden in many subclasses.
Reimplemented from vtkSource.
Reimplemented in vtkImageIterateFilter, vtkImageReslice, and vtkImageSeedConnectivity.

virtual void vtkImageToImageFilter::ComputeInputUpdateExtent ( int inExt[6],

int outExt[6]

) [protected, virtual]

Reimplemented in vtkImageAccumulate, vtkImageChangeInformation, vtkImageCityBlockDistance, vtkImageEuclideanDistance, vtkImageFFT, vtkImageFourierCenter, vtkImageGaussianSmooth, vtkImageIterateFilter, vtkImageLaplacian, vtkImageMagnify, vtkImageQuantizeRGBToIndex, vtkImageReslice, vtkImageRFFT, vtkImageSeparableConvolution, vtkImageShrink3D, vtkImageSkeleton2D, vtkImageSpatialFilter, vtkImageTranslateExtent, and vtkSweptSurface.

virtual void vtkImageToImageFilter::SetInputScalarsSelection ( const char * ) [protected, virtual]

Referenced by vtkImageMedian3D::SelectInputScalars(), vtkImageContinuousErode3D::SelectInputScalars(), and vtkImageContinuousDilate3D::SelectInputScalars().

virtual int vtkImageToImageFilter::FillInputPortInformation ( int ,

vtkInformation *

) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkProcessObject.
Reimplemented in vtkImageDataStreamer, and vtkImageStencil.

Member Data Documentation

vtkMultiThreader* vtkImageToImageFilter::Threader [protected]

Definition at line 101 of file vtkImageToImageFilter.h.

int vtkImageToImageFilter::Bypass [protected]

Definition at line 102 of file vtkImageToImageFilter.h.

int vtkImageToImageFilter::BypassWasOn [protected]

Definition at line 103 of file vtkImageToImageFilter.h.

int vtkImageToImageFilter::NumberOfThreads [protected]

Definition at line 104 of file vtkImageToImageFilter.h.

char* vtkImageToImageFilter::InputScalarsSelection [protected]

Definition at line 124 of file vtkImageToImageFilter.h.

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

dox/Filtering/vtkImageToImageFilter.h


Public Types
typedef vtkImageSource	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetInputMemoryLimit (int)
long	GetInputMemoryLimit ()

virtual void	SetInput (vtkImageData *input)
vtkImageData *	GetInput ()

void	SetBypass (int)
void	BypassOn ()
void	BypassOff ()
virtual int	GetBypass ()

virtual void	ThreadedExecute (vtkImageData inData, vtkImageData outData, int extent[6], int threadId)

virtual void	SetNumberOfThreads (int)
virtual int	GetNumberOfThreads ()

virtual int	SplitExtent (int splitExt[6], int startExt[6], int num, int total)
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkImageToImageFilter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageToImageFilter ()
	~vtkImageToImageFilter ()
void	ExecuteInformation ()
virtual void	ExecuteInformation (vtkImageData inData, vtkImageData outData)
void	ExecuteData (vtkDataObject *output)
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out)
void	MultiThread (vtkImageData input, vtkImageData output)
void	ComputeInputUpdateExtents (vtkDataObject *output)
virtual void	ComputeInputUpdateExtent (int inExt[6], int outExt[6])
virtual void	SetInputScalarsSelection (const char *)
virtual int	FillInputPortInformation (int, vtkInformation *)
Protected Attributes
vtkMultiThreader *	Threader
int	Bypass
int	BypassWasOn
int	NumberOfThreads
char *	InputScalarsSelection