Man Page for vtkImageSource
Table of Contents

NAME

vtkImageSource - Source of data for pipeline.

SYNOPSIS


#include "/opt/vtk-c++/common/vtkImageSource.h"

class VTK_EXPORT vtkImageSource : public vtkObject

vtkImageSource();
~vtkImageSource();
const char *GetClassName() {return "vtkImageSource";};
void PrintSelf(ostream& os, vtkIndent indent);
virtual void InterceptCacheUpdate();
virtual void InternalUpdate();
virtual void Update();
virtual void UpdateWholeExtent();
virtual void UpdateImageInformation() = 0;
virtual unsigned long GetPipelineMTime();
vtkImageCache *GetOutput();
virtual void SetCache(vtkImageCache *cache);
vtkImageCache *GetCache();
virtual void SetReleaseDataFlag(int value);
int GetReleaseDataFlag();
void ReleaseDataFlagOn();
void ReleaseDataFlagOff();
void SetOutputScalarTypeToFloat(){this->SetOutputScalarType(VTK_FLOAT);}
void SetOutputScalarTypeToInt(){this->SetOutputScalarType(VTK_INT);}
void SetOutputScalarTypeToShort(){this->SetOutputScalarType(VTK_SHORT);}
void SetOutputScalarTypeToUnsignedShort()
{this->SetOutputScalarType(VTK_UNSIGNED_SHORT);}
void SetOutputScalarTypeToUnsignedChar()
{this->SetOutputScalarType(VTK_UNSIGNED_CHAR);}
void SetOutputScalarType(int type);
int GetOutputScalarType();
virtual void SetStartMethod(void (*f)(void *), void *arg);
virtual void SetEndMethod(void (*f)(void *), void *arg);
virtual void SetStartMethodArgDelete(void (*f)(void *));
virtual void SetEndMethodArgDelete(void (*f)(void *));

DESCRIPTION

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

SEE ALSO

vtkImageCache vtkImageRegion

SUMMARY

~vtkImageSource()
Destructor: Delete the cache as well. (should caches by reference counted?)

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.

void Update()
This method can be called directly. It simply forwards the update to the cache.

void InternalUpdate()
This method is called by the cache.

void RecursiveLoopUpdate(int dim, vtkImageRegion *region) This is a recursive method that loops over "extra" axes. The recursion stops when the dimensionality of the regions are equal to "NumberOfExecutionAxes"

void UpdateWholeExtent()
This method updates the cache with the whole image extent.

void Execute(vtkImageRegion *region)
This function can be defined in a subclass to generate the data for a region.

vtkImageCache *GetCache()
Returns the cache object of the source. If one does not exist, a default is created.

vtkImageCache *GetOutput()
Returns an object which will generate data for Regions.

unsigned long GetPipelineMTime()
Returns the maximum mtime of this source and every object which effects this sources output.

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.

void SetReleaseDataFlag(int value)
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.

int GetReleaseDataFlag()
This method gets the value of the caches ReleaseDataFlag.

void SetOutputScalarType(int value)
This method sets the value of the caches ScalarType.

int GetOutputScalarType()
This method returns the caches ScalarType.

void CheckCache()
This private method creates a cache if one has not been set. ReleaseDataFlag is turned on.

void SetStartMethod(void (*f)(void *), void *arg)
Specify function to be called before object executes.

void SetEndMethod(void (*f)(void *), void *arg)
Specify function to be called after object executes.

void SetStartMethodArgDelete(void (*f)(void *))
Set the arg delete method. This is used to free user memory.

void SetEndMethodArgDelete(void (*f)(void *))
Set the arg delete method. This is used to free user memory.


Table of Contents