o :ao@sdZddlZddlZddlmZddlZddlZddlm Z m Z m Z m Z ddl mZeeZGdddZGdd 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_layoutrcParams)Bboxc@seZdZdZd'ddZddZeddd d Zed dd d Zd dZ d(ddZ d)ddZ ddZ ddZ ddZddZd*ddZedd 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 |dkrtd|t|tr|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_ratiosr5/usr/lib/python3/dist-packages/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__cC|jSN)r rrrrFzGridSpecBase.zThe number of rows in the grid.)doccCr"r#)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_geometryKs zGridSpecBase.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)rlocrowspancolspanZloc1Zloc2Z subplotspecrrrnew_subplotspecUs zGridSpecBase.new_subplotspeccC6|dur dg|j}n t||jkrtd||_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)rrrrrre  zGridSpecBase.set_width_ratioscCr")zo Return the width ratios. This is *None* if no width ratios have been set explicitly. )rr$rrrget_width_ratiosszGridSpecBase.get_width_ratioscCr/)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 {r0zGridSpecBase.set_height_ratioscCr")zq Return the height ratios. This is *None* if no height ratios have been set explicitly. )rr$rrrget_height_ratiosr2zGridSpecBase.get_height_ratiosFcst|\}}|rd}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?rcg|]}|qSrr.0rZnormrr z3GridSpecBase.get_grid_positions..rcr4rrr5r8rrr9r:))r(r*leftrightbottomtopwspacehspacesumrnpZcumsumZ column_stackflatrZreshapeT)rZfigrawrrr=r>r?r@rArBZsubplot_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_rightsrr8rget_grid_positionss@   zGridSpecBase.get_grid_positionscCs`|D]$}t|dr(|}t|dr|}|||fkr(|Sqt|||dS)zo Check if the figure already has a gridspec with these dimensions, or create a new one get_subplotspecget_topmost_subplotspecr))Zget_axeshasattrrM get_gridspecrNr(GridSpec)r)rraxgsrrr_check_gridspec_existss     z#GridSpecBase._check_gridspec_existsc Cs|\}}dd}t|tr._normalizezUnrecognized subplot specNrr)r(r tupler rDZravel_multi_index SubplotSpec) rrYrrr^Zk1Zk2errnum1num2rrr __getitem__s      zGridSpecBase.__getitem__T)sharexshareysqueeze subplot_kwc Csr|j}|dur tdt|tr|rdnd}t|tr!|rdnd}t|tr+tdtjgd||d|dur;i}|}t j |j |j ft d}t|j D]8}t|j D]0}d|d ||d f|d |fd } | ||d <| ||d <|j|||ffi||||f<qVqO|dvr|jD]} | jddq|dvr|jD]} | jddq|r|jdkr|S|S|S)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 figureallnonez]sharex argument to subplots() was an integer. Did you intend to use subplot() (without 's')?)rirowcolrj)rerf)Zdtype)rrr)rjrirkrlrerf)rlriT)Z check_patch)rkrir)r)r r boolrr warn_externalZ check_in_listcopyrDemptyr r objectrangeZ add_subplotrEZ_label_outer_xaxisZ_label_outer_yaxisrZitemrg) rrerfrgrhr)ZaxarrrkrlZ shared_withrSrrrsubplotssP           zGridSpecBase.subplots)NNr#)rrF)r __module__ __qualname____doc__rr!propertyrrr(r*r.rr1r r3rL staticmethodrUrdrtrrrrrs0     = %rcsZeZdZdZ    dfdd ZgdZddZddd Zd d Z  dd dZ Z S)rRz 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*. Nc sB||_||_||_||_||_| |_||_tj||| | ddS)a Parameters ---------- nrows, ncols : int The number of rows and columns of the grid. figure : `~.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) r=r?r>r@rArBr)superr) rrrr)r=r?r>r@rArBrrrrrrOs*  zGridSpec.__init__)r=r?r>r@rArBcKs|D]\}}||jvrt|||qt|dtjjD](}|jj j D] }t |t j j rH|}||krH|||j q(q!dS)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)axesr mplZ SubplotBaserMrNrQZ _set_position get_position)rkwargskvZ figmanagerrSssrrrupdates   zGridSpec.updatecs\|durddjD}tjjdi|}nt|j}|jdifddjD|S)z 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.*` NcSsi|] }|td|qS)zfigure.subplot.)rr6rrrr z/GridSpec.get_subplot_params..csi|]}|t|qSrgetattrrr$rrrsr)rrr) SubplotParamsro 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$rrr9rz.)rr$rr$rlocally_modified_subplot_paramssz(GridSpec.locally_modified_subplot_paramsHzG?c Csltj|j|d}d|vrtd|durt|}tj||j||||||d}|r4|jdi|dSdS)ay Adjust subplot parameters to give specified padding. Parameters ---------- 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 of 4 floats, default: (0, 0, 1, 1), i.e. the whole figure (left, bottom, right, top) rectangle in normalized figure coordinates that the whole subplots area (including labels) will fit into. )Z grid_specNzcThis figure includes Axes that are not compatible with tight_layout, so results might be incorrect.)padh_padw_padrectr)rZget_subplotspec_listrrrnZ get_rendererZget_tight_layout_figurer) rr)ZrendererrrrrZsubplotspec_listrrrrrs   zGridSpec.tight_layout) NNNNNNNNNr#)NrNNN) r rvrwrxrrrr*rr __classcell__rrr}rrRGs6  rRcs8eZdZdZ  d 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. r{N)_wspace_hspace _subplot_specrQr)r|r)rrrZ subplot_specrArBrrr}rrrs  z GridSpecFromSubplotSpec.__init__c Cs|jdur|jn |dur|jjntd}|jdur|jn |dur$|jjntd}|j|}|j\}}}}t j j ||||||dS)z1Return a dictionary of subplot layout parameters.Nzfigure.subplot.hspacezfigure.subplot.wspace)r=r>r?r@rArB) rrrBrrrArrZextentsrr)r) rr)rBrAfigboxr=r?r>r@rrrr*s  z*GridSpecFromSubplotSpec.get_subplot_paramscCs |jS)zY Return the topmost `.SubplotSpec` instance associated with the subplot. )rrNr$rrrrNs z/GridSpecFromSubplotSpec.get_topmost_subplotspec)NNNNr#)r rvrwrxrr*rNrrrr}rrs rc@seZdZdZd+ddZddZeddZed d Z e j d d Z d d Z ddZ ddZ eddZeddZddZddZddZddZeddd,d!d"Zd#d$Zd%d&Zd'd(Zd)d*ZdS)-r`aN The location of a subplot in a `GridSpec`. .. note:: Likely, you'll 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#) _gridspecrbrc)rgridspecrbrcrrrr/s zSubplotSpec.__init__c Cs6|d|jjd|jjd|jjd|jjd S)N[:z, ])rQr,r[r\r-r$rrrr!4s zSubplotSpec.__repr__c CsNt|dkr8|\}t|tr|St|tstd|z ttt|\}}}Wn%ty7td|dwt|dkrD|\}}}n tdt|dt |||}|dur`t |||d}t|t rt|dkrt d d |Ds{td ||\}}nt|tr|dks|||krtd ||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 Nz0subplot() takes 1 or 3 positional arguments but z were givenrOr<css|]}t|tVqdSr#)r r)r6nrrr Ysz1SubplotSpec._from_subplot_args..z3Subplot specifier tuple must contain integers, not znum must be 1 <= num <= z, not ) rr r`rr mapintstr TypeErrorrRrUr_ri) r)argsargrowscolsZnumrTijrrr_from_subplot_args9sR        zSubplotSpec._from_subplot_argscCs|jdur|jS|jSr#)_num2rbr$rrrrchszSubplotSpec.num2cCs ||_dSr#)r)rvaluerrrrcls cCs i|jSr#)__dict__r$rrr __getstate__ps zSubplotSpec.__getstate__cCr"r#)rr$rrrrQsszSubplotSpec.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``). )rQr(rbrc)rrrrrrr(vszSubplotSpec.get_geometrycCs$|j}t|j||j|dS)z6The rows spanned by this subplot, as a `range` object.r)rQrrrrbrc)rrrrrr,s zSubplotSpec.rowspancCs4|j}t|j||j|g\}}t||dS)z9The columns spanned by this subplot, as a `range` object.r)rQrsortedrbrcrr)rrZc1Zc2rrrr-s zSubplotSpec.colspancC |jjdkSNr)r,r[r$rrr is_first_row zSubplotSpec.is_first_rowcC|jj|jkSr#)r,r\rQrr$rrr is_last_rowzSubplotSpec.is_last_rowcCrr)r-r[r$rrr is_first_colrzSubplotSpec.is_first_colcCrr#)r-r\rQrr$rrr is_last_colrzSubplotSpec.is_last_colz3.4 return_allFcCs|}|\}}t|j|jg||f\}}||\}} } } ||} | |} | |}| |}t || || }|rN||d|d||fS|S)zJ Update the subplot position from ``figure.subplotpars``. r) rQr(rDZ unravel_indexrbrcrLminmaxrZ from_extents)rr)rrrrrrrIrHrJrKZ fig_bottomZfig_topZfig_leftZ fig_rightrrrrrs     zSubplotSpec.get_positioncCs|}t|dr |S|S)zX Return the topmost `SubplotSpec` instance associated with the subplot. rN)rQrPrN)rrrrrrNs 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`. rrbrc)rrbrcrrq)rotherrrr__eq__s    zSubplotSpec.__eq__cCst|j|j|jfSr#)hashrrbrcr$rrr__hash__szSubplotSpec.__hash__cKst|||fi|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 or 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)rrrrrrr subgridspecs(zSubplotSpec.subgridspecr#ru)r rvrwrxrr!rzrryrcsetterrrQr(r,r-rrrrrZdelete_parameterrrNrrrrrrrr`s6  .        r`)rxroZloggingZnumbersrZnumpyrDZ matplotlibrrrrrZmatplotlib.transformsrZ getLoggerr Z_logrrRrr`rrrrs     .7