VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkROIStencilSource Class Reference

create simple mask shapes More...

#include <vtkROIStencilSource.h>

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

List of all members.

Public Types

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

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])
- Public Member Functions inherited from vtkImageStencilSource
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetInformationInput (vtkImageData *)
virtual vtkImageDataGetInformationInput ()
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
void SetOutput (vtkImageStencilData *output)
vtkImageStencilDataGetOutput ()
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

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 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 Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int Shape
double Bounds [6]
- Protected Attributes inherited from vtkImageStencilSource
vtkImageDataInformationInput
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 37 of file vtkROIStencilSource.h.


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  
)
protectedvirtual

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: