Documentation: Made the ROI's interactive for example.

examples/plotting/ROI_insets.py

@@ -6,6 +6,8 @@
 ROI's can be powerful tools to help visualize data.  In this case we will define ROI's in hyperspy, sum
 the data within the ROI, and then plot the sum as a signal. Using the `matplotlib.figure.SubFigure` class
 we can create a custom layout to visualize and interact with the data.
+
+We can connect these ROI's using the :func:`hyperspy.api.interactive` function which allows us to move the ROI's and see the sum of the underlying data.
 """
 import matplotlib.pyplot as plt
 import hyperspy.api as hs
@@ -26,77 +28,56 @@
 r2 = hs.roi.RectangularROI(4, 4, 6, 6)
 r3 = hs.roi.RectangularROI(3, 7, 5, 9)
 
+navigator = s.sum(axis=(2, 3)).T  # create a navigator signal
+navigator.plot(fig=sub1, colorbar=False, axes_off=True, title="", plot_indices=False)
 
-s2 = r1(s).sum()
-s3 = r2(s).sum()
-s4 = r3(s).sum()
 
-navigator = s.sum(axis=(2, 3)).T  # create a navigator signal
+s2 = r1.interactive(s, navigation_signal=navigator, color="red")
+s3 = r2.interactive(s, navigation_signal=navigator, color="g")
+s4 = r3.interactive(s, navigation_signal=navigator, color="y")
 
-navigator.plot(fig=sub1, colorbar=False, axes_off=True, title="", plot_indices=False)
-s2.plot(fig=sub2, colorbar=False, axes_off=True, title="", plot_indices=False)
-s3.plot(fig=sub3, colorbar=False, axes_off=True, title="", plot_indices=False)
-s4.plot(fig=sub4, colorbar=False, axes_off=True, title="", plot_indices=False)
+s2_int = s2.sum()
+s3_int = s3.sum()
+s4_int = s4.sum()
 
-# Add ROI's to the navigator
+s2_int.plot(fig=sub2, colorbar=False, axes_off=True, title="", plot_indices=False)
+s3_int.plot(fig=sub3, colorbar=False, axes_off=True, title="", plot_indices=False)
+s4_int.plot(fig=sub4, colorbar=False, axes_off=True, title="", plot_indices=False)
 
-r1.add_widget(navigator, color="r")
-r2.add_widget(navigator, color="g")
-r3.add_widget(navigator, color="y")
+# Connect ROIS
+for s, s_int, roi in zip([s2, s3, s4], [s2_int, s3_int, s4_int],[r1,r2,r3]):
+    hs.interactive(
+        s.sum,
+        event=roi.events.changed,
+        recompute_out_event=None,
+        out=s_int,
+    )
 
 # Add Borders to the match the color of the ROI
 
-red_edge = hs.plot.markers.Squares(
+for signal,color, label  in zip([s2_int, s3_int, s4_int], ["r", "g", "y"], ["b.", "c.", "d."]):
+    edge =  hs.plot.markers.Squares(
     offset_transform="axes",
     offsets=(0.5, 0.5),
     units="width",
     widths=1,
-    color="r",
+    color=color,
     linewidth=5,
     facecolor="none",
-)
-s2.add_marker(red_edge)
+    )
 
-green_edge = hs.plot.markers.Squares(
-    offset_transform="axes",
-    offsets=(0.5, 0.5),
-    units="width",
-    widths=1,
-    color="g",
-    linewidth=5,
-    facecolor="none",
-)
-s3.add_marker(green_edge)
+    signal.add_marker(edge)
 
-yellow_edge = hs.plot.markers.Squares(
-    offset_transform="axes",
-    offsets=(0.5, 0.5),
-    units="width",
-    widths=1,
-    color="y",
-    linewidth=5,
-    facecolor="none",
-)
-
-s4.add_marker(yellow_edge)
+    label = hs.plot.markers.Texts(
+    texts=(label,), offsets=[[0.85, 0.85]], offset_transform="axes", sizes=2, color="w"
+    )
+    signal.add_marker(label)
 
-# Label the insets
+# Label the big plot
 
 label = hs.plot.markers.Texts(
     texts=("a.",), offsets=[[0.9, 0.9]], offset_transform="axes", sizes=10, color="w"
-)
+    )
 navigator.add_marker(label)
-label = hs.plot.markers.Texts(
-    texts=("b.",), offsets=[[0.8, 0.8]], offset_transform="axes", sizes=3, color="w"
-)
-s2.add_marker(label)
-label = hs.plot.markers.Texts(
-    texts=("c.",), offsets=[[0.8, 0.8]], offset_transform="axes", sizes=3, color="w"
-)
-s3.add_marker(label)
-label = hs.plot.markers.Texts(
-    texts=("d.",), offsets=[[0.8, 0.8]], offset_transform="axes", sizes=3, color="w"
-)
-s4.add_marker(label)
 
 # %%

examples/plotting/custom_figure_layout.py

@@ -3,9 +3,9 @@
 Creating Custom Layouts
 =======================
 
-Custom layouts for hyperspy figures can be created using the `matplotlib.figure.SubFigure` class. Passing
-the `fig` argument to the `plot` method of a hyperspy signal object will target that figure instead of
-creating a new one. This is useful for creating custom layouts with multiple subplots.
+Custom layouts for hyperspy figures can be created using the :class:`matplotlib.figure.SubFigure` class. Passing
+the `fig` argument to the :func:`hyperspy.api.BaseSignal.plot` method of a hyperspy signal object will target
+that figure instead of creating a new one. This is useful for creating custom layouts with multiple subplots.
 """
 
 # Creating a simple layout with two subplots