Documentation for vtkImageSource

vtkImageSource - Source of data for pipeline.

Super Class: vtkProcessObject

Description:

vtkImageSource is the supperclass for all imaging sources and filters. The method Update, called by the cache, is the major interface to the source.

 

See Also:

vtkImageCache vtkImageFilter

 

Methods:

void vtkImageSource ()
void vtkImageSource ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetReleaseDataFlag (int )
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int GetReleaseDataFlag ()
void InterceptCacheUpdate ()
void InternalUpdate (vtkImageData *)
void Update ()
void UpdateWholeExtent ()
void UpdateImageInformation ()
unsigned long GetPipelineMTime ()
vtkImageCache *GetOutput ()
void SetCache (vtkImageCache *)
vtkImageCache *GetCache ()
int SplitExtent (int ,int ,int ,int )
void UnRegister (vtkObject *)
void Execute (vtkImageData *)
void CheckCache ()

 

Detailed Method Descriptions:

This method sets the value of the caches ReleaseDataFlag. When this flag is set, the cache releases its data after every generate. When a default cache is created, this flag is automatically set.

void SetReleaseDataFlag (int )
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()

This method gets the value of the caches ReleaseDataFlag.

int GetReleaseDataFlag ()

This method can be used to intercept a generate call made to a cache. It allows a source to generate a larger region than was originally specified. The default method does not alter the specified region extent.

void InterceptCacheUpdate ()

This method is called by the cache.

void InternalUpdate (vtkImageData *)

This method can be called directly. It simply forwards the update to the cache.

void Update ()

This method updates the cache with the whole image extent.

void UpdateWholeExtent ()

This method updates the instance variables "WholeExtent", "Spacing", "Origin", "Bounds" etc. It needs to be separate from "Update" because the image information may be needed to compute the required UpdateExtent of the input (see "vtkImageFilter").

void UpdateImageInformation ()

Returns the maximum mtime of this source and every object which effects this sources output.

unsigned long GetPipelineMTime ()

Returns an object which will generate data for Regions.

vtkImageCache *GetOutput ()

Use this method to specify a cache object for the filter. If a cache has been set previously, it is deleted, and caches are not reference counted yet. BE CAREFUL. The Source of the Cache is set as a side action.

void SetCache (vtkImageCache *)

Returns the cache object of the source. If one does not exist, a default is created.

vtkImageCache *GetCache ()

subclass can over ride this method to do custom streaming and splitting for multiprocessing.

int SplitExtent (int ,int ,int ,int )

This UnRegister method detects the small reference counting loop: ImageSource <-> ImageCache, and destructs anyway.

void UnRegister (vtkObject *)