VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkROIStencilSource Class Reference

create simple mask shapes More...

#include <vtkROIStencilSource.h>

Inheritance diagram for vtkROIStencilSource:
[legend]
Collaboration diagram for vtkROIStencilSource:
[legend]

Public Types

enum  {
  BOX = 0, ELLIPSOID = 1, CYLINDERX = 2, CYLINDERY = 3,
  CYLINDERZ = 4
}
 
typedef vtkImageStencilSource Superclass
 
- Public Types inherited from vtkImageStencilSource
typedef vtkImageStencilAlgorithm Superclass
 
- Public Types inherited from vtkImageStencilAlgorithm
typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkROIStencilSourceNewInstance () const
 
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])
 
- Public Member Functions inherited from vtkImageStencilSource
vtkImageStencilSourceNewInstance () const
 
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])
 
- Public Member Functions inherited from vtkImageStencilAlgorithm
vtkImageStencilAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetOutput (vtkImageStencilData *output)
 
vtkImageStencilDataGetOutput ()
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Static Public Member Functions

static vtkROIStencilSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkROIStencilSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageStencilSource
static vtkImageStencilSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageStencilSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageStencilAlgorithm
static vtkImageStencilAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageStencilAlgorithmSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkROIStencilSource ()
 
 ~vtkROIStencilSource ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkImageStencilSource
 vtkImageStencilSource ()
 
 ~vtkImageStencilSource ()
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkImageStencilAlgorithm
 vtkImageStencilAlgorithm ()
 
 ~vtkImageStencilAlgorithm ()
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkImageStencilDataAllocateOutputData (vtkDataObject *out, int *updateExt)
 
virtual int FillOutputPortInformation (int, vtkInformation *)
 

Protected Attributes

int Shape
 
double Bounds [6]
 
- Protected Attributes inherited from vtkImageStencilSource
vtkImageData * InformationInput
 
int OutputWholeExtent [6]
 
double OutputOrigin [3]
 
double OutputSpacing [3]
 

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 38 of file vtkROIStencilSource.h.

Member Typedef Documentation

Definition at line 42 of file vtkROIStencilSource.h.

Member Enumeration Documentation

anonymous enum
Enumerator
BOX 
ELLIPSOID 
CYLINDERX 
CYLINDERY 
CYLINDERZ 

Definition at line 46 of file vtkROIStencilSource.h.

Constructor & Destructor Documentation

vtkROIStencilSource::vtkROIStencilSource ( )
protected
vtkROIStencilSource::~vtkROIStencilSource ( )
protected

Member Function Documentation

static vtkROIStencilSource* vtkROIStencilSource::New ( )
static
static int vtkROIStencilSource::IsTypeOf ( const char *  type)
static
virtual int vtkROIStencilSource::IsA ( const char *  type)
virtual

Reimplemented from vtkImageStencilSource.

static vtkROIStencilSource* vtkROIStencilSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkROIStencilSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageStencilSource.

vtkROIStencilSource* vtkROIStencilSource::NewInstance ( ) const
void vtkROIStencilSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 60 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 61 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 62 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 63 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 64 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 *   
)
protectedvirtual

Reimplemented from vtkImageStencilAlgorithm.

Member Data Documentation

int vtkROIStencilSource::Shape
protected

Definition at line 82 of file vtkROIStencilSource.h.

double vtkROIStencilSource::Bounds[6]
protected

Definition at line 83 of file vtkROIStencilSource.h.


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