# Difference between revisions of "VTK/Polyhedron Support"

(17 intermediate revisions by the same user not shown) | |||

Line 1: | Line 1: | ||

'''Overview''' | '''Overview''' | ||

This work extends VTK to support polyhedron cells. This new cell type can be applied to computational fluid dynamics (CFD) and other similar applications. The work consists of two parts: | This work extends VTK to support polyhedron cells. This new cell type can be applied to computational fluid dynamics (CFD) and other similar applications. The work consists of two parts: | ||

*Support of the new polyhedron cell type including: | |||

** A new cell class called vtkPolyhedron that implements common APIs of vtkCell3D. | |||

** Extended vtkUnstructuredGrid for storing and accessing this new cell type. | |||

** Modified vtkXMLUnstructuredGridReader/Writer for I/O of polyhedron meshes. | |||

*Implementation of mean value coordinates (MVC) interpolation method as a filter called vtkMeanValueCoordinateInterpolator. This filter is used in vtkPolyhedron as well as in vtkProbePolyhedron for smoothly interpolating/extrapolating point attributes (scalars, vectors, etc.) at a given point interior, exterior or on the surface of polyhedron cells. | |||

'''Polyhedron Cell Support''' | '''Polyhedron Cell Support''' | ||

''A new 3D cell class vtkPolyhedron'' | ''A new 3D cell class vtkPolyhedron'' | ||

Line 19: | Line 24: | ||

*Clip: this function clips the input polyhedron and outputs a new polyhedron. A clipping result is shown in Fig. 1. | *Clip: this function clips the input polyhedron and outputs a new polyhedron. A clipping result is shown in Fig. 1. | ||

[[Image:PolyhedronClipping.png|center|thumb|800px|Fig.1 Clipping a polyhedron mesh.]] | |||

Fig.1 Clipping a polyhedron mesh. | |||

''Polyhedron cells as face streams in vtkUnstructuredGrid'' | |||

Similar to other 3D cells of VTK such as vtkTetra and vtkHexahedron, vtkPolyhedrons--defined as VTK_POLYHEDRON type in vtkCellTypes.h--are stored as cell elements in vtkUnstructuredGrid. However, previous 3D cells are regular ones whose geometries are fully determined by a set of vertex points with predefined implicit ordering. Unfortunately, such an implicit ordering does not exist in polyhedron cells, the connectivities between polyhedron vertices need to be explicitly defined. The extended vtkUnstructuredGrid stores polyhedron cells as face streams of the following format: | |||

[numberOfCellFaces, (numberOfPointsOfFace0, pointId0, pointId1, … ), (numberOfPointsOfFace1, pointId0, pointId1, …), … ]. | |||

vtkIdType InsertNextCell(int cellType, vtkIdType nPoints, vtkIdType *pointIds, vtkIdType nFaces, vtkIdType*faceStream) | To insert a polyhedron cell into an unstructured grid, the user can use InsertNextCell with a new set of parameter (see below). Where cellType is the type of cell (VTK_POLYHEDRON), nPoints is the number of unique points in the cell, PointIds is the list of the unique cell point Ids, nFaces is the number of faces in the cell, and faces is the face stream defined above but without the numberOfCellFaces element | ||

[(numberOfPointsOfFace0, pointId0, pointId1, … ),(numberOfPointsOfFace1, pointId0, pointId1, …),… ]. | |||

For instance, a cube has 8 unique points but each point Id will be repeated three times (in three adjacent faces) in the face stream. | |||

vtkIdType InsertNextCell(int cellType, vtkIdType nPoints, vtkIdType *pointIds, vtkIdType nFaces, vtkIdType*faceStream) | |||

The user can also insert polyhedron cells using InsertNextCell with the old parameter types. But note that the parameters need to be provided in a different format than regular cells. Here faceStream is the face stream without the numberOfCellFaces element, and faceStream1 is the complete face-stream. | The user can also insert polyhedron cells using InsertNextCell with the old parameter types. But note that the parameters need to be provided in a different format than regular cells. Here faceStream is the face stream without the numberOfCellFaces element, and faceStream1 is the complete face-stream. | ||

vtkIdType InsertNextCell(int cellType, vtkIdType nFaces, vtkIdType *faceStream) | vtkIdType InsertNextCell(int cellType, vtkIdType nFaces, vtkIdType *faceStream) | ||

vtkIdType InsertNextCell(int cellType, vtkIdList *faceStream1) | |||

vtkIdType InsertNextCell(int cellType, vtkIdList *faceStream1) | |||

To get a polyhedron cell from vtkUnstructuredGrid, the user can use | To get a polyhedron cell from vtkUnstructuredGrid, the user can use | ||

void GetFaceStream(vtkIdType cellId, vtkIdType& nFaces, vtkIdType* &faceStream) | void GetFaceStream(vtkIdType cellId, vtkIdType& nFaces, vtkIdType* &faceStream) | ||

void GetFaceStream(vtkIdType cellId, vtkIdList *faceStream1) | |||

IO of polyhedron cells through vtkXMLUnstructuredGridReader/Writer | void GetFaceStream(vtkIdType cellId, vtkIdList *faceStream1) | ||

''IO of polyhedron cells through vtkXMLUnstructuredGridReader/Writer'' | |||

Meshes containing polyhedron cells can be read from and write into a XML (.vtm) file using vtkXMLUnstructuredGridReader/Writer. To represent the vertex connectivity of polyhedron cells, we added two additional XML sub-fields to the cells field. | Meshes containing polyhedron cells can be read from and write into a XML (.vtm) file using vtkXMLUnstructuredGridReader/Writer. To represent the vertex connectivity of polyhedron cells, we added two additional XML sub-fields to the cells field. | ||

The original cells field consists of three sub-fields: | *The original cells field consists of three sub-fields: | ||

** ''connectivity'': an array storing the point Ids of the unique points of all cells. | |||

** ''offsets'': an array indicating the end position (1-indexed) of each cell in the connectivity array. | |||

** ''types'': an array storing the types of each cell. | |||

The new sub-fields are | *The new sub-fields are: | ||

** ''faces'': an array storing the face streams of all the cells and | |||

** ''faceoffsets'': an array indicating the end position (1-indexed) of each cell in the faces array. Each cell in the faces array is represented using the face stream described earlier (with numberOfCellFaces). | |||

These new sub-fields are optional. When a mesh does not contain any polyhedron cell, the new sub-fields will not be included in the XML (.vtm) file. | These new sub-fields are optional. When a mesh does not contain any polyhedron cell, the new sub-fields will not be included in the XML (.vtm) file. | ||

3D Mean Value Coordinates Interpolation | '''3D Mean Value Coordinates Interpolation''' | ||

3D mean value coordinates (MVC) interpolation is an elegant yet efficient method for smoothly interpolating closed manifold polyhedrons. Given an input polyhedron with vertices | 3D mean value coordinates (MVC) interpolation is an elegant yet efficient method for smoothly interpolating closed manifold polyhedrons. Given an input polyhedron with vertices <math>v_i</math> (i=1,…,n) and a interpolation point <math>x</math>, the MVC interpolation weights of the vertices <math>w_i</math> satisfy the following four preferred properties. (Strictly speaking, positivity property is only valid for convex polyhedrons, the other three properties are valid for both convex and concave polyhedrons). The interpolation/extrapolation point x can be interior, exterior or on the boundary of the input polyhedrons. | ||

**Affine invariance: <math>\sum W_{i}=1</math> | |||

**Linear reproduction: <math>\sum W_{i} V_i= X</math> | |||

**Positivity: <math>W_{i} >=0 </math> | |||

**Smoothness: <math>W_{i} </math> at least C1 continuous. | |||

vtkMeanValueCoordinatesInterpolator filter implements two specific MVC algorithms. The first one is specialized/optimized for tetrahedral meshes [1]. The second one is for general polyhedron meshes [2]. The filter will detect whether the input mesh is tetrahedralized then automatically choose the right algorithm. Details about the two algorithms can be found in the referenced papers. A result of interpolating/extrapolating a hemisphere polyhedron mesh onto a planar mesh is presented in Fig. 2. | vtkMeanValueCoordinatesInterpolator filter implements two specific MVC algorithms. The first one is specialized/optimized for tetrahedral meshes [1]. The second one is for general polyhedron meshes [2]. The filter will detect whether the input mesh is tetrahedralized then automatically choose the right algorithm. Details about the two algorithms can be found in the referenced papers. A result of interpolating/extrapolating a hemisphere polyhedron mesh onto a planar mesh is presented in Fig. 2. | ||

[[Image:MVCInterpolation.png|center|thumb|400px|Fig. 2. MVC interpolation. Vertex colors are defined on the hemisphere (input polyhedron mesh) and are interpolated/extrapolated onto a planar mesh passing through the bottom of the hemisphere. The left and right images respectively show the interpolation result viewed from both sides of the planar mesh.]] | |||

Fig. 2. MVC interpolation. Vertex colors are defined on the hemisphere (input polyhedron mesh) and are interpolated/extrapolated onto a planar mesh passing through the bottom of the hemisphere. The left and right images respectively show the interpolation result viewed from both sides of the planar mesh. | |||

'''References''' | |||

[1] Tao Ju, Scott Schaefer, and Joe Warrent, "Mean Value Coordinates for Closed Triangular Meshes", ACM SIGGRAPH 2005. | [1] Tao Ju, Scott Schaefer, and Joe Warrent, "Mean Value Coordinates for Closed Triangular Meshes", ACM SIGGRAPH 2005. | ||

[2] Torsten Langer, Alexander Belyaev, and Hans-Peter Seidel, "Spherical Barycentric Coordinates", Eurographics Symposium on Geometry Processing (2006). | [2] Torsten Langer, Alexander Belyaev, and Hans-Peter Seidel, "Spherical Barycentric Coordinates", Eurographics Symposium on Geometry Processing (2006). | ||

'''Contacts''' | |||

''' | *Will Schroeder: will(dot)schroeder(at)kitware(dot)com | ||

*Hua Yang: hua(dot)yang(at)kitware(dot)com | |||

* | |||

* | |||

## Latest revision as of 17:32, 13 July 2010

**Overview**

This work extends VTK to support polyhedron cells. This new cell type can be applied to computational fluid dynamics (CFD) and other similar applications. The work consists of two parts:

- Support of the new polyhedron cell type including:
- A new cell class called vtkPolyhedron that implements common APIs of vtkCell3D.
- Extended vtkUnstructuredGrid for storing and accessing this new cell type.
- Modified vtkXMLUnstructuredGridReader/Writer for I/O of polyhedron meshes.

- Implementation of mean value coordinates (MVC) interpolation method as a filter called vtkMeanValueCoordinateInterpolator. This filter is used in vtkPolyhedron as well as in vtkProbePolyhedron for smoothly interpolating/extrapolating point attributes (scalars, vectors, etc.) at a given point interior, exterior or on the surface of polyhedron cells.

**Polyhedron Cell Support**

*A new 3D cell class vtkPolyhedron*

vtkPolyhedron represents a 3D polyhedron cell defined by a set of polygon faces. Both convex and concave polyhedrons are supported. However the polyhedrons need to be watertight, non-self-intersecting and manifold (each edge is used exactly twice), and the face polygons needs to be planar. vtkPolyhedron is implemented as a subclass of vtkCell3D. All common API functions of vtkCell3D are implemented. A few critical functions are described briefly as follows.

- InterpolateFunctions, EvaluateLocation and EvaluatePosition: these three functions use vtkMeanValueCoordinateInterpolator to compute the interpolation weights of vertices of a polyhedron cell at any given point position. Note that the point can be interior, exterior or on the surface of the polyhedron cell.

- Triangulate: this function uses vtkOrderedTriangulator to tetrahedralize a polyhedron cell.

- IsInside: this function determines whether a point is inside the polyhedron by shooting rays in multiple random directions then counting the number of intersections with cell faces.

- Contour: this function computes the intersection between a contouring function and a polyhedron and outputs a polygonal contour. When the result contour is non-planar, it will be triangulated then outputs as a triangular mesh.

- Clip: this function clips the input polyhedron and outputs a new polyhedron. A clipping result is shown in Fig. 1.

*Polyhedron cells as face streams in vtkUnstructuredGrid*

Similar to other 3D cells of VTK such as vtkTetra and vtkHexahedron, vtkPolyhedrons--defined as VTK_POLYHEDRON type in vtkCellTypes.h--are stored as cell elements in vtkUnstructuredGrid. However, previous 3D cells are regular ones whose geometries are fully determined by a set of vertex points with predefined implicit ordering. Unfortunately, such an implicit ordering does not exist in polyhedron cells, the connectivities between polyhedron vertices need to be explicitly defined. The extended vtkUnstructuredGrid stores polyhedron cells as face streams of the following format:

[numberOfCellFaces, (numberOfPointsOfFace0, pointId0, pointId1, … ), (numberOfPointsOfFace1, pointId0, pointId1, …), … ].

To insert a polyhedron cell into an unstructured grid, the user can use InsertNextCell with a new set of parameter (see below). Where cellType is the type of cell (VTK_POLYHEDRON), nPoints is the number of unique points in the cell, PointIds is the list of the unique cell point Ids, nFaces is the number of faces in the cell, and faces is the face stream defined above but without the numberOfCellFaces element

[(numberOfPointsOfFace0, pointId0, pointId1, … ),(numberOfPointsOfFace1, pointId0, pointId1, …),… ].

For instance, a cube has 8 unique points but each point Id will be repeated three times (in three adjacent faces) in the face stream.

vtkIdType InsertNextCell(int cellType, vtkIdType nPoints, vtkIdType *pointIds, vtkIdType nFaces, vtkIdType*faceStream)

The user can also insert polyhedron cells using InsertNextCell with the old parameter types. But note that the parameters need to be provided in a different format than regular cells. Here faceStream is the face stream without the numberOfCellFaces element, and faceStream1 is the complete face-stream.

vtkIdType InsertNextCell(int cellType, vtkIdType nFaces, vtkIdType *faceStream)

vtkIdType InsertNextCell(int cellType, vtkIdList *faceStream1)

To get a polyhedron cell from vtkUnstructuredGrid, the user can use

void GetFaceStream(vtkIdType cellId, vtkIdType& nFaces, vtkIdType* &faceStream)

void GetFaceStream(vtkIdType cellId, vtkIdList *faceStream1)

*IO of polyhedron cells through vtkXMLUnstructuredGridReader/Writer*

Meshes containing polyhedron cells can be read from and write into a XML (.vtm) file using vtkXMLUnstructuredGridReader/Writer. To represent the vertex connectivity of polyhedron cells, we added two additional XML sub-fields to the cells field.

- The original cells field consists of three sub-fields:
*connectivity*: an array storing the point Ids of the unique points of all cells.*offsets*: an array indicating the end position (1-indexed) of each cell in the connectivity array.*types*: an array storing the types of each cell.

- The new sub-fields are:
*faces*: an array storing the face streams of all the cells and*faceoffsets*: an array indicating the end position (1-indexed) of each cell in the faces array. Each cell in the faces array is represented using the face stream described earlier (with numberOfCellFaces).

These new sub-fields are optional. When a mesh does not contain any polyhedron cell, the new sub-fields will not be included in the XML (.vtm) file.

**3D Mean Value Coordinates Interpolation**

3D mean value coordinates (MVC) interpolation is an elegant yet efficient method for smoothly interpolating closed manifold polyhedrons. Given an input polyhedron with vertices (i=1,…,n) and a interpolation point , the MVC interpolation weights of the vertices satisfy the following four preferred properties. (Strictly speaking, positivity property is only valid for convex polyhedrons, the other three properties are valid for both convex and concave polyhedrons). The interpolation/extrapolation point x can be interior, exterior or on the boundary of the input polyhedrons.

- Affine invariance:
- Linear reproduction:
- Positivity:
- Smoothness: at least C1 continuous.

vtkMeanValueCoordinatesInterpolator filter implements two specific MVC algorithms. The first one is specialized/optimized for tetrahedral meshes [1]. The second one is for general polyhedron meshes [2]. The filter will detect whether the input mesh is tetrahedralized then automatically choose the right algorithm. Details about the two algorithms can be found in the referenced papers. A result of interpolating/extrapolating a hemisphere polyhedron mesh onto a planar mesh is presented in Fig. 2.

**References**

[1] Tao Ju, Scott Schaefer, and Joe Warrent, "Mean Value Coordinates for Closed Triangular Meshes", ACM SIGGRAPH 2005.

[2] Torsten Langer, Alexander Belyaev, and Hans-Peter Seidel, "Spherical Barycentric Coordinates", Eurographics Symposium on Geometry Processing (2006).

**Contacts**

- Will Schroeder: will(dot)schroeder(at)kitware(dot)com
- Hua Yang: hua(dot)yang(at)kitware(dot)com