vtkROIStencilSource Class Reference

#include <vtkROIStencilSource.h>

Inheritance diagram for vtkROIStencilSource:

[legend]

Collaboration diagram for vtkROIStencilSource:

[legend]

List of all members.

Detailed Description

create simple mask shapes

vtkROIStencilSource will create an image stencil with a simple shape like a box, a sphere, or a cylinder. Its output can be used with vtkImageStecil or other vtk classes that apply a stencil to an image.

See also:: vtkImplicitFunctionToImageStencil vtkLassoStencilSource

Thanks:: Thanks to David Gobbi for contributing this class to VTK.

Tests:: vtkROIStencilSource (Tests)

Definition at line 37 of file vtkROIStencilSource.h.


Public Types
enum	{ BOX = 0, ELLIPSOID = 1, CYLINDERX = 2, CYLINDERY = 3, CYLINDERZ = 4 }
typedef vtkImageStencilSource	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	GetShape ()
virtual void	SetShape (int)
void	SetShapeToBox ()
void	SetShapeToEllipsoid ()
void	SetShapeToCylinderX ()
void	SetShapeToCylinderY ()
void	SetShapeToCylinderZ ()
virtual const char *	GetShapeAsString ()

virtual double *	GetBounds ()
virtual void	GetBounds (double &, double &, double &, double &, double &, double &)
virtual void	GetBounds (double[6])
virtual void	SetBounds (double, double, double, double, double, double)
virtual void	SetBounds (double[6])
Static Public Member Functions
static vtkROIStencilSource *	New ()
static int	IsTypeOf (const char *type)
static vtkROIStencilSource *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkROIStencilSource ()
	~vtkROIStencilSource ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
int	Shape
double	Bounds [6]

Member Typedef Documentation

typedef vtkImageStencilSource vtkROIStencilSource::Superclass

Reimplemented from vtkImageStencilSource.

Definition at line 41 of file vtkROIStencilSource.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

BOX
ELLIPSOID
CYLINDERX
CYLINDERY
CYLINDERZ

Definition at line 45 of file vtkROIStencilSource.h.

Constructor & Destructor Documentation

vtkROIStencilSource::vtkROIStencilSource ( ) [protected]

vtkROIStencilSource::~vtkROIStencilSource ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

static int vtkROIStencilSource::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 vtkImageStencilSource.

virtual int vtkROIStencilSource::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 vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

void vtkROIStencilSource::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 vtkImageStencilSource.

virtual int vtkROIStencilSource::GetShape ( ) [virtual]