vtkPolyDataToImageStencil Class Reference

#include <vtkPolyDataToImageStencil.h>

Inheritance diagram for vtkPolyDataToImageStencil:

Inheritance graph
[legend]
Collaboration diagram for vtkPolyDataToImageStencil:

Collaboration graph
[legend]

List of all members.


Detailed Description

use polydata to mask an image

The vtkPolyDataToImageStencil class will convert a surface mesh into an image stencil that can be used to mask an image with vtkImageStencil, or used to calculate statistics within the enclosed region with vtkImageAccumulate.

Warning:
The input polydata must contain polygons (or other 2D cells) that form a 3D surface that encloses a finite volume. Polyline contours are ignored.
See also:
vtkImageStencil vtkImageAccumulate vtkImageBlend vtkImageReslice
Examples:
vtkPolyDataToImageStencil (Examples)
Tests:
vtkPolyDataToImageStencil (Tests)

Definition at line 79 of file vtkPolyDataToImageStencil.h.


Public Types

typedef vtkImageStencilSource Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInput (vtkPolyData *)
vtkPolyDataGetInput ()
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])
virtual void SetTolerance (double)
virtual double GetTolerance ()

Static Public Member Functions

static vtkPolyDataToImageStencilNew ()
static int IsTypeOf (const char *type)
static vtkPolyDataToImageStencilSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPolyDataToImageStencil ()
 ~vtkPolyDataToImageStencil ()
void ThreadedExecute (vtkImageStencilData *output, int extent[6], int threadId)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int, vtkInformation *)

Static Protected Member Functions

static void DataSetCutter (vtkDataSet *input, vtkPolyData *output, double z, vtkMergePoints *locator)

Protected Attributes

vtkImageDataInformationInput
double Tolerance
int OutputWholeExtent [6]
double OutputOrigin [3]
double OutputSpacing [3]

Member Typedef Documentation

Reimplemented from vtkImageStencilSource.

Definition at line 84 of file vtkPolyDataToImageStencil.h.


Constructor & Destructor Documentation

vtkPolyDataToImageStencil::vtkPolyDataToImageStencil (  )  [protected]

vtkPolyDataToImageStencil::~vtkPolyDataToImageStencil (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

static int vtkPolyDataToImageStencil::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageStencilSource.

virtual int vtkPolyDataToImageStencil::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

void vtkPolyDataToImageStencil::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 void vtkPolyDataToImageStencil::SetInput ( vtkPolyData  )  [virtual]

Specify the implicit function to convert into a stencil.

vtkPolyData* vtkPolyDataToImageStencil::GetInput (  ) 

Specify the implicit function to convert into a stencil.

virtual void vtkPolyDataToImageStencil::SetInformationInput ( vtkImageData  )  [virtual]

Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.

virtual vtkImageData* vtkPolyDataToImageStencil::GetInformationInput (  )  [virtual]

Set a vtkImageData that has the Spacing, Origin, and WholeExtent that will be used for the stencil. This input should be set to the image that you wish to apply the stencil to. If you use this method, then any values set with the SetOutputSpacing, SetOutputOrigin, and SetOutputWholeExtent methods will be ignored.

virtual void vtkPolyDataToImageStencil::SetOutputOrigin ( double  ,
double  ,
double   
) [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkPolyDataToImageStencil::SetOutputOrigin ( double  [3]  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual double* vtkPolyDataToImageStencil::GetOutputOrigin (  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkPolyDataToImageStencil::GetOutputOrigin ( double &  ,
double &  ,
double &   
) [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkPolyDataToImageStencil::GetOutputOrigin ( double  [3]  )  [virtual]

Set the Origin to be used for the stencil. It should be set to the Origin of the image you intend to apply the stencil to. The default value is (0,0,0).

virtual void vtkPolyDataToImageStencil::SetOutputSpacing ( double  ,
double  ,
double   
) [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkPolyDataToImageStencil::SetOutputSpacing ( double  [3]  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual double* vtkPolyDataToImageStencil::GetOutputSpacing (  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkPolyDataToImageStencil::GetOutputSpacing ( double &  ,
double &  ,
double &   
) [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkPolyDataToImageStencil::GetOutputSpacing ( double  [3]  )  [virtual]

Set the Spacing to be used for the stencil. It should be set to the Spacing of the image you intend to apply the stencil to. The default value is (1,1,1)

virtual void vtkPolyDataToImageStencil::SetOutputWholeExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual void vtkPolyDataToImageStencil::SetOutputWholeExtent ( int  [6]  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual int* vtkPolyDataToImageStencil::GetOutputWholeExtent (  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual void vtkPolyDataToImageStencil::GetOutputWholeExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
) [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual void vtkPolyDataToImageStencil::GetOutputWholeExtent ( int  [6]  )  [virtual]

Set the whole extent for the stencil (anything outside this extent will be considered to be "outside" the stencil). If this is not set, then the stencil will always use the requested UpdateExtent as the stencil extent.

virtual void vtkPolyDataToImageStencil::SetTolerance ( double   )  [virtual]

The tolerance to apply in when determining whether a voxel is inside the stencil, given as a fraction of a voxel. Only used in X and Y, not in Z.

virtual double vtkPolyDataToImageStencil::GetTolerance (  )  [virtual]

The tolerance to apply in when determining whether a voxel is inside the stencil, given as a fraction of a voxel. Only used in X and Y, not in Z.

void vtkPolyDataToImageStencil::ThreadedExecute ( vtkImageStencilData output,
int  extent[6],
int  threadId 
) [protected]

static void vtkPolyDataToImageStencil::DataSetCutter ( vtkDataSet input,
vtkPolyData output,
double  z,
vtkMergePoints locator 
) [static, protected]

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

Reimplemented from vtkImageStencilSource.

virtual int vtkPolyDataToImageStencil::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageStencilSource.

virtual int vtkPolyDataToImageStencil::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.


Member Data Documentation

Set in subclasses where the primary input is not a vtkImageData.

Definition at line 153 of file vtkPolyDataToImageStencil.h.

Set in subclasses where the primary input is not a vtkImageData.

Definition at line 157 of file vtkPolyDataToImageStencil.h.

Set in subclasses where the primary input is not a vtkImageData.

Definition at line 158 of file vtkPolyDataToImageStencil.h.

Set in subclasses where the primary input is not a vtkImageData.

Definition at line 159 of file vtkPolyDataToImageStencil.h.

The tolerance distance for favoring the inside of the stencil

Definition at line 163 of file vtkPolyDataToImageStencil.h.


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

Generated on Sat Dec 27 13:44:00 2008 for VTK by  doxygen 1.5.6