3
���h�F � @ s� d Z ddlmZ ddlZddlZddlZddlZddl m
Z
m Z ddl m
Z
dd� Zd d
� Zd%d d
�Zd&dd�Zdd� Zd'dd�Zdd� ZG dd� de�Zdd� Zedd � �Zed d � �Zed d � �Zd!d"� Zed#d$� �Z dS )(zw
Use this module directly:
import xarray.plot as xplt
Or use the methods on a DataArray:
DataArray.plot._____
� )�divisionN� )�_determine_cmap_params�_infer_xy_labels)� FacetGridc s t � fdd�|D ��S )z>
Is the numpy array a sub dtype of anything in types?
c 3 s | ]}t j� j|�V qd S )N)�np�
issubdtype�dtype)�.0�t)�arr� �0/tmp/pip-build-5_djhm0z/xray/xarray/plot/plot.py� <genexpr> s z _right_dtype.<locals>.<genexpr>)�any)r �typesr
)r r � _right_dtype s r c s6 t jt jt jt jg� t� fdd�| D ��s2td��dS )z\
Raise exception if there is anything in args that can't be plotted on
an axis.
c 3 s | ]}t tj|�� �V qd S )N)r r �array)r
�x)� plottypesr
r r $ s z$_ensure_plottable.<locals>.<genexpr>z5Plotting requires coordinates to be numeric or dates.N)r Zfloating�integerZ timedelta64�
datetime64r � TypeError)�argsr
)r r �_ensure_plottable s r � c
K sD |
j dd�} | dk r td��t| |||||| d�} | j|||f|
�S )z�
Convenience method to call xarray.plot.FacetGrid from 2d plotting methods
kwargs are the arguments to 2d plotting method
�axNz)Can't use axes when making faceted plots.)�data�col�row�col_wrap�aspect�size� subplot_kws)�pop�
ValueErrorr Z
map_dataarray)
�darray�plotfuncr �yr r r r! r" r# �kwargsr �gr
r
r �_easy_facetgrid) s
r+ �{�G�z�?c K s� | j � } t| j�}|j|� |j|� t|�} d}
| dkrP|sB|rJt|
��t} nB| dkr~||d< ||d< ||d< ||d< t} n|s�|r�t|
��t} ||d< | | f|�S ) a
Default plot of DataArray using matplotlib.pyplot.
Calls xarray plotting function based on the dimensions of
darray.squeeze()
=============== ===========================
Dimensions Plotting function
--------------- ---------------------------
1 :py:func:`xarray.plot.line`
2 :py:func:`xarray.plot.pcolormesh`
Anything else :py:func:`xarray.plot.hist`
=============== ===========================
Parameters
----------
darray : DataArray
row : string, optional
If passed, make row faceted plots on this dimension name
col : string, optional
If passed, make column faceted plots on this dimension name
col_wrap : integer, optional
Use together with ``col`` to wrap faceted plots
ax : matplotlib axes, optional
If None, uses the current axis. Not applicable when using facets.
rtol : number, optional
Relative tolerance used to determine if the indexes
are uniformly spaced. Usually a small positive number.
subplot_kws : dict, optional
Dictionary of keyword arguments for matplotlib subplots. Only applies
to FacetGrid plotting.
**kwargs : optional
Additional keyword arguments to matplotlib
z]Only 2d plots are supported for facets in xarray. See the package `Seaborn` for more options.r � r r r r# r ) Zsqueeze�set�dims�discard�lenr% �line�
pcolormesh�hist) r& r r r r Zrtolr# r) Z plot_dims�ndimsZ error_msgr' r
r
r �plot9 s* %
r6 c O s� ddl j}t| j�}|dkr,tdj|d���|jdd�}|dkrH|j� }t| j j
� �d \}}t |g� |j || f|�|�}|j
|� |j| j� � | jdk r�|j| j� tj|jtj�r�|j� j� |S )a`
Line plot of 1 dimensional DataArray index against values
Wraps matplotlib.pyplot.plot
Parameters
----------
darray : DataArray
Must be 1 dimensional
ax : matplotlib axes, optional
If not passed, uses the current axis
*args, **kwargs : optional
Additional arguments to matplotlib.pyplot.plot
r Nr zTLine plots are for 1 dimensional DataArrays. Passed DataArray has {ndims} dimensions)r5 r )�matplotlib.pyplot�pyplotr1 r/ r% �formatr$ �gca�list�indexes�itemsr r6 �
set_xlabel� set_title�_title_for_slice�name�
set_ylabelr r r r ZgcfZ
autofmt_xdate) r& r r) �pltr5 r Zxlabelr � primitiver
r
r r2 � s$
r2 c K sl ddl j}|dkr|j� }tj| j�}|tj|� }|j|f|�}|j d� | j
dk rh|j dj | j
�� |S )a|
Histogram of DataArray
Wraps matplotlib.pyplot.hist
Plots N dimensional arrays by first flattening the array.
Parameters
----------
darray : DataArray
Can be any dimension
ax : matplotlib axes, optional
If not passed, uses the current axis
**kwargs : optional
Additional keyword arguments to matplotlib.pyplot.hist
r NZCountzHistogram of {0})
r7 r8 r: r Zravel�values�pdZnotnullr4 rB rA r? r9 )r& r r) rC Zno_nanrD r
r
r r4 � s
r4 c C s| |dkr
n2|r"| j t| j� �� n|s<| j t| j� dd�� |dkrFn2|r^| jt| j� �� n|sx| jt| j� dd�� dS )zM
Update axes in place to increase or decrease
For use in _plot2d
NT)�reverse)�set_xlim�sortedZget_xlim�set_ylimZget_ylim)r � xincrease� yincreaser
r
r �_update_axes_limits� s rM c @ sF e Zd ZdZdd� Zdd� Zeje�d dd��Zeje �d d
� �Z dS ) � _PlotMethodszs
Enables use of xarray.plot functions as attributes on a DataArray.
For example, DataArray.plot.imshow
c C s
|| _ d S )N)�_da)�selfr& r
r
r �__init__� s z_PlotMethods.__init__c K s t | jf|�S )N)r6 rO )rP r) r
r
r �__call__� s z_PlotMethods.__call__Nc K s t | jfd|i|��S )Nr )r4 rO )rP r r) r
r
r r4 � s z_PlotMethods.histc O s t | jf|�|�S )N)r2 rO )rP r r) r
r
r r2 � s z_PlotMethods.line)N)
�__name__�
__module__� __qualname__�__doc__rQ rR � functools�wrapsr4 r2 r
r
r
r rN � s rN c sX d}dj �j|f��_tj��d
�fdd� �� tj� �d � fdd � �}tt|j|� � S ) zh
Decorator for common 2d plotting logic
Also adds the 2d plot method to class _PlotMethods
a,
Parameters
----------
darray : DataArray
Must be 2 dimensional, unless creating faceted plots
x : string, optional
Coordinate for x axis. If None use darray.dims[1]
y : string, optional
Coordinate for y axis. If None use darray.dims[0]
ax : matplotlib axes object, optional
If None, uses the current axis
row : string, optional
If passed, make row faceted plots on this dimension name
col : string, optional
If passed, make column faceted plots on this dimension name
col_wrap : integer, optional
Use together with ``col`` to wrap faceted plots
xincrease : None, True, or False, optional
Should the values on the x axes be increasing from left to right?
if None, use the default for the matplotlib function
yincrease : None, True, or False, optional
Should the values on the y axes be increasing from top to bottom?
if None, use the default for the matplotlib function
add_colorbar : Boolean, optional
Adds colorbar to axis
add_labels : Boolean, optional
Use xarray metadata to label axes
vmin, vmax : floats, optional
Values to anchor the colormap, otherwise they are inferred from the
data and other keyword arguments. When a diverging dataset is inferred,
setting one of these values 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.
cmap : matplotlib colormap name or object, optional
The mapping from data values to color space. If not provided, this
will be either be ``viridis`` (if the function infers a sequential
dataset) or ``RdBu_r`` (if the function infers a diverging dataset).
When when `Seaborn` is installed, ``cmap`` may also be a `seaborn`
color palette. If ``cmap`` is seaborn color palette and the plot type
is not ``contour`` or ``contourf``, ``levels`` must also be specified.
colors : discrete colors to plot, optional
A single color or a list of colors. If the plot type is not ``contour``
or ``contourf``, the ``levels`` argument is required.
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.
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 list-like object, optional
Split the colormap (cmap) into discrete color intervals.
subplot_kws : dict, optional
Dictionary of keyword arguments for matplotlib subplots. Only applies
to FacetGrid plotting.
**kwargs : optional
Additional arguments to wrapped matplotlib function
Returns
-------
artist :
The same type of primitive artist that the wrapped matplotlib
function returns
�
NTFc
s |s|r<t � j� }|j|jd�� t� � j |d< tf |�S dd lj}|
rV|rVt d��|rrd� jkrr| rrt d��t
|
t t f�r�t
jdtdd � |d kr�|j� }t| ||d
�\}}| | j}| | j}| jd d �}|| jd kr�|j}t||� d� jk�r
|d k�r
d
}|j| | |�r |n|
||||� jdkd� } tf | �} d� jk�rb| d |d< | d |d< |jd| d � � |||f|| d | d | d d�|��\}} |
�r�|j|� |j|� |j | j � � | �r |j | || d d�} | j �r |
�r | j | j dd� t!|||� | S )Nr) r' r z#Can't specify both cmap and colors.�contourz.Can only specify colors with contour or levelszNSpecifying a list of colors in cmap is deprecated. Use colors keyword instead.r )�
stacklevel)r& r r( F)�copy� ) Z plot_data�vmin�vmax�cmap�center�robust�extend�levelsZfilledrc rd Znormr` r^ r_ )r r` r^ r_ )r rc �Z )Zrotation)"�localsr\ �updater$ �globalsrS r+ r7 r8 r% �
isinstancer; �tuple�warnings�warn�DeprecationWarningr: r rE Zto_masked_arrayr/ �Tr r r �
setdefaultr> rB r? r@ ZcolorbarrA Z set_labelrM ) r& r r( r r r r rK rL � add_colorbar�
add_labelsr^ r_ r` ra rb rc rd �colorsr# r) �allargsrC ZxlabZylabZxvalZyvalZzvalZ cmap_kwargsZ cmap_paramsrD Zcbar)r' r
r � newplotfuncO sj
z _plot2d.<locals>.newplotfuncc s8 t � }| j|d< |j|� xdD ]
}||= q W � f |�S )z�
The method should have the same signature as the function.
This just makes the method work on Plotmethods objects,
and passes all the other arguments straight through.
r& �_PlotMethods_objrt r) )ru rt r) )rf rO rg )ru r r( r r r r rK rL rp rq r^ r_ r` rr ra rb rc rd r# r) rs �arg)rt r
r �
plotmethod� s
z_plot2d.<locals>.plotmethod)NNNNNNTTTTNNNNFNNNN)NNNNNNTTTTNNNNNFNNN)�joinrV rW rX �setattrrN rS )r' Z commondocrw r
)rt r' r �_plot2d s I ^ rz c
K s� | j dks|j dkr td��| d | d d }|d |d d }| d | | d | }}|d | |d | } }
||| |
gddd�} t|d�s�d | d
< | j|� |j|f| �} || fS )
a�
Image plot of 2d DataArray using matplotlib.pyplot
Wraps matplotlib.pyplot.imshow
..note::
This function needs uniformly spaced coordinates to
properly label the axes. Call DataArray.plot() to check.
The pixels are centered on the coordinates values. Ie, if the coordinate
value is 3.2 then the pixels for those coordinates will be centered on 3.2.
r zBimshow requires 1D coordinates, try using pcolormesh or contour(f)r g @�upperZnearest)Zextent�origin�
interpolation�
projection�autor! ���r� )�ndimr% �hasattrrg �imshow)
r r( �zr r) ZxstepZystep�left�rightZbottom�top�defaultsrD r
r
r r� � s
r� c K s |j | ||f|�}||fS )zK
Contour plot of 2d DataArray
Wraps matplotlib.pyplot.contour
)rZ )r r( r� r r) rD r
r
r rZ � s rZ c K s |j | ||f|�}||fS )zS
Filled contour plot of 2d DataArray
Wraps matplotlib.pyplot.contourf
)�contourf)r r( r� r r) rD r
r
r r� s r� c C sf t j| �} d| dd� | dd� }| d |d }| d |d }t j|g| dd� | |gf S ) zb
>>> _infer_interval_breaks(np.arange(5))
array([-0.5, 0.5, 1.5, 2.5, 3.5, 4.5])
g �?r Nr r� r� r� r� )r ZasarrayZr_)ZcoordZdeltas�first�lastr
r
r �_infer_interval_breaks s
r� c K sr t | �} t |�}|j| ||f|�}t|d� rj| jdkrj|jdkrj|j| d | d � |j|d |d � ||fS )zR
Pseudocolor plot of 2d DataArray
Wraps matplotlib.pyplot.pcolormesh
r~ r r r� r� )r� r3 r� r� rH rJ )r r( r� r r) rD r
r
r r3 s r3 )NNNr r N)NNNNr, N)N) rV �
__future__r rW rk Znumpyr ZpandasrF �utilsr r Z facetgridr r r r+ r6 r2 r4 rM �objectrN rz r� rZ r� r� r3 r
r
r
r �<module> s0
G1
$ K + |