| Server IP : 35.80.110.71 / Your IP : 216.73.216.221 Web Server : Apache/2.4.58 (Ubuntu) System : Linux ip-172-31-21-44 6.17.0-1019-aws #19~24.04.1-Ubuntu SMP Tue Jun 23 18:53:06 UTC 2026 x86_64 User : ubuntu ( 1000) PHP Version : 8.3.31 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /lib/python3/dist-packages/matplotlib/__pycache__/ |
Upload File : |
�
G8�c� � �
� d Z ddlmZ ddlZddlZddlZddlmZ ddlZ ddl
Z ddl
m Z m
Z
mZmZ ddlmZmZmZ ddlmZmZmZmZmZ ddlmZ ddl m Z ddl m Z ddl!m"Z# ddl$m%Z%m&Z&m'Z' dd l(m)Z) dd
l*m+Z+m,Z,m-Z-m.Z. ddl/m0Z1 dd l2m3Z3 dd l4m5Z5 dd
l6m7Z7m8Z8m9Z9m:Z: ejv e<� Z=d� Z> G d� d� Z? G d� d� Z@ G d� de� ZAej� G d� deA� � ZCej� G d� deA� � ZDd� ZEy)a�
`matplotlib.figure` implements the following classes:
`Figure`
Top level `~matplotlib.artist.Artist`, which holds all plot elements.
Many methods are implemented in `FigureBase`.
`SubFigure`
A logical figure inside a figure, usually added to a figure (or parent
`SubFigure`) with `Figure.add_subfigure` or `Figure.subfigures` methods
(provisional API v3.4).
`SubplotParams`
Control the default spacing between subplots.
� )� ExitStackN)�Integral)�_blocking_input�
backend_bases�
_docstring� projections)�Artist�allow_rasterization�_finalize_rasterization)� DrawEvent�FigureCanvasBase�NonGuiException� MouseButton�
_get_renderer)�Axes� SubplotBase�subplot_class_factory)�GridSpec)�ConstrainedLayoutEngine�TightLayoutEngine� LayoutEngine�PlaceHolderLayoutEngine)� Rectangle)�Text)�Affine2D�Bbox�BboxTransformTo�TransformedBboxc �@ � | j r|| j _ y y �N)�figure�stale��self�vals �3/usr/lib/python3/dist-packages/matplotlib/figure.py�_stale_figure_callbackr' 3 s � � �{�{� �� � �� � c �4 � e Zd ZdZd� Zd� Zd� Zd� Zd� Zd� Z y) �
_AxesStacka
Helper class to track axes in a figure.
Axes are tracked both in the order in which they have been added
(``self._axes`` insertion/iteration order) and in the separate "gca" stack
(which is the index to which they map in the ``self._axes`` dict).
c �D � i | _ t j � | _ y r )�_axes� itertools�count�_counter�r$ s r& �__init__z_AxesStack.__init__A s � ���
�!���)��
r( c � � g | j �S )z1List the axes that have been added to the figure.)r, r0 s r& �as_listz_AxesStack.as_listE s � � ����}� r( c �: � | j j |� y)z Remove the axes from the stack.N)r, �pop�r$ �as r& �removez_AxesStack.removeI s � � �
�
���q�r( c �z � || j vr t d� �t | j � | j |< y)z@Move an axes, which must already exist in the stack, to the top.zAxes has not been added yetN)r, �
ValueError�nextr/ r6 s r& �bubblez_AxesStack.bubbleM s0 � � �D�J�J� � � :�;� ;� �T�]�]�+��
�
�1�
r( c �f � || j vr#t | j � | j |< yy)z9Add an axes to the stack, ignoring it if already present.N)r, r; r/ r6 s r& �addz_AxesStack.addS s) � � �D�J�J� � �� � � /�D�J�J�q�M� r( c �Z � t | j | j j d�� S )z6Return the active axes, or None if the stack is empty.N)�key�default)�maxr, � __getitem__r0 s r& �currentz_AxesStack.currentX s � ��4�:�:�4�:�:�#9�#9�4�H�Hr( N)
�__name__�
__module__� __qualname__�__doc__r1 r3 r8 r< r> rD � r( r& r* r* 8 s& � ��*� ��,� 0�
Ir( r* c �L � e Zd ZdZ dd�Z ej d� Z dd�Zy)�
SubplotParamsz7
A class to hold the parameters for a subplot.
Nc � � d| _ dD ]# }t | |t j d|� � � �% | j ||||||� y)au
Defaults are given by :rc:`figure.subplot.[name]`.
Parameters
----------
left : float
The position of the left edge of the subplots,
as a fraction of the figure width.
right : float
The position of the right edge of the subplots,
as a fraction of the figure width.
bottom : float
The position of the bottom edge of the subplots,
as a fraction of the figure height.
top : float
The position of the top edge of the subplots,
as a fraction of the figure height.
wspace : float
The width of the padding between subplots,
as a fraction of the average Axes width.
hspace : float
The height of the padding between subplots,
as a fraction of the average Axes height.
T)�left�bottom�right�top�wspace�hspacezfigure.subplot.N)� _validate�setattr�mpl�rcParams�update)r$ rM rN rO rP rQ rR r@ s r& r1 zSubplotParams.__init__b sN � �4 ���I� F�C� �D�#�s�|�|�o�c�U�,C� D� E� F� � � �D�&�%��f�f�=r( z3.5c �: � | j rX|�|n | j |�|n | j k\ r t d� �|�|n | j |�|n | j
k\ r t d� �|�|| _ |�|| _ |�|| _ |�|| _ |�|| _ |�|| _ yy)zY
Update the dimensions of the passed parameters. *None* means unchanged.
Nzleft cannot be >= rightzbottom cannot be >= top)rS rM rO r: rN rP rQ rR )r$ rM rN rO rP rQ rR s r& rW zSubplotParams.update� s� � �
�>�>� �)��t�y�y�!&�!2���
�
�D� �!:�;�;�!�-��4�;�;� "���D�H�H�>� �!:�;�;� � � �D�I� � � �D�J� � � �D�K� �?��D�H� � � �D�K� � � �D�K� r( �NNNNNN) rE rF rG rH r1 �_api� deprecate_privatize_attribute�validaterW rI r( r& rK rK ] s6 � �� @D�%)� >�@ 2�t�1�1�%�8�H�=A�#'�!r( rK c � � � e Zd ZdZ� fd�Zd� Z dGd�Zd� Zd� Z e j dd� e j dd � dHd �� � Z d � Z e
j d
ddddd�� e
j e � d� � � Z e
j d
ddddd�� e
j e � d� � � Z e
j dd
dd dd�� e
j e � d � � � Zd � Zd � Zd � Zd!� Zd"� Zd#� Zd$� Zd%� Z eee� Z dId'�Z e
j< d(� � Z e
j< d)� � Z d*� Z!dJd&d&d+d
d
d
d
d,�d-�Z"d.� Z#dId/�Z$dId0�Z%e
j< d1� � Z&e
j< dHd2�� Z'e
j< dKd3�� Z( dLd4�Z)dHd5�Z*dHd6�Z+dHd7�Z,dJd8�Z- dMd9�Z.d:� Z/d;� Z0d<� Z1d=� Z2d
d&d
d>�d?�Z3d@� Z4dNdA�Z5e6dB� � Z7d&d&d
d
dCd
d
dD�dE�Z8dF� Z9� xZ:S )O�
FigureBasez�
Base class for `.Figure` and `.SubFigure` containing the methods that add
artists to the figure or subfigure, create Axes, etc.
c �j �� t �| � � | `d | _ d | _ d | _ t
j � t
j � d�| _ | | _ g | _
g | _ g | _ g | _
g | _ g | _ g | _ g | _ d| _ d | _ | j( di |�� y )N)�x�yTrI )�superr1 r, � _suptitle�
_supxlabel�
_supylabel�cbook�Grouper�_align_label_groupsr! �
_localaxes�artists�lines�patches�texts�images�legends�subfigsr" �suppressComposite�set)r$ �kwargs� __class__s �r& r1 zFigureBase.__init__� s� �� �
����
�J� ��� ��� ���
*/� � � �u�}�}��#O�� ��� � ����� ���
��� ���
��� ��� ��� ���
�!%�� ������6�r( c �: � | j � }| j D ]@ }|j |� |j � }|D ] }||v s�|j |� � �B |j | j � t d� |D � d� �� }| j
D ]| }|j
� }|j |r |||� nd� |j � D ]; }t |d� s�|j
� }|j |r |||� nd� �= �~ |S )zAlso runs apply_aspectc 3 �B K � | ] }|j � r�|�� � y �wr )� get_animated)�.0�artists r& � <genexpr>z/FigureBase._get_draw_artists.<locals>.<genexpr>� s � �� � G���1D�1D�1F�V� G�s � � c �" � | j � S r )�
get_zorder)ry s r& �<lambda>z.FigureBase._get_draw_artists.<locals>.<lambda>� s � �v� 0� 0� 2� r( )r@ N� apply_aspect) � get_childrenrp r8 �patch�sortedri �get_axes_locatorr~ �hasattr)r$ �rendererrj �sfig�childa�child�ax�locators r& �_get_draw_artistsz FigureBase._get_draw_artists� s � ��#�#�%���L�L� *�D� �N�N�4� ��&�&�(�F� �
*���G�#��N�N�5�)�
*� *� ���t�z�z�"�� G�'� G�2�4�� �/�/� G�B��)�)�+�G� �O�O�W�G�B�� 1�$� G�� � �*�
G���5�.�1� #� 4� 4� 6�G��&�&�4;���x�0��G�
G� G� �r( c � � t j g d�|�� t d� | j D � � }t | j � dk( rG| j d j |�� D ]$ }|j
|� |j |� �& n�|r�| j � D ]� }|j � j � r:|j |�� D ]$ }|j
|� |j |� �& �[|j |�� D ] }|j d� � |j d� �� |r| j |�� d | _ y
) a\
Date ticklabels often overlap, so it is useful to rotate them
and right align them. Also, a common use case is a number of
subplots with shared x-axis where the x-axis is date data. The
ticklabels are often long, and it helps to rotate them on the
bottom subplot and turn them off on other subplots, as well as
turn off xlabels.
Parameters
----------
bottom : float, default: 0.2
The bottom of the subplots for `subplots_adjust`.
rotation : float, default: 30 degrees
The rotation angle of the xtick labels in degrees.
ha : {'left', 'center', 'right'}, default: 'right'
The horizontal alignment of the xticklabels.
which : {'major', 'minor', 'both'}, default: 'major'
Selects which ticklabels to rotate.
)�major�minor�both)�whichc 3 �4 K � | ] }t |d � �� � y�w)�get_subplotspecN)r� )rx r� s r& rz z+FigureBase.autofmt_xdate.<locals>.<genexpr>� s � �� �M�R�'�"�&7�8�M�s �� r F� )rN TN)rZ �
check_in_list�all�axes�len�get_xticklabels�set_ha� set_rotation�get_axesr� � is_last_row� set_visible�
set_xlabel�subplots_adjustr" )r$ rN �rotation�har� � allsubplots�labelr� s r& �
autofmt_xdatezFigureBase.autofmt_xdate� s4 � �*
���5�U�C��M�4�9�9�M�M� � �t�y�y�>�Q� � ���1� �5�5�E�5�B�
-��� � �R� ��"�"�8�,�
-� � �-�-�/� *�B��)�)�+�7�7�9�%'�%7�%7�e�%7�%D� 9�E� !�L�L�� ,� !� .� .�x� 8�9� &(�%7�%7�e�%7�%D� 5�E� !� -� -�e� 4�5��
�
�b�)�*� � � � �� � /���
r( c �� � | j g| j �| j �| j �| j �| j
�| j �| j �| j �S )z.Get a list of artists contained in the figure.) r� rj ri rk rl rm rn ro rp r0 s r& r zFigureBase.get_children s � ��
�
� �� � � �� � � � ��� � � � � �
��� � ���
� � � � � � � � � r( c � � | j || �� \ }}|�||fS | j j |j |j � }|i fS )z|
Test whether the mouse event occurred on the figure.
Returns
-------
bool, {}
)r! )�_default_contains�bbox�containsr` ra )r$ �
mouseevent�inside�infos r& r� zFigureBase.contains sU � � �-�-�j��-�F� ��� � ��4�<� ����#�#�J�L�L�*�,�,�?���r�z�r( �3.6�argsrs Nc � � | j S r )r� )r$ r� r� rs s r& �get_window_extentz FigureBase.get_window_extent s � � �y�y�r( c � � t | |d � }|j dd� }|j dd� }|d dv r|du }n |d dk( r|du }|�|d }|�|d }d |vr d
|vr|d
|d < d |vr d |vr|d |d < d
|vr|d
|d
< d|vrBd|vr d|vrt j |d |d< d|vr d|vrt j |d |d< | j |||fi |��}|�F|j |� |j
||f� |j |� |j � n|}|_ t | |d |� d| _ |S )a�
Add a centered %(name)s to the figure.
Parameters
----------
t : str
The %(name)s text.
x : float, default: %(x0)s
The x location of the text in figure coordinates.
y : float, default: %(y0)s
The y location of the text in figure coordinates.
horizontalalignment, ha : {'center', 'left', 'right'}, default: %(ha)s
The horizontal alignment of the text relative to (*x*, *y*).
verticalalignment, va : {'top', 'center', 'bottom', 'baseline'}, default: %(va)s
The vertical alignment of the text relative to (*x*, *y*).
fontsize, size : default: :rc:`figure.%(rc)ssize`
The font size of the text. See `.Text.set_size` for possible
values.
fontweight, weight : default: :rc:`figure.%(rc)sweight`
The font weight of the text. See `.Text.set_weight` for possible
values.
Returns
-------
text
The `.Text` instance of the %(name)s.
Other Parameters
----------------
fontproperties : None or dict, optional
A dict of font properties. If *fontproperties* is given the
default values for font size and weight are taken from the
`.FontProperties` defaults. :rc:`figure.%(rc)ssize` and
:rc:`figure.%(rc)sweight` are ignored in this case.
**kwargs
Additional kwargs are `matplotlib.text.Text` properties.
�namer` Nra )rd rc re �x0�y0�horizontalalignmentr� �verticalalignment�var� �fontproperties�fontsize�size�
fontweight�weightT) �getattrr5 rU rV �text�set_text� set_position� update_fromr8 �_autoposrT r" ) r$ �tr� rs �suplabr` ra �autopos�sups r& �
_suplabelszFigureBase._suplabels% s� � �R ��t�F�|�,�� �J�J�s�D� !�� �J�J�s�D� !�� ��<�6� 6��4�i�G�
�&�\�\�
)��4�i�G� �9��T�
�A� �9��T�
�A� �� .�4�v�3E�,0��J�F�(� )� �f� ,��V�1C�*.�t�*�F�&� '� �V� #�!%�j�!1�F�:� � �6� )���'�F�&�,@�!$� � �d�6�l�!;��v���6�)�h�f�.D�#&�<�<��X��#?��x� ��d�i�i��1�a�*�6�*�� � � �O�O�A� � � � ��A�� '� � � �s� #� �J�J�L��F�!�����d�6�l�F�+���
��
r( � �?�\��(\�?�suptitle�centerrP �title)r� r� r� r� r� �rcc �@ � ddddddddd �} | j ||fi |��S )
Nrc r� r� r� rP r zfigure.titlesizezfigure.titleweight�r� r� r� r� r� r� r� r� �r� �r$ r� rs r� s r& r� zFigureBase.suptitleu s: � �
$�3�d� �e��*�6J�L�� �t���q�$�1�&�1�1r( �{�G�z�?� supxlabelrN r� c �@ � ddddddddd �} | j ||fi |��S )
Nrd r� r� r� rN r �figure.labelsize�figure.labelweightr� r� r� s r& r� zFigureBase.supxlabel s: � �
%�C�t� �h�A�*�6J�L�� �t���q�$�1�&�1�1r( �{�G�z�?� supylabelrM c
�B � ddddddddd d
� } | j ||fi |��S ) Nre r� r� rM r� �vertical�anchorr� r� ) r� r� r� r� r� r� �
rotation_moder� r� r� r� s r& r� zFigureBase.supylabel� s< � �
%�D�� �H�*�!)�3E�.�0�� �t���q�$�1�&�1�1r( c �6 � | j j � S )z+Get the edge color of the Figure rectangle.)r� �
get_edgecolorr0 s r& r� zFigureBase.get_edgecolor� � � ��z�z�'�'�)�)r( c �6 � | j j � S )z+Get the face color of the Figure rectangle.)r� �
get_facecolorr0 s r& r� zFigureBase.get_facecolor� r� r( c �6 � | j j � S )z�
Return the figure's background patch visibility, i.e.
whether the figure background will be drawn. Equivalent to
``Figure.patch.get_visible()``.
)r� � get_visibler0 s r& � get_frameonzFigureBase.get_frameon� s � � �z�z�%�%�'�'r( c �: � | j j |� y)z
Set the line width of the Figure rectangle.
Parameters
----------
linewidth : number
N)r� �
set_linewidth)r$ � linewidths r& r� zFigureBase.set_linewidth� s � �
�
�
� � ��+r( c �6 � | j j � S )z=
Get the line width of the Figure rectangle.
)r� �
get_linewidthr0 s r& r� zFigureBase.get_linewidth� s � � �z�z�'�'�)�)r( c �: � | j j |� y)zz
Set the edge color of the Figure rectangle.
Parameters
----------
color : color
N)r� �
set_edgecolor�r$ �colors r& r� zFigureBase.set_edgecolor� � � �
�
�
� � ��'r( c �: � | j j |� y)zz
Set the face color of the Figure rectangle.
Parameters
----------
color : color
N)r� �
set_facecolorr� s r& r� zFigureBase.set_facecolor� r� r( c �H � | j j |� d| _ y)z�
Set the figure's background patch visibility, i.e.
whether the figure background will be drawn. Equivalent to
``Figure.patch.set_visible()``.
Parameters
----------
b : bool
TN)r� r� r" )r$ �bs r& � set_frameonzFigureBase.set_frameon� s � �
�
�
� � �q�!���
r( Fc �2 � |j | � | j j |� | j j |_ |j � s|j
| j � |r|j | j � d| _
|S )a�
Add an `.Artist` to the figure.
Usually artists are added to `~.axes.Axes` objects using
`.Axes.add_artist`; this method can be used in the rare cases where
one needs to add artists directly to the figure instead.
Parameters
----------
artist : `~matplotlib.artist.Artist`
The artist to add to the figure. If the added artist has no
transform previously set, its transform will be set to
``figure.transSubfigure``.
clip : bool, default: False
Whether the added artist should be clipped by the figure patch.
Returns
-------
`~matplotlib.artist.Artist`
The added artist.
T) �
set_figurerj �appendr8 �_remove_method�is_transform_set�
set_transform�transSubfigure�
set_clip_pathr� r" )r$ ry �clips r& �
add_artistzFigureBase.add_artist� sw � �, ���$� � � � ���F�#� $� � � 3� 3�� ��&�&�(� � � ��!4�!4� 5� � � � ���� ,���
��
r( c � � t |� sd|vr t d� �d|v r(t |� r t d� �|j d� f}t |d t � r.|d }|j
}|j
� | urpt d� �|d }t j |� j � st dj |� � � | j |i |��\ }} || |fi |��}||f}| j ||� S )aZ
Add an `~.axes.Axes` to the figure.
Call signatures::
add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)
Parameters
----------
rect : tuple (left, bottom, width, height)
The dimensions (left, bottom, width, height) of the new
`~.axes.Axes`. All quantities are in fractions of figure width and
height.
projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional
The projection type of the `~.axes.Axes`. *str* is the name of
a custom projection, see `~matplotlib.projections`. The default
None results in a 'rectilinear' projection.
polar : bool, default: False
If True, equivalent to projection='polar'.
axes_class : subclass type of `~.axes.Axes`, optional
The `.axes.Axes` subclass that is instantiated. This parameter
is incompatible with *projection* and *polar*. See
:ref:`axisartist_users-guide-index` for examples.
sharex, sharey : `~.axes.Axes`, optional
Share the x or y `~matplotlib.axis` with sharex and/or sharey.
The axis will have the same limits, ticks, and scale as the axis
of the shared axes.
label : str
A label for the returned Axes.
Returns
-------
`~.axes.Axes`, or a subclass of `~.axes.Axes`
The returned axes class depends on the projection used. It is
`~.axes.Axes` if rectilinear projection is used and
`.projections.polar.PolarAxes` if polar projection is used.
Other Parameters
----------------
**kwargs
This method also takes the keyword arguments for
the returned Axes class. The keyword arguments for the
rectilinear Axes class `~.axes.Axes` can be found in
the following table but there might also be other keyword
arguments if another projection is used, see the actual Axes
class.
%(Axes:kwdoc)s
Notes
-----
In rare circumstances, `.add_axes` may be called with a single
argument, an Axes instance already created in the present figure but
not in the figure's list of Axes.
See Also
--------
.Figure.add_subplot
.pyplot.subplot
.pyplot.axes
.Figure.subplots
.pyplot.subplots
Examples
--------
Some simple examples::
rect = l, b, w, h
fig = plt.figure()
fig.add_axes(rect)
fig.add_axes(rect, frameon=False, facecolor='g')
fig.add_axes(rect, polar=True)
ax = fig.add_axes(rect, projection='polar')
fig.delaxes(ax)
fig.add_axes(ax)
�rectz9add_axes() missing 1 required positional argument: 'rect'z2add_axes() got multiple values for argument 'rect'r z5The Axes must have been created in the present figurez)all entries in rect must be finite not {})r� � TypeErrorr5 �
isinstancer �_projection_init�
get_figurer: �np�isfiniter� �format� _process_projection_requirements�_add_axes_internal)r$ r� rs r7 r@ r� �projection_class�pkws r& �add_axeszFigureBase.add_axes� s' � �l �4�y�V�6� 1��K�M�
M�
�v�
��4�y� �H�J� J��J�J�v�&�)�D� �d�1�g�t� $��Q��A��$�$�C��|�|�~�T�)� �K�M� M� ��7�D��;�;�t�$�(�(�*� � "*�*0�&��,�8� 8�$I�D�$I�$I��%!� �%!� !� �c� !��t�3�s�3�A�#�S�)�C��&�&�q�#�.�.r( c �� � d|v r t d� �t |� dk( rAt |d t � r.|d }|j }|j � | ur�t
d� �|sd}t |� dk( rIt |d t � r6d|d cxk rdk r(n n%t t t t |d � � � } | j |i |��\ }} t |� | g|��i |��}||f}| j ||� S ) a)
Add an `~.axes.Axes` to the figure as part of a subplot arrangement.
Call signatures::
add_subplot(nrows, ncols, index, **kwargs)
add_subplot(pos, **kwargs)
add_subplot(ax)
add_subplot()
Parameters
----------
*args : int, (int, int, *index*), or `.SubplotSpec`, default: (1, 1, 1)
The position of the subplot described by one of
- Three integers (*nrows*, *ncols*, *index*). The subplot will
take the *index* position on a grid with *nrows* rows and
*ncols* columns. *index* starts at 1 in the upper left corner
and increases to the right. *index* can also be a two-tuple
specifying the (*first*, *last*) indices (1-based, and including
*last*) of the subplot, e.g., ``fig.add_subplot(3, 1, (1, 2))``
makes a subplot that spans the upper 2/3 of the figure.
- A 3-digit integer. The digits are interpreted as if given
separately as three single-digit integers, i.e.
``fig.add_subplot(235)`` is the same as
``fig.add_subplot(2, 3, 5)``. Note that this can only be used
if there are no more than 9 subplots.
- A `.SubplotSpec`.
In rare circumstances, `.add_subplot` may be called with a single
argument, a subplot Axes instance already created in the
present figure but not in the figure's list of Axes.
projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional
The projection type of the subplot (`~.axes.Axes`). *str* is the
name of a custom projection, see `~matplotlib.projections`. The
default None results in a 'rectilinear' projection.
polar : bool, default: False
If True, equivalent to projection='polar'.
axes_class : subclass type of `~.axes.Axes`, optional
The `.axes.Axes` subclass that is instantiated. This parameter
is incompatible with *projection* and *polar*. See
:ref:`axisartist_users-guide-index` for examples.
sharex, sharey : `~.axes.Axes`, optional
Share the x or y `~matplotlib.axis` with sharex and/or sharey.
The axis will have the same limits, ticks, and scale as the axis
of the shared axes.
label : str
A label for the returned Axes.
Returns
-------
`.axes.SubplotBase`, or another subclass of `~.axes.Axes`
The Axes of the subplot. The returned Axes base class depends on
the projection used. It is `~.axes.Axes` if rectilinear projection
is used and `.projections.polar.PolarAxes` if polar projection
is used. The returned Axes is then a subplot subclass of the
base class.
Other Parameters
----------------
**kwargs
This method also takes the keyword arguments for the returned Axes
base class; except for the *figure* argument. The keyword arguments
for the rectilinear base class `~.axes.Axes` can be found in
the following table but there might also be other keyword
arguments if another projection is used.
%(Axes:kwdoc)s
See Also
--------
.Figure.add_axes
.pyplot.subplot
.pyplot.axes
.Figure.subplots
.pyplot.subplots
Examples
--------
::
fig = plt.figure()
fig.add_subplot(231)
ax1 = fig.add_subplot(2, 3, 1) # equivalent but more general
fig.add_subplot(232, frameon=False) # subplot with no frame
fig.add_subplot(233, projection='polar') # polar subplot
fig.add_subplot(234, sharex=ax1) # subplot sharing x-axis with ax1
fig.add_subplot(235, facecolor="red") # red subplot
ax1.remove() # delete ax1 from the figure
fig.add_subplot(ax1) # add ax1 back to the figure
r! z9add_subplot() got an unexpected keyword argument 'figure'r� r z8The Subplot must have been created in the present figure)r� r� r� �d i� )r r� r r r r r: r �tuple�map�int�strr r r )r$ r� rs r� r@ r r
s r& � add_subplotzFigureBase.add_subplotl s � �N �v� � �K�M�
M� �t�9��>�j��a��+� >��a��B��%�%�C��}�}��d�*� � "6� 7� 7� � �� �D� �Q��:�d�1�g�x�#@��t�A�w�-�#�-� �S��c�$�q�'�l� 3�4��$I�D�$I�$I��%!� �%!� !� �c�8�&�'7�8��L��L��L�B�#�S�)�C��&�&�r�3�/�/r( c � � | j j |� || j vr| j j |� | j |� | j
|_ ||_ d| _ t |_
|S )z0Private helper for `add_axes` and `add_subplot`.T) �_axstackr> ri r� �sca�delaxesr� r r" r' �stale_callback)r$ r� r@ s r& r z FigureBase._add_axes_internal� se � � �
�
���"� �
�T�_�_� $� �O�O� "� "�2� &� ���� � �L�L��� !�����
� 2���� r( T)�sharex�sharey�squeeze� width_ratios�
height_ratios�
subplot_kw� gridspec_kwc �� � t | xs i � } |�d| v r t d� �|| d< |�d| v r t d� �|| d< | j ||fd| i| ��}
|
j ||||�� } | S )a!
Add a set of subplots to this figure.
This utility wrapper makes it convenient to create common layouts of
subplots in a single call.
Parameters
----------
nrows, ncols : int, default: 1
Number of rows/columns of the subplot grid.
sharex, sharey : bool or {'none', 'all', 'row', 'col'}, default: False
Controls sharing of x-axis (*sharex*) or y-axis (*sharey*):
- True or 'all': x- or y-axis will be shared among all subplots.
- False or 'none': each subplot x- or y-axis will be independent.
- 'row': each subplot row will share an x- or y-axis.
- 'col': each subplot column will share an x- or y-axis.
When subplots have a shared x-axis along a column, only the x tick
labels of the bottom subplot are created. Similarly, when subplots
have a shared y-axis along a row, only the y tick labels of the
first column subplot are created. To later turn other subplots'
ticklabels on, use `~matplotlib.axes.Axes.tick_params`.
When subplots have a shared axis that has units, calling
`.Axis.set_units` will update each axis with the new units.
squeeze : bool, default: True
- If True, extra dimensions are squeezed out from the returned
array of Axes:
- if only one subplot is constructed (nrows=ncols=1), the
resulting single Axes object is returned as a scalar.
- for Nx1 or 1xM subplots, the returned object is a 1D numpy
object array of Axes objects.
- for NxM, subplots with N>1 and M>1 are returned as a 2D array.
- If False, no squeezing at all is done: the returned Axes object
is always a 2D array containing Axes instances, even if it ends
up being 1x1.
width_ratios : array-like of length *ncols*, optional
Defines the relative widths of the columns. Each column gets a
relative width of ``width_ratios[i] / sum(width_ratios)``.
If not given, all columns will have the same width. Equivalent
to ``gridspec_kw={'width_ratios': [...]}``.
height_ratios : array-like of length *nrows*, optional
Defines the relative heights of the rows. Each row gets a
relative height of ``height_ratios[i] / sum(height_ratios)``.
If not given, all rows will have the same height. Equivalent
to ``gridspec_kw={'height_ratios': [...]}``.
subplot_kw : dict, optional
Dict with keywords passed to the `.Figure.add_subplot` call used to
create each subplot.
gridspec_kw : dict, optional
Dict with keywords passed to the
`~matplotlib.gridspec.GridSpec` constructor used to create
the grid the subplots are placed on.
Returns
-------
`~.axes.Axes` or array of Axes
Either a single `~matplotlib.axes.Axes` object or an array of Axes
objects if more than one subplot was created. The dimensions of the
resulting array can be controlled with the *squeeze* keyword, see
above.
See Also
--------
.pyplot.subplots
.Figure.add_subplot
.pyplot.subplot
Examples
--------
::
# First create some toy data:
x = np.linspace(0, 2*np.pi, 400)
y = np.sin(x**2)
# Create a figure
plt.figure()
# Create a subplot
ax = fig.subplots()
ax.plot(x, y)
ax.set_title('Simple plot')
# Create two subplots and unpack the output array immediately
ax1, ax2 = fig.subplots(1, 2, sharey=True)
ax1.plot(x, y)
ax1.set_title('Sharing Y axis')
ax2.scatter(x, y)
# Create four polar Axes and access them through the returned array
axes = fig.subplots(2, 2, subplot_kw=dict(projection='polar'))
axes[0, 0].plot(x, y)
axes[1, 1].scatter(x, y)
# Share an X-axis with each column of subplots
fig.subplots(2, 2, sharex='col')
# Share a Y-axis with each row of subplots
fig.subplots(2, 2, sharey='row')
# Share both X- and Y-axes with all subplots
fig.subplots(2, 2, sharex='all', sharey='all')
# Note that this is the same as
fig.subplots(2, 2, sharex=True, sharey=True)
r �Q'height_ratios' must not be defined both as parameter and as key in 'gridspec_kw'r �P'width_ratios' must not be defined both as parameter and as key in 'gridspec_kw'r! )r r r r )�dictr: � add_gridspec�subplots) r$ �nrows�ncolsr r r r r r r �gs�axss r& r$ zFigureBase.subplots� s� � �n �;�,�"�-� � � $� �+�-� � "I� J� J�+8�K�� (� � #� ��,� � "I� J� J�*6�K�� '�
�T�
�
�u�e�
H�D�
H�K�
H���k�k����%/� � 1���
r( c �f � d� }d� }| j j |� | j j d| � d| _ | j
j |� |j D ]0 } |||j | � }|�� |t ||� d�� � �2 |||j � y)zY
Remove the `~.axes.Axes` *ax* from the figure; update the current Axes.
c � � | j � j | � | j � j | � | j � j | � | j � j | � y r )�get_major_formatter�set_axis�get_major_locator�get_minor_formatter�get_minor_locator��axiss r& � _reset_locators_and_formattersz:FigureBase.delaxes.<locals>._reset_locators_and_formatters� s` � �
� $� $� &� /� /�� 5� � "� "� $� -� -�d� 3� � $� $� &� /� /�� 5� � "� "� $� -� -�d� 3r( c � � |j | � }t |� dkD r |j | � |D ]
}| |us�|c S y )Nr� )� get_siblingsr� r8 )r� �grouper�siblings�last_axs r& �_break_share_linkz-FigureBase.delaxes.<locals>._break_share_link� sK � � �+�+�B�/�H��8�}�q� ����r�"� '� '�G���(� &��'� r( �_axes_change_eventTNr1 )
r r8 � _axobservers�processr" ri � _axis_names� _shared_axesr� �
_twinned_axes)r$ r� r2 r8 r� r7 s r& r zFigureBase.delaxes� s� � �
4� �
�
�
� � �R� � ���!�!�"6��=���
� ��� � �r�"� �N�N� P�D�'��B�O�O�D�,A�B�G��"�.�w�w�4�&��
�/N�O� P� �"�b� .� .�/r( c � � d| _ | j D ] }|j |�� � g | _ t | j � D ]# }|j � | j |� �% g | _ g | _ g | _ g | _ g | _
g | _ |st j � | _ d| _ d| _ d| _ d| _ y)z�
Clear the figure.
Parameters
----------
keep_observers: bool, default: False
Set *keep_observers* to True if, for example,
a gui widget is tracking the Axes in the figure.
N��keep_observersT)rq rp �clearr r� r rj rk rl rm rn ro rf �CallbackRegistryr: rc rd re r" )r$ rA �subfigr� s r& rB zFigureBase.clear� s� � � "&�� � �l�l� 8�F� �L�L��L� 7� 8��� ��� � �"� �B� �H�H�J� �L�L�� � � �� ���
��� ���
��� ��� � � %� 6� 6� 8�D� � ��� ��� �����
r( c �& � | j |�� S )a|
[*Discouraged*] Alias for the `clear()` method.
.. admonition:: Discouraged
The use of ``clf()`` is discouraged. Use ``clear()`` instead.
Parameters
----------
keep_observers: bool, default: False
Set *keep_observers* to True if, for example,
a gui widget is tracking the Axes in the figure.
r@ )rB )r$ rA s r& �clfzFigureBase.clf� s � � �z�z� �z�8�8r( c �Z � t j | j g|��i |��\ }}}}t |� r |j d| j
� }t j | ||g|��d|i|��}| j j |� | j j |_
d| _ |S )aI
Place a legend on the figure.
Call signatures::
legend()
legend(handles, labels)
legend(handles=handles)
legend(labels)
The call signatures correspond to the following different ways to use
this method:
**1. Automatic detection of elements to be shown in the legend**
The elements to be added to the legend are automatically determined,
when you do not pass in any extra arguments.
In this case, the labels are taken from the artist. You can specify
them either at artist creation or by calling the
:meth:`~.Artist.set_label` method on the artist::
ax.plot([1, 2, 3], label='Inline label')
fig.legend()
or::
line, = ax.plot([1, 2, 3])
line.set_label('Label via method')
fig.legend()
Specific lines can be excluded from the automatic legend element
selection by defining a label starting with an underscore.
This is default for all artists, so calling `.Figure.legend` without
any arguments and without setting the labels manually will result in
no legend being drawn.
**2. Explicitly listing the artists and labels in the legend**
For full control of which artists have a legend entry, it is possible
to pass an iterable of legend artists followed by an iterable of
legend labels respectively::
fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])
**3. Explicitly listing the artists in the legend**
This is similar to 2, but the labels are taken from the artists'
label properties. Example::
line1, = ax1.plot([1, 2, 3], label='label1')
line2, = ax2.plot([1, 2, 3], label='label2')
fig.legend(handles=[line1, line2])
**4. Labeling existing plot elements**
.. admonition:: Discouraged
This call signature is discouraged, because the relation between
plot elements and labels is only implicit by their order and can
easily be mixed up.
To make a legend for all artists on all Axes, call this function with
an iterable of strings, one for each legend item. For example::
fig, (ax1, ax2) = plt.subplots(1, 2)
ax1.plot([1, 3, 5], color='blue')
ax2.plot([2, 4, 6], color='red')
fig.legend(['the blues', 'the reds'])
Parameters
----------
handles : list of `.Artist`, optional
A list of Artists (lines, patches) to be added to the legend.
Use this together with *labels*, if you need full control on what
is shown in the legend and the automatic mechanism described above
is not sufficient.
The length of handles and labels should be the same in this
case. If they are not, they are truncated to the smaller length.
labels : list of str, optional
A list of labels to show next to the artists.
Use this together with *handles*, if you need full control on what
is shown in the legend and the automatic mechanism described above
is not sufficient.
Returns
-------
`~matplotlib.legend.Legend`
Other Parameters
----------------
%(_legend_kw_doc)s
See Also
--------
.Axes.legend
Notes
-----
Some artists are not supported by this function. See
:doc:`/tutorials/intermediate/legend_guide` for details.
�bbox_transformT) �mlegend�_parse_legend_argsr� r� r5 r� �Legendro r� r8 r� r" )r$ r� rs �handles�labels�
extra_args� transform�ls r& �legendzFigureBase.legend� s� � �^ /6�.H�.H�� � �/��/� �/�+����V�
�z�?�
��J�J� /��1D�1D�E� � �N�N�4��&�
?�:�
?�*3�
?�7=�
?�� � � ���A� � �<�<�.�.�����
��r( c � � d| j i|�|ni �|�}t d|||d�|��}|j | � t |_ | j
j
|� | j
j |_ d| _ |S )a�
Add text to figure.
Parameters
----------
x, y : float
The position to place the text. By default, this is in figure
coordinates, floats in [0, 1]. The coordinate system can be changed
using the *transform* keyword.
s : str
The text string.
fontdict : dict, optional
A dictionary to override the default text properties. If not given,
the defaults are determined by :rc:`font.*`. Properties passed as
*kwargs* override the corresponding ones given in *fontdict*.
Returns
-------
`~.text.Text`
Other Parameters
----------------
**kwargs : `~matplotlib.text.Text` properties
Other miscellaneous text parameters.
%(Text:kwdoc)s
See Also
--------
.Axes.text
.pyplot.text
rO )r` ra r� TrI )
r� r r� r' r rm r� r8 r� r" )r$ r` ra �s�fontdictrs �effective_kwargsr� s r& r� zFigureBase.texti s� � �J
��,�,�
�#�/�x�R�
� �
��
�9�a�1�1�9�(8�9�� ���� � 4��� �
�
���$� � "�j�j� /� /�����
�� r( c �t � |�
t |dd� }| j � � | j � j sd}|��|�'t j dd�� | j � }| j � }d}|r*t
|t � rt j |fi |��\ }}nt j |fi |��\ }}|j ddd�� nd }g d
�}|j � D � �
ci c]
\ } }
| |vs� | |
�� } } }
t j ||fi | ��} |s| j � d | _ | S c c}
} w ) a�
Add a colorbar to a plot.
Parameters
----------
mappable
The `matplotlib.cm.ScalarMappable` (i.e., `.AxesImage`,
`.ContourSet`, etc.) described by this colorbar. This argument is
mandatory for the `.Figure.colorbar` method but optional for the
`.pyplot.colorbar` function, which sets the default to the current
image.
Note that one can create a `.ScalarMappable` "on-the-fly" to
generate colorbars not attached to a previously drawn artist, e.g.
::
fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
cax : `~matplotlib.axes.Axes`, optional
Axes into which the colorbar will be drawn.
ax : `~.axes.Axes` or list or `numpy.ndarray` of Axes, optional
One or more parent axes from which space for a new colorbar axes
will be stolen, if *cax* is None. This has no effect if *cax* is
set.
use_gridspec : bool, optional
If *cax* is ``None``, a new *cax* is created as an instance of
Axes. If *ax* is an instance of Subplot and *use_gridspec* is
``True``, *cax* is created as an instance of Subplot using the
:mod:`.gridspec` module.
Returns
-------
colorbar : `~matplotlib.colorbar.Colorbar`
Other Parameters
----------------
%(_make_axes_kw_doc)s
%(_colormap_kw_doc)s
Notes
-----
If *mappable* is a `~.contour.ContourSet`, its *extend* kwarg is
included automatically.
The *shrink* kwarg provides a simple way to scale the colorbar with
respect to the axes. Note that if *cax* is specified, it determines the
size of the colorbar and *shrink* and *aspect* kwargs are ignored.
For more precise control, you can manually specify the positions of the
axes objects in which the mappable and the colorbar are drawn. In this
case, do not use any of the axes properties kwargs.
It is known that some vector graphics viewers (svg and pdf) renders
white gaps between segments of the colorbar. This is due to bugs in
the viewers, not Matplotlib. As a workaround, the colorbar can be
rendered with overlapping segments::
cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()
However, this has negative consequences in other circumstances, e.g.
with semi-transparent images (alpha < 1) and colorbar extensions;
therefore, this workaround is not used by default (see issue #1188).
Nr� Fr� z�Unable to determine Axes to steal space for Colorbar. Using gca(), but will raise in the future. Either provide the *cax* argument to use as the Axes for the Colorbar, provide the *ax* argument to steal space from it, or add *mappable* to an Axes.)�messager� )�visibler� r1 T)�fraction�pad�shrink�aspectr� �panchor)r� �get_layout_engine�colorbar_gridspecrZ �warn_deprecated�gcar r �cbar�make_axes_gridspec� make_axes�grid�items�Colorbarr r" )
r$ �mappable�caxr� � use_gridspecrs �
current_ax�userax�NON_COLORBAR_KEYS�k�v�cb_kw�cbs
r& �colorbarzFigureBase.colorbar� s4 � �N �:���6�4�0�B� � "� "� $� 0��*�*�,�>�>� �L� �;��z��$�$�U�=�?� �X�X�Z�� ����J��F� ��B� �!<� "� 5� 5�b� C�F� C� ��V� "�n�n�R� :�6� :� ��V� �H�H�U�&�v�H� >��F� (��"(�,�,�.�O�$�!�Q�A�=N�4N��A��O��O�
�]�]�3��
2�E�
2��� �H�H�Z� ���
�� �� Ps �, D4�9D4c �j � | j � �0| j � j st j d� y| j j ||||||� | j D ]= }t |d� s�|j |j � j | � � �? d| _ y)a
Adjust the subplot layout parameters.
Unset parameters are left unmodified; initial values are given by
:rc:`figure.subplot.[name]`.
Parameters
----------
left : float, optional
The position of the left edge of the subplots,
as a fraction of the figure width.
right : float, optional
The position of the right edge of the subplots,
as a fraction of the figure width.
bottom : float, optional
The position of the bottom edge of the subplots,
as a fraction of the figure height.
top : float, optional
The position of the top edge of the subplots,
as a fraction of the figure height.
wspace : float, optional
The width of the padding between subplots,
as a fraction of the average Axes width.
hspace : float, optional
The height of the padding between subplots,
as a fraction of the average Axes height.
Nz�This figure was using a layout engine that is incompatible with subplots_adjust and/or tight_layout; not calling subplots_adjust.r� T) r^ �adjust_compatiblerZ �
warn_external� subplotparsrW r� r� �
_set_positionr� � get_positionr" )r$ rM rN rO rP rQ rR r� s r& r� zFigureBase.subplots_adjust s� � �:
� "� "� $� 0��*�*�,�>�>� � � �/�
0�
� ��� � ��f�e�S�&�&�I��)�)� J�B��r�,�-�� � ��!3�!3�!5�!B�!B�4�!H�I� J� ��
r( c � � |� | j }t j |� }|D �cg c] }t |d� s�|�� }}|D ]� }t j d|j
� � |j � j }|j j � }|D ]� }|j j � |k( s�!|j � j }|dk( r|j |j k( s |dk( s�_|j |j k( s�y| j d j ||� �� �� yc c}w )ar
Align the xlabels of subplots in the same subplot column if label
alignment is being done automatically (i.e. the label position is
not manually set).
Alignment persists for draw events after this is called.
If a label is on the bottom, it is aligned with labels on Axes that
also have their label on the bottom and that have the same
bottom-most subplot row. If the label is on the top,
it is aligned with labels on Axes with the same top-most row.
Parameters
----------
axs : list of `~matplotlib.axes.Axes`
Optional list of (or ndarray) `~matplotlib.axes.Axes`
to align the xlabels.
Default is to align all Axes on the figure.
See Also
--------
matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_labels
Notes
-----
This assumes that ``axs`` are from the same `.GridSpec`, so that
their `.SubplotSpec` positions correspond to figure positions.
Examples
--------
Example with rotated xtick labels::
fig, axs = plt.subplots(1, 2)
for tick in axs[0].get_xticklabels():
tick.set_rotation(55)
axs[0].set_xlabel('XLabel 0')
axs[1].set_xlabel('XLabel 1')
fig.align_xlabels()
Nr� � Working on: %srP rN r` )r� r �ravelr� �_log�debug�
get_xlabelr� �rowspan�xaxis�get_label_position�start�stoprh �join)r$ r( r� r �pos�axc�rowspancs r& �
align_xlabelszFigureBase.align_xlabels2 s � �R �;��)�)�C��h�h�s�m�� �B�b�7�2�/@�#A�r�B��B�� D�B� �J�J�(�"�-�-�/� :��(�(�*�2�2�G��(�(�-�-�/�C� �
D���9�9�/�/�1�S�8� "� 2� 2� 4� <� <�H��u� �� � �(�.�.�)H� �8�O�� � ��
�
�0M� �0�0��5�:�:�2�s�C�
D� D�� C�
�D<�D<c � � |� | j }t j |� }|D �cg c] }t |d� s�|�� }}|D ]� }t j d|j
� � |j � j }|j j � }|D ]� }|j j � |k( s�!|j � j }|dk( r|j |j k( s |dk( s�_|j |j k( s�y| j d j ||� �� �� yc c}w )aM
Align the ylabels of subplots in the same subplot column if label
alignment is being done automatically (i.e. the label position is
not manually set).
Alignment persists for draw events after this is called.
If a label is on the left, it is aligned with labels on Axes that
also have their label on the left and that have the same
left-most subplot column. If the label is on the right,
it is aligned with labels on Axes with the same right-most column.
Parameters
----------
axs : list of `~matplotlib.axes.Axes`
Optional list (or ndarray) of `~matplotlib.axes.Axes`
to align the ylabels.
Default is to align all Axes on the figure.
See Also
--------
matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_labels
Notes
-----
This assumes that ``axs`` are from the same `.GridSpec`, so that
their `.SubplotSpec` positions correspond to figure positions.
Examples
--------
Example with large yticks labels::
fig, axs = plt.subplots(2, 1)
axs[0].plot(np.arange(0, 1000, 50))
axs[0].set_ylabel('YLabel 0')
axs[1].set_ylabel('YLabel 1')
fig.align_ylabels()
Nr� rz rM rO ra )r� r r{ r� r| r} �
get_ylabelr� �colspan�yaxisr� r� r� rh r� )r$ r( r� r� r� r� �colspancs r& �
align_ylabelszFigureBase.align_ylabelsq s � �P �;��)�)�C��h�h�s�m�� �B�b�7�2�/@�#A�r�B��B�� D�B� �J�J�(�"�-�-�/� :��(�(�*�2�2�G��(�(�-�-�/�C� �
D���9�9�/�/�1�S�8� "� 2� 2� 4� <� <�H��v�
�'�-�-�8�>�>�*I� �7�N�w�|�|�x�}�}�/L� �0�0��5�:�:�2�s�C�
D� D�� Cr� c �L � | j |�� | j |�� y)a�
Align the xlabels and ylabels of subplots with the same subplots
row or column (respectively) if label alignment is being
done automatically (i.e. the label position is not manually set).
Alignment persists for draw events after this is called.
Parameters
----------
axs : list of `~matplotlib.axes.Axes`
Optional list (or ndarray) of `~matplotlib.axes.Axes`
to align the labels.
Default is to align all Axes on the figure.
See Also
--------
matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels
)r( N)r� r� )r$ r( s r& � align_labelszFigureBase.align_labels� s& � �*
���s��#� ���s��#r( c �H � |j dd� }t d||| d�|��}|S )ak
Return a `.GridSpec` that has this figure as a parent. This allows
complex layout of Axes in the figure.
Parameters
----------
nrows : int, default: 1
Number of rows in grid.
ncols : int, default: 1
Number of columns in grid.
Returns
-------
`.GridSpec`
Other Parameters
----------------
**kwargs
Keyword arguments are passed to `.GridSpec`.
See Also
--------
matplotlib.pyplot.subplots
Examples
--------
Adding a subplot that spans two rows::
fig = plt.figure()
gs = fig.add_gridspec(2, 2)
ax1 = fig.add_subplot(gs[0, 0])
ax2 = fig.add_subplot(gs[1, 0])
# spans two rows:
ax3 = fig.add_subplot(gs[:, 1])
r! N)r% r& r! rI )r5 r )r$ r% r& rs �_r' s r& r# zFigureBase.add_gridspec� s0 � �N
�J�J�x�� &��
�
F�E��t�
F�v�
F��� r( c �@ � t ||| ||||�� } t j ||ft �� }
t |� D ]/ } t |� D ] } | j
| | | f fi |��|
| | f< �! �1 |r/|
j dk( r|
j � S |
j � S |
S )az
Add a set of subfigures to this figure or subfigure.
A subfigure has the same artist methods as a figure, and is logically
the same as a figure, but cannot print itself.
See :doc:`/gallery/subplots_axes_and_figures/subfigures`.
Parameters
----------
nrows, ncols : int, default: 1
Number of rows/columns of the subfigure grid.
squeeze : bool, default: True
If True, extra dimensions are squeezed out from the returned
array of subfigures.
wspace, hspace : float, default: None
The amount of width/height reserved for space between subfigures,
expressed as a fraction of the average subfigure width/height.
If not given, the values will be inferred from a figure or
rcParams when necessary.
width_ratios : array-like of length *ncols*, optional
Defines the relative widths of the columns. Each column gets a
relative width of ``width_ratios[i] / sum(width_ratios)``.
If not given, all columns will have the same width.
height_ratios : array-like of length *nrows*, optional
Defines the relative heights of the rows. Each row gets a
relative height of ``height_ratios[i] / sum(height_ratios)``.
If not given, all rows will have the same height.
)r% r& r! rQ rR r r ��dtyper� ) r r �empty�object�range�
add_subfigurer� �itemr )
r$ r% r& r rQ rR r r rs r' �sfarr�i�js
r& �
subfigureszFigureBase.subfigures� s� � �H �E��t� #�F�#/�$1�3��
���%�� �v�6���u� � E�A��5�\�
E�� 0�d� 0� 0��A�q�D�� D�V� D��a��d� �
E� E� � $)�:�:��?�5�:�:�<� G��
�
�� G� �Lr( c �L � t | |fi |��}| xj |gz
c_ |S )a�
Add a `.SubFigure` to the figure as part of a subplot arrangement.
Parameters
----------
subplotspec : `.gridspec.SubplotSpec`
Defines the region in a parent gridspec where the subfigure will
be placed.
Returns
-------
`.SubFigure`
Other Parameters
----------------
**kwargs
Are passed to the `.SubFigure` object.
See Also
--------
.Figure.subfigures
)� SubFigurerp )r$ � subplotspecrs �sfs r& r� zFigureBase.add_subfigure( s* � �. �t�[�
3�F�
3�� � � ��� � �� r( c �t � | j j |� | j j d| � |S )z.Set the current Axes to be *a* and return *a*.r9 )r r< r: r; r6 s r& r zFigureBase.scaC s0 � � �
�
� � �Q� � ���!�!�"6��=��r( c �^ � | j j � }|�|S | j � S )a�
Get the current Axes.
If there is currently no Axes on this Figure, a new one is created
using `.Figure.add_subplot`. (To test whether there is currently an
Axes on a Figure, check whether ``figure.axes`` is empty. To test
whether there is currently a Figure on the pyplot figure stack, check
whether `.pyplot.get_fignums()` is empty.)
)r rD r )r$ r� s r& ra zFigureBase.gcaI s. � � �]�]�
"�
"�
$���^�r�;��)9�)9�);�;r( c �� � | j j � }|�y|j � }|�|S t | j � D ] }|j � }|��|c S y)a>
Get the current colorable artist.
Specifically, returns the current `.ScalarMappable` instance (`.Image`
created by `imshow` or `figimage`, `.Collection` created by `pcolor` or
`scatter`, etc.), or *None* if no such instance has been defined.
The current image is an attribute of the current Axes, or the nearest
earlier Axes in the current figure that contains an image.
Notes
-----
Historically, the only colorable artists were images; hence the name
``gci`` (get current image).
N)r rD �_gci�reversedr� )r$ r� �ims r& r� zFigureBase._gciV sg � �$ �]�]�
"�
"�
$��
�:��
�W�W�Y��
�>��I� �4�9�9�%� �B�����B��~�� � � r( )�
axes_class�polar�
projectionc �~ � |�|s|� t d� �|}n�|r|�|dk7 rt d|� d|�d�� �d}t |t � s|�t j |� }n@t |d� r&|j
� \ }} |j d i |�� nt d|��� �|j dk( r|j d d
� ||fS ) z�
Handle the args/kwargs to add_axes/add_subplot/gca, returning::
(axes_proj_class, proj_class_kwargs)
which can be used for new Axes initialization/identification.
z7Cannot combine 'axes_class' and 'projection' or 'polar'r� zpolar=z, yet projection=z1. Only one of these arguments should be supplied.� _as_mpl_axeszJprojection must be a string, None or implement a _as_mpl_axes method, not �Axes3D�auto_add_to_figureFrI ) r: r r r �get_projection_classr� r� rW r rE �
setdefault)r$ r� r� r� r� rs r � extra_kwargss r& r z+FigureBase._process_projection_requirementsw s � � � !��
�.� �M�O� O� )� � � �)�j�G�.C�$� ���'8��� GJ� J�� � %�
��*�c�*�j�.@�#.�#C�#C�J�#O� ���^�4�1;�1H�1H�1J�.� �,� ��
�
�-� �-� �0�0:�~�?�@� @� � $� $�� 0� � � � 2�E� :� ��'�'r( c � � | j � D �cg c]$ }|j � r|j � r|��& }}| j D ]2 }|j � s�|j |j � � �4 |S c c}w r )r r� �
get_in_layoutr� �extend� get_default_bbox_extra_artists)r$ ry � bbox_artistsr� s r& r� z)FigureBase.get_default_bbox_extra_artists� s� � �-1�->�->�-@� N�6� "� .� .� 0�V�5I�5I�5K� � N� � N��)�)� I�B��~�~� � �#�#�B�$E�$E�$G�H� I� ��� Ns �)Bc �T � |�| j j � }g }|�| j � }n|}|D ]' }|j |� }|��|j |� �) | j
D ]8 }|j
� s� |j ||�� }|j |� �: |D �cg c]` }t j |j � r?t j |j � r |j dk7 s|j dk7 r|��b }}t | d� } t |� dk( r| r | j S | j g}t! j" |� }
| r$t% |
| j& j) � � }
|
S # t $ r |j |� }Y ��
w xY wc c}w )aF
Return a (tight) bounding box of the figure *in inches*.
Note that `.FigureBase` differs from all other artists, which return
their `.Bbox` in pixels.
Artists that have ``artist.set_in_layout(False)`` are not included
in the bbox.
Parameters
----------
renderer : `.RendererBase` subclass
Renderer that will be used to draw the figures (i.e.
``fig.canvas.get_renderer()``)
bbox_extra_artists : list of `.Artist` or ``None``
List of artists to include in the tight bounding box. If
``None`` (default), then all artist children of each Axes are
included in the tight bounding box.
Returns
-------
`.BboxBase`
containing the bounding box (in figure inches).
)�bbox_extra_artistsr � bbox_inches)r! r r� �
get_tightbboxr� r� r� r r r �width�heightr� r� r� r� r �unionr �dpi_scale_trans�inverted) r$ r� r� �bbrj r7 r� r� r� �isfigure�_bboxs r& r� zFigureBase.get_tightbbox� s� � �6 � ��{�{�0�0�2�H�
�� � %��9�9�;�G�(�G�� �A��?�?�8�,�D�� �� � �$�� �
�)�)� �B��~�~� �6� �+�+� �5G� ,� I�D� � � �$�� � � 8�A��+�+�a�g�g�&�2�;�;�q�x�x�+@��w�w�!�|�q�x�x�1�}� � 8�� 8� �4� �/�� �r�7�a�<���'�'�'� �i�i�[���
�
�2��� �#�E�4�+?�+?�+H�+H�+J�K�E�� ��+ !� 6� �+�+�H�5�D�6��8s �F�+A%F%�F"�!F"c � � d| vr(| j d� D �cg c]
}t |� �� c}S t j | � } | j d� j d� D �cg c]
}t |� �� c}S c c}w c c}w )N�
�;)�split�list�inspect�cleandoc�strip)�layout�lns r& �_normalize_grid_stringz!FigureBase._normalize_grid_string� sn � � �v� �'-�|�|�C�'8�9��D��H�9� 9� �%�%�f�-�F�'-�|�|�D�'9�'?�'?��'E�F��D��H�F� F�� :�� Gs �A9�$A>�.)r r r r �empty_sentinelr r c �" � ������� �xs i �t �xs i � �|�d�v r t d� �|�d< |�d�v r t d� �|�d< t |t � r� j |� }t j t ||�� d� ���fd������ �fd�� �|� }|j \ } }
� j | |
fi ���} �| |g �|� ��� } t t | j � � � }
| j � D ]M }|r#|j |
� |j d �
� |s�+|j |
� |j! d �
� �O | j# � D ]' \ }}t |t � s�|j% |� �) | S ) a�
Build a layout of Axes based on ASCII art or nested lists.
This is a helper function to build complex GridSpec layouts visually.
.. note::
This API is provisional and may be revised in the future based on
early user feedback.
See :doc:`/tutorials/provisional/mosaic`
for an example and full API documentation
Parameters
----------
mosaic : list of list of {hashable or nested} or str
A visual layout of how you want your Axes to be arranged
labeled as strings. For example ::
x = [['A panel', 'A panel', 'edge'],
['C panel', '.', 'edge']]
produces 4 Axes:
- 'A panel' which is 1 row high and spans the first two columns
- 'edge' which is 2 rows high and is on the right edge
- 'C panel' which in 1 row and 1 column wide in the bottom left
- a blank space 1 row and 1 column wide in the bottom center
Any of the entries in the layout can be a list of lists
of the same form to create nested layouts.
If input is a str, then it can either be a multi-line string of
the form ::
'''
AAE
C.E
'''
where each character is a column and each line is a row. Or it
can be a single-line string where rows are separated by ``;``::
'AB;CC'
The string notation allows only single character Axes labels and
does not support nesting but is very terse.
sharex, sharey : bool, default: False
If True, the x-axis (*sharex*) or y-axis (*sharey*) will be shared
among all subplots. In that case, tick label visibility and axis
units behave as for `subplots`. If False, each subplot's x- or
y-axis will be independent.
width_ratios : array-like of length *ncols*, optional
Defines the relative widths of the columns. Each column gets a
relative width of ``width_ratios[i] / sum(width_ratios)``.
If not given, all columns will have the same width. Equivalent
to ``gridspec_kw={'width_ratios': [...]}``.
height_ratios : array-like of length *nrows*, optional
Defines the relative heights of the rows. Each row gets a
relative height of ``height_ratios[i] / sum(height_ratios)``.
If not given, all rows will have the same height. Equivalent
to ``gridspec_kw={'height_ratios': [...]}``.
subplot_kw : dict, optional
Dictionary with keywords passed to the `.Figure.add_subplot` call
used to create each subplot.
gridspec_kw : dict, optional
Dictionary with keywords passed to the `.GridSpec` constructor used
to create the grid the subplots are placed on.
empty_sentinel : object, optional
Entry in the layout to mean "leave this space empty". Defaults
to ``'.'``. Note, if *layout* is a string, it is processed via
`inspect.cleandoc` to remove leading white space, which may
interfere with using white-space as the empty sentinel.
Returns
-------
dict[label, Axes]
A dictionary mapping the labels to the Axes objects. The order of
the axes is left-to-right and top-to-bottom of their position in the
total layout.
r r r r! )r r c �� � | ^}}t |t � r t d� �t |d�� D ]d \ }}t |t � r t d� �t |� t |� k7 s�9t d|�dt |� � d|� d|�dt |� � d� � � t j t | � t |� ft � � }t | � D ] \ }}t |� D ] \ }}||||f< � �! |S )
aV
Convert input into 2D array
We need to have this internal function rather than
``np.asarray(..., dtype=object)`` so that a list of lists
of lists does not get converted to an array of dimension >
2
Returns
-------
2D object array
z$List mosaic specification must be 2Dr� )r� z@All of the rows must be the same length, however the first row (z
) has length z and row z (r� r� )r r r: � enumerater� r �zerosr� )�inp�r0�restr� �r�outrn ro s r& � _make_arrayz.FigureBase.subplot_mosaic.<locals>._make_arraye s � � �I�B���"�c�"� �!G�H�H�!�$�a�0�
���1� �a��%�$�%K�L�L��r�7�c�!�f�$�$�*�*,��}�S��W�I� F#�#$�#�R��u�M�#�a�&���D�� �
� �(�(�C��H�c�"�g�.�f�=�C�!�#��
"���1� %�a�L� "�D�A�q� !�C��1��I�"�
"� �Jr( c �
�� t j � }i }t | � D ]R \ }}t |� D ]? \ }}|�k( r� t j |� s �|� |||f< �/|j |� �A �T t |� |fS )ax
Given a 2D object array, identify unique IDs and nested mosaics
Parameters
----------
mosaic : 2D numpy object array
Returns
-------
unique_ids : tuple
The unique non-sub mosaic entries in this mosaic
nested : dict[tuple[int, int]], 2D object array
)rf � _OrderedSetr� �is_scalar_or_stringr> r ) �mosaic�
unique_ids�nestedr� �rowrn ro r� r� s ��r& �_identify_keys_and_nestedz<FigureBase.subplot_mosaic.<locals>._identify_keys_and_nested� s� �� � �*�*�,�J��F�#�F�+�
*���3� %�c�N� *�D�A�q��N�*� � "� 6� 6�q� 9�)4�Q� ���1�v��"���q�)�
*�
*� ��$�f�,� ,r( c � �� t � }t � }|D ]� }t j ||k( � }t j |d�� \ }} t j |d�� dz \ }
} t ||
� t | | � f} || |k7 j
� rt d|�d|�d�� �|| df||| f< �� |j � D ] \ \ }
}}d|d f||
|f< � t |� D ]� }|| \ }}}|dk( r@|} ||v rt d
|� d |��� � �j | | fi d t |� i� ���}|||< �Q|d k( r||}|\ }
}|j \ }} � | |
|f j ||fi ���|g �|� ��� }t |� t |� z }|rt d
|� d
|�d|� �� �|j |� ��t! d� � |S )aB
Recursively do the mosaic.
Parameters
----------
gs : GridSpec
mosaic : 2D object array
The input converted to a 2D numpy array for this level.
unique_ids : tuple
The identified scalar labels at this level of nesting.
nested : dict[tuple[int, int]], 2D object array
The identified nested mosaics, if any.
Returns
-------
dict[label, Axes]
A flat dict of all of the Axes created.
r r0 r� zWhile trying to layout
z
we found that the label z4 specifies a non-rectangular or non-contiguous area.r� Nr� zThere are duplicate keys z in the layout
r� z between the outer layout
z
and the nested layout
zThis should never happen)r" r �argwhere�minrB �slice�anyr: rf r� r r �shape� subgridspecrr rW � RuntimeError) r' r� r� r� �output�
this_levelr� �indx� start_row� start_col�end_row�end_col�slcr� rn �
nested_mosaicr@ �arg�methodr� �rows�cols�
nested_output�overlap�
_do_layoutr� r r$ r s �����r& r� z-FigureBase.subplot_mosaic.<locals>._do_layout� s{ �� �& �V�F� ��J� #�
I���{�{�6�T�>�2��')�v�v�d��';�$� �9�#%�6�6�$�Q�#7�!�#;� ��� �Y��0�%� �7�2K�L���3�K�4�'�,�,�.�$�2�6�*� =3�37�(� ;B�B�C� C�
7;�C��5H�
�I�y�1�2�
I�$ *0� � � �
E�%���A�
�&*�M�8�%D�
�A�q�6�"�
E�
�j�)� "
C��$.�s�O�!��c�6� �V�#� �C��v�~� (�+D�T�F� K;�;A�*�*F� G� G�)��)�)��3���$+�S��Y�#E�*�#E��B� $&�F�4�L��x�'�$'�M� �D�A�q�!.�!4�!4�J�D�$�$.�,��1�a�4��,�,�T�4�G�;�G�%�%� 3�=�A�%�M�
"�&�k�C�
�,>� >�G� � (� 7��y� A9�9?�
� C6�6C�_� F� � �
�M�M�-�0�&�'A�B�B�E"
C�F �Mr( T)� check_patch)r" r: r r r� rZ �check_isinstance�boolr� r# r; �iter�valuesr �_label_outer_xaxisr �_label_outer_yaxisrf � set_label)r$ r� r r r r r� r r r� r� r' �ret�ax0r� rn r� r� r� s ` ``` @@@r& �subplot_mosaiczFigureBase.subplot_mosaic� s� �� �x �%�2�
��;�,�"�-� � � $� �+�-� � "I� J� J�+8�K�� (� � #� ��,� � "I� J� J�*6�K�� '� �f�c� "��0�0��8�F� � � �d�6�&�A� �@ -�8Y � Y �v �V�$���\�\�
��d�
�T�
�
�t�T�
9�[�
9����V�H�&?��&G�H���4��
�
� �%�&���*�*�,� 8�B��� � �#���%�%�$�%�7��� � �#���%�%�$�%�7�
8� �Y�Y�[� �E�A�r��!�S�!�� � �Q�� � �
r( c �| � || k7 r|j | � t |_ |j | j � y r )r� r' r r� r� r6 s r& �_set_artist_propsz FigureBase._set_artist_props
s/ � � ��9�
�L�L�� �1��� ����+�+�,r( )g�������?� rO r� r �F)r� r� )NNTrY )r� r� TNNNN)NN);rE rF rG rH r1 r� r� r r� rZ �delete_parameterr� r� r � Substitution�copyr� r� r� r� r� r� r� r� r� r� r� �property�frameonr� �dedent_interpdr r r r$ r rB rF rQ r� rr r� r� r� r� r# r� r� r ra r� r r� r� � staticmethodr� r r �
__classcell__�rt s @r& r^ r^ � s� �� �� �<�4 >E�)�V
� � �T���5�&�)��T���5�(�+�� ,� *��N�` �Z� � ���:�(� %�'�3��Z�_�_�Z� �2� !�3�2� �Z� � ���;�8� (�W�6��Z�_�_�Z� �2� !�6�2� �Z� � ���;�6� (�W�6��Z�_�_�Z� �2� !�6�2�*�*�(�,�*� (�(� � �{�K�0�G�!�F � � �o/� �o/�b � � �0� �0�B �F�5�� �D�� �d�F�P#0�J!�H9�, � � �D� �D�L � � �/� �/�b � � �<@�j� �j�X GK�,0�(�T=D�~<D�|$�0)�V 48�'+�48�4�l�6� <� �D %)��$�$(�L �E�N �G� �G� 05�U�$(��&)�d��U�n-r( r^ c � � � e Zd ZdZ ej
dd�� ed� � � Zddddd�� fd �
Zed
� � Z e j d � � Z d � Z d
� Z d� Z
dd�Zd� Zdd�Zd� Zed� � Zej& Zd� Z� xZS )r� at
Logical figure that can be placed inside a figure.
Typically instantiated using `.Figure.add_subfigure` or
`.SubFigure.add_subfigure`, or `.SubFigure.subfigures`. A subfigure has
the same methods as a figure except for those particularly tied to the size
or dpi of the figure, and is confined to a prescribed region of the figure.
For example the following puts two subfigures side-by-side::
fig = plt.figure()
sfigs = fig.subfigures(1, 2)
axsL = sfigs[0].subplots(1, 2)
axsR = sfigs[1].subplots(2, 1)
See :doc:`/gallery/subplots_axes_and_figures/subfigures`
r� �4the 'resize_event' signal in Figure.canvas.callbacks�� alternativec � � | j S r ��_fig_callbacksr0 s r& r} zSubFigure.<lambda>) s � �D�$7�$7� r( N� )� facecolor� edgecolorr� r c �v �� t �| � d i |�� |�t j d }|�t j d }|�t j d }|| _ || _ |j | _ |j | _ |j | _ |j | _ |j | _
|j | _ |j | _ |j | _
d| _ | j � | j
j | _ t# | j | j
j$ � | _ t) | j& � | _ t+ ddd||||d| j$ �� | _ | j/ | j, � | j, j1 d� y)
a�
Parameters
----------
parent : `.Figure` or `.SubFigure`
Figure or subfigure that contains the SubFigure. SubFigures
can be nested.
subplotspec : `.gridspec.SubplotSpec`
Defines the region in a parent gridspec where the subfigure will
be placed.
facecolor : default: :rc:`figure.facecolor`
The figure patch face color.
edgecolor : default: :rc:`figure.edgecolor`
The figure patch edge color.
linewidth : float
The linewidth of the frame (i.e. the edge linewidth of the figure
patch).
frameon : bool, default: :rc:`figure.frameon`
If ``False``, suppress drawing the figure background patch.
Other Parameters
----------------
**kwargs : `.SubFigure` properties, optional
%(SubFigure:kwdoc)s
N�figure.facecolor�figure.edgecolor�figure.frameon�r r r� F) �xyr� r� rX r r r� � in_layoutrO rI )rb r1 rU rV � _subplotspec�_parentr! r r rv r� r: �canvas� transFigure�
bbox_relative�_redo_transform_rel_fig�figbboxr r� r� r r r� r �set_antialiased) r$ �parentr� r r r� r rs rt s �r& r1 zSubFigure.__init__+ sq �� �H ���"�6�"� � �� � �%7�8�I� � �� � �%7�8�I� �?��l�l�#3�4�G� '��� �� � �m�m�� � $� 3� 3��� ����
�!�-�-��� %� 5� 5�� � "� /� /��� �m�m�� �!�-�-��� !��� �$�$�&��|�|�+�+�� �#�D�$6�$6�$(�L�L�$?�$?�A�� � -�d�i�i� 8��� ��Q�q�'� �9� ��t�':�':� <��
�
� � �t�z�z�*� �
�
�"�"�5�)r( c �. � | j j S r �r& �dpir0 s r& r0 z
SubFigure.dpir s � ��|�|� � � r( c �& � || j _ y r r/ )r$ �values r& r0 z
SubFigure.dpiv s � � �� � �r( c �. � | j j S )zY
Return the resolution of the parent figure in dots-per-inch as a float.
r/ r0 s r& �get_dpizSubFigure.get_dpiz s � � �|�|� � � r( c �4 � || j _ d| _ y)z�
Set the resolution of parent figure in dots-per-inch.
Parameters
----------
val : float
TN)r& r0 r" r# s r& �set_dpizSubFigure.set_dpi� s � � �� � ����
r( c �6 � | j j � S r )r& r r0 s r& r zSubFigure._get_renderer� s � ��|�|�)�)�+�+r( c �� � |�7|j | j _ |j | j _ y| j j � }t j |j � � }t j |j � � }|| j j j � |j � z }|| j j j � |j � z }|d| j j j j � |j � z }d|d| j j j j � |j � z z
}| j � t j ||||� | _ y||f| j _ ||z ||z f| j _ y)a
Make the transSubfigure bbox relative to Figure transform.
Parameters
----------
bbox : bbox or None
If not None, then the bbox is used for relative bounding box.
Otherwise, it is calculated from the subplotspec.
Nr� )�p0r) �p1r% � get_gridspecr �asarray�get_width_ratios�get_height_ratiosr� �sumr r� r� r � from_bounds) r$ r� r' �wr�hr�dx�dyr� r� s r& r* z!SubFigure._redo_transform_rel_fig� s� � � � �$(�G�G�D� � � !�$(�G�G�D� � � !� �
�
�
�
+�
+�
-��
�Z�Z��+�+�-�
.��
�Z�Z��,�,�.�
/��
��!�!�)�)�
*�
.�
.�
0�2�6�6�8�
;��
��!�!�)�)�
*�
.�
.�
0�2�6�6�8�
;��
�0��"�"�*�*�0�0�
1�
5�
5�
7�"�&�&�(�
B��
��3�T�&�&�.�.�3�3�4�8�8�:�R�V�V�X�E�
E�� � � � %�!%�!1�!1�"�b�"�b�!A�D� �%'��H�D� � � !�%'�"�W�b�2�g�$6�D� � � !r( c �6 � | j j � S �z�
Return whether constrained layout is being used.
See :doc:`/tutorials/intermediate/constrainedlayout_guide`.
)r& �get_constrained_layoutr0 s r& rG z SubFigure.get_constrained_layout� s � � �|�|�2�2�4�4r( c �: � | j j |�� S )az
Get padding for ``constrained_layout``.
Returns a list of ``w_pad, h_pad`` in inches and
``wspace`` and ``hspace`` as fractions of the subplot.
See :doc:`/tutorials/intermediate/constrainedlayout_guide`.
Parameters
----------
relative : bool
If `True`, then convert from inches to figure relative.
)�relative)r& �get_constrained_layout_pads)r$ rI s r& rJ z%SubFigure.get_constrained_layout_pads� s � � �|�|�7�7��7�J�Jr( c �6 � | j j � S r )r& r^ r0 s r& r^ zSubFigure.get_layout_engine� s � ��|�|�-�-�/�/r( c � � | j dd S )a�
List of Axes in the SubFigure. You can access and modify the Axes
in the SubFigure through this list.
Modifying this list has no effect. Instead, use `~.SubFigure.add_axes`,
`~.SubFigure.add_subplot` or `~.SubFigure.delaxes` to add or remove an
Axes.
Note: The `.SubFigure.axes` property and `~.SubFigure.get_axes` method
are equivalent.
N)ri r0 s r& r� zSubFigure.axes� s � � ���q�!�!r( c � � | j � sy | j |� } |j d| j � �� | j j |� t
j || || j j � | j D ] }|j |� � |j d� d| _ y # d| _ w xY w)N� subfigure��gidF)
r� r� �
open_group�get_gidr� �draw�mimage� _draw_list_compositing_imagesr! rq rp � close_groupr" �r$ r� rj r� s r& rS zSubFigure.draw� s� � � � � �!� ��(�(��2��
� � � � �� � � � � @� �J�J�O�O�H� %� � 0� 0��$�����)F�)F�
H� � � �
$��� � �(�#�
$� � � �� -� �D�J���D�J�s �BC � Cr r
)rE rF rG rH rZ �
deprecatedr � callbacksr1 r0 �setterr4 r6 r r* rG rJ r^ r� �fgetr� rS r r s @r& r� r� s� �� �� ����� � !:�� �7�8�:�I� � � � � E*�N � � � � �Z�Z�!� �!� � �,�7�85�K� 0� � "� � "� �y�y�H� r( r� c �t � � e Zd ZdZ ej
dd�� ed� � � Zd� Zd� Z ej dd� d@d d
�� fd � � Z � fd �Z d
� Z
dAd�Zd� Zd� ZdBd�Zed� � Zej& Zd� Zd� ZdBd�Z eeed�� Zd� Z ej
ddd�� d � � Zd � Z ej
dd d�� d � � Z ej
dd d�� d!� � Z ej
dd"d�� dCd#�� Z d$� Z e jB dDd%�� Z"dEd&�Z#d'� Z$d(� Z%d)� Z&d*� Z'd+� Z(dBd,�Z)dBd-�Z*dC� fd.� Z+e,e-d/� � � Z.d0� Z/d1� Z0� fd2�Z1d3� Z2d4� Z3d d5�d6�Z4d7d8de5jl e5jn e5jp fd9�Z9dFd:�Z: ej
dd;�� dAd<�� Z;d=d d d d>�d?�Z<� xZ=S )G�Figurea�
The top level container for all the plot elements.
Attributes
----------
patch
The `.Rectangle` instance representing the figure background patch.
suppressComposite
For multiple images, the figure will make composite images
depending on the renderer option_image_nocomposite function. If
*suppressComposite* is a boolean, this will override the renderer.
r� r r c � � | j S r r r0 s r& r} zFigure.<lambda> s � �� 3� 3� r( c �F � dt | j j � z S )Nz
Figure(%gx%g))r r� r� r0 s r& �__str__zFigure.__str__ s � � ��t�y�y�~�~�!6�6�6r( c �� � dj | j j | j j d | j j d t | j � �� S )Nz.<{clsname} size {h:g}x{w:g} with {naxes} Axes>r r� )�clsname�h�w�naxes)r rt rE r� r� r� r� r0 s r& �__repr__zFigure.__repr__ sR � �?�F�F��N�N�+�+��i�i�n�n�Q� �4�9�9�>�>�!�#4��d�i�i�.� G�
�
r( r N�r� c
�z �� t �
| � di | �� d| _ |
�A|�t j d� | �t j d� | j |
�� n�|�Z| �t j d� | j d�� t
|t � r� | j � j di |�� nl| �Xt
| t � r3| j d�� | j � j di | �� n'| r%| j d�� n| j |
�� t j dg� � | _ t j t j � � | _ | j j } | d
t" j$ � | d t" j$ � | d t" j$ � | d t" j& � | d
t" j& � | dt" j& � | dt" j& � g| _ | d | j* � | _ | d| j* � | _ |�t0 j2 d }|�t0 j2 d }|�t0 j2 d }|�t0 j2 d }|�t0 j2 d }t5 j6 |� j9 � r&t5 j: |� dk j= � rt? d|� �� �tA jB ddg|��� | _" tG � jI |� | _% || _& tO | jD | jJ � | _( | jP | _) tU | jP � | _+ | jV | _, t[ ddd||||d�� | _. | j_ | j\ � | j\ ja d� t | � |�
tc � }|| _2 tg � | _4 | jk � y) a�
Parameters
----------
figsize : 2-tuple of floats, default: :rc:`figure.figsize`
Figure dimension ``(width, height)`` in inches.
dpi : float, default: :rc:`figure.dpi`
Dots per inch.
facecolor : default: :rc:`figure.facecolor`
The figure patch facecolor.
edgecolor : default: :rc:`figure.edgecolor`
The figure patch edge color.
linewidth : float
The linewidth of the frame (i.e. the edge linewidth of the figure
patch).
frameon : bool, default: :rc:`figure.frameon`
If ``False``, suppress drawing the figure background patch.
subplotpars : `SubplotParams`
Subplot parameters. If not given, the default subplot
parameters :rc:`figure.subplot.*` are used.
tight_layout : bool or dict, default: :rc:`figure.autolayout`
Whether to use the tight layout mechanism. See `.set_tight_layout`.
.. admonition:: Discouraged
The use of this parameter is discouraged. Please use
``layout='tight'`` instead for the common case of
``tight_layout=True`` and use `.set_tight_layout` otherwise.
constrained_layout : bool, default: :rc:`figure.constrained_layout.use`
This is equal to ``layout='constrained'``.
.. admonition:: Discouraged
The use of this parameter is discouraged. Please use
``layout='constrained'`` instead.
layout : {'constrained', 'compressed', 'tight', `.LayoutEngine`, None}
The layout mechanism for positioning of plot elements to avoid
overlapping Axes decorations (labels, ticks, etc). Note that
layout managers can have significant performance penalties.
Defaults to *None*.
- 'constrained': The constrained layout solver adjusts axes sizes
to avoid overlapping axes decorations. Can handle complex plot
layouts and colorbars, and is thus recommended.
See :doc:`/tutorials/intermediate/constrainedlayout_guide`
for examples.
- 'compressed': uses the same algorithm as 'constrained', but
removes extra space between fixed-aspect-ratio Axes. Best for
simple grids of axes.
- 'tight': Use the tight layout mechanism. This is a relatively
simple algorithm that adjusts the subplot parameters so that
decorations do not overlap. See `.Figure.set_tight_layout` for
further details.
- A `.LayoutEngine` instance. Builtin layout classes are
`.ConstrainedLayoutEngine` and `.TightLayoutEngine`, more easily
accessible by 'constrained' and 'tight'. Passing an instance
allows third parties to provide their own layout engine.
If not given, fall back to using the parameters *tight_layout* and
*constrained_layout*, including their config defaults
:rc:`figure.autolayout` and :rc:`figure.constrained_layout.use`.
Other Parameters
----------------
**kwargs : `.Figure` properties, optional
%(Figure:kwdoc)s
NzdThe Figure parameters 'layout' and 'tight_layout' cannot be used together. Please use 'layout' only.zjThe Figure parameters 'layout' and 'constrained_layout' cannot be used together. Please use 'layout' only.rg ztThe Figure parameters 'tight_layout' and 'constrained_layout' cannot be used together. Please use 'layout' parameter�tight� constrained� dpi_changed)�signals�key_press_event�key_release_event�button_press_event�button_release_event� scroll_event�motion_notify_event�figure.figsizez
figure.dpir r r! r �(figure size must be positive finite not r" r� F)r# r� r� rX r r r� r$ rI )6rb r1 �_layout_enginerZ ru �set_layout_enginer r" r^ rr rf rC r r
�events�_canvas_callbacks�_connect_picklabler � _key_handler�_mouse_handler�_mouse_key_ids�pick�_button_pick_id�_scroll_pick_idrU rV r r r� �arrayr� r: r r@ r� r �scaler� �_dpir r� r+ r r( r� r r� r r, rK rv r* r rB )r$ �figsizer0 r r r� r rv � tight_layout�constrained_layoutr� rs �connectrt s �r& r1 zFigure.__init__ s� �� �~ ���"�6�"� "��� � � �(��"�"�B�C� #�.��"�"�I�J�
� "� "�&� "� 1�
�
%�!�-��"�"�)�*�
� "� "�'� "� 2��,��-�,��&�&�(�,�,�<�|�<�
�
+��,�d�3��&�&�m�&�<�,��&�&�(�,�,�B�/A�B�#��&�&�m�&�<�
� "� "�&� "� 1� #� 4� 4�m�_� M��� "'�!7�!7�$�+�+�"-�� ��(�(�;�;�� �%�}�'A�'A� B� �'� �)C�)C� D� �'� �)C�)C� D� �(�-�*F�*F� G� �*�M�,H�,H� I� �N�M�$@�$@� A� �)�=�+G�+G� H�
��� '�';�T�Y�Y� G�� � &�~�t�y�y� A�� � �?��l�l�#3�4�G� �;��,�,�|�,�C� � �� � �%7�8�I� � �� � �%7�8�I� �?��l�l�#3�4�G��{�{�7�#�'�'�)�b�h�h�w�.?�!�.C�-H�-H�-J� � G� '�y� *� +�
+� �+�+�A�q�;�7�;��� '�z� /� /�� 4�� ��� �#�D�$4�$4�d�6J�6J�K�� ��y�y�� �*�4�9�9�5��� "� .� .��� ��Q�q�'� �9� �� ��
�
� � �t�z�z�*� �
�
�"�"�5�)��� � � �'�/�K�&���"� ��
� �
�
� r( c �n �� | j j j � st �| � |� y y r )r' �
widgetlock�lockedrb r} )r$ r� rt s �r& r} z Figure.pick� s* �� ��{�{�%�%�,�,�.� �G�L�� $� /r( c � � |�|�y|j |j k( ry| j D ] }t |d� s� y y)z�
Helper for set_layout engine
If the figure has used the old engine and added a colorbar then the
value of colorbar_gridspec must be the same on the new engine.
T� _colorbarF)r_ r� r� )r$ �old�newr� s r& � _check_layout_engines_compatz#Figure._check_layout_engines_compat� sN � � �;�#�+�� � � �C�$9�$9� 9�� �)�)� �B��r�;�'� � � r( c �
� |�4t j d rd}n t j d rd}nd| _ y|dk( r t d i |��}n�|dk( r t d i |��}n}|dk( rt d ddi|��}nj|d k( rD| j �5t | j j | j j � }n$d}n!t |t � r|}nt d
|��� �| j | j |� r|| _ yt d � �)
a�
Set the layout engine for this figure.
Parameters
----------
layout: {'constrained', 'compressed', 'tight', 'none'} or `LayoutEngine` or None
- 'constrained' will use `~.ConstrainedLayoutEngine`
- 'compressed' will also use `~.ConstrainedLayoutEngine`, but with
a correction that attempts to make a good layout for fixed-aspect
ratio Axes.
- 'tight' uses `~.TightLayoutEngine`
- 'none' removes layout engine.
If `None`, the behavior is controlled by :rc:`figure.autolayout`
(which if `True` behaves as if 'tight' was passed) and
:rc:`figure.constrained_layout.use` (which if `True` behaves as if
'constrained' was passed). If both are `True`,
:rc:`figure.autolayout` takes priority.
Users and libraries can define their own layout engines and pass
the instance directly as well.
kwargs: dict
The keyword arguments are passed to the layout engine to set things
like padding and margin sizes. Only used if *layout* is a string.
N�figure.autolayoutri � figure.constrained_layout.userj �
compressed�compressT�nonez Invalid value for 'layout': zzColorbar layout of new layout engine not compatible with old engine, and a colorbar has been created. Engine not changed.rI )
rU rV ru r r r rt r_ r r r: r� r� )r$ r� rs �new_layout_engines r& rv zFigure.set_layout_engine� s( � �< �>��|�|� /�0� ��� � � =�>�&��&*��#�� �W� � 1� ;�F� ;� �
�}�
$� 7� A�&� A� �
�|�
#� 7� !B�� !B�:@�!B� �
�v�
��"�"�.�$;��'�'�9�9��'�'�9�9�%�!�
%)�!�
�� �
-� &� � � ;�F�:� F�G� G� � ,� ,�T�-@�-@�->� @�"3�D� � � H� I�
Ir( c � � | j S r )ru r0 s r& r^ zFigure.get_layout_engine"
s � ��"�"�"r( c �t � dt | j � j v rddlm} |j | � S y )N�WebAggr )�backend_webagg)�typer' rE �matplotlib.backendsr� �ipython_inline_display)r$ r� s r& � _repr_html_zFigure._repr_html_)
s4 � � �t�D�K�K�(�1�1� 1� :�!�8�8��>� >� 2r( Tc � � | j j � t d� � | j j j � y# t $ r/}|r#t j t |� � Y d}~yY d}~yd}~ww xY w)a�
If using a GUI backend with pyplot, display the figure window.
If the figure was not created using `~.pyplot.figure`, it will lack
a `~.backend_bases.FigureManagerBase`, and this method will raise an
AttributeError.
.. warning::
This does not manage an GUI event loop. Consequently, the figure
may only be shown briefly or not shown at all if you or your
environment are not managing an event loop.
Use cases for `.Figure.show` include running this from a GUI
application (where there is persistently an event loop running) or
from a shell, like IPython, that install an input hook to allow the
interactive shell to accept input while the figure is also being
shown and interactive. Some, but not all, GUI toolkits will
register an input hook on import. See :ref:`cp_integration` for
more details.
If you're in a shell without input hook integration or executing a
python script, you should use `matplotlib.pyplot.show` with
``block=True`` instead, which takes care of starting and running
the event loop for you.
Parameters
----------
warn : bool, default: True
If ``True`` and we are not running headless (i.e. on Linux with an
unset DISPLAY), issue warning when called on a non-GUI backend.
NzYFigure.show works only for figures managed by pyplot, normally created by pyplot.figure())r' �manager�AttributeError�showr rZ ru r )r$ �warn�excs r& r� z Figure.show0
so � �D �;�;� � � &� �6�7�
7� -� �K�K� � � $� $� &�� � -���"�"�3�s�8�,�,� �� -�s �$A � B � A;�;B c �6 � | j j � S )as
List of Axes in the Figure. You can access and modify the Axes in the
Figure through this list.
Do not modify the list itself. Instead, use `~Figure.add_axes`,
`~.Figure.add_subplot` or `~.Figure.delaxes` to add or remove an Axes.
Note: The `.Figure.axes` property and `~.Figure.get_axes` method are
equivalent.
)r r3 r0 s r& r� z Figure.axes\
s � � �}�}�$�$�&�&r( c �x � t | j d� r| j j � S t | � S )N� get_renderer)r� r' r� r r0 s r& r zFigure._get_rendererl
s. � � �4�;�;�� /��;�;�+�+�-� -� ��&� &r( c � � | j S r )r� r0 s r& �_get_dpizFigure._get_dpir
s � ��y�y�r( c �
� || j k( ry|| _ | j j � j |� | j � \ }}| j |||�� | j j d| � y)z�
Parameters
----------
dpi : float
forward : bool
Passed on to `~.Figure.set_size_inches`
N��forwardrk )r� r� rB r� �get_size_inches�set_size_inchesr r; )r$ r0 r� rd rc s r& �_set_dpizFigure._set_dpiu
st � � �$�)�)� � ��� � � � �"�"�$�*�*�3�/��#�#�%���1� � � �Q��7� �3� ���#�#�M�4�8r( z The resolution in dots per inch.)�docc �> � t | j � t � S )z6Return whether `.tight_layout` is called when drawing.)r r^ r r0 s r& �get_tight_layoutzFigure.get_tight_layout�
s � ��$�0�0�2�4E�F�Fr( rv )r �pendingc � � |�t j d }t |t � r|ni }t |� r| j t
di |��� d| _ y)a=
[*Discouraged*] Set whether and how `.tight_layout` is called when
drawing.
.. admonition:: Discouraged
This method is discouraged in favor of `~.set_layout_engine`.
Parameters
----------
tight : bool or dict with keys "pad", "w_pad", "h_pad", "rect" or None
If a bool, sets whether to call `.tight_layout` upon drawing.
If ``None``, use :rc:`figure.autolayout` instead.
If a dict, pass it as kwargs to `.tight_layout`, overriding the
default paddings.
Nr� TrI )rU rV r r" r� rv r r" )r$ ri �_tight_parameterss r& �set_tight_layoutzFigure.set_tight_layout�
sO � �& �=��L�L�!4�5�E�%/��t�%<�E�"�� ��;� � "� "�#4�#I�7H�#I� J���
r( c �> � t | j � t � S rF )r r^ r r0 s r& rG z Figure.get_constrained_layout�
s � � �$�0�0�2�4K�L�Lr( z set_layout_engine('constrained')c � � |�t j d }t |� }t |t � r|ni }|r| j t
di |��� d| _ y)a�
[*Discouraged*] Set whether ``constrained_layout`` is used upon
drawing.
If None, :rc:`figure.constrained_layout.use` value will be used.
When providing a dict containing the keys ``w_pad``, ``h_pad``
the default ``constrained_layout`` paddings will be
overridden. These pads are in inches and default to 3.0/72.0.
``w_pad`` is the width padding and ``h_pad`` is the height padding.
.. admonition:: Discouraged
This method is discouraged in favor of `~.set_layout_engine`.
Parameters
----------
constrained : bool or dict or None
Nr� TrI )rU rV r� r r" rv r r" )r$ rj � _constrained� _parameterss r& �set_constrained_layoutz Figure.set_constrained_layout�
sT � �, � � �,�,�'F�G�K��K�(� �%/� �T�%B�k�� � � � "� "�#:�#I�[�#I� J���
r( z figure.get_layout_engine().set()c � � t | j � t � r! | j � j di |�� yy)ak
Set padding for ``constrained_layout``.
Tip: The parameters can be passed from a dictionary by using
``fig.set_constrained_layout(**pad_dict)``.
See :doc:`/tutorials/intermediate/constrainedlayout_guide`.
Parameters
----------
w_pad : float, default: :rc:`figure.constrained_layout.w_pad`
Width padding in inches. This is the pad around Axes
and is meant to make sure there is enough room for fonts to
look good. Defaults to 3 pts = 0.04167 inches
h_pad : float, default: :rc:`figure.constrained_layout.h_pad`
Height padding in inches. Defaults to 3 pts.
wspace : float, default: :rc:`figure.constrained_layout.wspace`
Width padding between subplots, expressed as a fraction of the
subplot width. The total padding ends up being w_pad + wspace.
hspace : float, default: :rc:`figure.constrained_layout.hspace`
Height padding between subplots, expressed as a fraction of the
subplot width. The total padding ends up being h_pad + hspace.
NrI )r r^ r rr )r$ rs s r& �set_constrained_layout_padsz"Figure.set_constrained_layout_pads�
s: � �> �d�,�,�.�0G� H� (�D� "� "� $� (� (� 2�6� 2� Ir( z fig.get_layout_engine().get()c �< � t | j � t � sy| j � j � }|d }|d }|d }|d }|rD|�|�@| j � }|j
}||z |j z }||z |j z }||||fS )a�
Get padding for ``constrained_layout``.
Returns a list of ``w_pad, h_pad`` in inches and
``wspace`` and ``hspace`` as fractions of the subplot.
All values are None if ``constrained_layout`` is not used.
See :doc:`/tutorials/intermediate/constrainedlayout_guide`.
Parameters
----------
relative : bool
If `True`, then convert from inches to figure relative.
)NNNN�w_pad�h_padrQ rR )r r^ r �get_infor r0 r� r� ) r$ rI r� r� r� rQ rR r� r0 s r& rJ z"Figure.get_constrained_layout_pads�
s� � �" �$�0�0�2�4K�L�)��%�%�'�0�0�2���W�
���W�
���h� ���h� �� ��*�e�.?��)�)�+�H��,�,�C��C�K�(�.�.�0�E��C�K�(�/�/�1�E��e�V�V�+�+r( c � � || _ y)z~
Set the canvas that contains the figure
Parameters
----------
canvas : FigureCanvas
N)r' )r$ r' s r& �
set_canvaszFigure.set_canvas s � � �� r( c �� � |
rQ| j � } |j d |j d fD �
cg c] }
|
| z �� }}
| j |d�� t j | f||||| d�| ��}t
|_ |j |� |j |� |�|j ||� | j j |� | j j |_
d| _ |S c c}
w )a
Add a non-resampled image to the figure.
The image is attached to the lower or upper left corner depending on
*origin*.
Parameters
----------
X
The image data. This is an array of one of the following shapes:
- (M, N): an image with scalar data. Color-mapping is controlled
by *cmap*, *norm*, *vmin*, and *vmax*.
- (M, N, 3): an image with RGB values (0-1 float or 0-255 int).
- (M, N, 4): an image with RGBA values (0-1 float or 0-255 int),
i.e. including transparency.
xo, yo : int
The *x*/*y* image offset in pixels.
alpha : None or float
The alpha blending value.
%(cmap_doc)s
This parameter is ignored if *X* is RGB(A).
%(norm_doc)s
This parameter is ignored if *X* is RGB(A).
%(vmin_vmax_doc)s
This parameter is ignored if *X* is RGB(A).
origin : {'upper', 'lower'}, default: :rc:`image.origin`
Indicates where the [0, 0] index of the array is in the upper left
or lower left corner of the axes.
resize : bool
If *True*, resize the figure to match the given image size.
Returns
-------
`matplotlib.image.FigureImage`
Other Parameters
----------------
**kwargs
Additional kwargs are `.Artist` kwargs passed on to `.FigureImage`.
Notes
-----
figimage complements the Axes image (`~matplotlib.axes.Axes.imshow`)
which will be resampled to fit the current Axes. If you want
a resampled image to fill the entire figure, you can define an
`~matplotlib.axes.Axes` with extent [0, 0, 1, 1].
Examples
--------
::
f = plt.figure()
nx = int(f.get_figwidth() * f.dpi)
ny = int(f.get_figheight() * f.dpi)
data = np.random.random((ny, nx))
f.figimage(data)
plt.show()
r� r Tr� )�cmap�norm�offsetx�offsety�origin)r4 r� r� rT � FigureImager' r � set_array� set_alpha�set_climrn r� r8 r� r" )r$ �X�xo�yo�alphar� r� �vmin�vmaxr� �resizers r0 r` r� r� s r& �figimagezFigure.figimage s� � �P ��,�,�.�C�)*�����Q�W�W�Q�Z�(@�A�1�q�3�w�A�G�A� � � ��$� � 7�
�
�
�� 9�4�d�(*�B�'-�9�17�9�� 3���
� � �Q��
� � �U�� �<� �K�K��d� #� � � ���2� � �K�K� .� .�����
�� �� Bs � C0c � � |�|\ }}t j ||g� }t j |� j � r|dk j � rt d|� �� �|| j _ |rG| j j }|�/ |j || j z j t � � d| _ y)aH
Set the figure size in inches.
Call signatures::
fig.set_size_inches(w, h) # OR
fig.set_size_inches((w, h))
Parameters
----------
w : (float, float) or float
Width and height in inches (if height not specified as a separate
argument) or width.
h : float
Height in inches.
forward : bool, default: True
If ``True``, the canvas size is automatically updated, e.g.,
you can resize the figure window from the shell.
See Also
--------
matplotlib.figure.Figure.get_size_inches
matplotlib.figure.Figure.set_figwidth
matplotlib.figure.Figure.set_figheight
Notes
-----
To transform from pixels to inches divide by `Figure.dpi`.
Nr rt T)r r� r r� r� r: r� r: r' r� r� r0 �astyper r" )r$ rd rc r� r� r� s r& r� zFigure.set_size_inchesu s� � �<
�9��D�A�q��x�x��A�� ���{�{�4� �$�$�&�4�!�8�.�.�*:� � G��v� N�O� O� "����� ��k�k�)�)�G��"� �������� � 8� 8�� =�>���
r( c �T � t j | j j � S )a�
Return the current size of the figure in inches.
Returns
-------
ndarray
The size (width, height) of the figure in inches.
See Also
--------
matplotlib.figure.Figure.set_size_inches
matplotlib.figure.Figure.get_figwidth
matplotlib.figure.Figure.get_figheight
Notes
-----
The size in pixels can be obtained by multiplying with `Figure.dpi`.
)r r� r� r: r0 s r& r� zFigure.get_size_inches� s � �& �x�x��(�(�+�+�,�,r( c �. � | j j S )z"Return the figure width in inches.)r� r� r0 s r& � get_figwidthzFigure.get_figwidth� s � �� � �%�%�%r( c �. � | j j S )z#Return the figure height in inches.)r� r� r0 s r& �
get_figheightzFigure.get_figheight� s � �� � �&�&�&r( c � � | j S )z2Return the resolution in dots per inch as a float.)r0 r0 s r& r4 zFigure.get_dpi� s � ��x�x�r( c � � || _ d| _ y)z
Set the resolution of the figure in dots-per-inch.
Parameters
----------
val : float
TN)r0 r" r# s r& r6 zFigure.set_dpi� s � � �����
r( c �H � | j || j � |�� y)a0
Set the width of the figure in inches.
Parameters
----------
val : float
forward : bool
See `set_size_inches`.
See Also
--------
matplotlib.figure.Figure.set_figheight
matplotlib.figure.Figure.set_size_inches
r� N)r� r� �r$ r% r� s r& � set_figwidthzFigure.set_figwidth� s" � �
� � �S�$�"4�"4�"6�� �Hr( c �H � | j | j � ||�� y)a0
Set the height of the figure in inches.
Parameters
----------
val : float
forward : bool
See `set_size_inches`.
See Also
--------
matplotlib.figure.Figure.set_figwidth
matplotlib.figure.Figure.set_size_inches
r� N)r� r� r� s r& �
set_figheightzFigure.set_figheight� s" � �
� � �T� .� .� 0�#�w� �Gr( c �x �� t �| � |�� | j j }|�|j � y y )Nr@ )rb rB r' �toolbarrW )r$ rA r� rt s �r& rB z Figure.clear� s7 �� �
��
�^�
�4� �+�+�%�%�� � � �N�N� � r( c �r � | j � sy | j |� } |j d| j � �� | j r0| j � � | j � j
| � | j j |� t j || || j � | j D ] }|j |� � |j d� d| _ t! d| j" |� j% � y # t $ r Y ��w xY w# d| _ w xY w)Nr! rO F�
draw_event)r� r� rQ rR r� r^ �executer: r� rS rT rU rq rp rV r" r r' �_processrW s r& rS z Figure.draw� s � � � � �!� ��(�(��2�� � � � ��d�l�l�n� � =��y�y�T� 3� 3� 5� A���*�*�,�4�4�T�:�
�J�J�O�O�H� %� � 0� 0��$���)?�)?�
A� � � �
$��� � �(�#�
$�
� � �� *� �D�J��,�� � �X�6�?�?�A�� "� ���� �D�J�s0 �=D- �" D �A0D- � D*�'D- �)D*�*D- �- D6c � � t | � }|j � 5 | j |� ddd� y# 1 sw Y yxY w)z�
Draw the figure with no output. Useful to get the final size of
artists that require a draw before their size is known (e.g. text).
N)r �_draw_disabledrS �r$ r� s r& �draw_without_renderingz Figure.draw_without_rendering s; � �
!��&��
�
$�
$�
&� � �I�I�h� � � � �s �7�A c �V � |j | j j � � y)z*
Draw `.Artist` *a* only.
N)rS r' r� r6 s r& � draw_artistzFigure.draw_artist s � �
���t�{�{�'�'�)�*r( c �& �� t �| � � }|j d� |j d|d � |d< t j
|d< ddlm} | j j |j j j � v rd|d< |S ) Nr' �
_original_dpir� �__mpl_version__r )�_pylab_helpersT�_restore_to_pylab)
rb � __getstate__r5 �getrU � __version__�
matplotlibr� r' r� �Gcf�figsr )r$ �stater� rt s �r& r� zFigure.__getstate__% s� �� ���$�&��
� � �(�� � � �/�5��=�A��f�
� $'�?�?�� � � .� �;�;� � �.�"4�"4�"9�"9�"@�"@�"B� B�)-�E�%� &�� r( c �� � |j d� }|j dd� }|t j k7 rt j d|� d�� || _ t
| � |r{dd lm} dd l m
} |j � }|rt |� dz nd}|j � }|j || � } |j j! | � |j# � d| _ y ) Nr� r� Fz.This figure was saved with matplotlib version z' and is unlikely to function correctly.r r� T)r5 rU r� rZ ru �__dict__r
�matplotlib.pyplot�pyplot�matplotlib._pylab_helpersr� � get_fignumsrB �_get_backend_mod� new_figure_manager_given_figurer� �_set_new_active_manager�draw_if_interactiver" )
r$ r� �version�restore_to_pylab�plt�
pylab_helpers�allnums�num�backend�mgrs
r& � __setstate__zFigure.__setstate__9 s� � ��)�)� -�.�� �9�9�%8�%�@�� �c�o�o� %� � � �@�� � J5� 6�
7� ��
� �� � � +� =��o�o�'�G�&-�#�g�,��"�1�C��*�*�,�G��9�9�#�t�D�C� � � � 5� 5�c� :� � #� #� %���
r( c �D �� | j j d�fd�� y)z>Whenever the Axes state change, ``func(self)`` will be called.r9 c � �� �| � S r rI )r� �funcs �r& r} z'Figure.add_axobserver.<locals>.<lambda>X s �� �D��I� r( N)r: r� )r$ r s `r& �add_axobserverzFigure.add_axobserverT s �� �
���!�!�"6�8M�Nr( )� transparentc � � |j dt j d � |�t j d }t � 5 }|ra|j dd� |j dd� | j D ]. }|j |j j dd�� � �0 | j j |fi |�� ddd� y# 1 sw Y yxY w) a�
Save the current figure.
Call signature::
savefig(fname, *, dpi='figure', format=None, metadata=None,
bbox_inches=None, pad_inches=0.1,
facecolor='auto', edgecolor='auto',
backend=None, **kwargs
)
The available output formats depend on the backend being used.
Parameters
----------
fname : str or path-like or binary file-like
A path, or a Python file-like object, or
possibly some backend-dependent object such as
`matplotlib.backends.backend_pdf.PdfPages`.
If *format* is set, it determines the output format, and the file
is saved as *fname*. Note that *fname* is used verbatim, and there
is no attempt to make the extension, if any, of *fname* match
*format*, and no extension is appended.
If *format* is not set, then the format is inferred from the
extension of *fname*, if there is one. If *format* is not
set and *fname* has no extension, then the file is saved with
:rc:`savefig.format` and the appropriate extension is appended to
*fname*.
Other Parameters
----------------
dpi : float or 'figure', default: :rc:`savefig.dpi`
The resolution in dots per inch. If 'figure', use the figure's
dpi value.
format : str
The file format, e.g. 'png', 'pdf', 'svg', ... The behavior when
this is unset is documented under *fname*.
metadata : dict, optional
Key/value pairs to store in the image metadata. The supported keys
and defaults depend on the image format and backend:
- 'png' with Agg backend: See the parameter ``metadata`` of
`~.FigureCanvasAgg.print_png`.
- 'pdf' with pdf backend: See the parameter ``metadata`` of
`~.backend_pdf.PdfPages`.
- 'svg' with svg backend: See the parameter ``metadata`` of
`~.FigureCanvasSVG.print_svg`.
- 'eps' and 'ps' with PS backend: Only 'Creator' is supported.
bbox_inches : str or `.Bbox`, default: :rc:`savefig.bbox`
Bounding box in inches: only the given portion of the figure is
saved. If 'tight', try to figure out the tight bbox of the figure.
pad_inches : float, default: :rc:`savefig.pad_inches`
Amount of padding around the figure when bbox_inches is 'tight'.
facecolor : color or 'auto', default: :rc:`savefig.facecolor`
The facecolor of the figure. If 'auto', use the current figure
facecolor.
edgecolor : color or 'auto', default: :rc:`savefig.edgecolor`
The edgecolor of the figure. If 'auto', use the current figure
edgecolor.
backend : str, optional
Use a non-default backend to render the file, e.g. to render a
png file with the "cairo" backend rather than the default "agg",
or a pdf file with the "pgf" backend rather than the default
"pdf". Note that the default backend is normally sufficient. See
:ref:`the-builtin-backends` for a list of valid backends for each
file format. Custom backends can be referenced as "module://...".
orientation : {'landscape', 'portrait'}
Currently only supported by the postscript backend.
papertype : str
One of 'letter', 'legal', 'executive', 'ledger', 'a0' through
'a10', 'b0' through 'b10'. Only supported for postscript
output.
transparent : bool
If *True*, the Axes patches will all be transparent; the
Figure patch will also be transparent unless *facecolor*
and/or *edgecolor* are specified via kwargs.
If *False* has no effect and the color of the Axes and
Figure patches are unchanged (unless the Figure patch
is specified via the *facecolor* and/or *edgecolor* keyword
arguments in which case those colors are used).
The transparency of these patches will be restored to their
original values upon exit of this function.
This is useful, for example, for displaying
a plot on top of a colored background on a web page.
bbox_extra_artists : list of `~matplotlib.artist.Artist`, optional
A list of extra artists that will be considered when the
tight bbox is calculated.
pil_kwargs : dict, optional
Additional keyword arguments that are passed to
`PIL.Image.Image.save` when saving the figure.
r0 z savefig.dpiNzsavefig.transparentr r� r )r r )
r� rU rV r r� �
enter_contextr� �_cm_setr' � print_figure)r$ �fnamer rs �stackr� s r& �savefigzFigure.savefigZ s� � �^ ���%�� � �m�!<�=� � � �,�,�'<�=�K�
�[� 6�E���!�!�+�v�6��!�!�+�v�6� �)�)� N�B��'�'����(�(�6�V�(�L�N�N�
%�D�K�K� $� $�U� 5�f� 5� 6� 6� 6�s
�BC
�
Cr� r c �� � ������ �
� g � g �
� �
����� �fd�}t j � ddg||� �
D ] }|j � � � j j � � S )a
Blocking call to interact with a figure.
Wait until the user clicks *n* times on the figure, and return the
coordinates of each click in a list.
There are three possible interactions:
- Add a point.
- Remove the most recently added point.
- Stop the interaction and return the points added so far.
The actions are assigned to mouse buttons via the arguments
*mouse_add*, *mouse_pop* and *mouse_stop*.
Parameters
----------
n : int, default: 1
Number of mouse clicks to accumulate. If negative, accumulate
clicks until the input is terminated manually.
timeout : float, default: 30 seconds
Number of seconds to wait before timing out. If zero or negative
will never time out.
show_clicks : bool, default: True
If True, show a red cross at the location of each click.
mouse_add : `.MouseButton` or None, default: `.MouseButton.LEFT`
Mouse button used to add points.
mouse_pop : `.MouseButton` or None, default: `.MouseButton.RIGHT`
Mouse button used to remove the most recently added point.
mouse_stop : `.MouseButton` or None, default: `.MouseButton.MIDDLE`
Mouse button used to stop input.
Returns
-------
list of tuples
A list of the clicked (x, y) coordinates.
Notes
-----
The keyboard can also be used to select points in case your mouse
does not have one or more of the buttons. The delete and backspace
keys act like right-clicking (i.e., remove last point), the enter key
terminates input and any other key (not already used by the window
manager) selects a point.
c � �� | j dk( }| j dk( }|r| j �k( s|r*| j dv r �
j j � �ny|r| j �k( s|r^| j dv rP��rU�j � � �rB�j � j
� �
j j � �n|r| j �k( s|r�| j ��| j r݉j | j | j f� t j dt �� | j | j � � rt j j# | j g| j gdd�� }| j j% |� �j |� �
j j � t �� � k( r!� d kD r�
j j � y y y )
Nro rm )�escape�enter)� backspace�deletezinput %i: %f, %f�+r� )�markerr� r )r� �buttonr@ r' �stop_event_loopr5 r8 rS �inaxesr� �xdata�ydatar| r� r� rU rk �Line2D�add_line) �event� is_button�is_key�line�clicks�marks� mouse_add� mouse_pop�
mouse_stop�nr$ � show_clickss ��������r& �handlerz Figure.ginput.<locals>.handler
s� �� � �
�
�&:�:�I��Z�Z�#4�4�F� �e�l�l�j� 8� �%�)�)�/B�"B�� � �+�+�-��� � � � 9��� � �-D� D���J�J�L�"� � � � �*�*�,� � � �(�(�*��� � � � 9��� � � 5��<�<��M�M�5�;�;�� � �"<�=��I�I� 0� !�&�k�5�;�;�� � �E�"� "�y�y� /� /����
�� � �}�7:�#� 0� G�� � � �-�-�d�3� � � �T�*� � � �(�(�*��6�{�a� �A��E�� � �+�+�-� %*� r( ro rm )r �blocking_input_loopr8 r' rS ) r$ r2 �timeoutr3 r/ r0 r1 r4 �markr- r. s `` ```` @@r& �ginputz
Figure.ginput� sk �� �b ���� .� .�D �+�+� �'�):�;�W�g� O� � �D� �K�K�M� � � � �����
r( c �p � �� d��� fd�}t j � ddg||� ��dS �j dk( S )a
Blocking call to interact with the figure.
Wait for user input and return True if a key was pressed, False if a
mouse button was pressed and None if no input was given within
*timeout* seconds. Negative values deactivate *timeout*.
Nc �> �� | ��j j � y r )r' r# )�evr) r$ s ��r& r4 z*Figure.waitforbuttonpress.<locals>.handlerA
s �� ��E� �K�K� '� '� )r( ro rm )r r5 r� )r$ r6 r4 r) s ` @r& �waitforbuttonpresszFigure.waitforbuttonpress7
sK �� � �� *�
�+�+� �'�):�;�W�g� O� �}�t�I�%�*�*�8I�*I�Ir( z$figure.get_layout_engine().execute()c �~ � t | j � t � sy| j � j | � S )z�
Use ``layoutgrid`` to determine pos positions within Axes.
See also `.set_constrained_layout_pads`.
Returns
-------
layoutgrid : private debugging object
N)r r^ r r� r� s r& �execute_constrained_layoutz!Figure.execute_constrained_layoutK
s5 � � �$�0�0�2�4K�L���%�%�'�/�/��5�5r( gH�z�G�?�rZ r� r� r� c � � t ||||�� } | j |� |j | � | j d� y# | j d� w xY w)a�
Adjust the padding between and around subplots.
To exclude an artist on the Axes from the bounding box calculation
that determines the subplot parameters (i.e. legend, or annotation),
set ``a.set_in_layout(False)`` for that artist.
Parameters
----------
pad : float, default: 1.08
Padding between the figure edge and the edges of subplots,
as a fraction of the font size.
h_pad, w_pad : float, default: *pad*
Padding (height/width) between edges of adjacent subplots,
as a fraction of the font size.
rect : tuple (left, bottom, right, top), default: (0, 0, 1, 1)
A rectangle in normalized figure coordinates into which the whole
subplots area (including labels) will fit.
See Also
--------
.Figure.set_layout_engine
.pyplot.tight_layout
r? N)r rv r� )r$ rZ r� r� r� �engines r& r� zFigure.tight_layoutZ
sS � �8 #�s�%�u�(,�.�� )� � "� "�6� *� �N�N�4� � � "� "�4� (��D� "� "�4� (�s �"A �A) NNNNr NNNNr )Tr
) r r NNNNNNF)NT)���)>rE rF rG rH rZ rX r rY r` rf �make_keyword_onlyr1 r} r� rv r^ r� r� r� r[ r� r r� r� r0 r� r� rG r� r� rJ r� r �interpdr� r� r� r� r� r4 r6 r� r� rB r r
rS r� r� r� r
r r r �LEFT�RIGHT�MIDDLEr8 r< r> r� r r s @r& r] r] � s� �� � �
�����
� 6�
� �3�
4�6�I�
7�
� �T���E�;�/� �� � � � � !� "�$(�z� �z� 0�z�x%��&@I�D#�?�*-�X � '� � '� �y�y�H�'� �9�$ �8�X�+M�
N�C�G� �T�_�_�U�(;� !�#��#��0M� �T�_�_�U�(J� !�#��#��8 �T�_�_� � >��� 3�� 3�> �T�_�_�U�(G� !�#� ,�#� ,�> � ���BF�;@�X� �X�t(�T-�*&�'�� �I�"H�" � �� B� � � B�< �+� �(�6O� -1� {6�z �"�$�$�)�)�$�*�*�%�,�,�^�@J�( �T�_�_�U�(N�O� 6� P� 6� #'�d�$�T� ")� ")r( r] c � � t | d� xr t j | � }t j d� }t j d� }|r| j dd \ }}||z }n| }t
j d d }t j ||z |f� }|t dg||z ��� z }|t dg||z ��� z }t j |||� }|S ) a�
Calculate the width and height for a figure with a specified aspect ratio.
While the height is taken from :rc:`figure.figsize`, the width is
adjusted to match the desired aspect ratio. Additionally, it is ensured
that the width is in the range [4., 16.] and the height is in the range
[2., 16.]. If necessary, the default height is adjusted to ensure this.
Parameters
----------
arg : float or 2D array
If a float, this defines the aspect ratio (i.e. the ratio height /
width).
In case of an array the aspect ratio is number of rows / number of
columns, so that the array could be fitted in the figure undistorted.
Returns
-------
width, height : float
The figure size in inches.
Notes
-----
If you want to create an Axes within the figure, that still preserves the
aspect ratio, be sure to create it with equal width and height. See
examples below.
Thanks to Fernando Perez for this function.
Examples
--------
Make a figure twice as tall as it is wide::
w, h = figaspect(2.)
fig = Figure(figsize=(w, h))
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax.imshow(A, **kwargs)
Make a figure with the proper aspect for an array::
A = rand(5, 3)
w, h = figaspect(A)
fig = Figure(figsize=(w, h))
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax.imshow(A, **kwargs)
r� )g @g @)� 0@rI N� rs r� g �?)
r� r �isscalarr� r� rU rV r� rB r� ) r� �isarray� figsize_min� figsize_max�nr�nc� arr_ratio�
fig_height�newsizes r& � figaspectrT
s� � �` �c�7�#�<�B�K�K��,<�(<�G� �(�(�:�&�K��(�(�<�(�K� ����2�A� ���B���G� �� � � � � .�/��2�J� �h�h�
�Y�.�
�;�<�G� �s�3�1�'�K�/�1�1�G� �s�3�1�'�K�/�1�1�G� �g�g�g�{�K�8�G� �Nr( )FrH �
contextlibr r� r- �logging�numbersr �numpyr r� rU r r r r �matplotlib.artistr r
r �matplotlib.backend_basesr r
r r r �matplotlib._apirZ �matplotlib.cbookrf �matplotlib.colorbarrr rb �matplotlib.image�imagerT �matplotlib.axesr r r �matplotlib.gridspecr �matplotlib.layout_enginer r r r �matplotlib.legendrQ rI �matplotlib.patchesr �matplotlib.textr �matplotlib.transformsr r r r � getLoggerrE r| r' r* rK r^ rD r� r] rT rI r( r& �<module>rh s ��� !� � � � � � � N� N�:� :�N� N� � � "� !� D� D� (�� � $� (� �4� 4� �w����"�� �
"I� "I�J>!� >!�Bs -�� s -�l; ���T �
� T � �T �n ���O)�Z� O)� �O)�d$Mr(