vtkImageStencilSource Class Reference

#include <vtkImageStencilSource.h>

Inheritance diagram for vtkImageStencilSource:

[legend]

Collaboration diagram for vtkImageStencilSource:

[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 vtkImageData *	GetInformationInput ()

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 vtkImageStencilSource *	New ()
static int	IsTypeOf (const char *type)
static vtkImageStencilSource *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageStencilSource ()
	~vtkImageStencilSource ()
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
vtkImageData *	InformationInput
int	OutputWholeExtent [6]
double	OutputOrigin [3]
double	OutputSpacing [3]

Member Typedef Documentation

typedef vtkImageStencilAlgorithm vtkImageStencilSource::Superclass

Reimplemented from vtkImageStencilAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

Definition at line 45 of file vtkImageStencilSource.h.

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]

Reimplemented from vtkImageStencilAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

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]

Reimplemented from vtkImageStencilAlgorithm.

Reimplemented in vtkPolyDataToImageStencil, vtkImplicitFunctionToImageStencil, vtkLassoStencilSource, and vtkROIStencilSource.

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]`