Update docs build

current/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8fc0022a04022d208c9f7eec51d04bd9
+config: 50c4115e39bd2203a736e3f92cb0f75e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

current/_downloads/00132bda28da71a5a986ed4cb33d6cf1/SpanROI_interactive_sum.ipynb

@@ -143,7 +143,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.9"
     }
   },
   "nbformat": 4,

current/_downloads/07ae15baa45bc560aaf1420e4b45c013/arrows.ipynb

@@ -67,7 +67,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.9"
     }
   },
   "nbformat": 4,

current/_downloads/1385e6594be55eee03c3bc687fbb7ef8/map_signal.py

@@ -0,0 +1,32 @@
+"""
+Create Map from ROI in signal space
+===================================
+
+Use the :func:`~.api.plot.plot_roi_map` function to create interactive maps defined
+from ROIs in signal space.
+
+"""
+
+import hyperspy.api as hs
+
+#%%
+# Create a signal:
+s = hs.data.two_gaussians()
+
+#%%
+# Add 2 ROIs in signal space and map the corresponding signal using :func:`~.api.plot.plot_roi_map`
+# The ROIs are added to the plot of the signal:
+s.plot()
+roi = hs.plot.plot_roi_map(s, rois=2)
+
+#%%
+# Same as above, but plotting the maps in a single figure:
+s.plot()
+roi = hs.plot.plot_roi_map(s, rois=2, single_figure=True)
+# Choose this figure as gallery thumbnail:
+# sphinx_gallery_thumbnail_number = 7
+
+#%%
+# Same as in previous step, but additionally specifying ``cmap`` and ``colors``:
+s.plot()
+roi = hs.plot.plot_roi_map(s, rois=2, color=["r", "b"], cmap="gray", single_figure=True)

current/_downloads/13ee3f520472f6867f436b8b9c4bc348/rectangles.ipynb

@@ -85,7 +85,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.9"
     }
   },
   "nbformat": 4,

current/_downloads/17c3a9e6fb7db955adf2d8c5870bc702/from_tabular_data.ipynb

@@ -125,7 +125,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.9"
     }
   },
   "nbformat": 4,

current/_downloads/185f8785ccea35af1bcf2896aedd5597/transforms_and_units.ipynb

@@ -103,7 +103,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.9"
     }
   },
   "nbformat": 4,

current/_downloads/1becff7a610aee42b57e8b026cbe1fd8/map_signal.ipynb

@@ -0,0 +1,115 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "\n# Create Map from ROI in signal space\n\nUse the :func:`~.api.plot.plot_roi_map` function to create interactive maps defined\nfrom ROIs in signal space.\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "import hyperspy.api as hs"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Create a signal:\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "s = hs.data.two_gaussians()"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Add 2 ROIs in signal space and map the corresponding signal using :func:`~.api.plot.plot_roi_map`\nThe ROIs are added to the plot of the signal:\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "s.plot()\nroi = hs.plot.plot_roi_map(s, rois=2)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Same as above, but plotting the maps in a single figure:\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "s.plot()\nroi = hs.plot.plot_roi_map(s, rois=2, single_figure=True)\n# Choose this figure as gallery thumbnail:\n# sphinx_gallery_thumbnail_number = 7"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Same as in previous step, but additionally specifying ``cmap`` and ``colors``:\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "s.plot()\nroi = hs.plot.plot_roi_map(s, rois=2, color=[\"r\", \"b\"], cmap=\"gray\", single_figure=True)"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": "Python 3",
+      "language": "python",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.11.9"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}

current/_downloads/1fe9a7b6d4e2c4b4682a04f3d6a365b0/map_signal_circleROI.ipynb

@@ -0,0 +1,97 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "\n# Create Map from CircleROI in signal space\n\nUse the :func:`~.api.plot.plot_roi_map` function to create interactive maps defined\nfrom a :class:`~.api.roi.CircleROI` in signal space.\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "import hyperspy.api as hs\nimport numpy as np"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Create a signal:\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "rng = np.random.default_rng(0)\ndata = rng.random(size=(100, 100, 50, 50))\ns = hs.signals.Signal2D(data)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Add 2 ROIs in signal space and map the corresponding signal using :func:`~.api.plot.plot_roi_map`.\nThe ROIs are added to the plot of the signal and by default a\n:class:`~.api.roi.RectangularROI` is used\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "s.plot()\nroi = hs.plot.plot_roi_map(s, rois=2)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Same as above but with using :class:`~.api.roi.CircleROI` with predefined position:\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "roi1 = hs.roi.CircleROI(cx=25, cy=25, r=5)\nroi2 = hs.roi.CircleROI(cx=25, cy=25, r=15, r_inner=10)\ns.plot()\nroi = hs.plot.plot_roi_map(s, rois=[roi1, roi2])\n# Choose this figure as gallery thumbnail:\n# sphinx_gallery_thumbnail_number = 6"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": "Python 3",
+      "language": "python",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.11.9"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}

current/_downloads/2902e504355b85195b282e1feb17f937/ragged_points.ipynb

@@ -67,7 +67,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.9"
     }
   },
   "nbformat": 4,

current/_downloads/3cf3ca628ceea0bcede72bf1abe09297/circles_color_radius.ipynb

@@ -85,7 +85,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.9"
     }
   },
   "nbformat": 4,