From 52ed0100160b9a038608bfb72968a38b98bcd345 Mon Sep 17 00:00:00 2001
From: salinasd <salinasd@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Wed, 17 Dec 2014 12:34:37 +0000
Subject: doc + skbl example

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@370 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 275a355a9d88697bb42fa6f4c50cf9403906e588
---
 src/Contraction/doc/SO3_rips.png                 | Bin 0 -> 883320 bytes
 src/Contraction/doc/SO3_simplified.png           | Bin 0 -> 48126 bytes
 src/Contraction/doc/SO3points.png                | Bin 0 -> 62539 bytes
 src/Contraction/doc/so3.png                      | Bin 0 -> 137258 bytes
 src/Contraction/doc/so3.svg                      | 209 +++++++++++++++++++++++
 src/Contraction/doc/zoom.png                     | Bin 0 -> 39710 bytes
 src/Contraction/include/gudhi/Edge_contraction.h |  12 +-
 7 files changed, 216 insertions(+), 5 deletions(-)
 create mode 100644 src/Contraction/doc/SO3_rips.png
 create mode 100644 src/Contraction/doc/SO3_simplified.png
 create mode 100644 src/Contraction/doc/SO3points.png
 create mode 100644 src/Contraction/doc/so3.png
 create mode 100644 src/Contraction/doc/so3.svg
 create mode 100644 src/Contraction/doc/zoom.png

(limited to 'src/Contraction')

diff --git a/src/Contraction/doc/SO3_rips.png b/src/Contraction/doc/SO3_rips.png
new file mode 100644
index 00000000..60452f86
Binary files /dev/null and b/src/Contraction/doc/SO3_rips.png differ
diff --git a/src/Contraction/doc/SO3_simplified.png b/src/Contraction/doc/SO3_simplified.png
new file mode 100644
index 00000000..f70a1903
Binary files /dev/null and b/src/Contraction/doc/SO3_simplified.png differ
diff --git a/src/Contraction/doc/SO3points.png b/src/Contraction/doc/SO3points.png
new file mode 100644
index 00000000..0362d98f
Binary files /dev/null and b/src/Contraction/doc/SO3points.png differ
diff --git a/src/Contraction/doc/so3.png b/src/Contraction/doc/so3.png
new file mode 100644
index 00000000..e66acae1
Binary files /dev/null and b/src/Contraction/doc/so3.png differ
diff --git a/src/Contraction/doc/so3.svg b/src/Contraction/doc/so3.svg
new file mode 100644
index 00000000..adea3f38
--- /dev/null
+++ b/src/Contraction/doc/so3.svg
@@ -0,0 +1,209 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="744.09448819"
+   height="1052.3622047"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.48.4 r9939"
+   sodipodi:docname="so3.svg"
+   inkscape:export-filename="/home/dsalinas/Documents/CodeSVN/gudhi_depot/trunk/src/Contraction/doc/so3.png"
+   inkscape:export-xdpi="200.20428"
+   inkscape:export-ydpi="200.20428">
+  <defs
+     id="defs4">
+    <marker
+       inkscape:stockid="Arrow1Lend"
+       orient="auto"
+       refY="0.0"
+       refX="0.0"
+       id="Arrow1Lend"
+       style="overflow:visible;">
+      <path
+         id="path3888"
+         d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z "
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1.0pt;"
+         transform="scale(0.8) rotate(180) translate(12.5,0)" />
+    </marker>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="2.8"
+     inkscape:cx="302.8754"
+     inkscape:cy="816.37285"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="2560"
+     inkscape:window-height="1523"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1" />
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1">
+    <image
+       y="175.32289"
+       x="87.6194"
+       id="image3026"
+       xlink:href="file:///user/dsalinas/home/Documents/CodeSVN/gudhi_depot/trunk/src/Contraction/doc/SO3points.png"
+       height="107.55493"
+       width="121.70161" />
+    <image
+       y="174.31145"
+       x="250.86069"
+       id="image3037"
+       xlink:href="file:///user/dsalinas/home/Documents/CodeSVN/gudhi_depot/trunk/src/Contraction/doc/SO3_rips.png"
+       height="107.95626"
+       width="121.70161" />
+    <image
+       y="174.31216"
+       x="415.46198"
+       id="image3048"
+       xlink:href="file:///user/dsalinas/home/Documents/CodeSVN/gudhi_depot/trunk/src/Contraction/doc/SO3_simplified.png"
+       height="107.85593"
+       width="122.0026" />
+    <rect
+       style="color:#000000;fill:none;stroke:#000000;stroke-width:0.10033109;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+       id="rect3080-2"
+       width="27.49983"
+       height="26.862415"
+       x="160.74173"
+       y="176.24422" />
+    <image
+       y="124.78581"
+       x="168.92697"
+       id="image3077"
+       xlink:href="file:///user/dsalinas/home/Documents/CodeSVN/gudhi_depot/trunk/src/Contraction/doc/zoom.png"
+       height="59.596668"
+       width="60.499645" />
+    <rect
+       style="color:#000000;fill:none;stroke:#000000;stroke-width:0.20066218;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+       id="rect3080"
+       width="61.215229"
+       height="59.796326"
+       x="168.33478"
+       y="124.91287" />
+    <path
+       style="fill:none;stroke:#000000;stroke-width:0.20066218;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-end:url(#Arrow1Lend)"
+       d="m 163.59862,176.17779 c -2.13689,-4.88892 1.1683,-8.41755 4.60541,-9.6451"
+       id="path3879"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="cc" />
+    <text
+       xml:space="preserve"
+       style="font-size:6.70418215px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="151.0036"
+       y="300.44409"
+       id="text4507"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan4509"
+         x="152.07077"
+         y="300.44409"
+         style="text-align:center;text-anchor:middle">Point cloud sampling SO3 </tspan><tspan
+         sodipodi:role="line"
+         x="151.0036"
+         y="308.82431"
+         id="tspan4513"
+         style="text-align:center;text-anchor:middle">(points are in R but projected into R</tspan><tspan
+         sodipodi:role="line"
+         x="151.0036"
+         y="317.20456"
+         id="tspan4515"
+         style="text-align:center;text-anchor:middle">for vizualization)</tspan><tspan
+         sodipodi:role="line"
+         x="151.0036"
+         y="325.58478"
+         id="tspan4511"
+         style="text-align:center;text-anchor:middle" /></text>
+    <text
+       xml:space="preserve"
+       style="font-size:4.58914995px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="141.32632"
+       y="304.69067"
+       id="text4517"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan4519"
+         x="141.32632"
+         y="304.69067">9 </tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:4.58914995px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="210.88516"
+       y="304.76022"
+       id="text4521"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan4523"
+         x="210.88516"
+         y="304.76022">3</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:6.70418215px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="309.4176"
+       y="300.58682"
+       id="text4507-8"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         x="309.4176"
+         y="300.58682"
+         id="tspan4515-4"
+         style="text-align:center;text-anchor:middle">Rips complex built uppon these points</tspan><tspan
+         sodipodi:role="line"
+         x="309.4176"
+         y="308.96704"
+         style="text-align:center;text-anchor:middle"
+         id="tspan4599">20 millions simplices</tspan><tspan
+         sodipodi:role="line"
+         x="309.4176"
+         y="317.34729"
+         id="tspan4511-3"
+         style="text-align:center;text-anchor:middle" /></text>
+    <text
+       xml:space="preserve"
+       style="font-size:6.70418215px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="476.61395"
+       y="300.4592"
+       id="text4507-8-0"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         x="476.61395"
+         y="300.4592"
+         id="tspan4511-3-9"
+         style="text-align:center;text-anchor:middle">Simplicial complex obtained after simplification</tspan><tspan
+         sodipodi:role="line"
+         x="476.61395"
+         y="308.83942"
+         style="text-align:center;text-anchor:middle"
+         id="tspan4601">714 simplices</tspan></text>
+  </g>
+</svg>
diff --git a/src/Contraction/doc/zoom.png b/src/Contraction/doc/zoom.png
new file mode 100644
index 00000000..38d2b520
Binary files /dev/null and b/src/Contraction/doc/zoom.png differ
diff --git a/src/Contraction/include/gudhi/Edge_contraction.h b/src/Contraction/include/gudhi/Edge_contraction.h
index b5d85ae4..94638415 100644
--- a/src/Contraction/include/gudhi/Edge_contraction.h
+++ b/src/Contraction/include/gudhi/Edge_contraction.h
@@ -57,12 +57,14 @@ most operations needed (link computation, edge contraction and so on) have polyn
 The simplification can be done without enumerating the set of simplices that is often non tracktable in high-dimension and is then very efficient
 (sub-linear with regards to the number of simplices in practice).
 
-A typical application of this package for homology group computation and is illustrated in the next three figure where a Rips is built uppon a set of high-dimensional points.
-It has initially a huge number of simplices (todo) but simplifying it to a much reduced form with todo vertices takes only few seconds on a desktop machine.
+A typical application of this package for homology group computation and is illustrated in the next figure where a Rips is built uppon a set of high-dimensional points and
+simplified with edge contractions.
+It has initially a big number of simplices (around 20 millions) but simplifying it to a much reduced form with 15 vertices (and 714 simplices) takes only few seconds on a desktop machine (see the example bellow).
 One can then compute homology group with a simplicial complex of less than one hundred simplices instead of running the homology algorithm on the much bigger initial set of 
-simplices.
+simplices which would take much more time and memory.
 
 
+\image html "so3.png" "Edge contraction illustration" 
 
 \section Design
 
@@ -71,7 +73,7 @@ This class design is policy based and heavily inspired from the similar edge col
 
 \subsection Policies
 
-Four policies can be customized in this package.
+Four policies can be customized in this package:
 
 \li Cost_policy: specify how much cost an edge contraction of a given edge. The edge with lowest cost is iteratively picked and contracted if valid.
 \li Valid_contraction_policy: specify if a given edge contraction is valid. For instance, this policy can check the link condition which ensures that the homotopy type is preserved afer the edge contraction.
@@ -107,7 +109,7 @@ to simplices in an external map if storing information on simplices such
 as orientation is needed.
 
 
-\image html "sphere_contraction.png" "Time to simplify random 2-spheres to a tetrahedron" width=10cm
+\image html "sphere_contraction.png" "Time in seconds to simplify random 2-spheres to a tetrahedron" width=10cm
 
 \section Example
 
-- 
cgit v1.2.3