Documentation for vtkImageFilter

vtkImageFilter - Generic filter that has one input..

Super Class: vtkImageSource

Description:

vtkImageFilter is a filter superclass that hides much of the pipeline complexity. It handles breaking the pipeline execution into smaller extents so that the vtkImageCache memory limits are observed. It also provides support for multithreading.

 

Methods:

void vtkImageFilter ()
void vtkImageFilter ()
static vtkImageFilter *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetInput (vtkImageCache *)
void SetInput (vtkStructuredPoints *)
void InternalUpdate (vtkImageData *)
void UpdateImageInformation ()
unsigned long GetPipelineMTime ()
vtkImageCache *GetInput ()
void SetBypass (int )
int GetBypass ()
void BypassOn ()
void BypassOff ()
void SetNumberOfThreads (int )
int GetNumberOfThreads ()
void ThreadedExecute (vtkImageData * ,vtkImageData * ,int ,int )
void ExecuteImageInformation ()
void ComputeRequiredInputUpdateExtent (int ,int )
void RecursiveStreamUpdate (vtkImageData *)
void Execute (vtkImageData * ,vtkImageData *)

 

Detailed Method Descriptions:

Set the Input of a filter.

void SetInput (vtkImageCache *)

This method is called by the cache. It eventually calls the Execute(vtkImageData *, vtkImageData *) method. ImageInformation has already been updated by this point, and outRegion is in local coordinates. This method will stream to get the input, and loops over extra axes. Only the UpdateExtent from output will get updated.

void SetInput (vtkStructuredPoints *)
void InternalUpdate (vtkImageData *)

This method sets the WholeExtent, Spacing and Origin of the output.

void UpdateImageInformation ()

This Method returns the MTime of the pipeline up to and including this filter Note: current implementation may create a cascade of GetPipelineMTime calls. Each GetPipelineMTime call propagates the call all the way to the original source.

unsigned long GetPipelineMTime ()

Get input to this filter.

vtkImageCache *GetInput ()

Turning bypass on will cause the filter to turn off and simply pass the data through. This main purpose for this functionality is support for vtkImageDecomposedFilter. InputMemoryLimit is ignored when Bypass in on.

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

Get/Set the number of threads to create when rendering

void SetNumberOfThreads (int )
int GetNumberOfThreads ()

subclasses should define this function

void ThreadedExecute (vtkImageData * ,vtkImageData * ,int ,int )