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:

• vtkImageFilter ();
• ~vtkImageFilter ();
• vtkImageFilter *New ();
• char *GetClassName ();
• void PrintSelf (ostream &os, vtkIndent indent);
• virtual void SetInput (vtkImageCache *input);
• void SetInput (vtkStructuredPoints *spts);
• virtual void InternalUpdate (vtkImageData *outData);
• virtual void UpdateImageInformation ();
• unsigned long GetPipelineMTime ();
• vtkImageCacheGetInput ();
• void SetBypass (int );
• int GetBypass ();
• void BypassOn ();
• void BypassOff ();
• void SetNumberOfThreads (int );
• int GetNumberOfThreads ();
• virtual void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId);
• virtual vtkImageCache *InputvtkMultiThreader *Threaderint Bypassint Updatingint NumberOfThreadsvoid ExecuteImageInformation ();
• virtual void ComputeRequiredInputUpdateExtent (int inExt[6], int outExt[6]);
• virtual void RecursiveStreamUpdate (vtkImageData *outData);
• virtual void Execute (vtkImageData *inData, vtkImageData *outData);

Detailed Method Descriptions:

• virtual void SetInput (vtkImageCache *input);

Set the Input of a filter.

• void SetInput (vtkStructuredPoints *spts);
• virtual void InternalUpdate (vtkImageData *outData);

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.

• virtual void UpdateImageInformation ();

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

• unsigned long GetPipelineMTime ();

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.

• vtkImageCacheGetInput ();

Get input to this filter.

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

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 SetNumberOfThreads (int );
• int GetNumberOfThreads ();

Get/Set the number of threads to create when rendering

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

subclasses should define this function