Add plotting and images to README and documentation (#12)

JeffLIrion · Feb 29, 2020 · fc1700d · fc1700d
1 parent 25a4cac
commit fc1700d
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -42,12 +42,16 @@ SE(3) Dataset
 
    >>> g = load_g2o_se3("parking-garage.g2o")
 
+   >>> g.plot(vertex_markersize=1)
+
    >>> g.calc_chi2()
 
    16720.020602489112
 
    >>> g.optimize()
 
+   >>> g.plot(vertex_markersize=1)
+
 
 **Output:**
 
@@ -63,6 +67,13 @@ SE(3) Dataset
            5               1.2395          -0.000091
 
 
++--------------------------------------+------------------------------------------------+
+| **Original**                         | **Optimized**                                  |
++--------------------------------------+------------------------------------------------+
+| .. image:: images/parking-garage.png | .. image:: images/parking-garage-optimized.png |
++--------------------------------------+------------------------------------------------+
+
+
 SE(2) Dataset
 ^^^^^^^^^^^^^
 
@@ -72,12 +83,16 @@ SE(2) Dataset
 
    >>> g = load_g2o_se2("input_INTEL.g2o")  # https://lucacarlone.mit.edu/datasets/
 
+   >>> g.plot()
+
    >>> g.calc_chi2()
 
    7191686.382493544
 
    >>> g.optimize()
 
+   >>> g.plot()
+
 
 **Output:**
 
@@ -94,6 +109,12 @@ SE(2) Dataset
            6             215.8405          -0.000000
 
 
++-----------------------------------+---------------------------------------------+
+| **Original**                      | **Optimized**                               |
++-----------------------------------+---------------------------------------------+
+| .. image:: images/input_INTEL.png | .. image:: images/input_INTEL-optimized.png |
++-----------------------------------+---------------------------------------------+
+
 References and Links
 --------------------
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -96,7 +96,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['images']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

diff --git a/docs/source/images/input_INTEL-optimized.png b/docs/source/images/input_INTEL-optimized.png
diff --git a/docs/source/images/input_INTEL.png b/docs/source/images/input_INTEL.png
diff --git a/docs/source/images/parking-garage-optimized.png b/docs/source/images/parking-garage-optimized.png
diff --git a/docs/source/images/parking-garage.png b/docs/source/images/parking-garage.png
diff --git a/images/input_INTEL-optimized.png b/images/input_INTEL-optimized.png
diff --git a/images/input_INTEL.png b/images/input_INTEL.png
diff --git a/images/parking-garage-optimized.png b/images/parking-garage-optimized.png
diff --git a/images/parking-garage.png b/images/parking-garage.png