Rc@sdZddlmZddlZddlZddlZddlj Z ddl j Z ddl jZddljZddljZddljZddljZddljZddljZddljZddlj Z ddl!j"Z#ddlm$Z$dZ%dZ&de%e&fZ'e$j(j)de'd Z*d ej+fd YZ,d e,fd YZ-e$j.e%e/e/ddddZ0e$j.e%dZ1de-fdYZ2dZ3dS(s Colorbar toolkit with two classes and a function: :class:`ColorbarBase` the base class with full colorbar drawing functionality. It can be used as-is to make a colorbar for a given colormap; a mappable object (e.g., image) is not needed. :class:`Colorbar` the derived class for use with images or contour plots. :func:`make_axes` a function for resizing an axes and adding a second axes suitable for a colorbar The :meth:`~matplotlib.figure.Figure.colorbar` method uses :func:`make_axes` and :class:`Colorbar`; the :func:`~matplotlib.pyplot.colorbar` function is a thin wrapper over :meth:`~matplotlib.figure.Figure.colorbar`. i(tprint_functionN(t docstrings ============= ==================================================== Property Description ============= ==================================================== *orientation* vertical or horizontal *fraction* 0.15; fraction of original axes to use for colorbar *pad* 0.05 if vertical, 0.15 if horizontal; fraction of original axes between colorbar and new image axes *shrink* 1.0; fraction by which to shrink the colorbar *aspect* 20; ratio of long to short dimensions *anchor* (0.0, 0.5) if vertical; (0.5, 1.0) if horizontal; the anchor point of the colorbar axes *panchor* (1.0, 0.5) if vertical; (0.5, 0.0) if horizontal; the anchor point of the colorbar parent axes. If False, the parent axes' anchor will be unchanged ============= ==================================================== sS ============ ==================================================== Property Description ============ ==================================================== *extend* [ 'neither' | 'both' | 'min' | 'max' ] If not 'neither', make pointed end(s) for out-of- range values. These are set for a given colormap using the colormap set_under and set_over methods. *extendfrac* [ *None* | 'auto' | length | lengths ] If set to *None*, both the minimum and maximum triangular colorbar extensions with have a length of 5% of the interior colorbar length (this is the default setting). If set to 'auto', makes the triangular colorbar extensions the same lengths as the interior boxes (when *spacing* is set to 'uniform') or the same lengths as the respective adjacent interior boxes (when *spacing* is set to 'proportional'). If a scalar, indicates the length of both the minimum and maximum triangular colorbar extensions as a fraction of the interior colorbar length. A two-element sequence of fractions may also be given, indicating the lengths of the minimum and maximum colorbar extensions respectively as a fraction of the interior colorbar length. *extendrect* [ *False* | *True* ] If *False* the minimum and maximum colorbar extensions will be triangular (the default). If *True* the extensions will be rectangular. *spacing* [ 'uniform' | 'proportional' ] Uniform spacing gives each discrete color the same space; proportional makes the space proportional to the data interval. *ticks* [ None | list of ticks | Locator object ] If None, ticks are determined automatically from the input. *format* [ None | format string | Formatter object ] If None, the :class:`~matplotlib.ticker.ScalarFormatter` is used. If a format string is given, e.g., '%.3f', that is used. An alternative :class:`~matplotlib.ticker.Formatter` object may be given instead. *drawedges* [ False | True ] If true, draw lines at color boundaries. ============ ==================================================== The following will probably be useful only in the context of indexed colors (that is, when the mappable has norm=NoNorm()), or other unusual circumstances. ============ =================================================== Property Description ============ =================================================== *boundaries* None or a sequence *values* None or a sequence which must be of length 1 less than the sequence of *boundaries*. For each region delimited by adjacent entries in *boundaries*, the color mapped to the corresponding value in values will be used. ============ =================================================== s Add a colorbar to a plot. Function signatures for the :mod:`~matplotlib.pyplot` interface; all but the first are also method signatures for the :meth:`~matplotlib.figure.Figure.colorbar` method:: colorbar(**kwargs) colorbar(mappable, **kwargs) colorbar(mappable, cax=cax, **kwargs) colorbar(mappable, ax=ax, **kwargs) arguments: *mappable* the :class:`~matplotlib.image.Image`, :class:`~matplotlib.contour.ContourSet`, etc. to which the colorbar applies; this argument is mandatory for the :meth:`~matplotlib.figure.Figure.colorbar` method but optional for the :func:`~matplotlib.pyplot.colorbar` function, which sets the default to the current image. keyword arguments: *cax* None | axes object into which the colorbar will be drawn *ax* None | parent axes object(s) from which space for a new colorbar axes will be stolen. If a list of axes is given they will all be resized to make room for the colorbar axes. *use_gridspec* False | If *cax* is None, a new *cax* is created as an instance of Axes. If *ax* is an instance of Subplot and *use_gridspec* is True, *cax* is created as an instance of Subplot using the grid_spec module. Additional keyword arguments are of two kinds: axes properties: %s colorbar properties: %s If *mappable* is a :class:`~matplotlib.contours.ContourSet`, its *extend* kwarg is included automatically. Note that the *shrink* kwarg provides a simple way to keep a vertical colorbar, for example, from being taller than the axes of the mappable to which the colorbar is attached; but it is a manual method requiring some trial and error. If the colorbar is too tall (or a horizontal colorbar is too wide) use a smaller value of *shrink*. For more precise control, you can manually specify the positions of the axes objects in which the mappable and the colorbar are drawn. In this case, do not use any of the axes properties kwargs. It is known that some vector graphics viewer (svg and pdf) renders white gaps between segments of the colorbar. This is due to bugs in the viewers not matplotlib. As a workaround the colorbar can be rendered with overlapping segments:: cbar = colorbar() cbar.solids.set_edgecolor("face") draw() However this has negative consequences in other circumstances. Particularly with semi transparent images (alpha < 1) and colorbar extensions and is not enabled by default see (issue #1188). returns: :class:`~matplotlib.colorbar.Colorbar` instance; see also its base class, :class:`~matplotlib.colorbar.ColorbarBase`. Call the :meth:`~matplotlib.colorbar.ColorbarBase.set_label` method to label the colorbar. t colorbar_doccOstjddS(Ns,Use the colorbar set_ticks() method instead.(twarningstwarn(targstkw((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt_set_ticks_on_axis_warnst ColorbarBasecBseZdZiedd(d6eddd6edd(d6eddd6Zd(d(d(d(d(dd dd d(d(eed(ed d Zd Z dZ dZ dZ dZ dZedZedZdZdZdZdZdZdZedZdZd(dZdZdZd Zd!d"Zd#Zd$Zd%Z d&Z!d'Z"RS()sF Draw a colorbar in an existing axes. This is a base class for the :class:`Colorbar` class, which is the basis for the :func:`~matplotlib.pyplot.colorbar` function and the :meth:`~matplotlib.figure.Figure.colorbar` method, which are the usual ways of creating a colorbar. It is also useful by itself for showing a colormap. If the *cmap* kwarg is given but *boundaries* and *values* are left as None, then the colormap will be displayed on a 0-1 scale. To show the under- and over-value colors, specify the *norm* as:: colors.Normalize(clip=False) To show the colors versus index instead of on the 0-1 scale, use:: norm=colors.NoNorm. Useful attributes: :attr:`ax` the Axes instance in which the colorbar is drawn :attr:`lines` a list of LineCollection if lines were drawn, otherwise an empty list :attr:`dividers` a LineCollection if *drawedges* is True, otherwise None Useful public methods are :meth:`set_label` and :meth:`add_lines`. itneitheriitbothtmintmaxtverticaltautotuniformtcCs||_|j|dkr.tj}n|dkrItj}n||_tjj |d|d|||_ ||_ | |_ |j | |_| |_||_| |_||_||_||_d|_t|_d|_d|_d|_|dkr&|dkrdnd}n||_|j|tj| rltj | dt!| |_"n | |_"| dkrt#|j$tj%rtj&|_'qtj(|_'n-tj)| rtj*| |_'n | |_'|j+|j,dS(NtcmaptnormRt horizontaltbottomtrighttnbins(-taxt _patch_axtNonetcmtget_cmaptcolorst NormalizetalphatScalarMappablet__init__tvaluest boundariestextendt _slice_dictt_insidetspacingt orientationt drawedgestfilledt extendfract extendrecttsolidstlisttlinestoutlinetpatchtdividerst ticklocationt set_labeltcbooktiterablettickert FixedLocatortlentlocatort isinstanceRtLogNormtLogFormatterMathtextt formattertScalarFormattertis_string_liketFormatStrFormattert config_axistdraw_all(tselfRRRRR!R"R'R2R#R&ttickstformatR(R)R*R+tlabel((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyR sN                      !    cCs |jdkS(s.Returns whether the lower limit is open ended.R R (R smin(R#(RC((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt _extend_lower?scCs |jdkS(s-Returns whether the uper limit is open ended.R R (sbothsmax(R#(RC((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt _extend_upperCscCst|j_t|j_dS(N(RRt set_xtickst set_yticks(RC((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRGs cCsu|j|j|j\}}|jddtjf}|j|||jrq|j|||ndS(ss Calculate any free parameters based on the current cmap and norm, and do all the drawing. N( t_process_valuest _find_ranget_mesht_valuestnptnewaxist _config_axesR)t _add_solids(RCtXtYtC((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRBMs   cCs|j}|jdkrQ|jjg|jj|j|jj|jn6|jjg|jj|j|jj|j|jdS(NR ( RR'txaxist set_tickstyaxistset_label_positionR2tset_ticks_positiont _set_label(RCR((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRAZs cCs|j}|j\}}}|jdkrc|jj||j||jjj|n3|jj||j ||jjj|dS(s Force the update of the ticks and ticklabels. This must be called whenever the tick locator and/or tick formatter changes. R N( Rt_tickerR'RXRWtset_yticklabelstget_major_formattertset_offset_stringRVtset_xticklabels(RCRRDt ticklabelst offset_string((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt update_ticksis   cCsPtj|r0tj|dt||_n ||_|rL|jndS(s set tick locations. Tick locations are updated immediately unless update_ticks is *False*. To manually update the ticks, call *update_ticks* method explicitly. RN(R4R5R6R7R8R9Rc(RCRDRc((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRWzs ! cCsNt|jtjr=tj||_|rJ|jqJn tjddS(s set tick labels. Tick labels are updated immediately unless update_ticks is *False*. To manually update the ticks, call *update_ticks* method explicitly. s"set_ticks() must have been called.N( R:R9R6R7tFixedFormatterR=RcRR(RCRaRc((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pytset_ticklabelss c Csz|j}|jt|jt|j||}|j||j|jj|j |jj |j dk r|j j ntj|dddf|dddfdtjddtjd|_ |j|j |j jd|j jdtjd}|jdk r2|jj ntj|d |d |dd d d |_|j|j|jdS(s1 Make an axes patch and outline. Niitcolorsaxes.edgecolort linewidthsaxes.linewidthsaxes.facecolort edgecolort facecolorg{Gz?tzorderi(Rt set_frame_ontFalset set_navigatet_outlinetupdate_datalimtset_xlimtdataLimt intervalxtset_ylimt intervalyR/RtremoveR.tLine2DtmpltrcParamst add_artistt set_clip_boxt set_clip_pathR0tmpatchestPolygonRc(RCRSRTRtxytc((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRQs0    6  cCsH|jdkr+|jj|j|jn|jj|j|jdS(NR (R'Rt set_ylabelt_labelt_labelkwt set_xlabel(RC((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyR[scKs'd|f|_||_|jdS(s5 Label the long axis of the colorbar s%sN(RRR[(RCRFR((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyR3s c Cs|jd}dd|d|dd|dd|d|d|dg }tjtjtj||}tjtjtj||}|jt|df}|jt|df}|jdkrtj||fStj||fS(so Return *x*, *y* arrays of colorbar bounding polygon, taking orientation into account. iiiR( tshapeROttaketravelt transposetreshapeR8R'thstack(RCRSRTtNtiitxty((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRns =$$cCs|jd}|jdkrQgtd|dD]}t||||^q0Sgtd|dD]}t||||^qeSdS(sM Return the separator line segments; helper for _add_solids. iR iN(RR'txrangetzip(RCRSRTRti((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt_edgess 5c Cst|jdkr!|||f}n*tj|tj|tj|f}td|jd|jd|jdd}|jj}|jj t |jj ||}|jj ||j d k r|j jn||_ |jd k r |jjd |_n|jrpdtjdf}tj|j||d tjd fd ||_|jj|jnd S( st Draw the colors using :meth:`~matplotlib.axes.Axes.pcolormesh`; optionally add separators. R RRRt edgecolorsRg?saxes.linewidthRsaxes.edgecolort linewidthsN(R'RORtdictRRRRtisholdtholdtTruet pcolormeshR,RRuR1R(RwRxt collectionstLineCollectionRtadd_collection( RCRSRTRURRt_holdtcolR((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRRs.*        cCs|j|}|dk|dk@}||}tj|rTtj||}ntj|rytj||}nt|}tjddg}tj||\} } |jdkrgt |D]} t | | | | ^q} n0gt |D]} t | | | | ^q} t j | d|} |rr|j rrx|j D]}|jqRWg|_ n|j j| | j||jj| dS(s Draw lines on the colorbar. *colors* and *linewidths* must be scalars or sequences the same length as *levels*. Set *erase* to False to add lines without first removing any previously added lines. gjt?gMbPgg?R RN(t_locateR4R5ROtasarrayR8tarraytmeshgridR'RRRRR.Rutappendt set_colorRR(RCtlevelsRRteraseRtigoodRRRSRTRR~Rtlc((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt add_liness*   30  c CsS|j}|j}|d kr|jd krt|jtjrt|j }dt |d}t j d|dd}qt|jtj r|jj}t j|dd}qt|jtjrt j}qt j}q|j|j}t j|dd}nt|jtjrF|j d|j df}n|j|jf}|jd|d|jd|d|j||j||j||j|tj|}|j|}|d k|d k@}||}||}|j|gt|D]\} } || | ^q} |j} || | fS( si Return two sequences: ticks (colorbar data locations) and ticklabels (strings). ii tbasetoffsetiRitminposgMbPgjt?N(R9R=RR"R:RRtNoNormR8RNtintR6t IndexLocatort BoundaryNormR7R;t LogLocatort MaxNLocatort _boundariesR%tvmintvmaxtcreate_dummy_axistset_view_intervaltset_data_intervalRORRtset_locst enumeratet get_offset( RCR9R=tnvRtbtintvRDtinrangeRttRaRb((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyR\!sD           . cCs!|dkr|j}n|dk rtj|dt|_|jdkrd|jd |jd|_t|j t j r|jdj tj |_ndStj|j|_dS|jdk rtj|j|_|jdkrqtjt|jdd}d|jd |jd|dd+d|d|d |d Ntdg@iiii(RR"RORtfloatRR!RNR:RRRtastypetint16RtzerosR8t _uniform_yRRtarangeR%RGRHRR-tscaledRRtinverseRK(RCRtvtbi((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRKMsx    # '%%       "      %  cCs.|j|j}|d|_|d|_dS(s Set :attr:`vmin` and :attr:`vmax` attributes to the first and last boundary excluding extended end boundaries. iiN(RR%RR(RCR((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRLs cCsKt|j}|jdkr+|d8}n|jdkrG|d8}n|S(s1number of boundaries **before** extension of endsR iR R i(sminsmax(R8RR#(RCtnb((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt _central_Ns   cCsL|jjd}|jdkr,|d7}n|jdkrH|d7}n|S(se Based on the colormap and extend variable, return the number of boundaries. iR iR R (sminsmax(RRR#(RCR((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt _extended_Ns   g?cCstj||g}t|tr\|jdkrM||d<||d|d|d}|d|d|}|d|d|}|j|j||d d }|jdkrd |d|deZdZdZdZedZdZdZRS(s This class connects a :class:`ColorbarBase` to a :class:`~matplotlib.cm.ScalarMappable` such as a :class:`~matplotlib.image.AxesImage` generated via :meth:`~matplotlib.axes.Axes.imshow`. It is not intended to be instantiated directly; instead, use :meth:`~matplotlib.figure.Figure.colorbar` or :func:`~matplotlib.pyplot.colorbar` to make your colorbar. cKsL|j||_|j|d<}|j|d<}t|tjr|}|j|d<|j|d<|j |d<|j |d<|j dt j |jdd |j|d ssJUnable to create a colorbar axes as not all parents share the same figure.toriginalit adjustabletboxN(g?g?(gg?(gg?(g?g?(g?g(g?g?(g?g?(g?g(sleftsright(RREtjoinRRtpopR:R-ttupleR talltmtranstBboxtuniont get_positionRtfrozentsplitxtshrunktanchoredtsplityt BboxTransformt transformt set_positionRlt set_anchortadd_axest set_aspect(tparentstlocationR'tfractiontshrinktaspectRt locationstmsgtdefault_location_settingst loc_settingsRt parent_anchorR Rt parents_bboxtpbtpbcbt_tpb1tshrinking_transtnew_posntcax((R sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyt make_axess|              +  "'! "'    c Ks!|jdd}d|d<|jdd}|jdd}|jd d }d|}d|d }|||g}tj} |dkr|jd d } d| d| } | ddd|jd| d|| |g} | ddd| dddd|} d}d}n|jd d} d| d| } | ddd|jd| d|| |g} | ddd| dddd|} d|}d}d}|j| d|j|j|j|j ||j }|j | d}|j |d|dd||fS(sY Resize and reposition a parent axes, and return a child axes suitable for a colorbar. This function is similar to make_axes. Prmary differences are * *make_axes_gridspec* only handles the *orientation* keyword and cannot handle the "location" keyword. * *make_axes_gridspec* should only be used with a subplot parent. * *make_axes* creates an instance of Axes. *make_axes_gridspec* creates an instance of Subplot. * *make_axes* updates the position of the parent. *make_axes_gridspec* replaces the grid_spec attribute of the parent with a new one. While this function is meant to be compatible with *make_axes*, there could be some minor differences.:: cax, kw = make_axes_gridspec(parent, **kw) Keyword arguments may include the following (with defaults): *orientation* 'vertical' or 'horizontal' %s All but the first of these are stripped from the input kw set. Returns (cax, kw), the child axes and the reduced kw dictionary to be passed when creating the colorbar instance. R'R RR2R&g333333?R'g?R(ig?R g?iit subplot_spectwspacet width_ratiosithspacegt height_ratiosiRRR(gg?(g?g?(g?g?(g?g( RRtgridspectGridSpecFromSubplotSpectget_subplotspectset_subplotspect update_paramsR tfigboxR!R t add_subplotR#(tparentRR'R&R'R(tx1tpad_st wh_ratiostgs_from_subplotspecR twh_spacetgstgs2RR R R5((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pytmake_axes_gridspec=sV%                   t ColorbarPatchcBs eZdZdZdZRS(s] A Colorbar which is created using :class:`~matplotlib.patches.Patch` rather than the default :func:`~matplotlib.axes.pcolor`. It uses a list of Patch instances instead of a :class:`~matplotlib.collections.PatchCollection` because the latter does not allow the hatch pattern to vary among the members of the collection. cKs#g|_tj||||dS(N(tsolids_patchesRR (RCRRR((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyR s c Csj|jj}|jjti|jd6}t|}|jj|}g}xFtt|dD].} || d} || } t j || d|| dg|| d|| dg|| dd|| ddg|| dd|| ddgg} |j dkr4| ddddf} nt j tj| d|j|j| d | d dd t|} |jj| |j| qhW|jrx|jD]}|jqWn||_|jdk r|jjd|_n|jrVtj|j||d tjd fddtjdf|_|jj|jn|jj|dS(sn Draw the colors using :class:`~matplotlib.patches.Patch`; optionally add separators. RiiR.NiRithatchRgt antialiasedRsaxes.edgecolorRg?saxes.linewidth( RRRRRR8RthatchesRRORR'R|t PathPatchtmpathtPathRRRlt add_patchRRMRuR1RR(RRRRwRxR(RCRSRTRURRt n_segmentsRPtpatchesRtvalRNR~R0tsolid((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRRsD  !*       (RRRR RR(((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyRLs  cKst|tjrOtg|jD]}|dk ^qrOt|||}nt|||}|jj d|j ||_ |S(s Creates a colorbar on the given axes for the given mappable. Typically, for automatic colorbar placement given only a mappable use :meth:`~matplotlib.figure.Figure.colorbar`. tchangedN( R:RRRRPRRLRt callbacksSMtconnectRtcolorbar(R5RtkwargsRNtcb((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pytcolorbar_factorys ( (4Rt __future__RRtnumpyROt matplotlibRwtmatplotlib.artisttartistRtmatplotlib.cbookR4tmatplotlib.collectionsRtmatplotlib.colorsRtmatplotlib.contourRt matplotlib.cmRtmatplotlib.gridspecR<tmatplotlib.linesR.tmatplotlib.patchesRVR|tmatplotlib.pathtpathRRtmatplotlib.tickerR6tmatplotlib.transformst transformsRRtmake_axes_kw_doctcolormap_kw_docRtinterpdtupdateRRRRt SubstitutionRR6RKRLR_(((sM/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/colorbar.pyts@   @O q  wdK