Merge pull request #996 from dstl/example_thumbnails

Improve thumbnails in example gallery
dstl · Apr 26, 2024 · 990aa7c · 990aa7c
2 parents 0f9a749 + ad128fb
commit 990aa7c
Show file tree

Hide file tree

Showing 16 changed files with 21 additions and 1 deletion.
diff --git a/docs/examples/dataassociation/One_to_One_Associator.py b/docs/examples/dataassociation/One_to_One_Associator.py
@@ -150,6 +150,7 @@
 # The plot below shows the states. Source A states are shown with crosses and source B states are
 # shown with circles. Associations are shown by matching colours and lines between the states.
 
+# sphinx_gallery_thumbnail_number = 2
 plotter.fig
 
 # %%

diff --git a/docs/examples/filters/EnsembleFilterExample.py b/docs/examples/filters/EnsembleFilterExample.py
@@ -168,6 +168,8 @@
 # we plot each member of the ensembles. As usual, the ellipses represent the uncertainty in the
 # tracks.
 
+# sphinx_gallery_thumbnail_number = 3
+
 from stonesoup.types.hypothesis import SingleHypothesis
 from stonesoup.types.track import Track
 

diff --git a/docs/examples/metrics/Metrics.py b/docs/examples/metrics/Metrics.py
@@ -495,6 +495,8 @@
 # We now plot the sum of covariance norms metrics for both trackers. We plot the
 # metrics separately and specify additional keyword arguments to customise the plot.
 
+# sphinx_gallery_thumbnail_number = 7
+
 graph = MetricPlotter()
 graph.plot_metrics(metrics, generator_names=['sum_cov_norms_EKF',
                                              'sum_cov_norms_PF'],

diff --git a/docs/examples/oosm/KalmanFilterOOSMExample.py b/docs/examples/oosm/KalmanFilterOOSMExample.py
@@ -323,3 +323,4 @@
 #        Multi-target out-of-sequence data association: Tracking using
 #        graphical models, Information Fusion.
 
+# sphinx_gallery_thumbnail_path = '_static/sphinx_gallery/OOSM_Kalman_Thumb.png'
diff --git a/docs/examples/oosm/PF_OOSM_example.py b/docs/examples/oosm/PF_OOSM_example.py
@@ -328,3 +328,5 @@
 #
 # .. [#] M. Orton and A. Marrs, 2001, A Bayesian approach to multi-target tracking and data fusion
 #        with out-of-sequence measurements, IEE Target Tracking: Algorithms and Applications.
+
+# sphinx_gallery_thumbnail_path = '_static/sphinx_gallery/OOSM_Particle_Thumb.png'
diff --git a/docs/examples/oosm/example_oosm_algorithm.py b/docs/examples/oosm/example_oosm_algorithm.py
@@ -405,4 +405,5 @@
 #        Multi-target out-of-sequence data association: Tracking using
 #        graphical models, Information Fusion.
 #
-# # sphinx_gallery_thumbnail_number = 1
+
+# sphinx_gallery_thumbnail_path = '_static/sphinx_gallery/OOSM_inv_time_Thumb.png'
diff --git a/docs/examples/oosm/example_simple_oosm.py b/docs/examples/oosm/example_simple_oosm.py
@@ -287,3 +287,5 @@
 # .. [#] S. R. Maskell, R. G. Everitt, R. Wright, M. Briers, 2005,
 #        Multi-target out-of-sequence data association: Tracking using
 #        graphical models, Information Fusion.
+
+# sphinx_gallery_thumbnail_path = '_static/sphinx_gallery/OOSM_simple_Thumb.png'
diff --git a/docs/examples/plotting/Polar_Plotting.py b/docs/examples/plotting/Polar_Plotting.py
@@ -171,6 +171,8 @@
 # %%
 # Azimuth Angle (Degrees) vs Range (m)
 # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+# sphinx_gallery_thumbnail_number = 4
 plotter_az_r = PolarPlotterly(title="Azimuth Angle (Degrees) vs Range (m)")
 mapping = [0, 1]
 plotter_az_r.plot_ground_truths({angular_ground_truth_1}, mapping=mapping, truths_label="Target 1")

diff --git a/docs/examples/plotting/density_plot_example.py b/docs/examples/plotting/density_plot_example.py
@@ -76,6 +76,9 @@ def generate_ground_truth_path(initial_state, num_steps=20, motion_model_noise=0
 # The function allows you to pick an index of the state sequence (ground truth in this example) to
 # plot. In this example we're only interested in the final state of the sequences. An index of '-1'
 # is the last state in the sequence. The resultant plot is much more spread out.
+
+# sphinx_gallery_thumbnail_number = 4
+
 plotter = Plotter()
 plotter.plot_density(truths, index=-1)
 

diff --git a/docs/examples/readers/Custom_Pandas_Dataloader.py b/docs/examples/readers/Custom_Pandas_Dataloader.py
@@ -293,3 +293,5 @@ def detections_gen(self):
 # read any type of data supported by the pandas library, which gives us a huge range of
 # options. This strategy also saves us the overhead of manually specifying custom Stone
 # Soup Reader classes for each format of data.
+
+# sphinx_gallery_thumbnail_path = '_static/sphinx_gallery/pandas_thumb.png'
diff --git a/docs/examples/readers/README.rst b/docs/examples/readers/README.rst
@@ -0,0 +1,2 @@
+Readers
+-------
diff --git a/docs/source/_static/sphinx_gallery/OOSM_Kalman_Thumb.png b/docs/source/_static/sphinx_gallery/OOSM_Kalman_Thumb.png
diff --git a/docs/source/_static/sphinx_gallery/OOSM_Particle_Thumb.png b/docs/source/_static/sphinx_gallery/OOSM_Particle_Thumb.png
diff --git a/docs/source/_static/sphinx_gallery/OOSM_inv_time_Thumb.png b/docs/source/_static/sphinx_gallery/OOSM_inv_time_Thumb.png
diff --git a/docs/source/_static/sphinx_gallery/OOSM_simple_Thumb.png b/docs/source/_static/sphinx_gallery/OOSM_simple_Thumb.png
diff --git a/docs/source/_static/sphinx_gallery/pandas_thumb.png b/docs/source/_static/sphinx_gallery/pandas_thumb.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -323,3 +323,4 @@
		# Multi-target out-of-sequence data association: Tracking using
		# graphical models, Information Fusion.

		# sphinx_gallery_thumbnail_path = '_static/sphinx_gallery/OOSM_Kalman_Thumb.png'