3 ƽhgA@sdZddlmZddlZddlZddlmZddlZddl j Z ddl j Z ddl mZddlmZddZe jd d d d d ZejdZddZGdddeZeZejeeeZdddZdddZGdddZdS)a Builtin colormaps, colormap handling utilities, and the `ScalarMappable` mixin. .. seealso:: :doc:`/gallery/color/colormap_reference` for a list of builtin colormaps. :doc:`/tutorials/colors/colormap-manipulation` for examples of how to make colormaps. :doc:`/tutorials/colors/colormaps` an in-depth discussion of choosing colormaps. :doc:`/tutorials/colors/colormapnorms` for more details about data normalization. )MutableMappingN)ma)datad)cmapscCs |d|S)N)fxrr3/tmp/pip-build-7iwl8md4/matplotlib/matplotlib/cm.py _reversersr z3.2zColormap.reversed()) alternativecCsNi}xD|jD]8\}}t|r,tjt|}nddt|D}|||<qW|S)z:Can only handle specification *data* in dictionary format.cSs g|]\}}}d|||fqS)g?r).0r Zy0y1rrr -szrevcmap..)itemscallable functoolspartialr reversed)dataZdata_rkeyvalZvalnewrrr revcmap#s rz image.lutcCst}xVtjD]J\}}d|kr.tj||tn&d|krFtj|d|ntjj||t||<qWx2t|j D]"}|j }d|_ d|_ |||j <qlW|S)zw Generate a dict mapping standard colormap names to standard colormaps, as well as the reversed colormaps. ZredZlistedT) cmaps_listedrrcolorsLinearSegmentedColormapLUTSIZEZListedColormap from_listlistvaluesr_globalname)cmap_dr!speccmapZrmaprrr _gen_cmap_registry5sr%c@sReZdZdZddZddZddZdd Zd d Zd d Z dddZ ddZ dS)_DeprecatedCmapDictWrapperz1Dictionary mapping for deprecated _cmap_d access.cCs ||_dS)N)_cmap_registry)selfZ cmap_registryrrr __init__Nsz#_DeprecatedCmapDictWrapper.__init__cCs|j|jj|dS)N)_warn_deprecatedr' __delitem__)r(rrrr r+Qsz&_DeprecatedCmapDictWrapper.__delitem__cCs|j|jj|S)N)r*r' __getitem__)r(rrrr r,Usz&_DeprecatedCmapDictWrapper.__getitem__cCs|j|jjS)N)r*r'__iter__)r(rrr r-Ysz#_DeprecatedCmapDictWrapper.__iter__cCs|j|jjS)N)r*r'__len__)r(rrr r.]sz"_DeprecatedCmapDictWrapper.__len__cCs|j|jj||dS)N)r*r' __setitem__)r(rrrrr r/asz&_DeprecatedCmapDictWrapper.__setitem__NcCs|j|jj||S)N)r*r'get)r(rdefaultrrr r0esz_DeprecatedCmapDictWrapper.getcCstjdddddS)Nz3.3zCThe global colormaps dictionary is no longer considered public API.zSPlease use register_cmap() and get_cmap() to access the contents of the dictionary.)messager )cbookwarn_deprecated)r(rrr r*isz+_DeprecatedCmapDictWrapper._warn_deprecated)N) __name__ __module__ __qualname____doc__r)r+r,r-r.r/r0r*rrrr r&Ks r&cCstjtdf|d|dkrRy |j}Wn,tk rP}ztd|WYdd}~XnXt|tjrpd|_ |t |<dS|dk s|dk rtj ddd|dkrt j d}tj|||}d|_ |t |<dS) aC Add a colormap to the set recognized by :func:`get_cmap`. It can be used in two ways:: register_cmap(name='swirly', cmap=swirly_cmap) register_cmap(name='choppy', data=choppydata, lut=128) In the first case, *cmap* must be a :class:`matplotlib.colors.Colormap` instance. The *name* is optional; if absent, the name will be the :attr:`~matplotlib.colors.Colormap.name` attribute of the *cmap*. The second case is deprecated. Here, the three arguments are passed to the :class:`~matplotlib.colors.LinearSegmentedColormap` initializer, and the resulting colormap is registered. Instead of this implicit colormap creation, create a `.LinearSegmentedColormap` and use the first case: ``register_cmap(cmap=LinearSegmentedColormap(name, data, lut))``. Notes ----- Registering a colormap stores a reference to the colormap object which can currently be modified and inadvertantly change the global colormap state. This behavior is deprecated and in Matplotlib 3.5 the registered colormap will be immutable. N)r!z+Arguments must include a name or a ColormapTz3.3zPassing raw data via parameters data and lut to register_cmap() is deprecated since %(since)s and will become an error %(removal)s. Instead use: register_cmap(cmap=LinearSegmentedColormap(name, data, lut)))r2z image.lut)r3_check_isinstancestrr!AttributeError ValueError isinstancerColormapr r'r4mplrcParamsr)r!r$rluterrrrr register_cmap|s(   rCcCsV|dkrtjd}t|tjr"|Stjtt|d|dkrDt|St|j |SdS)a_ Get a colormap instance, defaulting to rc values if *name* is None. Colormaps added with :func:`register_cmap` take precedence over built-in colormaps. Notes ----- Currently, this returns the global colormap object, which is deprecated. In Matplotlib 3.5, you will no longer be able to modify the global colormaps in-place. Parameters ---------- name : `matplotlib.colors.Colormap` or str or None, default: None If a `.Colormap` instance, it will be returned. Otherwise, the name of a colormap known to Matplotlib, which will be resampled by *lut*. The default, None, means :rc:`image.cmap`. lut : int or None, default: None If *name* is not already a Colormap instance and *lut* is not None, the colormap will be resampled to have *lut* entries in the lookup table. Nz image.cmap)r!) r?r@r=rr>r3Z_check_in_listsortedr'Z _resample)r!rArrr get_cmaps  rEc@seZdZdZd*ddZddZd+d d Zd d Zd dZddZ ddZ d,ddZ ddZ ddZ ddZddZddZdd Zd!d"Zd#d$Zejd%Zejd%d&d'Zejd%d(d)ZdS)-ScalarMappablez A mixin class to map scalar data to RGBA. The ScalarMappable applies data normalization before returning RGBA colors from the given colormap. NcCsDd|_d|_|j|d|_|j|d|_tj|_ddi|_ dS)a Parameters ---------- norm : `matplotlib.colors.Normalize` (or subclass thereof) The normalizing object which scales data, typically into the interval ``[0, 1]``. If *None*, *norm* defaults to a *colors.Normalize* object which initializes its scaling based on the first data processed. cmap : str or `~matplotlib.colors.Colormap` The colormap used to map normalized data values to RGBA colors. NarrayF) _Anormset_normr$set_cmapZcolorbarr3ZCallbackRegistry callbacksSM _update_dict)r(rIr$rrr r)s    zScalarMappable.__init__cCs>|dk s|dk r2|j|||dk r2tjddd|jdS)a, Helper for initial scaling. Used by public functions that create a ScalarMappable and support parameters *vmin*, *vmax* and *norm*. This makes sure that a *norm* will take precedence over *vmin*, *vmax*. Note that this method does not set the norm. Nz3.3zPassing parameters norm and vmin/vmax simultaneously is deprecated since %(since)s and will become an error %(removal)s. Please pass vmin/vmax directly to the norm when creating it.)r2)set_climr3r4autoscale_None)r(rIvminvmaxrrr _scale_norms  zScalarMappable._scale_normFTc Csy<|jdkr<|jddkr|dkr*d}|jtjkrDtj|d}|jdd\}}tj||df|jd}||ddddddf<||dddddf<n|jddkr|}ntd|jjd kr|r|jdks|j d krtd |r8|dj tj}n4|jtjkr*|s8|j tj d}ntd |j|SWnt k rTYnXt j|}|rp|j|}|j|||d }|S)a Return a normalized rgba array corresponding to *x*. In the normal case, *x* is a 1-D or 2-D sequence of scalars, and the corresponding ndarray of rgba values will be returned, based on the norm and colormap set for this ScalarMappable. There is one special case, for handling images that are already rgb or rgba, such as might have been read from an image file. If *x* is an ndarray with 3 dimensions, and the last dimension is either 3 or 4, then it will be treated as an rgb or rgba array, and no mapping will be done. The array can be uint8, or it can be floating point with values in the 0-1 range; otherwise a ValueError will be raised. If it is a masked array, the mask will be ignored. If the last dimension is 3, the *alpha* kwarg (defaulting to 1) will be used to fill in the transparency. If the last dimension is 4, the *alpha* kwarg is ignored; it does not replace the pre-existing alpha. A ValueError will be raised if the third dimension is other than 3 or 4. In either case, if *bytes* is *False* (default), the rgba array will be floats in the 0-1 range; if it is *True*, the returned rgba array will be uint8 in the 0 to 255 range. If norm is False, no normalization of the input data is performed, and it is assumed to be in the range (0-1). Nr)shapedtypezThird dimension must be 3 or 4rrz:Floating point image RGB values must be in the 0..1 range.z9Image RGB array must be uint8 or floating point; found %s)alphabytes)ndimrWrXnpZuint8emptyr<kindmaxminZastypeZfloat32r;rZasarrayrIr$) r(r rYrZrImnZxxZrgbarrr to_rgba s@     zScalarMappable.to_rgbacCs||_d|jd<dS)zv Set the image array from numpy array *A*. Parameters ---------- A : ndarray TrGN)rHrM)r(Arrr set_arrayPszScalarMappable.set_arraycCs|jS)zReturn the data array.)rH)r(rrr get_array[szScalarMappable.get_arraycCs|jS)z Return the `.Colormap` instance.)r$)r(rrr rE_szScalarMappable.get_cmapcCs|jj|jjfS)zV Return the values (min, max) that are mapped to the colormap limits. )rIrPrQ)r(rrr get_climcszScalarMappable.get_climc Csf|dkr.y |\}}Wnttfk r,YnX|dk rDtj||j_|dk rZtj||j_|jdS)a> Set the norm limits for image scaling. Parameters ---------- vmin, vmax : float The limits. The limits may also be passed as a tuple (*vmin*, *vmax*) as a single positional argument. .. ACCEPTS: (vmin: float, vmax: float) N) TypeErrorr<rZ_sanitize_extremarIrPrQchanged)r(rPrQrrr rNis zScalarMappable.set_climcCsdS)zU Returns ------- float Always returns 1. g?r)r(rrr get_alphaszScalarMappable.get_alphacCs(|jdk}t|}||_|s$|jdS)z Set the colormap for luminance data. Parameters ---------- cmap : `.Colormap` or str or None N)r$rEri)r(r$in_initrrr rKs  zScalarMappable.set_cmapcCsDtjtjdf|d|jdk}|dkr.tj}||_|s@|jdS)aX Set the normalization instance. Parameters ---------- norm : `.Normalize` or None Notes ----- If there are any colorbars using the mappable for this norm, setting the norm of the mappable will reset the norm, locator, and formatters on the colorbar to default. N)rI)r3r9rZ NormalizerIri)r(rIrkrrr rJs zScalarMappable.set_normcCs,|jdkrtd|jj|j|jdS)zb Autoscale the scalar limits on the norm instance using the current array Nz%You must first set_array for mappable)rHrhrI autoscaleri)r(rrr rls zScalarMappable.autoscalecCs,|jdkrtd|jj|j|jdS)z Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None Nz%You must first set_array for mappable)rHrhrIrOri)r(rrr rOs zScalarMappable.autoscale_NonecCsd|j|<dS)zz Add an entry to a dictionary of boolean flags that are set to True when the mappable is changed. FN)rM)r(checkerrrr _add_checkerszScalarMappable._add_checkercCs|j|rd|j|<dSdS)z9Return whether mappable has changed since the last check.FT)rM)r(rmrrr _check_updates  zScalarMappable._check_updatecCs2|jjd|x|jD]}d|j|<qWd|_dS)z Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal. riTN)rLprocessrMstale)r(rrrr ris zScalarMappable.changedz3.3cCs |j|S)N)rn)r(rmrrr add_checkerszScalarMappable.add_checkercCs |j|S)N)ro)r(rmrrr check_updateszScalarMappable.check_update)NN)NFT)NN)r5r6r7r8r)rRrcrerfrErgrNrjrKrJrlrOrnrorir3Z_deprecate_privatize_attributeZ update_dict deprecatedrrrsrrrr rFs(  F      rF)NNNN)NN) r8collections.abcrrnumpyr\rZ matplotlibr?Zmatplotlib.colorsrZmatplotlib.cbookr3Zmatplotlib._cmrZmatplotlib._cm_listedrrr rtrr@rr%r&r'localsupdater"rCrErFrrrr s(       (  5 "