Merge pull request #530 from nontas/widgets_improvements

Visualization and Widgets upgrade
menpo · Jan 28, 2015 · 5e1d05b · 5e1d05b
2 parents 433df01 + fd65d2e
commit 5e1d05b
Show file tree

Hide file tree

Showing 70 changed files with 11,813 additions and 6,505 deletions.
diff --git a/docs/source/api/menpo/feature/features_selection_widget.rst b/docs/source/api/menpo/feature/features_selection_widget.rst
@@ -0,0 +1,7 @@
+.. _menpo-feature-features_selection_widget:
+
+.. currentmodule:: menpo.feature
+
+features_selection_widget
+=========================
+.. autofunction:: features_selection_widget
diff --git a/docs/source/api/menpo/feature/index.rst b/docs/source/api/menpo/feature/index.rst
@@ -17,4 +17,13 @@
   igo
   imgfeature
   daisy
-  ndfeature
+  ndfeature
+
+
+Widget
+------
+
+.. toctree::
+   :maxdepth: 1
+
+  features_selection_widget
diff --git a/docs/source/api/menpo/landmark/OrderedDict.rst b/docs/source/api/menpo/landmark/OrderedDict.rst
@@ -0,0 +1,10 @@
+.. _menpo-landmark-OrderedDict:
+
+.. currentmodule:: menpo.landmark
+
+OrderedDict
+===========
+.. autoclass:: OrderedDict
+  :members:
+  :inherited-members:
+  :show-inheritance:
diff --git a/docs/source/api/menpo/landmark/index.rst b/docs/source/api/menpo/landmark/index.rst
@@ -6,35 +6,98 @@
 .. toctree::
    :maxdepth: 1
 
-  ibug_face_51
-  ibug_face_49
+
+Abstract Classes
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
+  Landmarkable
+  LandmarkableViewable
   LabellingError
-  ibug_close_eye_trimesh
-  ibug_face_66
-  ibug_face_68
-  stickmen_pose
-  ibug_face_65_closed_mouth
-  ibug_open_eye
+
+
+Landmarks & Labeller
+--------------------
+
+.. toctree::
+   :maxdepth: 1
+
+  LandmarkGroup
   LandmarkManager
   labeller
+
+
+Face Labels
+-----------
+
+.. toctree::
+   :maxdepth: 2
+
+  ibug_face_49
+  ibug_face_51
+  ibug_face_66
+  ibug_face_68
   ibug_face_68_trimesh
-  flic_pose
-  streetscene_car_view_3
-  streetscene_car_view_2
-  streetscene_car_view_1
-  streetscene_car_view_7
-  streetscene_car_view_6
-  streetscene_car_view_5
-  streetscene_car_view_4
-  ibug_hand
-  ibug_tongue
-  LandmarkGroup
+  ibug_face_65_closed_mouth
   imm_face
   lfpw_face
+  bu3dfe_83
+
+
+Eyes Labels
+-----------
+
+.. toctree::
+   :maxdepth: 1
+
+  ibug_open_eye
+  ibug_open_eye_trimesh
+  ibug_close_eye_trimesh
   ibug_close_eye_points
+
+
+Hands Labels
+------------
+
+.. toctree::
+   :maxdepth: 1
+
+  ibug_hand
+
+
+Pose Labels
+-----------
+
+.. toctree::
+   :maxdepth: 1
+
+  stickmen_pose
+  flic_pose
   lsp_pose
+
+
+Car Labels
+----------
+
+.. toctree::
+   :maxdepth: 1
+
   streetscene_car_view_0
-  Landmarkable
-  LandmarkableViewable
-  ibug_open_eye_trimesh
-  bu3dfe_83
+  streetscene_car_view_1
+  streetscene_car_view_2
+  streetscene_car_view_3
+  streetscene_car_view_4
+  streetscene_car_view_5
+  streetscene_car_view_6
+  streetscene_car_view_7
+
+
+Tongue Labels
+-------------
+
+.. toctree::
+   :maxdepth: 1
+
+  ibug_tongue
diff --git a/docs/source/api/menpo/math/index.rst b/docs/source/api/menpo/math/index.rst
@@ -3,11 +3,34 @@
 :mod:`menpo.math`
 =================
 
+.. toctree::
+   :maxdepth: 1
+
+
+Decomposition
+-------------
+
 .. toctree::
    :maxdepth: 1
 
   eigenvalue_decomposition
-  dot_inplace_right
   principal_component_decomposition
+
+
+Linear Algebra
+--------------
+
+.. toctree::
+   :maxdepth: 1
+
+  dot_inplace_right
   dot_inplace_left
+
+
+Convolution
+-----------
+
+.. toctree::
+   :maxdepth: 1
+
   log_gabor
diff --git a/docs/source/api/menpo/shape/PointGraph.rst b/docs/source/api/menpo/shape/PointGraph.rst
@@ -0,0 +1,10 @@
+.. _menpo-shape-PointGraph:
+
+.. currentmodule:: menpo.shape
+
+PointGraph
+==========
+.. autoclass:: PointGraph
+  :members:
+  :inherited-members:
+  :show-inheritance:
diff --git a/docs/source/api/menpo/shape/index.rst b/docs/source/api/menpo/shape/index.rst
@@ -3,6 +3,13 @@
 :mod:`menpo.shape`
 ==================
 
+.. toctree::
+   :maxdepth: 1
+
+
+PointCloud
+--------------------
+
 .. toctree::
    :maxdepth: 1
 

diff --git a/docs/source/api/menpo/visualize/GraphPlotter.rst b/docs/source/api/menpo/visualize/GraphPlotter.rst
@@ -0,0 +1,10 @@
+.. _menpo-visualize-GraphPlotter:
+
+.. currentmodule:: menpo.visualize
+
+GraphPlotter
+============
+.. autoclass:: GraphPlotter
+  :members:
+  :inherited-members:
+  :show-inheritance:
diff --git a/docs/source/api/menpo/visualize/ImageViewer.rst b/docs/source/api/menpo/visualize/ImageViewer.rst
@@ -0,0 +1,10 @@
+.. _menpo-visualize-ImageViewer:
+
+.. currentmodule:: menpo.visualize
+
+ImageViewer
+===========
+.. autoclass:: ImageViewer
+  :members:
+  :inherited-members:
+  :show-inheritance:
diff --git a/...pi/menpo/visualize/PointCloudViewer2d.rst → ...pi/menpo/visualize/MatplotlibRenderer.rst b/...pi/menpo/visualize/PointCloudViewer2d.rst → ...pi/menpo/visualize/MatplotlibRenderer.rst
@@ -1,10 +1,10 @@
-.. _menpo-visualize-PointCloudViewer2d:
+.. _menpo-visualize-MatplotlibRenderer:
 
 .. currentmodule:: menpo.visualize
 
-PointCloudViewer2d
+MatplotlibRenderer
 ==================
-.. autoclass:: PointCloudViewer2d
+.. autoclass:: MatplotlibRenderer
   :members:
   :inherited-members:
   :show-inheritance:
diff --git a/docs/source/api/menpo/visualize/Renderer.rst b/docs/source/api/menpo/visualize/Renderer.rst
@@ -0,0 +1,10 @@
+.. _menpo-visualize-Renderer:
+
+.. currentmodule:: menpo.visualize
+
+Renderer
+========
+.. autoclass:: Renderer
+  :members:
+  :inherited-members:
+  :show-inheritance:
diff --git a/docs/source/api/menpo/visualize/features_selection.rst b/docs/source/api/menpo/visualize/features_selection.rst
@@ -0,0 +1,7 @@
+.. _menpo-visualize-features_selection:
+
+.. currentmodule:: menpo.visualize
+
+features_selection
+==================
+.. autofunction:: features_selection
diff --git a/docs/source/api/menpo/visualize/index.rst b/docs/source/api/menpo/visualize/index.rst
@@ -6,16 +6,50 @@
 .. toctree::
    :maxdepth: 1
 
-  LandmarkViewer
-  visualize_shapes
+
+Abstract Classes
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
+  Renderer
+  Viewable
+  MatplotlibRenderer
+
+
+Viewers
+-------
+
+.. toctree::
+   :maxdepth: 1
+
+  PointCloudViewer
   PointGraphViewer
-  AlignmentViewer2d
+  LandmarkViewer
   TriMeshViewer
-  PointCloudViewer
-  Viewable
-  LandmarkViewer2d
-  progress_bar_str
-  ImageViewer2d
+  ImageViewer
+
+
+Widgets
+-------
+
+.. toctree::
+   :maxdepth: 1
+
   visualize_images
+  visualize_landmarks
+  visualize_landmarkgroups
+  visualize_pointclouds
+  features_selection
+  save_matplotlib_figure
+
+
+Text Utils
+----------
+
+.. toctree::
+   :maxdepth: 1
+
   print_dynamic
-  PointCloudViewer2d
+  progress_bar_str
diff --git a/docs/source/api/menpo/visualize/save_matplotlib_figure.rst b/docs/source/api/menpo/visualize/save_matplotlib_figure.rst
@@ -0,0 +1,7 @@
+.. _menpo-visualize-save_matplotlib_figure:
+
+.. currentmodule:: menpo.visualize
+
+save_matplotlib_figure
+======================
+.. autofunction:: save_matplotlib_figure
diff --git a/docs/source/api/menpo/visualize/visualize_landmarkgroups.rst b/docs/source/api/menpo/visualize/visualize_landmarkgroups.rst
@@ -0,0 +1,7 @@
+.. _menpo-visualize-visualize_landmarkgroups:
+
+.. currentmodule:: menpo.visualize
+
+visualize_landmarkgroups
+========================
+.. autofunction:: visualize_landmarkgroups
diff --git a/docs/source/api/menpo/visualize/visualize_landmarks.rst b/docs/source/api/menpo/visualize/visualize_landmarks.rst
@@ -0,0 +1,7 @@
+.. _menpo-visualize-visualize_landmarks:
+
+.. currentmodule:: menpo.visualize
+
+visualize_landmarks
+===================
+.. autofunction:: visualize_landmarks
diff --git a/docs/source/api/menpo/visualize/visualize_pointclouds.rst b/docs/source/api/menpo/visualize/visualize_pointclouds.rst
@@ -0,0 +1,7 @@
+.. _menpo-visualize-visualize_pointclouds:
+
+.. currentmodule:: menpo.visualize
+
+visualize_pointclouds
+=====================
+.. autofunction:: visualize_pointclouds
diff --git a/docs/source/api/menpo/visualize/visualize_shapes.rst b/docs/source/api/menpo/visualize/visualize_shapes.rst