CRc@ sdZddlmZmZddlZddlZddlmZddl m Z m Z ddl m Z mZmZmZddlmZddlmZdd lmZmZmZmZdd lmZmZmZmZdd lm Z m!Z!m"Z"dd lm#Z#m$Z$dd l%m&Z&m'Z'm(Z(m)Z)ddl%m*Z*ddl+m,Z,m-Z-m.Z.ddl/Z/de*fdYZ0de fdYZ1dS(s The legend module defines the Legend class, which is responsible for drawing legends associated with axes and/or figures. The Legend class can be considered as a container of legend handles and legend texts. Creation of corresponding legend handles from the plot elements in the axes or figures (e.g., lines, patches, etc.) are specified by the handler map, which defines the mapping between the plot elements and the legend handlers to be used (the default legend handlers are defined in the :mod:`~matplotlib.legend_handler` module). Note that not all kinds of artist are supported by the legend yet (See :ref:`plotting-guide-legend` for more information). i(tdivisiontprint_functionN(trcParams(tArtisttallow_rasterization(tis_string_liketiterablet silent_listtsafezip(tFontProperties(tLine2D(tPatcht RectangletShadowtFancyBboxPatch(tLineCollectiontRegularPolyCollectiontCircleCollectiontPathCollection(tBboxtBboxBasetTransformedBbox(tBboxTransformTotBboxTransformFrom(tHPackertVPackertTextAreat DrawingArea(tDraggableOffsetBox(tErrorbarContainert BarContainert StemContainertDraggableLegendcB s;eZeddZdZdZdZdZRS(tloccC sQ||_|dkr!||_ntd|tj|||jd|dS(s update : If "loc", update *loc* parameter of legend upon finalizing. If "bbox", update *bbox_to_anchor* parameter. R!tbboxs'update parameter '%s' is not supported.tuse_blitN(slocsbbox(tlegendt_updatet ValueErrorRt__init__t _legend_box(tselfR$R#tupdate((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR'&s    cC s|jj|S(N(R$tcontains(R)R$tevt((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt artist_picker7scC sa|j}|jdkr+|j|n2|jdkrJ|j|ntd|jdS(NR!R"s'update parameter '%s' is not supported.(tget_loc_in_canvasR%t _update_loct_update_bbox_to_anchort RuntimeErrorR*(R)t loc_in_canvas((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pytfinalize_offset:s cC sz|jj}|jdks-|jdkrO|jjd|jj}nt|}t|j||j_ dS(Ni( R$tget_bbox_to_anchortwidththeighttset_bbox_to_anchortNoneRttuplettransform_pointt_loc(R)R2R"t_bbox_transform((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR/Es cC s2|jjj}|j|}|jj|dS(N(R$taxest transAxesR:R7(R)R2ttrt loc_in_bbox((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR0Rs(t__name__t __module__tFalseR'R-R3R/R0(((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR %s   tLegendcB seZdZi dd6dd6dd6dd6d d 6d d 6d d6dd6dd6dd6dd6Zd ZdZd:d:d:d:d:d:d:d:d:d:d:d:d:d:dd:d:d:d:d:d:d:d:d:dZdZdZ dZ e e e Z dZ dZedZd:dZi eje6eje6eje6eje6eje6eje6eje 6ejd ej!e"6ej#e$6ej%e&6Z'e(d!Z)e(d"Z*e(d#Z+d$Z,e-d%Z.d&Z/d'Z0d(Z1d)Z2d*Z3d+Z4d,Z5d-Z6d:d.Z7d/Z8d0Z9d1Z:d2Z;d3Z<d:d4Z=d5Z>d:d6Z?d7Z@d:eAd8d9ZBRS(;s` Place a legend on the axes at location loc. Labels are a sequence of strings and loc can be a string or an integer specifying the legend location The location codes are:: 'best' : 0, (only implemented for axis legends) 'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4, 'right' : 5, 'center left' : 6, 'center right' : 7, 'lower center' : 8, 'upper center' : 9, 'center' : 10, loc can be a tuple of the normalized coordinate values with respect its parent. itbestis upper rightis upper leftis lower leftis lower rightitrightis center leftis center rightis lower centeri s upper centeri tcentercC sdS(NRD((R)((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt__str__sc&C suddlm}ddlm}tj|| d4krs| d4k rZtd| |_qtdt d|_nMt | t rt| |_d| kr|jj t dqn | |_|jj |_dddd d d g}g|_g|_d4|_||_t}xI|D]A} || d4krEt d | }!n || }!t|| |!qW|j}"t|"j|"j|j}#x\d ddddgD]E}$||$d4krt||$t d |$qt||$||$qW~t|}t|dkrd}n||_|jdkr<td|n|d4krftjd5d6d7g|_ ntj!||_ t"|j#t|j d}%tj$|j |%|j# |_ d4|_%t ||rt&|_'|j(||j)|j*n4t ||r t+|_'|j)|n t,d||_-|d4krmt d}|j' rm|d8krmd}qmnt.|r||j/kr|j'rt0j1d|dj2|j/j3fd}qt0j1d |dj2|j/j3fd}q|j/|}n|j' r1|dkr1t0j1d!d}n||_4|j5||t6d"d9d$d%d&d%d't d(d)t d*d+|jd,t&|_7|d4krt d-}n|r|j7j8d.d/dd0d1n|j7j8d2d/d|j9|j7||_:|d4krt d3|_:n|j;|||d4k rF|j<j=|n||_>|j?||j|_@d4|_Ad4S(:s - *parent*: the artist that contains the legend - *handles*: a list of artists (lines, patches) to be added to the legend - *labels*: a list of strings to label the legend Optional keyword arguments: ================ ==================================================== Keyword Description ================ ==================================================== loc a location code prop the font property fontsize the font size (used only if prop is not specified) markerscale the relative size of legend markers vs. original numpoints the number of points in the legend for line scatterpoints the number of points in the legend for scatter plot scatteryoffsets a list of yoffsets for scatter symbols in legend frameon if True, draw a frame around the legend. If None, use rc fancybox if True, draw a frame with a round fancybox. If None, use rc shadow if True, draw a shadow behind legend framealpha If not None, alpha channel for the frame. ncol number of columns borderpad the fractional whitespace inside the legend border labelspacing the vertical space between the legend entries handlelength the length of the legend handles handleheight the length of the legend handles handletextpad the pad between the legend handle and text borderaxespad the pad between the axes and legend border columnspacing the spacing between columns title the legend title bbox_to_anchor the bbox that the legend will be anchored. bbox_transform the transform for the bbox. transAxes if None. ================ ==================================================== The pad and spacing parameters are measured in font-size units. e.g., a fontsize of 10 points and a handlelength=5 implies a handlelength of 50 points. Values from rcParams will be used if None. Users can specify any arbitrary location for the legend using the *bbox_to_anchor* keyword argument. bbox_to_anchor can be an instance of BboxBase(or its derivatives) or a tuple of 2 or 4 floats. See :meth:`set_bbox_to_anchor` for more detail. The legend location can be specified by setting *loc* with a tuple of 2 floats, which is interpreted as the lower-left corner of the legend in the normalized axes coordinate. i(tAxes(tFiguretsizeslegend.fontsizet numpointst markerscaletshadowt columnspacingt scatterpointst handleheightslegend.t borderpadt labelspacingt handlelengtht handletextpadt borderaxespadiiis numpoints must be > 0; it was %dg@g @g@g@s,Legend needs either Axes or Figure as parents legend.locREs upper rightsLUnrecognized location "%s". Falling back on "best"; valid locations are %s s sSUnrecognized location "%s". Falling back on "upper right"; valid locations are %s siAutomatic legend placement (loc="best") not implemented for figure legend. Falling back on "upper right".txygR5g?R6t facecolorsaxes.facecolort edgecolorsaxes.edgecolortmutation_scaletsnapslegend.fancyboxtroundtpadt rounding_sizeg?tsquareslegend.frameonNg?g?g?(isbest(gg(Btmatplotlib.axesRItmatplotlib.figureRJRR'R8R tpropRt isinstancetdicttset_sizetget_size_in_pointst _fontsizettextst legendHandlest_legend_title_boxt _handler_maptlocalstsetattrR"tminR5R6tlisttlent_ncolRLR&tnptarrayt_scatteryoffsetstasarraytintRPttileR(tTruetisaxestset_axest set_figuretfigureRCt TypeErrortparentRtcodestwarningstwarntjointiterkeyst_modeR7Rt legendPatcht set_boxstylet_set_artist_propst _drawFramet_init_legend_boxt get_framet set_alphaR;t set_titlet_last_fontsize_pointst _draggable(&R)R~thandlestlabelsR!RLRMRPtscatteryoffsetsRbtfontsizeRRRSRTRQRURVROtncoltmodetfancyboxRNttitlet framealphatbbox_to_anchortbbox_transformtframeont handler_mapRIRJt propnamest localdicttnametvalueR"taxessize_fontsizetvtreps((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR'sZ                                                       cC sC|j|j|jr,|j|jn|j|jdS(sE set the boilerplate props for artists added to axes N(R{R|RyRzR=t set_transformt get_transform(R)ta((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR{s cC sG||_|dkr!|j}n |j}|jj|||_dS(Ni(t _loc_realt_findoffset_bestt_findoffset_locR(t set_offset(R)R!t _findoffset((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt_set_locs     cC s|jS(N(R(R)((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt_get_locscC s-|j|||\}}||||fS(s9Helper function to locate the legend at its best position(t_find_best_position(R)R5R6txdescenttydescenttrenderertoxtoy((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRsc C st|jrkt|jdkrk|j\}}|j}|j|j||j|j|} } n?tj dd||}|j |j||j|\} } | || |fS(s<Helper function to locate the legend using the location codeii( RR;RpR4tx0R5ty0R6Rt from_boundst_get_anchored_bbox( R)R5R6RRRtfxtfyR"txty((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRs$ , cC s(|jsdS|jd|j|j}|jdkrvd|j|j|}|jj|j j |n|jj |}|j j |j|j|j |j|j j||jr|jrt|j dd}|j|n|j j|n|jj||jddS(s*Draw everything that belongs to the legendNR$texpandii(sexpand(t get_visiblet open_grouptpoints_to_pixelsRgRRVRRR(t set_widthR4R5tget_window_extentRt set_boundsRRR6tset_mutation_scaleRRNR tdrawt close_group(R)RRR]R"RN((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRs$     cC s'|dkr|jS|j|jSdS(sm Return the approximate height of the text. This is used to place the legend handle. N(R8RgR(R)R((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt_approx_text_heights t update_funccC s|jS(sF A class method that returns the default handler map. (t_default_handler_map(tcls((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pytget_default_handler_mapscC s ||_dS(s@ A class method to set the default handler map. N(R(RR((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pytset_default_handler_mapscC s|jj|dS(sC A class method to update the default handler map. N(RR*(RR((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pytupdate_default_handler_mapscC s=|j}|jr5|j}|j|j|S|SdS(s) return the handler map. N(RRktcopyR*(R)tdefault_handler_mapthm((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pytget_legend_handler_maps    cC sf|j}||kr%||}n=x:t|jD] }||kr8||}Pq8q8Wd}|S(s return a legend handler from *legend_handler_map* that corresponds to *orig_handler*. *legend_handler_map* should be a dictionary object (that is returned by the get_legend_handler_map method). It first checks if the *orig_handle* itself is a key in the *legend_hanler_map* and return the associated value. Otherwise, it checks for each of the classes in its method-resolution-order. If no matching key is found, it returns None. N(tkeysttypetmroR8(tlegend_handler_mapt orig_handletlegend_handler_keysthandlert handle_type((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pytget_legend_handlers     c! C s|j}g}g}tddddd|j}g}g}d|j|jd} |j|j| } |j} xt||D]\} } |j| | }|dkrt j dt | f|j dqnt | d |d td t}|j |j|j |td |j|d | ddd| }||| ||}|j ||j |qWt|dkr.t|jt|}tt||\}}||}ttd||d|d|dg|}tt||dt|||g|}n gg}}t||}g}x||D]\}}g||||!D]:\}}tddd|j|d||gdd^qy}|djdjt|j tddd|j|ddd|q[W|jdkrd}nd}|j |} tddd| ddd|d||_!t d|_"td|j#|d|j|ddd|j"|j!g|_$|j$j%|j&||_'||_(dS(s Initialize the legend_box. The legend_box is an instance of the OffsetBox, which is packed with legend handles and texts. Once packed, their location is calculated during the drawing time. tverticalalignmenttbaselinethorizontalalignmenttlefttfontpropertiesgffffff?gffffff?sLegend does not support %s Use proxy artist instead. http://matplotlib.sourceforge.net/users/legend_guide.html#using-proxy-artist t textpropstmultilinebaselinetminimumdescentR5R6RgRiiR]tseptchildrentaligniRtfixedRtRGN()RgRdRbRRQRtzipRR8RRtstrtappendRRxt_textRRTRpRnRqtdivmodRtrangeRRUt get_childrentset_minimumdescentRCRRSRROt_legend_handle_boxRjRRR(R{R|RhRi(!R)RRRt text_listt handle_listt label_propt labelboxest handleboxestdescentR6RRtlabRttextboxt handleboxthandleRtnrowst num_largecolt num_smallcoltlargecoltsmallcolt handle_labelt columnboxti0tdithttt itemBoxesRR((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR/s                O        c C se|jst|j}g}g}xZ|jD]O}t|tsIt|j}|j}|j|}|j |q.Wx|j D]}}t|t stt|t r|j }|j |jj|q|j}|j |jj|qWy)tjg|D]} | j^q} Wn tk rWtjg} nX| ||gS(s{ Returns list of vertices and extents covered by the plot. Returns a two long list. First element is a list of (x, y) vertices (in display-coordinates) covered by all the lines and line collections, in the legend's handles. Second element is a list of bounding boxes for all the patches in the legend's handles. (RytAssertionErrorR~tlinesRcR tget_pathRttransform_pathRtpatchesR R tget_data_transformtget_bboxt transformedt get_extentsRrt concatenatetverticesR&Rs( R)taxtbboxesRRtpathttransttpatht transformtlR((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt_auto_legend_datas,      ) cC s|j|dS(s$b is a boolean. Set draw frame to bN(t set_frame_on(R)tb((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt draw_framescC sg}|jr"|j|jn|j|j|j|j|j|j|j|j|jr|j|jn|S(sreturn a list of child artists( R(Rtextendt get_linest get_patchest get_textsRRjt get_title(R)R((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRs  cC s|jS(s6return the Rectangle instance used to frame the legend(R(R)((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRscC s)g|jD]}t|tr |^q S(s5return a list of lines.Line2D instances in the legend(RiRcR (R)R((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRscC s2tdg|jD]}t|tr|^qS(s.return a list of patch instances in the legendR (RRiRcR (R)R((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRscC std|jS(s1return a list of text.Text instance in the legendtText(RRh(R)((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRscC s|jjj||dk rSt|tr=t|}n|jjj|n|rl|jjt n|jjt dS(sk set the legend title. Fontproperties can be optionally set with *prop* parameter. N( RjRtset_textR8RcRdR tset_fontpropertiest set_visibleRxRC(R)RRb((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR s cC s |jjS(s)return Text instance for the legend title(RjR(R)((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRscO s|jj||S(s!return a extent of the the legend(RR(R)targstkwargs((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR scC s|jS(s; Get whether the legend box patch is drawn (R(R)((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt get_frame_on$scC s ||_dS(sb Set whether the legend box patch is drawn ACCEPTS: [ *True* | *False* ] N(R(R)R((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR*scC s$|jdkr|jjS|jSdS(sB return the bbox that the legend will be anchored N(t_bbox_to_anchorR8R~R"(R)((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR42s cC s|dkrd|_dSt|tr4||_nuyt|}Wn'tk rmtdt|nX|dkr|d|dddg}ntj ||_|dkrt |j j }nt |j||_dS(s> set the bbox that the legend will be anchored. *bbox* can be a BboxBase instance, a tuple of [left, bottom, width, height] in the given transform (normalized axes coordinate if None), or a tuple of [left, bottom] where the width and height will be assumed to be zero. NsInvalid argument for bbox : %siii(R8R'RcRRpR}R&RRRRR~R"R(R)R"RR((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR7;s       c C s|tddksttd\ }}}}} } } } } }}i d|6d|6d|6d| 6d| 6d| 6d| 6d | 6d |6d |6}||}|j|j}|j|j |}|j|d |}|j|jfS( s Place the *bbox* inside the *parentbbox* according to a given location code. Return the (x,y) coordinate of the bbox. - loc: a location code in range(1, 11). This corresponds to the possible values for self._loc, excluding "best". - bbox: bbox to be placed, display coodinate units. - parentbbox: a parent box which will contain the bbox. In display coordinates. ii tNEtNWtSWtSEtEtWtStNtCt container( RRRRgtpaddedRVtanchoredRR(R)R!R"t parentbboxRtBESTtURtULtLLtLRtRtCLtCRtLCtUCR0t anchor_coefstcRR1t anchored_box((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRZs" -   cC s|jst|j\}}}tjdd||}|dkrgtdt|jD]$} |j | ||j |^qa}ng} x|D]\} } tj| | ||} d}| j |}|| j |7}x*|D]"}|j | r|d7}qqW| | }}|dkr7||fS| j|| | ffqW| d}x+| D]#}|d|dkre|}qeqeW|d\}}||fS(s Determine the best location to place the legend. `consider` is a list of (x, y) pairs to consider as a potential lower-left corner of the legend. All are display coords. iiN(RyRRRRR8RRpRRR4tcount_containstcount_overlapstintersects_bboxR(R)R5R6RtconsidertvertsRRR"Rt candidatesRRt legendBoxtbadnesstlineRRt minCandidatet candidate((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR}s2 C       cC s|jj|S(N(RR+(R)tevent((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyR+sR!cC s|jdk }|dkr%| }n|rX|jdkrt||d||_qn(|jdk rw|jjnd|_|jS(s< Set the draggable state -- if state is * None : toggle the current state * True : turn draggable on * False : turn draggable off If draggable is on, you can drag the legend on the canvas with the mouse. The DraggableLegend helper instance is returned if draggable is on. The update parameter control which parameter of the legend changes when dragged. If update is "loc", the *loc* paramter of the legend is changed. If "bbox", the *bbox_to_anchor* parameter is changed. R*N(RR8R t disconnect(R)tstateR#R*t is_draggable((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt draggables   N(CRARBt__doc__RtzorderRHR8R'RRRtpropertyR;RRRRRtlegend_handlert HandlerStemRtHandlerErrorbarRt HandlerLine2DR t HandlerPatchR tHandlerLineCollectionRtHandlerRegularPolyCollectionRtHandlerCircleCollectionRtupdate_from_first_childRt HandlerTupleR9tHandlerPathCollectionRRt classmethodRRRRt staticmethodRRRRRRRRRRRRR&RR4R7RRR+RCRQ(((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyRDZs       "             ,             # < (2RRt __future__RRRtnumpyRrt matplotlibRtmatplotlib.artistRRtmatplotlib.cbookRRRRtmatplotlib.font_managerR tmatplotlib.linesR tmatplotlib.patchesR R R Rtmatplotlib.collectionsRRRRtmatplotlib.transformsRRRRRtmatplotlib.offsetboxRRRRRtmatplotlib.containerRRRRUR RD(((sK/opt/xtal/ccp4-6.5-linux32/lib/python2.7/site-packages/matplotlib/legend.pyt s$  """" 5