
.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "gallery/images_contours_and_fields/demo_bboximage.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. meta::
        :keywords: codex

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_gallery_images_contours_and_fields_demo_bboximage.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_gallery_images_contours_and_fields_demo_bboximage.py:


==============
BboxImage Demo
==============

A `~matplotlib.image.BboxImage` can be used to position an image according to
a bounding box. This demo shows how to show an image inside a `.text.Text`'s
bounding box as well as how to manually create a bounding box for the image.

.. GENERATED FROM PYTHON SOURCE LINES 10-52

.. code-block:: Python


    import matplotlib.pyplot as plt
    import numpy as np

    from matplotlib.image import BboxImage
    from matplotlib.transforms import Bbox, TransformedBbox

    fig, (ax1, ax2) = plt.subplots(ncols=2)

    # ----------------------------
    # Create a BboxImage with Text
    # ----------------------------
    txt = ax1.text(0.5, 0.5, "test", size=30, ha="center", color="w")
    ax1.add_artist(
        BboxImage(txt.get_window_extent, data=np.arange(256).reshape((1, -1))))

    # ------------------------------------
    # Create a BboxImage for each colormap
    # ------------------------------------
    # List of all colormaps; skip reversed colormaps.
    cmap_names = sorted(m for m in plt.colormaps if not m.endswith("_r"))

    ncol = 2
    nrow = len(cmap_names) // ncol + 1

    xpad_fraction = 0.3
    dx = 1 / (ncol + xpad_fraction * (ncol - 1))

    ypad_fraction = 0.3
    dy = 1 / (nrow + ypad_fraction * (nrow - 1))

    for i, cmap_name in enumerate(cmap_names):
        ix, iy = divmod(i, nrow)
        bbox0 = Bbox.from_bounds(ix*dx*(1+xpad_fraction),
                                 1 - iy*dy*(1+ypad_fraction) - dy,
                                 dx, dy)
        bbox = TransformedBbox(bbox0, ax2.transAxes)
        ax2.add_artist(
            BboxImage(bbox, cmap=cmap_name, data=np.arange(256).reshape((1, -1))))

    plt.show()




.. image-sg:: /gallery/images_contours_and_fields/images/sphx_glr_demo_bboximage_001.png
   :alt: demo bboximage
   :srcset: /gallery/images_contours_and_fields/images/sphx_glr_demo_bboximage_001.png, /gallery/images_contours_and_fields/images/sphx_glr_demo_bboximage_001_2_00x.png 2.00x
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 53-62

.. admonition:: References

   The use of the following functions, methods, classes and modules is shown
   in this example:

   - `matplotlib.image.BboxImage`
   - `matplotlib.transforms.Bbox`
   - `matplotlib.transforms.TransformedBbox`
   - `matplotlib.text.Text`


.. _sphx_glr_download_gallery_images_contours_and_fields_demo_bboximage.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: demo_bboximage.ipynb <demo_bboximage.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: demo_bboximage.py <demo_bboximage.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: demo_bboximage.zip <demo_bboximage.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_
