---

vtkImageStencilSource Class Reference

helper class for clipping images. More...

#include <vtkImageStencilSource.h>

Inheritance diagram for vtkImageStencilSource:

[legend]Collaboration diagram for vtkImageStencilSource:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetOutput (vtkImageStencilData *output)
vtkImageStencilData *	GetOutput ()
Static Public Methods
vtkImageStencilSource *	New ()
int	IsTypeOf (const char *type)
vtkImageStencilSource *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageStencilSource ()
	~vtkImageStencilSource ()
void	ExecuteData (vtkDataObject *out)
vtkImageStencilData *	AllocateOutputData (vtkDataObject *out)
virtual void	ThreadedExecute (vtkImageStencilData *output, int extent[6], int threadId)

---

Detailed Description

helper class for clipping images.

Date:

2001/11/13 14:32:42

Revision:

1.5

Thanks:

Thanks to David G. Gobbi who developed this class.

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 vtkImagePolyDataStencilSource

Definition at line 67 of file vtkImageStencilSource.h.

---

Constructor & Destructor Documentation

vtkImageStencilSource::vtkImageStencilSource (    )  [protected]

vtkImageStencilSource::~vtkImageStencilSource (    )  [protected]

---

Member Function Documentation

vtkImageStencilSource* vtkImageStencilSource::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkSource. Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. 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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkSource. Reimplemented in vtkPolyDataToImageStencil, vtkImageToImageStencil, and vtkImplicitFunctionToImageStencil.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. 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]

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.

---

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

• Imaging/vtkImageStencilSource.h

---