Merge branch 'blender2.7'
[blender.git] / intern / dualcon / intern / readme.txt
1 PolyMender program for robustly repairing a polygonal model.
2
3 Author: Tao Ju (jutao@cs.wustl.edu)
4
5 Version: 1.6 (Updated: Oct. 12, 2006)
6
7 Platform: Windows
8
9
10 I. What's new in v1.6:
11
12
13 > Removal of disconnected components
14
15 > Topologically manifold dual contouring
16
17 > Output signed octree with geometry
18
19
20
21 II. Introduction
22
23
24 PolyMender is based on the algorithm presented in the paper "Robust Repair of Polygonal Models" (SIGGRAPH 2004). The program reads in a polygonal model (i.e., a bag of polygons) and produces a closed surface that approximates the original model. PolyMender consumes a small amount of time and memory space, and can accurately reproduce the original geometry. PolyMender is suitable for repairing CAD models and gigantic polygonal models. Alternatively, PolyMender can also be used to generate a signed volume from any polygonal models.
25
26
27
28 III. How to run
29
30
31 The executable package contains three programs:
32
33 1. PolyMender, PolyMender-clean
34
35 Purpose: repairs general purpose models, such as those created from range scanners. The repaired surface is constructed using Marching Cubes. Consumes minimal memory and time and generates closed, manifold triangular surfaces. The -clean option removes isolated pieces.
36
37 2. PolyMender-qd, PolyMender-qd-clean
38
39 Purpose: same as PolyMender and PolyMender-clean, but outputs a quad-mesh.
40
41 3. PolyMender-dc, PolyMender-dc-clean
42
43 Purpose: repairs models containing sharp features, such as CAD models. The repaired surface is constructed using Dual Contouring with a manifold topology, which is capable of reproducing sharp edges and corners. However, more memory is required. Generates closed triangular and quadrilateral surfaces. The -clean option removes isolated pieces.
44
45
46 Type the program names (e.g., PolyMender) on the DOS prompt and you will see their usages:
47
48 Usage:   PolyMender <input_file> <octree_depth> <scale> <output_file>
49
50 Example: PolyMender bunny.ply 6 0.9 closedbunny.ply
51
52 Description:
53
54 <input_file>    Polygonal file of format STL (binary only), ASC, or PLY.
55
56 <octree_depth>  Integer depth of octree. The dimension of the volumetric
57                 grid is 2^<octree_depth> on each side.
58
59 <scale>         Floating point number between 0 and 1 denoting the ratio of
60                 the largest dimension of the model over the size of the grid.
61
62 <output_file>   Output in polygonal format PLY or signed-octree format SOF (or SOG).
63
64
65 Additional notes:
66
67 1. STL(binary) is preferred input format, since the program does not need to store the model in memory at all. ASC or PLY formats require additional storage of vertices, due to their topology-geometry file structure.
68
69 2. The running time and memory consumption of the program depends on several factors: the number of input polygons, the depth of the octree, and the surface area of the model (hence the number of leaf nodes on the octree). To give an idea, processing the David model with 56 million triangles at depth 13 takes 45 minutes using 500 MB RAM (excluding the mem allocated for storing vertices when reading PLY format) on a PC with AMD 1.5Hz CPU.
70
71 3. The number of output polygons can be finely controlled using the scale argument. The large the scale, the more polygons are generated, since the model occupies a larger portion of the volume grid.
72
73 4. As an alternative of output repaired models, the intermediate signed octree can be generated as a SOF or SOG file. The signed octree can be used for generating signed distance field, extracting isosurfaces, or multiresolution spatial representation of the polygonal model.
74
75
76 IV SOF format
77
78 SOF (Signed Octree Format) records an octree grid with signes attached to the 8 corners of each leaf node. All leaf nodes appear at the same depth that is specified by the <octree_depth> argument to the program. The tree is recorded in SOF file using pre-order traversal. Here is the structure of a SOF file (binary):
79
80 <header>
81
82 <node>
83
84 <header> is a 4-bytes integer that equals 2 ^ octree_depth. The first byte of a <node> is either 0 (denoting an intermediate node) or 1 (denoting an empty node) or 2 (denoting a leaf node). After the first byte, an intermediate node <node> contains (after the first byte) eight <node> structures for its eight children; an empty node <node> contains one byte of value 0 or 1 denoting if it is inside or outside; and a leaf node contains one byte whose eight bits correspond to the signs at its eight corners (0 for inside and 1 for outside). The order of enumeration of the eight children nodes in an intermediate nodeis the following (expressed in coordinates <x,y,z> ): <0,0,0>,<0,0,1>,<0,1,0>,<0,1,1>,<1,0,0>,<1,0,1>,<1,1,0>,<1,1,1>. The enumeration of the eight corners in a leaf node follows the same order (e.g., the lowest bit records the sign at <0,0,0>).
85
86
87
88 V SOG format
89
90 SOF (Signed Octree with Geometry) has the same data structure with SOG, with the addition of following features:
91
92 1. The file starts with a 128-byte long header. Currently, the header begins with the string "SOG.Format 1.0" followed by 3 floats representing the lower-left-near corner of the octree follwed by 1 float denoting the length of the octree (in one direction). The locations and lengths are in the input model's coordinate space. The rest of the header is left empty.
93
94 2. Each leaf node has additioanl three floats {x,y,z} (following the signs) denoting the geometric location of a feature vertex within the cell.
95
96
97
98 VI Test data
99
100 Three models are included in the testmodels package. (Suggested arguments are provided in the parathesis).
101
102 bunny.ply (octree depth: 7, scale: 0.9)
103
104 - The Stanford Bunny (containing big holes at the bottom)
105
106 horse.stl (octree depth: 8, scale: 0.9)
107
108 - The horse model with 1/3 of all polygons removed and vertices randomly perturbed.
109
110 mechanic.asc (octree depth: 6, scale: 0.9)
111
112 - A mechanic part with hanging triangles