vtkImageStencilSource Class Reference

#include <vtkImageStencilSource.h>

Inheritance diagram for vtkImageStencilSource:

Inheritance graph
[legend]
Collaboration diagram for vtkImageStencilSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

generate an image stencil

vtkImageStencilSource is a superclass for filters that generate image stencils. Given a clipping object such as a vtkImplicitFunction, it will set up a list of clipping extents for each x-row through the image data. The extents for each x-row can be retrieved via the GetNextExtent() method after the extent lists have been built with the BuildExtents() method. For large images, using clipping extents is much more memory efficient (and slightly more time-efficient) than building a mask. This class can be subclassed to allow clipping with objects other than vtkImplicitFunction.

See also:
vtkImplicitFunction vtkImageStencil vtkPolyDataToImageStencil

Definition at line 40 of file vtkImageStencilSource.h.


Public Types

typedef vtkImageStencilAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetInformationInput (vtkImageData *)
virtual vtkImageDataGetInformationInput ()
virtual void SetOutputOrigin (double, double, double)
virtual void SetOutputOrigin (double[3])
virtual double * GetOutputOrigin ()
virtual void GetOutputOrigin (double &, double &, double &)
virtual void GetOutputOrigin (double[3])
virtual void SetOutputSpacing (double, double, double)
virtual void SetOutputSpacing (double[3])
virtual double * GetOutputSpacing ()
virtual void GetOutputSpacing (double &, double &, double &)
virtual void GetOutputSpacing (double[3])
virtual void SetOutputWholeExtent (int, int, int, int, int, int)
virtual void SetOutputWholeExtent (int[6])
virtual int * GetOutputWholeExtent ()
virtual void GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)
virtual void GetOutputWholeExtent (int[6])

Static Public Member Functions

static vtkImageStencilSourceNew ()
static int IsTypeOf (const char *type)
static vtkImageStencilSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageStencilSource ()
 ~vtkImageStencilSource ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

vtkImageDataInformationInput
int OutputWholeExtent [6]
double OutputOrigin [3]
double OutputSpacing [3]

Member Typedef Documentation


Constructor & Destructor Documentation

vtkImageStencilSource::vtkImageStencilSource (  )  [protected]

vtkImageStencilSource::~vtkImageStencilSource (  )  [protected]


Member Function Documentation

static vtkImageStencilSource* vtkImageStencilSource::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkImageStencilAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

virtual const char* vtkImageStencilSource::GetClassName (  )  [virtual]

static int vtkImageStencilSource::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageStencilAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

virtual int vtkImageStencilSource::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageStencilAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

static vtkImageStencilSource* vtkImageStencilSource::SafeDownCast ( vtkObject o  )  [static]

void vtkImageStencilSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageStencilAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

virtual void vtkImageStencilSource::SetInformationInput ( vtkImageData  )  [virtual]

Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.

virtual vtkImageData* vtkImageStencilSource::GetInformationInput (  )  [virtual]

Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.

virtual void vtkImageStencilSource::SetOutputOrigin ( double  ,
double  ,
double   
) [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImageStencilSource::SetOutputOrigin ( double  [3]  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual double* vtkImageStencilSource::GetOutputOrigin (  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImageStencilSource::GetOutputOrigin ( double &  ,
double &  ,
double &   
) [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImageStencilSource::GetOutputOrigin ( double  [3]  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkImageStencilSource::SetOutputSpacing ( double  ,
double  ,
double   
) [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImageStencilSource::SetOutputSpacing ( double  [3]  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual double* vtkImageStencilSource::GetOutputSpacing (  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImageStencilSource::GetOutputSpacing ( double &  ,
double &  ,
double &   
) [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImageStencilSource::GetOutputSpacing ( double  [3]  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkImageStencilSource::SetOutputWholeExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual void vtkImageStencilSource::SetOutputWholeExtent ( int  [6]  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual int* vtkImageStencilSource::GetOutputWholeExtent (  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual void vtkImageStencilSource::GetOutputWholeExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
) [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual void vtkImageStencilSource::GetOutputWholeExtent ( int  [6]  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil).

virtual void vtkImageStencilSource::ReportReferences ( vtkGarbageCollector  )  [virtual]

Report object referenced by instances of this class.

Reimplemented from vtkAlgorithm.

virtual int vtkImageStencilSource::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageStencilAlgorithm.


Member Data Documentation

Definition at line 92 of file vtkImageStencilSource.h.

Definition at line 94 of file vtkImageStencilSource.h.

double vtkImageStencilSource::OutputOrigin[3] [protected]

Definition at line 95 of file vtkImageStencilSource.h.

double vtkImageStencilSource::OutputSpacing[3] [protected]

Definition at line 96 of file vtkImageStencilSource.h.


The documentation for this class was generated from the following file:

Generated on Wed Aug 24 11:42:27 2011 for VTK by  doxygen 1.5.6