vtkImageStencilSource Class Reference

#include <vtkImageStencilSource.h>

Inheritance diagram for vtkImageStencilSource:

[legend]Collaboration diagram for vtkImageStencilSource:

[legend]List of all members.

Detailed Description

helper class for clipping images

vtkImageStencilSource is a helper class for vtkImageToImageFilter classes. 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

Created by:

Gobbi, David

CVS contributions (if > 5%):

Gobbi, David (73%)
Schroeder, Will (9%)
King, Brad (7%)

CVS logs (CVSweb):

.cxx (/Imaging/vtkImageStencilSource.cxx)
.h (/Imaging/vtkImageStencilSource.h)

Definition at line 51 of file vtkImageStencilSource.h.

Public Types

typedef vtkSource Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void SetOutput (vtkImageStencilData *output)

vtkImageStencilData * GetOutput ()

Static Public Member Functions

vtkImageStencilSource * New ()

int IsTypeOf (const char *type)

vtkImageStencilSource * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkImageStencilSource ()

~vtkImageStencilSource ()

void ExecuteData (vtkDataObject *out)

vtkImageStencilData * AllocateOutputData (vtkDataObject *out)

virtual int FillOutputPortInformation (int, vtkInformation *)

virtual void ThreadedExecute (vtkImageStencilData *output, int extent[6], int threadId)

Member Typedef Documentation

typedef vtkSource vtkImageStencilSource::Superclass

Reimplemented from vtkSource.
Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.
Definition at line 55 of file vtkImageStencilSource.h.

Constructor & Destructor Documentation

vtkImageStencilSource::vtkImageStencilSource ( ) [protected]

vtkImageStencilSource::~vtkImageStencilSource ( ) [protected]

Member Function Documentation

vtkImageStencilSource* vtkImageStencilSource::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

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

Reimplemented from vtkSource.
Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

int vtkImageStencilSource::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkSource.
Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

virtual int vtkImageStencilSource::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkSource.
Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

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

Reimplemented from vtkSource.
Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

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 vtkSource.
Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

void vtkImageStencilSource::SetOutput ( vtkImageStencilData * output )

Get or set the output for this source.

vtkImageStencilData* vtkImageStencilSource::GetOutput ( )

Get or set the output for this source.

void vtkImageStencilSource::ExecuteData ( vtkDataObject * out ) [protected, virtual]

This method is the one that should be used by subclasses, right now the default implementation is to call the backwards compatibility method
Reimplemented from vtkSource.
Reimplemented in vtkPolyDataToImageStencil.

vtkImageStencilData* vtkImageStencilSource::AllocateOutputData ( vtkDataObject * out ) [protected]

virtual void vtkImageStencilSource::ThreadedExecute ( vtkImageStencilData * output,

int extent[6],

int threadId

) [protected, virtual]

Override this method to support clipping with different kinds of objects. Eventually the extent could be split up and handled by multiple threads, but it isn't for now. But please ensure that all code inside this method is thread-safe.
Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

virtual int vtkImageStencilSource::FillOutputPortInformation ( int ,

vtkInformation *

) [protected, virtual]

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkSource.

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

dox/Imaging/vtkImageStencilSource.h


Public Types
typedef vtkSource	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

void	SetOutput (vtkImageStencilData *output)
vtkImageStencilData *	GetOutput ()
Static Public Member Functions
vtkImageStencilSource *	New ()
int	IsTypeOf (const char *type)
vtkImageStencilSource *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageStencilSource ()
	~vtkImageStencilSource ()
void	ExecuteData (vtkDataObject *out)
vtkImageStencilData *	AllocateOutputData (vtkDataObject *out)
virtual int	FillOutputPortInformation (int, vtkInformation *)

virtual void	ThreadedExecute (vtkImageStencilData *output, int extent[6], int threadId)