vtkImageSource - Source of data for the imaging pipeline

Super Class: vtkProcessObject

Description:

vtkImageSource is the superclass 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:

• vtkImageSource ();
• ~vtkImageSource ();
• char *GetClassName ();
• void PrintSelf (ostream &os, vtkIndent indent);
• virtual void SetReleaseDataFlag (int value);
• void ReleaseDataFlagOn ();
• void ReleaseDataFlagOff ();
• int GetReleaseDataFlag ();
• virtual void InterceptCacheUpdate ();
• virtual void InternalUpdate (vtkImageData *data);
• virtual void Update ();
• virtual void UpdateWholeExtent ();
• virtual void UpdateImageInformation () = 0;
• virtual unsigned long GetPipelineMTime ();
• vtkImageCache *GetOutput ();
• virtual void SetCache (vtkImageCache *cache);
• vtkImageCache *GetCache ();
• virtual int SplitExtent (int splitExt[6], int startExt[6], int num, int total);
• void UnRegister (vtkObject *o);
• virtual vtkImageCache *Outputvoid Execute (vtkImageData *data);
• virtual void CheckCache ();

Detailed Method Descriptions:

• virtual void SetReleaseDataFlag (int value);
• void ReleaseDataFlagOn ();
• void ReleaseDataFlagOff ();

This method sets the value of the cache's 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.

• int GetReleaseDataFlag ();

This method gets the value of the caches ReleaseDataFlag.

• virtual void InterceptCacheUpdate ();

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.

• virtual void InternalUpdate (vtkImageData *data);

This method is called by the cache.

• virtual void Update ();

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

• virtual void UpdateWholeExtent ();

This method updates the cache with the whole image extent.

• virtual void UpdateImageInformation () = 0;

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").

• virtual unsigned long GetPipelineMTime ();

Returns the maximum MTime of this source and every object affecting this source's output.

• vtkImageCache *GetOutput ();

Returns an object which will generate data for Regions.

• virtual void SetCache (vtkImageCache *cache);

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.

• vtkImageCache *GetCache ();

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

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

Subclasses can override this method to do custom streaming and splitting for multiprocessing.

• void UnRegister (vtkObject *o);

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