U Cv fGx(@sxddlmZddlZddlZddlZddlmZmZmZm Z m Z m Z m Z ddl mZddlmZddlmZddlmZmZmZmZmZerddlmZdd lmZmZdd lmZm Z dd l!m"Z"dd l#m$Z$dd l%m&Z&ddl'm(Z(ddl)m*Z*m+Z+m,Z,m-Z-ddlm.Z.ddZ/e dddddddddddddddddddddddddddddddddddddddddddddddd d!d dddd"d!dd#d!d$d%d&dd'd(!d)d*Z0e ddddddddddddddddddddddddddddd+ddddddddd,ddddddddd d!d dddd"d!dd#d!d$d%d&dd-d(!d.d*Z0e ddddddddddddddddddddddddddddd/dddddddddd,dddddddd d!d dddd"d!dd#d!d$d%d&dd-d(!d0d*Z0e/dd,d,d1d,d,dd'd2d3d*Z0e dddddddddddddddddddddddddddddddddddddddddddddddd d!d dddd"d!dd#d!d$d%d&dd4d(!d5d6Z1e ddddddddddddddddddddddddddddd+ddddddddd,ddddddddd d!d dddd"d!dd#d!d$d%d&dd-d(!d7d6Z1e ddddddddddddddddddddddddddddd/dddddddddd,dddddddd d!d dddd"d!dd#d!d$d%d&dd-d(!d8d6Z1e/dd,d,d1d,d,dd4d2d9d6Z1e d:ed;Z2dd?d@Z3dAdBdCdCdDdEdFZ4dd,dCdGdHdIdJZ5e ddddddddddddddddddddddddddddddddddK!ddddddddddddddddd!d!d!d!dLdd dMdMd#d#d#d#d&ddd"d%d#ddNdO%dPdQZ6e dddddddddddddddddddddddddddddddddR ddddddddddddddd,dd!d!d!d!dLdd dMdMd#d#d#d#d&ddd"d%d#ddSdO%dTdQZ6e dddddddddddddddddddddddddddddddddU dddddddddddddd,ddd!d!d!d!dLdd dMdMd#d#d#d#d&ddd"d%d#ddSdO%dVdQZ6e3ej6ddddddddddddddddddddddddddddddddddK!ddddddddddddddddd!d!d!d!dLdd dMdMd#d#d#d#d&ddd"d%d#ddWdO%dXdQZ6dS)Y) annotationsN) TYPE_CHECKINGAnyCallableHashableIterableTypeVaroverload) broadcast)dataarray_plot)_easy_facetgrid) _add_colorbar_get_nice_quiver_magnitude_infer_meta_data_process_cmap_cbar_kwargsget_axis)Axes)LineCollectionPathCollection)Colormap Normalize)Quiver) ArrayLike DataArray)Dataset) AspectOptions ExtendOptionsHueStyleOptions ScaleOptions) FacetGridc$sd}jd|_tjddddddddddddddddddddddddddddddddddd d d d d d d d d d d dddddddd ddddddddddddd!fdd}|`|S)Na Parameters ---------- ds : Dataset x : Hashable or None, optional Variable name for x-axis. y : Hashable or None, optional Variable name for y-axis. u : Hashable or None, optional Variable name for the *u* velocity (in *x* direction). quiver/streamplot plots only. v : Hashable or None, optional Variable name for the *v* velocity (in *y* direction). quiver/streamplot plots only. hue: Hashable or None, optional Variable by which to color scatter points or arrows. hue_style: {'continuous', 'discrete'} or None, optional How to use the ``hue`` variable: - ``'continuous'`` -- continuous color scale (default for numeric ``hue`` variables) - ``'discrete'`` -- a color for each unique value, using the default color cycle (default for non-numeric ``hue`` variables) row : Hashable or None, optional If passed, make row faceted plots on this dimension name. col : Hashable or None, optional If passed, make column faceted plots on this dimension name. col_wrap : int, optional Use together with ``col`` to wrap faceted plots. ax : matplotlib axes object or None, optional If ``None``, use the current axes. Not applicable when using facets. figsize : Iterable[float] or None, optional A tuple (width, height) of the figure in inches. Mutually exclusive with ``size`` and ``ax``. size : scalar, optional If provided, create a new figure for the plot with the given size. Height (in inches) of each plot. See also: ``aspect``. aspect : "auto", "equal", scalar or None, optional Aspect ratio of plot, so that ``aspect * size`` gives the width in inches. Only used if a ``size`` is provided. sharex : bool or None, optional If True all subplots share the same x-axis. sharey : bool or None, optional If True all subplots share the same y-axis. add_guide: bool or None, optional Add a guide that depends on ``hue_style``: - ``'continuous'`` -- build a colorbar - ``'discrete'`` -- build a legend subplot_kws : dict or None, optional Dictionary of keyword arguments for Matplotlib subplots (see :py:meth:`matplotlib:matplotlib.figure.Figure.add_subplot`). Only applies to FacetGrid plotting. cbar_kwargs : dict, optional Dictionary of keyword arguments to pass to the colorbar (see :meth:`matplotlib:matplotlib.figure.Figure.colorbar`). cbar_ax : matplotlib axes object, optional Axes in which to draw the colorbar. cmap : matplotlib colormap name or colormap, optional The mapping from data values to color space. Either a Matplotlib colormap name or object. If not provided, this will be either ``'viridis'`` (if the function infers a sequential dataset) or ``'RdBu_r'`` (if the function infers a diverging dataset). See :doc:`Choosing Colormaps in Matplotlib ` for more information. If *seaborn* is installed, ``cmap`` may also be a `seaborn color palette `_. Note: if ``cmap`` is a seaborn color palette, ``levels`` must also be specified. vmin : float or None, optional Lower value to anchor the colormap, otherwise it is inferred from the data and other keyword arguments. When a diverging dataset is inferred, setting `vmin` or `vmax` will fix the other by symmetry around ``center``. Setting both values prevents use of a diverging colormap. If discrete levels are provided as an explicit list, both of these values are ignored. vmax : float or None, optional Upper value to anchor the colormap, otherwise it is inferred from the data and other keyword arguments. When a diverging dataset is inferred, setting `vmin` or `vmax` will fix the other by symmetry around ``center``. Setting both values prevents use of a diverging colormap. If discrete levels are provided as an explicit list, both of these values are ignored. norm : matplotlib.colors.Normalize, optional If ``norm`` has ``vmin`` or ``vmax`` specified, the corresponding kwarg must be ``None``. infer_intervals: bool | None If True the intervals are infered. center : float, optional The value at which to center the colormap. Passing this value implies use of a diverging colormap. Setting it to ``False`` prevents use of a diverging colormap. robust : bool, optional If ``True`` and ``vmin`` or ``vmax`` are absent, the colormap range is computed with 2nd and 98th percentiles instead of the extreme values. colors : str or array-like of color-like, optional A single color or a list of colors. The ``levels`` argument is required. extend : {'neither', 'both', 'min', 'max'}, optional How to draw arrows extending the colorbar beyond its limits. If not provided, ``extend`` is inferred from ``vmin``, ``vmax`` and the data limits. levels : int or array-like, optional Split the colormap (``cmap``) into discrete color intervals. If an integer is provided, "nice" levels are chosen based on the data range: this can imply that the final number of levels is not exactly the expected one. Setting ``vmin`` and/or ``vmax`` with ``levels=N`` is equivalent to setting ``levels=np.linspace(vmin, vmax, N)``. **kwargs : optional Additional keyword arguments to wrapped Matplotlib function.  ) __module____name__ __qualname____doc__)assignedT)xyuvhue hue_stylerowcolcol_wrapaxfigsizesizeaspectsharexsharey add_guide subplot_kws cbar_kwargscbar_axcmapvminvmaxnorminfer_intervalscenterrobustcolorsextendlevelsrrHashable | Noner int | None Axes | NoneIterable[float] | None float | Nonerbool bool | Nonedict[str, Any] | Nonestr | Colormap | NoneNormalize | Nonestr | ArrayLike | NonerArrayLike | None)!dsargsr'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rArBrCkwargsreturnc* sF|rd} |dkst|d}t|dkr<|dks4t|d}t|dkr\|dksTt|d}t|dkr||dkstt|d}t|dkr|dkst|d}t|dkrt| ntj| tdd~|d d }!|!r|d }"nt||||||jd }"|"d }|s |rTt }#t j|#d<||#d<dD] }$|#|$=q2t fddi|#|S|dd} t | | | | } |dkr|dk r|!r|"d}|"dnt||jft \}fdddD}%ni}%|dk s|dk rjdkrtdf|||| |||||%d |}&|!r |&S|"ddr>| |"d|"ddr\| |"d|"dr|| j|&|"d dd!|"d"r|dkrin|}d#|kr|"d d|d#<t|&| |||"d$rt||||}'||jd%d&}(| j|&d'd(|'|'d)|(d*d+d,jdkr,||})n ||})| |)|&S)-NzYUsing positional arguments is deprecated for plot methods, use keyword arguments instead.r) stacklevel _is_facetgridF meta_data)funcnamer,plotfuncdata)r[rRrPkindZdatasetr1Z continuousr8 cmap_paramscsi|]}||qSra).0vvr`rasz0_dsplot..newplotfunc..)r;r<r=r:)quiver streamplotz5u, v are only allowed for quiver or streamplot plots.) rPr'r(r0r)r*r+r,r`ZxlabelZylabel add_legendZ hue_label)Zhandlestitle add_colorbarlabelZ add_quiverkeyunitsg333333?g?r!Efigure)XYUrlZlabelposZ coordinates)AssertionErrorlen ValueErrorwarningswarnDeprecationWarningpoprr#localscopyglobalsr rrvaluesgetZ set_xlabelZ set_ylabelZlegendr rattrsZ quiverkeyZ_title_for_slice set_title)*rPr'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rArBrCrQrRmsgrZr[allargsargZcmap_params_subsetZ primitiveZ magnitudermrjr]rdre newplotfuncs&                              z_dsplot..newplotfunc)r% functoolswraps __wrapped__)r]Z commondocrrarre_dsplot%sNuXrT)r'r(r)r*r+r,r.r-r0r1r2r/r4r5r3r7r6r8r9r;r<r=r>r?rCr@rArBr:rrrDrNonerFrGrHrErIrrKrJrMrOrNrrLr)!rPrQr'r(r)r*r+r,r.r-r0r1r2r/r4r5r3r7r6r8r9r;r<r=r>r?rCr@rArBr:rRrSc OsdSNra rPr'r(r)r*r+r,r.r-r0r1r2r/r4r5r3r7r6r8r9r;r<r=r>r?rCr@rArBr:rQrRrararergCs#rg)r'r(r)r*r+r,r-r0r1r2r/r4r5r3r7r6r8r9r;r<r=r>r?rCr@rArBr:rzFacetGrid[Dataset]c OsdSrrarrararergis#)r'r(r)r*r+r,r.r0r1r2r/r4r5r3r7r6r8r9r;r<r=r>r?rCr@rArBr:c OsdSrrarrararergs#r)rPr'r(r0r)r*rRrScKsddl}|dks(|dks(|dks(|dkr0tdt||||||||\}} } } |j| j| j| jg} |d} |d}| r| || j|ds|j|d|d|d<|d |d d |j | ||}|S) zaQuiver plot of Dataset variables. Wraps :py:func:`matplotlib:matplotlib.pyplot.quiver`. rNz)Must specify x, y, u, v for quiver plots.r+r`r=r;r<r,ZpivotZmiddle) matplotlibrvr r~rzappendrAr setdefaultrg)rPr'r(r0r)r*rRmpldxdydudvrQr+r`hdlrararergs$ &    rc OsdSrrarrararerhs#rhc OsdSrrarrararerhs#c OsdSrrarrararerh)s#cKsddl}|dks(|dks(|dks(|dkr0tdt||jdkrP||jdnd}t||jdkrt||jdnd} |dk r| dkrt||j|h} t| dkrtt| } | dk r|dkrt||j| h} t| dkrtt| }t||||||||\} } }}|dk rZ| dk rZ| | |} | | |} || |}|| |}| j | j |j |j g}| d}| d}|r||j |d<|ds|j | d | d |d<| d |j |||}|jS) zjPlot streamlines of Dataset variables. Wraps :py:func:`matplotlib:matplotlib.pyplot.streamplot`. rNz-Must specify x, y, u, v for streamplot plots.rTr+r`colorr=r;r<r,)rrvruZdimssetnextiterr Z transposer~rzrArrhlines)rPr'r(r0r)r*rRrZxdimZydimZydimsZxdimsrrrrrQr+r`rrararerhOs@ $$    &        F)boundrzCallable[[F], F])dataarray_plotfuncrScsb|j}|dkrtdd}d}||kr<|||ddn|t|dddfd d }|S) a  Add a common docstring by re-using the DataArray one. TODO: Reduce code duplication. * The goal is to reduce code duplication by moving all Dataset specific plots to the DataArray side and use this thin wrapper to handle the conversion between Dataset and DataArray. * Improve docstring handling, maybe reword the DataArray versions to explain Datasets better. Parameters ---------- dataarray_plotfunc : Callable Function that returns a finished plot primitive. Nz*DataArray plot method requires a docstringz: Parameters ---------- darray : DataArray z The `y` DataArray will be used as base, any other variables are added as coords. Parameters ---------- ds : Dataset ZdarrayrPr)dataset_plotfuncrScs |_|Sr)r%)rZds_docrarewrappersz'_update_doc_to_dataset..wrapper)r%NotImplementedErrorreplacerr)rZda_docZda_strZds_strrrarre_update_doc_to_datasets rstrztuple[Any, ...]zdict[str, Any]) plotmethodrQrRrScCsHddlm}ttt|j|j||j }| | di|S)NrrrR) xarray.core.dataarrayrdictinspect signaturegetattrplotbind argumentsitemsupdaterz)rrQrRrlocals_rarare_normalize_argss rr)rPr(rrSc Cs~ddlm}t|j}ddddddd d h}||@}|D](}||}|j|d k r:||||<q:|||} || |d S) z.Create a temporary datarray with extra coords.rrr'z markersizer+r-r.r)r*N)coords)rrrrkeysZ data_varsrZbroadcast_like) rPr(rrrZvalid_coord_kwargsZ coord_kwargskkeyZ_yrarare_temp_dataarrays   r)!r'r(rr+r,r linewidthr1r2r3r0r-r.r/ xincrease yincreaserirk add_labels add_titler7xscaleyscalexticksyticksxlimylimr:r;r<r=rBrCzbool | Iterable[bool]rr)%rPrQr'r(rr+r,rrr1r2r3r0r-r.r/rrrirkrrr7rrrrrrr:r;r<r=rBrCrRrSc!$OsdSrra$rPr'r(rr+r,rrr1r2r3r0r-r.r/rrrirkrrr7rrrrrrr:r;r<r=rBrCrQrRrararescatters'r) r'r(rr+r,rrr1r2r3r0r-r/rrrirkrrr7rrrrrrr:r;r<r=rBrCzFacetGrid[DataArray]c!$OsdSrrarrararers') r'r(rr+r,rrr1r2r3r0r.r/rrrirkrrr7rrrrrrr:r;r<r=rBrCc!$OsdSrrarrararerBs'z%PathCollection | FacetGrid[DataArray]c!&Os@t}$|$d=|$|$dit|||$}%|%jj|$dd|$S)z7Scatter plot Dataset data variables against each other.rPrRrQra)r{rrzrrr)&rPr'r(rr+r,rrr1r2r3r0r-r.r/rrrirkrrr7rrrrrrr:r;r<r=rBrCrQrRrdarararerls ( )7 __future__rrrrwtypingrrrrrrr Zxarray.core.alignmentr Z xarray.plotr Zxarray.plot.facetgridr Zxarray.plot.utilsr rrrrZmatplotlib.axesrZmatplotlib.collectionsrrZmatplotlib.colorsrrZmatplotlib.quiverrZ numpy.typingrrrZxarray.core.datasetrZxarray.core.typesrrrrr rrgrhrrrrrrararares $          T%T%T%'T%T%T%? 2\)\)\)