vtkROIStencilSource Class Reference

#include <vtkROIStencilSource.h>

Inheritance diagram for vtkROIStencilSource:

Inheritance graph
[legend]
Collaboration diagram for vtkROIStencilSource:

Collaboration graph
[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 vtkROIStencilSourceNew ()
static int IsTypeOf (const char *type)
static vtkROIStencilSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkROIStencilSource ()
 ~vtkROIStencilSource ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

int Shape
double Bounds [6]

Member Typedef Documentation

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]

The shape of the region of interest. Cylinders can be oriented along the X, Y, or Z axes. The default shape is "Box".

virtual void vtkROIStencilSource::SetShape ( int   )  [virtual]

The shape of the region of interest. Cylinders can be oriented along the X, Y, or Z axes. The default shape is "Box".

void vtkROIStencilSource::SetShapeToBox (  )  [inline]

The shape of the region of interest. Cylinders can be oriented along the X, Y, or Z axes. The default shape is "Box".

Definition at line 59 of file vtkROIStencilSource.h.

void vtkROIStencilSource::SetShapeToEllipsoid (  )  [inline]

The shape of the region of interest. Cylinders can be oriented along the X, Y, or Z axes. The default shape is "Box".

Definition at line 60 of file vtkROIStencilSource.h.

void vtkROIStencilSource::SetShapeToCylinderX (  )  [inline]

The shape of the region of interest. Cylinders can be oriented along the X, Y, or Z axes. The default shape is "Box".

Definition at line 61 of file vtkROIStencilSource.h.

void vtkROIStencilSource::SetShapeToCylinderY (  )  [inline]

The shape of the region of interest. Cylinders can be oriented along the X, Y, or Z axes. The default shape is "Box".

Definition at line 62 of file vtkROIStencilSource.h.

void vtkROIStencilSource::SetShapeToCylinderZ (  )  [inline]

The shape of the region of interest. Cylinders can be oriented along the X, Y, or Z axes. The default shape is "Box".

Definition at line 63 of file vtkROIStencilSource.h.

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

The shape of the region of interest. Cylinders can be oriented along the X, Y, or Z axes. The default shape is "Box".

virtual double* vtkROIStencilSource::GetBounds (  )  [virtual]

Set the bounds of the region of interest. The bounds take the spacing and origin into account.

virtual void vtkROIStencilSource::GetBounds ( double &  ,
double &  ,
double &  ,
double &  ,
double &  ,
double &   
) [virtual]

Set the bounds of the region of interest. The bounds take the spacing and origin into account.

virtual void vtkROIStencilSource::GetBounds ( double  [6]  )  [virtual]

Set the bounds of the region of interest. The bounds take the spacing and origin into account.

virtual void vtkROIStencilSource::SetBounds ( double  ,
double  ,
double  ,
double  ,
double  ,
double   
) [virtual]

Set the bounds of the region of interest. The bounds take the spacing and origin into account.

virtual void vtkROIStencilSource::SetBounds ( double  [6]  )  [virtual]

Set the bounds of the region of interest. The bounds take the spacing and origin into account.

virtual int vtkROIStencilSource::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageStencilAlgorithm.


Member Data Documentation

int vtkROIStencilSource::Shape [protected]

Definition at line 81 of file vtkROIStencilSource.h.

double vtkROIStencilSource::Bounds[6] [protected]

Definition at line 82 of file vtkROIStencilSource.h.


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

Generated on Wed Aug 24 12:04:18 2011 for VTK by  doxygen 1.5.6