vtkPolyDataToImageStencil Class Reference

use polydata to mask an image More...

#include <vtkPolyDataToImageStencil.h>

Inheritance diagram for vtkPolyDataToImageStencil:

Collaboration diagram for vtkPolyDataToImageStencil:

List of all members.

Public Types
typedef vtkImageStencilSource	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkPolyDataToImageStencil *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetInputData (vtkPolyData *)
vtkPolyData *	GetInput ()
virtual void	SetTolerance (double)
virtual double	GetTolerance ()
Static Public Member Functions
static vtkPolyDataToImageStencil *	New ()
static int	IsTypeOf (const char *type)
static vtkPolyDataToImageStencil *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPolyDataToImageStencil ()
	~vtkPolyDataToImageStencil ()
void	ThreadedExecute (vtkImageStencilData *output, int extent[6], int threadId)
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	FillInputPortInformation (int, vtkInformation *)
Static Protected Member Functions
static void	PolyDataCutter (vtkPolyData *input, vtkPolyData *output, double z)
static void	PolyDataSelector (vtkPolyData *input, vtkPolyData *output, double z, double thickness)
Protected Attributes
double	Tolerance

---

Detailed Description

use polydata to mask an image

The vtkPolyDataToImageStencil class will convert polydata into an image stencil. The polydata can either be a closed surface mesh or a series of polyline contours (one contour per slice).

Warning:

If contours are provided, the contours must be aligned with the Z planes. Other contour orientations are not supported.

See also:

vtkImageStencil vtkImageAccumulate vtkImageBlend vtkImageReslice

Examples:

vtkPolyDataToImageStencil (Examples)

Tests:

vtkPolyDataToImageStencil (Tests)

Definition at line 77 of file vtkPolyDataToImageStencil.h.

---

Member Typedef Documentation

typedef vtkImageStencilSource vtkPolyDataToImageStencil::Superclass

Reimplemented from vtkImageStencilSource.

Definition at line 82 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.

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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageStencilSource.

static vtkPolyDataToImageStencil* vtkPolyDataToImageStencil::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkImageStencilSource.

virtual vtkObjectBase* vtkPolyDataToImageStencil::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkImageStencilSource.

vtkPolyDataToImageStencil* vtkPolyDataToImageStencil::NewInstance

(

)

const

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::SetInputData

(

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::SetTolerance

(

double

)

[virtual]

The tolerance for including a voxel inside the stencil. This is in fractions of a voxel, and must be between 0 and 1. Tolerance is only applied in the x and y directions, not in z. Setting the tolerance to zero disables all tolerance checks and might result in faster performance.

virtual double vtkPolyDataToImageStencil::GetTolerance

(

)

[virtual]

The tolerance for including a voxel inside the stencil. This is in fractions of a voxel, and must be between 0 and 1. Tolerance is only applied in the x and y directions, not in z. Setting the tolerance to zero disables all tolerance checks and might result in faster performance.

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

static void vtkPolyDataToImageStencil::PolyDataCutter	(	vtkPolyData *	input,
		vtkPolyData *	output,
		double	z
	)		[static, protected]

static void vtkPolyDataToImageStencil::PolyDataSelector	(	vtkPolyData *	input,
		vtkPolyData *	output,
		double	z,
		double	thickness
	)		[static, protected]

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

Reimplemented from vtkImageStencilAlgorithm.

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

double vtkPolyDataToImageStencil::Tolerance [protected]

The tolerance distance for favoring the inside of the stencil

Definition at line 120 of file vtkPolyDataToImageStencil.h.

---

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

• /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Imaging/Stencil/vtkPolyDataToImageStencil.h