U Ev fl@sdZddlZddlZddlmZddlZddlZddlm Z m Z m Z ddl m Z eeZGdddZGdd d eZGd d d eZGd d d ZdS)a :mod:`~matplotlib.gridspec` contains classes that help to layout multiple `~.axes.Axes` in a grid-like pattern within a figure. The `GridSpec` specifies the overall grid structure. Individual cells within the grid are referenced by `SubplotSpec`\s. Often, users need not access this module directly, and can use higher-level methods like `~.pyplot.subplots`, `~.pyplot.subplot_mosaic` and `~.Figure.subfigures`. See the tutorial :doc:`/tutorials/intermediate/arranging_axes` for a guide. N)Integral)_api_pylab_helpers _tight_layout)Bboxc@seZdZdZd)ddZddZeddd d Zed dd d Zd dZ d*ddZ d+ddZ ddZ ddZ ddZddZeddd,dd Zed!d"Zd#d$Zddd%dd&d'd(ZdS)- GridSpecBasezm A base class of GridSpec that specifies the geometry of the grid that a subplot will be placed. NcCsft|tr|dkr td|t|tr2|dkr@td||||_|_||||dS)a Parameters ---------- nrows, ncols : int The number of rows and columns of the grid. 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. rz/Number of rows must be a positive integer, not z2Number of columns must be a positive integer, not N) isinstancer ValueError_nrows_ncolsset_height_ratiosset_width_ratios)selfnrowsncols height_ratios width_ratiosr7/tmp/pip-unpacked-wheel-7vhvci0g/matplotlib/gridspec.py__init__!s zGridSpecBase.__init__cCsbtt|jdkrd|jfnd}tt|jdkr@d|jfnd}dj|jj|j|j||dS)Nz, height_ratios=%rz, width_ratios=%rz&{clsname}({nrows}, {ncols}{optionals}))Zclsnamerr optionals) lenset_row_height_ratios_col_width_ratiosformat __class____name__r r )rZ height_argZ width_argrrr__repr__:szGridSpecBase.__repr__cCs|jSN)r rrrrFzGridSpecBase.zThe number of rows in the grid.)doccCs|jSr!)r r"rrrr#Hr$z"The number of columns in the grid.cCs |j|jfS)zW Return a tuple containing the number of rows and columns in the grid. )r r r"rrr get_geometryKszGridSpecBase.get_geometrycCsdSr!r)rfigurerrrget_subplot_paramsQszGridSpecBase.get_subplot_paramsrcCs(|\}}|||||||f}|S)a[ Create and return a `.SubplotSpec` instance. Parameters ---------- loc : (int, int) The position of the subplot in the grid as ``(row_index, column_index)``. rowspan, colspan : int, default: 1 The number of rows and columns the subplot should span in the grid. r)rlocrowspancolspanloc1loc2Z subplotspecrrrnew_subplotspecUs zGridSpecBase.new_subplotspeccCs6|dkrdg|j}nt||jkr,td||_dS)z Set the relative widths of the columns. *width_ratios* must be of length *ncols*. Each column gets a relative width of ``width_ratios[i] / sum(width_ratios)``. NrzTExpected the given number of width ratios to match the number of columns of the grid)r rr r)rrrrrr es zGridSpecBase.set_width_ratioscCs|jS)zo Return the width ratios. This is *None* if no width ratios have been set explicitly. )rr"rrrget_width_ratiossszGridSpecBase.get_width_ratioscCs6|dkrdg|j}nt||jkr,td||_dS)z Set the relative heights of the rows. *height_ratios* must be of length *nrows*. Each row gets a relative height of ``height_ratios[i] / sum(height_ratios)``. NrzRExpected the given number of height ratios to match the number of rows of the grid)r rr r)rrrrrr {s zGridSpecBase.set_height_ratioscCs|jS)zq Return the height ratios. This is *None* if no height ratios have been set explicitly. )rr"rrrget_height_ratiosszGridSpecBase.get_height_ratiosz3.7rawFcst|\}}|r*d}d}d}d}d} d} n.||} | j}| j}| j}| j}| j} | j} ||} ||} | || |d}| |}||t|j fdd|j D}dg|g|d}t t ||gj }| || |d}| |}||t|jfdd|jD}dg|g|d}t t ||gj }||dj\}}||dj\}}||||fS) a Return the positions of the grid cells in figure coordinates. Parameters ---------- fig : `~matplotlib.figure.Figure` The figure the grid should be applied to. The subplot parameters (margins and spacing between subplots) are taken from *fig*. raw : bool, default: False If *True*, the subplot parameters of the figure are not taken into account. The grid spans the range [0, 1] in both directions without margins and there is no space between grid cells. This is used for constrained_layout. Returns ------- bottoms, tops, lefts, rights : array The bottom, top, left, right positions of the grid cells in figure coordinates. gg?rcsg|] }|qSrr.0rZnormrr sz3GridSpecBase.get_grid_positions..rcsg|] }|qSrrr2r5rrr6s))r&r(leftrightbottomtopwspacehspacesumrnpZcumsumZ column_stackflatrZreshapeT)rZfigr1rrr9r:r;r<r=r>Zsubplot_paramsZ tot_widthZ tot_heightZcell_hZsep_hZ cell_heightsZ sep_heightsZcell_hsZcell_wZsep_wZ cell_widthsZ sep_widthsZcell_wsfig_tops fig_bottoms fig_lefts fig_rightsrr5rget_grid_positionss@  zGridSpecBase.get_grid_positionscCsZ|D]B}|}|dk rt|dr2|}|||fkr|Sqt|||dS)zo Check if the figure already has a gridspec with these dimensions, or create a new one Nget_topmost_subplotspecr')Zget_axes get_gridspechasattrrHr&GridSpec)r'rraxgsrrr_check_gridspec_existss    z#GridSpecBase._check_gridspec_existsc Cs|\}}dd}t|trz |\}}Wn,tk rV}ztd|W5d}~XYnXt|||d|||dg||f\}} n||||d\}} t||| S)z,Create and return a `.SubplotSpec` instance.cSs|}t|tr<||\}}}||kr2||dfStdnh|dkrL||}d|kr`|krlnn||fS|dk rtd|d|d|ntd|d|dS)Nrz=GridSpec slice would result in no space allocated for subplotrzindex z is out of bounds for axis z with size z) is out of bounds for GridSpec with size )rsliceindices IndexError)keysizeZaxisZorig_keystartstop_rrr _normalizes   z,GridSpecBase.__getitem__.._normalizezUnrecognized subplot specNrr)r&rtupler r@Zravel_multi_index SubplotSpec) rrSrrrXZk1Zk2errnum1num2rrr __getitem__s    zGridSpecBase.__getitem__T)sharexshareysqueeze subplot_kwc Csr|j}|dkrtdt|ts,|r(dnd}t|tsB|r>dnd}tjddddddg||d |dkrji}|}tj|j |j ft d }t |j D]l}t |j D]\}d|d ||d f|d |fd } | ||d<| ||d<|j |||ff||||f<qq|dkr$|jD]} | jddq|dkrH|jD]} | jddq4|rj|jdkrb|S|S|SdS)z Add all subplots specified by this `GridSpec` to its parent figure. See `.Figure.subplots` for detailed documentation. NzIGridSpec.subplots() only works for GridSpecs created with a parent figureallnonerowcolFT)r_r`)Zdtype)rrr)rdrcrerfr_r`)rfrc)Z check_patch)rercr)r'r rstrrZ check_in_listcopyr@emptyr r objectrangeZ add_subplotrAZ_label_outer_xaxisZ_label_outer_yaxisrTitemra) rr_r`rarbr'ZaxarrrerfZ shared_withrMrrrsubplots sJ            zGridSpecBase.subplots)NN)N)rr)F)r __module__ __qualname____doc__rr propertyrrr&r(r.r r/r r0rZdelete_parameterrG staticmethodrOr^rmrrrrrs0      = %rc sVeZdZdZdfdd Zddddd d gZd d Zdd dZddZdddZ Z S)rLa A grid layout to place subplots within a figure. The location of the grid cells is determined in a similar way to `~.figure.SubplotParams` using *left*, *right*, *top*, *bottom*, *wspace* and *hspace*. Indexing a GridSpec instance returns a `.SubplotSpec`. Nc sB||_||_||_||_||_| |_||_tj||| | ddS)a Parameters ---------- nrows, ncols : int The number of rows and columns of the grid. figure : `.Figure`, optional Only used for constrained layout to create a proper layoutgrid. left, right, top, bottom : float, optional Extent of the subplots as a fraction of figure width or height. Left cannot be larger than right, and bottom cannot be larger than top. If not given, the values will be inferred from a figure or rcParams at draw time. See also `GridSpec.get_subplot_params`. wspace : float, optional The amount of width reserved for space between subplots, expressed as a fraction of the average axis width. If not given, the values will be inferred from a figure or rcParams when necessary. See also `GridSpec.get_subplot_params`. hspace : float, optional The amount of height reserved for space between subplots, expressed as a fraction of the average axis height. If not given, the values will be inferred from a figure or rcParams when necessary. See also `GridSpec.get_subplot_params`. 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. rrN) r9r;r:r<r=r>r'superr) rrrr'r9r;r:r<r=r>rrrrrrIs* zGridSpec.__init__r9r;r:r<r=r>cKs|D].\}}||jkr(t|||qt|dqtjjD]N}|jj j D]>}| dk rR| }| |krR|| |j qRqDdS)a  Update the subplot parameters of the grid. Parameters that are not explicitly given are not changed. Setting a parameter to *None* resets it to :rc:`figure.subplot.*`. Parameters ---------- left, right, top, bottom : float or None, optional Extent of the subplots as a fraction of figure width or height. wspace, hspace : float, optional Spacing between the subplots as a fraction of the average subplot width / height. z is an unknown keywordN)items _AllowedKeyssetattrAttributeErrorrZGcfZfigsvaluesZcanvasr'axesZget_subplotspecrHrJZ _set_position get_position)rkwargskvZ figmanagerrMssrrrupdates    zGridSpec.updatecsT|dkr(ddjD}tjjf|}n t|j}|jffddjD|S)a: Return the `.SubplotParams` for the GridSpec. In order of precedence the values are taken from - non-*None* attributes of the GridSpec - the provided *figure* - :rc:`figure.subplot.*` Note that the ``figure`` attribute of the GridSpec is always ignored. NcSsi|]}|tjd|qS)zfigure.subplot.)mplrcParamsr3r~rrr sz/GridSpec.get_subplot_params..csi|]}|t|qSrgetattrrr"rrrs)rwrr' SubplotParamsrh subplotparsr)rr'kwrrr"rr(s  zGridSpec.get_subplot_paramscsfddjDS)z Return a list of the names of the subplot parameters explicitly set in the GridSpec. This is a subset of the attributes of `.SubplotParams`. csg|]}t|r|qSrrrr"rrr6s z.)rwr"rr"rlocally_modified_subplot_paramssz(GridSpec.locally_modified_subplot_paramsHzG?c CsL|dkr|}tj||jtj|j|d|||||d}|rH|jf|dS)a Adjust subplot parameters to give specified padding. Parameters ---------- figure : `.Figure` The figure. renderer : `.RendererBase` subclass, optional The renderer to be used. pad : float Padding between the figure edge and the edges of subplots, as a fraction of the font-size. h_pad, w_pad : float, optional Padding (height/width) between edges of adjacent subplots. Defaults to *pad*. rect : tuple (left, bottom, right, top), default: None (left, bottom, right, top) rectangle in normalized figure coordinates that the whole subplots area (including labels) will fit into. Default (None) is the whole figure. N)Z grid_spec)padh_padw_padrect)Z _get_rendererrZget_tight_layout_figurer{Zget_subplotspec_listr)rr'Zrendererrrrrr}rrr tight_layoutszGridSpec.tight_layout) NNNNNNNNN)N)NrNNN) rrnrorprrwrr(rr __classcell__rrrurrL?s* 6  rLcs4eZdZdZd fdd Zd ddZddZZS) GridSpecFromSubplotSpeczx GridSpec whose subplot layout parameters are inherited from the location specified by a given SubplotSpec. Ncs8||_||_||_|jj|_tj||||ddS)ak Parameters ---------- nrows, ncols : int Number of rows and number of columns of the grid. subplot_spec : SubplotSpec Spec from which the layout parameters are inherited. wspace, hspace : float, optional See `GridSpec` for more details. If not specified default values (from the figure or rcParams) are used. height_ratios : array-like of length *nrows*, optional See `GridSpecBase` for details. width_ratios : array-like of length *ncols*, optional See `GridSpecBase` for details. rsN)_wspace_hspace _subplot_specrJr'rtr)rrrZ subplot_specr=r>rrrurrrs z GridSpecFromSubplotSpec.__init__c Cs|jdk r|jn|dk r |jjntjd}|jdk r:|jn|dk rJ|jjntjd}|j|}|j \}}}}tj j ||||||dS)z1Return a dictionary of subplot layout parameters.Nzfigure.subplot.hspacezfigure.subplot.wspace)r9r:r;r<r=r>) rrr>rrrr=rr|Zextentsr'r) rr'r>r=Zfigboxr9r;r:r<rrrr(s   z*GridSpecFromSubplotSpec.get_subplot_paramscCs |jS)zY Return the topmost `.SubplotSpec` instance associated with the subplot. )rrHr"rrrrH sz/GridSpecFromSubplotSpec.get_topmost_subplotspec)NNNN)N)rrnrorprr(rHrrrrurrs rc@seZdZdZd&ddZddZeddZed d Z e j d d Z d d Z ddZ eddZ eddZddZddZddZddZddZddZd d!Zd"d#Zd$d%ZdS)'rZa] The location of a subplot in a `GridSpec`. .. note:: Likely, you will never instantiate a `SubplotSpec` yourself. Instead, you will typically obtain one from a `GridSpec` using item-access. Parameters ---------- gridspec : `~matplotlib.gridspec.GridSpec` The GridSpec, which the subplot is referencing. num1, num2 : int The subplot will occupy the *num1*-th cell of the given *gridspec*. If *num2* is provided, the subplot will span between *num1*-th cell and *num2*-th cell **inclusive**. The index starts from 0. NcCs||_||_||_dSr!) _gridspecr\r])rgridspecr\r]rrrr(szSubplotSpec.__init__c Cs6|d|jjd|jjd|jjd|jjd S)N[:z, ])rJr*rUrVr+r"rrrr -szSubplotSpec.__repr__c Csbt|dkrx|\}t|tr |St|ts8td|zttt|\}}}Wqtk rttd|dYqXn,t|dkr|\}}}ntj ddt|dt |||}|dkrt |||d}t|t rt|d krt d d |Dstd ||\}}nDt|tr2|dks2|||krJtd ||d||}}||d|S)z Construct a `.SubplotSpec` from a parent `.Figure` and either - a `.SubplotSpec` -- returned as is; - one or three numbers -- a MATLAB-style subplot specifier. rz>Single argument to subplot must be a three-digit integer, not NZsubplotz1 or 3)ZtakesgivenrIr8css|]}t|tVqdSr!)rr)r3nrrr Qsz1SubplotSpec._from_subplot_args..z3Subplot specifier tuple must contain integers, not z(num must be an integer with 1 <= num <= z, not )rrrZrr mapintrgrZ nargs_errorrLrOrYrc) r'argsargrowscolsnumrNijrrr_from_subplot_args2sD       $zSubplotSpec._from_subplot_argscCs|jdkr|jS|jSr!)_num2r\r"rrrr]bszSubplotSpec.num2cCs ||_dSr!)r)rvaluerrrr]fscCs|jSr!)rr"rrrrJjszSubplotSpec.get_gridspeccCs |\}}|||j|jfS)a Return the subplot geometry as tuple ``(n_rows, n_cols, start, stop)``. The indices *start* and *stop* define the range of the subplot within the `GridSpec`. *stop* is inclusive (i.e. for a single cell ``start == stop``). )rJr&r\r])rrrrrrr&mszSubplotSpec.get_geometrycCs$|j}t|j||j|dS)z6The rows spanned by this subplot, as a `range` object.r)rJrrkr\r])rrrrrr*xs zSubplotSpec.rowspancCs4|j}t|j||j|g\}}t||dS)z9The columns spanned by this subplot, as a `range` object.r)rJrsortedr\r]rk)rrZc1c2rrrr+~s zSubplotSpec.colspancCs |jjdkSNr)r*rUr"rrr is_first_rowszSubplotSpec.is_first_rowcCs|jj|jkSr!)r*rVrJrr"rrr is_last_rowszSubplotSpec.is_last_rowcCs |jjdkSr)r+rUr"rrr is_first_colszSubplotSpec.is_first_colcCs|jj|jkSr!)r+rVrJrr"rrr is_last_colszSubplotSpec.is_last_colcCs|}|\}}t|j|jg||f\}}||\}}} } ||} ||} | |} | |}t | | || S)zJ Update the subplot position from ``figure.subplotpars``. ) rJr&r@Z unravel_indexr\r]rGminmaxrZ from_extents)rr'rrrrrrDrCrErFZ fig_bottomZfig_topZfig_leftZ fig_rightrrrr|s      zSubplotSpec.get_positioncCs"|}t|dr|S|SdS)zX Return the topmost `SubplotSpec` instance associated with the subplot. rHN)rJrKrH)rrrrrrHs z#SubplotSpec.get_topmost_subplotspeccCs8|j|j|jft|dtt|dtt|dtfkS)z} Two SubplotSpecs are considered equal if they refer to the same position(s) in the same `GridSpec`. rr\r])rr\r]rrj)rotherrrr__eq__s    zSubplotSpec.__eq__cCst|j|j|jfSr!)hashrr\r]r"rrr__hash__szSubplotSpec.__hash__cKst|||f|S)a Create a GridSpec within this subplot. The created `.GridSpecFromSubplotSpec` will have this `SubplotSpec` as a parent. Parameters ---------- nrows : int Number of rows in grid. ncols : int Number of columns in grid. Returns ------- `.GridSpecFromSubplotSpec` Other Parameters ---------------- **kwargs All other parameters are passed to `.GridSpecFromSubplotSpec`. See Also -------- matplotlib.pyplot.subplots Examples -------- Adding three subplots in the space occupied by a single subplot:: fig = plt.figure() gs0 = fig.add_gridspec(3, 1) ax1 = fig.add_subplot(gs0[0]) ax2 = fig.add_subplot(gs0[1]) gssub = gs0[2].subgridspec(1, 3) for i in range(3): fig.add_subplot(gssub[0, i]) )r)rrrr}rrr subgridspecs(zSubplotSpec.subgridspec)N)rrnrorprr rrrrqr]setterrJr&r*r+rrrrr|rHrrrrrrrrZs0  /       rZ)rprhloggingZnumbersrZnumpyr@Z matplotlibrrrrZmatplotlib.transformsr getLoggerr_logrrLrrZrrrrs    &7