vtkDelaunay3D Class Reference

#include <vtkDelaunay3D.h>

Inheritance diagram for vtkDelaunay3D:

[legend]

Collaboration diagram for vtkDelaunay3D:

[legend]

List of all members.

Detailed Description

create 3D Delaunay triangulation of input points

vtkDelaunay3D is a filter that constructs a 3D Delaunay triangulation from a list of input points. These points may be represented by any dataset of type vtkPointSet and subclasses. The output of the filter is an unstructured grid dataset. Usually the output is a tetrahedral mesh, but if a non-zero alpha distance value is specified (called the "alpha" value), then only tetrahedra, triangles, edges, and vertices lying within the alpha radius are output. In other words, non-zero alpha values may result in arbitrary combinations of tetrahedra, triangles, lines, and vertices. (The notion of alpha value is derived from Edelsbrunner's work on "alpha shapes".)

The 3D Delaunay triangulation is defined as the triangulation that satisfies the Delaunay criterion for n-dimensional simplexes (in this case n=3 and the simplexes are tetrahedra). This criterion states that a circumsphere of each simplex in a triangulation contains only the n+1 defining points of the simplex. (See text for more information.) While in two dimensions this translates into an "optimal" triangulation, this is not true in 3D, since a measurement for optimality in 3D is not agreed on.

Delaunay triangulations are used to build topological structures from unorganized (or unstructured) points. The input to this filter is a list of points specified in 3D. (If you wish to create 2D triangulations see vtkDelaunay2D.) The output is an unstructured grid.

The Delaunay triangulation can be numerically sensitive. To prevent problems, try to avoid injecting points that will result in triangles with bad aspect ratios (1000:1 or greater). In practice this means inserting points that are "widely dispersed", and enables smooth transition of triangle sizes throughout the mesh. (You may even want to add extra points to create a better point distribution.) If numerical problems are present, you will see a warning message to this effect at the end of the triangulation process.

Warning:

Points arranged on a regular lattice (termed degenerate cases) can be triangulated in more than one way (at least according to the Delaunay criterion). The choice of triangulation (as implemented by this algorithm) depends on the order of the input points. The first four points will form a tetrahedron; other degenerate points (relative to this initial tetrahedron) will not break it.

Points that are coincident (or nearly so) may be discarded by the algorithm. This is because the Delaunay triangulation requires unique input points. You can control the definition of coincidence with the "Tolerance" instance variable.

The output of the Delaunay triangulation is supposedly a convex hull. In certain cases this implementation may not generate the convex hull. This behavior can be controlled by the Offset instance variable. Offset is a multiplier used to control the size of the initial triangulation. The larger the offset value, the more likely you will generate a convex hull; and the more likely you are to see numerical problems.

The implementation of this algorithm varies from the 2D Delaunay algorithm (i.e., vtkDelaunay2D) in an important way. When points are injected into the triangulation, the search for the enclosing tetrahedron is quite different. In the 3D case, the closest previously inserted point point is found, and then the connected tetrahedra are searched to find the containing one. (In 2D, a "walk" towards the enclosing triangle is performed.) If the triangulation is Delaunay, then an enclosing tetrahedron will be found. However, in degenerate cases an enclosing tetrahedron may not be found and the point will be rejected.

See also:: vtkDelaunay2D vtkGaussianSplatter vtkUnstructuredGrid

Tests:: vtkDelaunay3D (Tests)

Definition at line 104 of file vtkDelaunay3D.h.


Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	CreateDefaultLocator ()
void	EndPointInsertion ()
unsigned long	GetMTime ()

virtual void	SetAlpha (double)
virtual double	GetAlpha ()

virtual void	SetTolerance (double)
virtual double	GetTolerance ()

virtual void	SetOffset (double)
virtual double	GetOffset ()

virtual void	SetBoundingTriangulation (int)
virtual int	GetBoundingTriangulation ()
virtual void	BoundingTriangulationOn ()
virtual void	BoundingTriangulationOff ()

void	SetLocator (vtkPointLocator *locator)
virtual vtkPointLocator *	GetLocator ()

vtkUnstructuredGrid *	InitPointInsertion (double center[3], double length, vtkIdType numPts, vtkPoints *&pts)

void	InsertPoint (vtkUnstructuredGrid Mesh, vtkPoints points, vtkIdType id, double x[3], vtkIdList *holeTetras)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkDelaunay3D *	SafeDownCast (vtkObject *o)
static vtkDelaunay3D *	New ()
Protected Member Functions
	vtkDelaunay3D ()
	~vtkDelaunay3D ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
int	FindTetra (vtkUnstructuredGrid *Mesh, double x[3], vtkIdType tetId, int depth)
int	InSphere (double x[3], vtkIdType tetraId)
void	InsertTetra (vtkUnstructuredGrid Mesh, vtkPoints pts, vtkIdType tetraId)
vtkIdType	FindEnclosingFaces (double x[3], vtkUnstructuredGrid Mesh, vtkIdList tetras, vtkIdList faces, vtkPointLocator Locator)
virtual int	FillInputPortInformation (int, vtkInformation *)
Protected Attributes
double	Alpha
double	Tolerance
int	BoundingTriangulation
double	Offset
vtkPointLocator *	Locator
vtkTetraArray *	TetraArray
int	NumberOfDuplicatePoints
int	NumberOfDegeneracies
int *	References

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkDelaunay3D::Superclass

Reimplemented from vtkUnstructuredGridAlgorithm.

Definition at line 107 of file vtkDelaunay3D.h.

Constructor & Destructor Documentation

vtkDelaunay3D::vtkDelaunay3D ( ) [protected]

vtkDelaunay3D::~vtkDelaunay3D ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkDelaunay3D::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 vtkUnstructuredGridAlgorithm.

virtual int vtkDelaunay3D::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 vtkUnstructuredGridAlgorithm.

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

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkDelaunay3D::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 vtkUnstructuredGridAlgorithm.

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

Construct object with Alpha = 0.0; Tolerance = 0.001; Offset = 2.5; BoundingTriangulation turned off.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual void vtkDelaunay3D::SetAlpha ( double ) [virtual]

Specify alpha (or distance) value to control output of this filter. For a non-zero alpha value, only edges, faces, or tetra contained within the circumsphere (of radius alpha) will be output. Otherwise, only tetrahedra will be output.

virtual double vtkDelaunay3D::GetAlpha ( ) [virtual]

Specify alpha (or distance) value to control output of this filter. For a non-zero alpha value, only edges, faces, or tetra contained within the circumsphere (of radius alpha) will be output. Otherwise, only tetrahedra will be output.

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

Specify a tolerance to control discarding of closely spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the points.

virtual double vtkDelaunay3D::GetTolerance ( ) [virtual]

Specify a tolerance to control discarding of closely spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the points.

virtual void vtkDelaunay3D::SetOffset ( double ) [virtual]

Specify a multiplier to control the size of the initial, bounding Delaunay triangulation.

virtual double vtkDelaunay3D::GetOffset ( ) [virtual]

Specify a multiplier to control the size of the initial, bounding Delaunay triangulation.

virtual void vtkDelaunay3D::SetBoundingTriangulation ( int ) [virtual]

Boolean controls whether bounding triangulation points (and associated triangles) are included in the output. (These are introduced as an initial triangulation to begin the triangulation process. This feature is nice for debugging output.)

virtual int vtkDelaunay3D::GetBoundingTriangulation ( ) [virtual]

Boolean controls whether bounding triangulation points (and associated triangles) are included in the output. (These are introduced as an initial triangulation to begin the triangulation process. This feature is nice for debugging output.)

virtual void vtkDelaunay3D::BoundingTriangulationOn ( ) [virtual]

Boolean controls whether bounding triangulation points (and associated triangles) are included in the output. (These are introduced as an initial triangulation to begin the triangulation process. This feature is nice for debugging output.)

virtual void vtkDelaunay3D::BoundingTriangulationOff ( ) [virtual]

Boolean controls whether bounding triangulation points (and associated triangles) are included in the output. (These are introduced as an initial triangulation to begin the triangulation process. This feature is nice for debugging output.)

void vtkDelaunay3D::SetLocator ( vtkPointLocator * locator )

Set / get a spatial locator for merging points. By default, an instance of vtkPointLocator is used.

virtual vtkPointLocator* vtkDelaunay3D::GetLocator ( ) [virtual]

Set / get a spatial locator for merging points. By default, an instance of vtkPointLocator is used.

void vtkDelaunay3D::CreateDefaultLocator ( )

Create default locator. Used to create one when none is specified. The locator is used to eliminate "coincident" points.

vtkUnstructuredGrid* vtkDelaunay3D::InitPointInsertion	(	double	center[3],
		double	length,
		vtkIdType	numPts,
		vtkPoints *&	pts
	)

This is a helper method used with InsertPoint() to create tetrahedronalizations of points. Its purpose is construct an initial Delaunay triangulation into which to inject other points. You must specify the center of a cubical bounding box and its length, as well as the number of points to insert. The method returns a pointer to an unstructured grid. Use this pointer to manipulate the mesh as necessary. You must delete (with Delete()) the mesh when done. Note: This initialization method places points forming bounding octahedron at the end of the Mesh's point list. That is, InsertPoint() assumes that you will be inserting points between (0,numPtsToInsert-1).

void vtkDelaunay3D::InsertPoint	(	vtkUnstructuredGrid *	Mesh,
		vtkPoints *	points,
		vtkIdType	id,
		double	x[3],
		vtkIdList *	holeTetras
	)

This is a helper method used with InitPointInsertion() to create tetrahedronalizations of points. Its purpose is to inject point at coordinates specified into tetrahedronalization. The point id is an index into the list of points in the mesh structure. (See vtkDelaunay3D::InitPointInsertion() for more information.) When you have completed inserting points, traverse the mesh structure to extract desired tetrahedra (or tetra faces and edges).The holeTetras id list lists all the tetrahedra that are deleted (invalid) in the mesh structure.

void vtkDelaunay3D::EndPointInsertion ( )

Invoke this method after all points have been inserted. The purpose of the method is to clean up internal data structures. Note that the (vtkUnstructuredGrid *)Mesh returned from InitPointInsertion() is NOT deleted, you still are responsible for cleaning that up.

unsigned long vtkDelaunay3D::GetMTime ( ) [virtual]

Return the MTime also considering the locator.

Reimplemented from vtkObject.

int vtkDelaunay3D::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

This is called by the superclass. This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

int vtkDelaunay3D::FindTetra	(	vtkUnstructuredGrid *	Mesh,
		double	x[3],
		vtkIdType	tetId,
		int	depth
	)			`[protected]`

int vtkDelaunay3D::InSphere	(	double	x[3],
		vtkIdType	tetraId
	)			`[protected]`

void vtkDelaunay3D::InsertTetra	(	vtkUnstructuredGrid *	Mesh,
		vtkPoints *	pts,
		vtkIdType	tetraId
	)			`[protected]`

vtkIdType vtkDelaunay3D::FindEnclosingFaces	(	double	x[3],
		vtkUnstructuredGrid *	Mesh,
		vtkIdList *	tetras,
		vtkIdList *	faces,
		vtkPointLocator *	Locator
	)			`[protected]`

virtual int vtkDelaunay3D::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 vtkUnstructuredGridAlgorithm.