.. note::

   This page is a reference documentation. It only explains the function signature, and not how to use it.
   Please refer to the :ref:`What you really need to know <need_to_know>` section for the big picture.


{{ fullname | underline(line="-") }}

.. currentmodule:: {{ module }}

.. autofunction:: {{ objname }}

.. _sphx_glr_backreferences_{{ fullname }}:

.. minigallery:: {{fullname}}
    :add-heading:


.. raw:: html

    <div style='clear:both'></div>
