Update docs build

hyperspy · Oct 5, 2024 · 3c51115 · 3c51115
1 parent 9ff5219
commit 3c51115
Show file tree

Hide file tree

Showing 351 changed files with 5,850 additions and 1,138 deletions.
diff --git a/dev/_downloads/00132bda28da71a5a986ed4cb33d6cf1/SpanROI_interactive_sum.ipynb b/dev/_downloads/00132bda28da71a5a986ed4cb33d6cf1/SpanROI_interactive_sum.ipynb
@@ -143,7 +143,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/00d780175b5dd0fea70f958ff4bee948/from_tabular_data_file.zip b/dev/_downloads/00d780175b5dd0fea70f958ff4bee948/from_tabular_data_file.zip
diff --git a/dev/_downloads/05fedb0ac190395987edb1422768a796/from_tabular_data.zip b/dev/_downloads/05fedb0ac190395987edb1422768a796/from_tabular_data.zip
diff --git a/dev/_downloads/07ae15baa45bc560aaf1420e4b45c013/arrows.ipynb b/dev/_downloads/07ae15baa45bc560aaf1420e4b45c013/arrows.ipynb
@@ -67,7 +67,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/dev/_downloads/0b54a39b2ec8fc51693c97f74798b0f0/SpanROI.zip b/dev/_downloads/0b54a39b2ec8fc51693c97f74798b0f0/SpanROI.zip
diff --git a/dev/_downloads/0d4d28ba01513b323c96abf51cfa12c4/fast_fourier_transform_live.ipynb b/dev/_downloads/0d4d28ba01513b323c96abf51cfa12c4/fast_fourier_transform_live.ipynb
@@ -125,7 +125,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/0d75b5dc3a2efb88420f6f32b357684b/polygons.zip b/dev/_downloads/0d75b5dc3a2efb88420f6f32b357684b/polygons.zip
diff --git a/dev/_downloads/0da4dfb9841f7100dfe8d3a926ab7618/circles_color_radius.zip b/dev/_downloads/0da4dfb9841f7100dfe8d3a926ab7618/circles_color_radius.zip
diff --git a/dev/_downloads/11b08f0f37c302dbc328fcc6b378a258/stars.zip b/dev/_downloads/11b08f0f37c302dbc328fcc6b378a258/stars.zip
diff --git a/dev/_downloads/122c7538faaed8f951768e29f816df2d/map_signal.zip b/dev/_downloads/122c7538faaed8f951768e29f816df2d/map_signal.zip
diff --git a/dev/_downloads/13ee3f520472f6867f436b8b9c4bc348/rectangles.ipynb b/dev/_downloads/13ee3f520472f6867f436b8b9c4bc348/rectangles.ipynb
@@ -85,7 +85,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/17c3a9e6fb7db955adf2d8c5870bc702/from_tabular_data.ipynb b/dev/_downloads/17c3a9e6fb7db955adf2d8c5870bc702/from_tabular_data.ipynb
@@ -125,7 +125,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/185f8785ccea35af1bcf2896aedd5597/transforms_and_units.ipynb b/dev/_downloads/185f8785ccea35af1bcf2896aedd5597/transforms_and_units.ipynb
@@ -103,7 +103,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/1bd3ab776b59e162833c99f389a77d37/add_remove_marker.zip b/dev/_downloads/1bd3ab776b59e162833c99f389a77d37/add_remove_marker.zip
diff --git a/dev/_downloads/1becff7a610aee42b57e8b026cbe1fd8/map_signal.ipynb b/dev/_downloads/1becff7a610aee42b57e8b026cbe1fd8/map_signal.ipynb
@@ -107,7 +107,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/1fe9a7b6d4e2c4b4682a04f3d6a365b0/map_signal_circleROI.ipynb b/dev/_downloads/1fe9a7b6d4e2c4b4682a04f3d6a365b0/map_signal_circleROI.ipynb
@@ -89,7 +89,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/2138292dbc3c67ded70204f2d62a0252/compose_figure.zip b/dev/_downloads/2138292dbc3c67ded70204f2d62a0252/compose_figure.zip
diff --git a/dev/_downloads/24831b32e81d1315cd64203e4e17d1bf/simple_arctan_fit.zip b/dev/_downloads/24831b32e81d1315cd64203e4e17d1bf/simple_arctan_fit.zip
diff --git a/dev/_downloads/2902e504355b85195b282e1feb17f937/ragged_points.ipynb b/dev/_downloads/2902e504355b85195b282e1feb17f937/ragged_points.ipynb
@@ -67,7 +67,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/2b84d772626ea7a0fcc0013ab2737a7d/convert_color_image.zip b/dev/_downloads/2b84d772626ea7a0fcc0013ab2737a7d/convert_color_image.zip
diff --git a/dev/_downloads/2bcec1d86daa27f36b937f1d374d4257/SpanROI_interactive_sum.zip b/dev/_downloads/2bcec1d86daa27f36b937f1d374d4257/SpanROI_interactive_sum.zip
diff --git a/dev/_downloads/2d564c11ee264e43fb9a17efa057db3e/ROI_insets.py b/dev/_downloads/2d564c11ee264e43fb9a17efa057db3e/ROI_insets.py
@@ -7,6 +7,9 @@
 the data within the ROI, and then plot the sum as a signal. Using the :class:`matplotlib.figure.SubFigure` class
 we can create a custom layout to visualize and interact with the data.
 
+.. Note::
+    Plotting data with subfigures is slower than using separates figures.
+
 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

diff --git a/dev/_downloads/2d5731efe27b3b944d909df605e0f43a/rectangles.zip b/dev/_downloads/2d5731efe27b3b944d909df605e0f43a/rectangles.zip
diff --git a/dev/_downloads/2fa841961c1ff162d317536d9d5205b5/two_gaussians.zip b/dev/_downloads/2fa841961c1ff162d317536d9d5205b5/two_gaussians.zip
diff --git a/dev/_downloads/3080bfa6ae75202292606b91927ad59b/arrows_navigation.zip b/dev/_downloads/3080bfa6ae75202292606b91927ad59b/arrows_navigation.zip
diff --git a/dev/_downloads/39bdd9167500d55149f53669113756be/lines.zip b/dev/_downloads/39bdd9167500d55149f53669113756be/lines.zip
diff --git a/dev/_downloads/3cf3ca628ceea0bcede72bf1abe09297/circles_color_radius.ipynb b/dev/_downloads/3cf3ca628ceea0bcede72bf1abe09297/circles_color_radius.ipynb
@@ -85,7 +85,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/3e2f149eea05b05314534276b13539f1/ExtractLineProfile.ipynb b/dev/_downloads/3e2f149eea05b05314534276b13539f1/ExtractLineProfile.ipynb
@@ -157,7 +157,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/452cb31e36fa4bfcce1af2f9d19e1658/compose_figure.ipynb b/dev/_downloads/452cb31e36fa4bfcce1af2f9d19e1658/compose_figure.ipynb
@@ -0,0 +1,79 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "\n# Composing Figure\n\nThis example shows how to compose a figure using\n:func:`~.api.plot.plot_images` and :func:`~.api.plot.plot_spectra`\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "import hyperspy.api as hs\nimport matplotlib.pyplot as plt\nimport numpy as np"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Create the 1D and 2D signals\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "s2D_0 = hs.signals.Signal2D(np.arange(100).reshape(10, 10))\ns2D_1 = -s2D_0\n\ns1D_0 = hs.signals.Signal1D(np.arange(100))\ns1D_1 = -s1D_0"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Create an array of :external+matplotlib:class:`matplotlib.axis.Axis` using :external+matplotlib:func:`matplotlib.pyplot.subplots` \n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "fig, axs = plt.subplots(ncols=2, nrows=2)\nhs.plot.plot_images([s2D_0, s2D_1], ax=axs[:, 0], axes_decor=\"off\")\nhs.plot.plot_spectra([s1D_0, s1D_1], ax=axs[:, 1], style=\"mosaic\")"
+      ]
+    }
+  ],
+  "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.10"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}
diff --git a/dev/_downloads/4e1721e8f83906959dad15e7eb198bcf/circles.ipynb b/dev/_downloads/4e1721e8f83906959dad15e7eb198bcf/circles.ipynb
@@ -85,7 +85,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/4e59edd7523a2edaf5dd1ceb420f9772/custom_figure_layout.ipynb b/dev/_downloads/4e59edd7523a2edaf5dd1ceb420f9772/custom_figure_layout.ipynb
@@ -4,7 +4,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "\n# Creating Custom Layouts\n\nCustom layouts for hyperspy figures can be created using the :class:`matplotlib.figure.SubFigure` class. Passing\nthe ``fig`` argument to the :meth:`~.api.signals.BaseSignal.plot` method of a hyperspy signal object will target\nthat figure instead of creating a new one. This is useful for creating custom layouts with multiple subplots.\n"
+        "\n# Creating Custom Layouts\n\nCustom layouts for hyperspy figures can be created using the :class:`matplotlib.figure.SubFigure` class. Passing\nthe ``fig`` argument to the :meth:`~.api.signals.BaseSignal.plot` method of a hyperspy signal object will target\nthat figure instead of creating a new one. This is useful for creating custom layouts with multiple subplots.\n\n.. Note::\n    Plotting data with subfigures is slower than using separates figures.\n"
       ]
     },
     {
@@ -53,7 +53,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.10.14"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/5306e20f83db64d0484eafff9044ceba/custom_figure_layout.py b/dev/_downloads/5306e20f83db64d0484eafff9044ceba/custom_figure_layout.py
@@ -6,6 +6,10 @@
 Custom layouts for hyperspy figures can be created using the :class:`matplotlib.figure.SubFigure` class. Passing
 the ``fig`` argument to the :meth:`~.api.signals.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.
+
+.. Note::
+    Plotting data with subfigures is slower than using separates figures.
+
 """
 
 # Creating a simple layout with two subplots

diff --git a/dev/_downloads/57f4677c2d7d7104cf999be7160254d4/ragged_points.zip b/dev/_downloads/57f4677c2d7d7104cf999be7160254d4/ragged_points.zip
diff --git a/dev/_downloads/5b3a93d109399ba08d1fe92d3af0986c/line_spectrum.ipynb b/dev/_downloads/5b3a93d109399ba08d1fe92d3af0986c/line_spectrum.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/5dc4e5c189309b5012410438f5309145/vertical_lines.zip b/dev/_downloads/5dc4e5c189309b5012410438f5309145/vertical_lines.zip
diff --git a/dev/_downloads/669fee9db8cffd9b928a948fa0a5ab73/arrows.zip b/dev/_downloads/669fee9db8cffd9b928a948fa0a5ab73/arrows.zip
diff --git a/dev/_downloads/6ba26e6400ba59958928ff0ea9523ad6/line_spectrum.zip b/dev/_downloads/6ba26e6400ba59958928ff0ea9523ad6/line_spectrum.zip
diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_downloads/73693989857e0680d20c231f90dea8ac/specifying_ax.zip b/dev/_downloads/73693989857e0680d20c231f90dea8ac/specifying_ax.zip
diff --git a/dev/_downloads/764c7a9ef5a38758f267f3187a5e347e/custom_figure_layout.zip b/dev/_downloads/764c7a9ef5a38758f267f3187a5e347e/custom_figure_layout.zip
diff --git a/dev/_downloads/7eb4813e7b074915f6a32ebb16ec6f7b/filled_circles.zip b/dev/_downloads/7eb4813e7b074915f6a32ebb16ec6f7b/filled_circles.zip
diff --git a/dev/_downloads/819cb88dd7984809b5ca5012f8c8e866/ROI_insets.zip b/dev/_downloads/819cb88dd7984809b5ca5012f8c8e866/ROI_insets.zip
diff --git a/dev/_downloads/84cd18905f59e5a15b49ead3e18799bb/specifying_ax.ipynb b/dev/_downloads/84cd18905f59e5a15b49ead3e18799bb/specifying_ax.ipynb
@@ -0,0 +1,133 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "\n# Specifying Matplotlib Axis\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "import hyperspy.api as hs\nimport matplotlib.pyplot as plt\nimport numpy as np"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## Signal2D\n\nCreate two Signal2D\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "s = hs.signals.Signal2D(np.arange(100).reshape(10, 10))\ns2 = -s"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Create a list of :external+matplotlib:class:`matplotlib.axis.Axis` using\n:external+matplotlib:func:`matplotlib.pyplot.subplots` and\nspecify the second matplotlib axis of the list to :func:`~.api.plot.plot_images`\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "fig, axs = plt.subplots(ncols=3, nrows=1)\nhs.plot.plot_images(s, ax=axs[1], axes_decor=\"off\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "The same can be done for a list of signals and axis\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "fig, axs = plt.subplots(ncols=3, nrows=1)\nhs.plot.plot_images([s, s2], ax=axs[1:3], axes_decor=\"off\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## Signal1D\n\nThe same can be for :class:`~.api.signals.Signal1D`\n\nCreate two Signal2D\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "s = hs.signals.Signal1D(np.arange(100))\ns2 = -s"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Create an array of :external+matplotlib:class:`matplotlib.axis.Axis` using\n:external+matplotlib:func:`matplotlib.pyplot.subplots` and\nspecify the two las matplotlib axis of the second line to :func:`~.api.plot.plot_spectra`\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "fig, axs = plt.subplots(ncols=3, nrows=2)\nhs.plot.plot_spectra([s, s2], ax=axs[1, 1:3], style=\"mosaic\")"
+      ]
+    }
+  ],
+  "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.10"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}
diff --git a/dev/_downloads/85a78734181ae31ad1be2f06150bc92c/convert_color_image.ipynb b/dev/_downloads/85a78734181ae31ad1be2f06150bc92c/convert_color_image.ipynb
@@ -197,7 +197,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/86d461ad89fc7ebabcad4a0462681610/fast_fourier_transform_live.zip b/dev/_downloads/86d461ad89fc7ebabcad4a0462681610/fast_fourier_transform_live.zip
diff --git a/dev/_downloads/88eddcee30e0f8e56613316c2a039892/circles.zip b/dev/_downloads/88eddcee30e0f8e56613316c2a039892/circles.zip
diff --git a/dev/_downloads/8ac62499ff3ae3879006917d10a8cfae/arrows_ragged.ipynb b/dev/_downloads/8ac62499ff3ae3879006917d10a8cfae/arrows_ragged.ipynb
@@ -67,7 +67,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,

diff --git a/dev/_downloads/8c831c6660a710c72dfebabffdd00c16/SpanROI.ipynb b/dev/_downloads/8c831c6660a710c72dfebabffdd00c16/SpanROI.ipynb
@@ -107,7 +107,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.9"
+      "version": "3.11.10"
     }
   },
   "nbformat": 4,