vtkImageToImageFilter Class Reference

#include <vtkImageToImageFilter.h>

Inheritance diagram for vtkImageToImageFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkImageToImageFilter:

Collaboration graph
[legend]

List of all members.


Detailed Description

Generic filter that has one input of type vtkImageData.

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.

Warning:
This used to be the parent class for most imaging filter in VTK4.x, now this role has been replaced by vtkImageAlgorithm. You should consider using vtkImageAlgorithm instead, when writing filter for VTK5 and above. This class was kept to ensure full backward compatibility.
See also:
vtkSimpleImageToImageFilter vtkImageSpatialFilter vtkImageAlgorithm

Definition at line 39 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)
vtkImageDataGetInput ()
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

static int IsTypeOf (const char *type)
static vtkImageToImageFilterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageToImageFilter ()
 ~vtkImageToImageFilter ()
void ExecuteInformation ()
virtual void ExecuteInformation (vtkImageData *inData, vtkImageData *outData)
void ExecuteData (vtkDataObject *output)
virtual vtkImageDataAllocateOutputData (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

vtkMultiThreaderThreader
int Bypass
int BypassWasOn
int NumberOfThreads
char * InputScalarsSelection

Member Typedef Documentation

Reimplemented from vtkImageSource.

Reimplemented in vtkImageSpatialFilter.

Definition at line 42 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 vtkImageSpatialFilter.

static int vtkImageToImageFilter::IsTypeOf ( const char *  name  )  [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 vtkImageSpatialFilter.

virtual int vtkImageToImageFilter::IsA ( const char *  name  )  [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 vtkImageSpatialFilter.

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

Reimplemented from vtkImageSource.

Reimplemented in vtkImageSpatialFilter.

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 vtkImageSpatialFilter.

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

Set the Input of a filter.

vtkImageData* vtkImageToImageFilter::GetInput (  ) 

Set the Input of a filter.

void vtkImageToImageFilter::SetBypass ( int   )  [inline]

Obsolete feature - do not use.

Definition at line 53 of file vtkImageToImageFilter.h.

void vtkImageToImageFilter::BypassOn (  )  [inline]

Obsolete feature - do not use.

Definition at line 54 of file vtkImageToImageFilter.h.

void vtkImageToImageFilter::BypassOff (  )  [inline]

Obsolete feature - do not use.

Definition at line 55 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.

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 75 of file vtkImageToImageFilter.h.

long vtkImageToImageFilter::GetInputMemoryLimit (  )  [inline]

Definition at line 77 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.

void vtkImageToImageFilter::ExecuteInformation (  )  [protected, virtual]

Reimplemented from vtkSource.

Reimplemented in vtkImageSpatialFilter.

virtual void vtkImageToImageFilter::ExecuteInformation ( vtkImageData inData,
vtkImageData outData 
) [protected, virtual]

Reimplemented in vtkImageSpatialFilter.

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.

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

Reimplemented from vtkImageSource.

void vtkImageToImageFilter::MultiThread ( vtkImageData input,
vtkImageData output 
) [protected]

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.

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

Reimplemented in vtkImageSpatialFilter.

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

virtual int vtkImageToImageFilter::FillInputPortInformation ( int  port,
vtkInformation info 
) [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.


Member Data Documentation

Definition at line 90 of file vtkImageToImageFilter.h.

Definition at line 91 of file vtkImageToImageFilter.h.

Definition at line 92 of file vtkImageToImageFilter.h.

Definition at line 93 of file vtkImageToImageFilter.h.

Definition at line 113 of file vtkImageToImageFilter.h.


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

Generated on Sat Dec 27 13:31:37 2008 for VTK by  doxygen 1.5.6