OwlCyberSecurity - MANAGER
Edit File: sankey.cpython-38.pyc
U ��]�� � @ s� d Z ddlZddlmZ ddlZddlmZ ddlm Z ddl m Z ddl m Z ddl mZ e�e�Zd Zd gZd Zd ZdZd ZdZG dd� de�ZdS )z7 Module for creating Sankey diagrams using Matplotlib. � N)�SimpleNamespace)�Path)� PathPatch)�Affine2D)� docstring)�rcParamszKevin L. Daviesz Yannick CopinZBSDz 2011/09/16� � c @ sZ e Zd ZdZd d d�Zd dd�Zdd� Zdd� Zej fdd�Z e j d!dd ��Z d d � ZdS )"�Sankeyab Sankey diagram. Sankey diagrams are a specific type of flow diagram, in which the width of the arrows is shown proportionally to the flow quantity. They are typically used to visualize energy or material or cost transfers between processes. `Wikipedia (6/1/2011) <https://en.wikipedia.org/wiki/Sankey_diagram>`_ N� �?� �%G� �?皙�����?� ��Q��?�333333�?�d 皙�����?���ư>c K s |dk rt d��||kr t d��| dk r0t d��| dk r@t d��|dkrpddlm} | �� }|jdddg g d�}g | _|| _|| _|| _|| _ || _ || _ || _ || _ | | _t�tjd| d d �| _| | _t�tjtj tjtj f�| _t| ��r| jf | � dS ) aH Create a new Sankey instance. Optional keyword arguments: =============== =================================================== Field Description =============== =================================================== *ax* axes onto which the data should be plotted If *ax* isn't provided, new axes will be created. *scale* scaling factor for the flows *scale* sizes the width of the paths in order to maintain proper layout. The same scale is applied to all subdiagrams. The value should be chosen such that the product of the scale and the sum of the inputs is approximately 1.0 (and the product of the scale and the sum of the outputs is approximately -1.0). *unit* string representing the physical unit associated with the flow quantities If *unit* is None, then none of the quantities are labeled. *format* a Python number formatting string to be used in labeling the flow as a quantity (i.e., a number times a unit, where the unit is given) *gap* space between paths that break in/break away to/from the top or bottom *radius* inner radius of the vertical paths *shoulder* size of the shoulders of output arrowS *offset* text offset (from the dip or tip of the arrow) *head_angle* angle of the arrow heads (and negative of the angle of the tails) [deg] *margin* minimum space between Sankey outlines and the edge of the plot area *tolerance* acceptable maximum of the magnitude of the sum of flows The magnitude of the sum of connected flows cannot be greater than *tolerance*. =============== =================================================== The optional arguments listed above are applied to all subdiagrams so that there is consistent alignment and formatting. If :class:`Sankey` is instantiated with any keyword arguments other than those explicitly listed above (``**kwargs``), they will be passed to :meth:`add`, which will create the first subdiagram. In order to draw a complex Sankey diagram, create an instance of :class:`Sankey` by calling it without any kwargs:: sankey = Sankey() Then add simple Sankey sub-diagrams:: sankey.add() # 1 sankey.add() # 2 #... sankey.add() # n Finally, create the full diagram:: sankey.finish() Or, instead, simply daisy-chain those calls:: Sankey().add().add... .add().finish() See Also -------- Sankey.add Sankey.finish Examples -------- .. plot:: gallery/specialty_plots/sankey_basics.py r zS'gap' is negative, which is not allowed because it would cause the paths to overlapz`'radius' is greater than 'gap', which is not allowed because it would cause the paths to overlapzp'head_angle' is negative, which is not allowed because it would cause inputs to look like outputs and vice versaz3'tolerance' is negative, but it must be a magnitudeNr )ZxticksZyticksg �f@� @)� ValueErrorZmatplotlib.pyplotZpyplotZfigureZ add_subplot�diagrams�ax�unit�format�scale�gap�radius�shoulder�offset�margin�npZtanZpi�pitch� tolerance�array�inf�extent�len�add)�selfr r r r r r r r Z head_angler r# �kwargsZpltZfig� r+ �3/usr/lib/python3/dist-packages/matplotlib/sankey.py�__init__* sF Q���� zSankey.__init__r Tr �r r c C s" t jt jt jt jt jt jt jg}t�ddgddgddgddgddgddgddgg�}|dksd|dkr�|rn|}q�|d d �d d d �f }nf|d ks�|d kr�|r�t�|d d �d f |d d �df f�}n(t�|d d �df |d d �d f f�}|d kr�| }tt||| t�||j d d f� ��S ) a= Return the codes and vertices for a rotated, scaled, and translated 90 degree arc. Optional keyword arguments: =============== ========================================== Keyword Description =============== ========================================== *quadrant* uses 0-based indexing (0, 1, 2, or 3) *cw* if True, clockwise *center* (x, y) tuple of the arc's center =============== ========================================== r g gw,���?g����S��?g�����?g>�ef���?r � N���r r ) r �LINETO�CURVE4r! r$ Z column_stack�list�zipZtile�shape)r) �quadrant�cwr �centerZ ARC_CODESZ ARC_VERTICES�verticesr+ r+ r, �_arc� sB � � �� �z Sankey._arcc C s |dkrddgddgfS |d d \}}|d | j }|tkr�||8 }|| ||d g}|�tj||gftj|ftj||| gftj|| j || gfg� |d | j |d g} �nJ|| j8 }|tkr�d} nd} ||d || || g}|tk�r d} nd} | j �r@|�| j | |tk| j || j || | j fd�� n|� tj||gf� |�tj||| | gftj|ftj|| || | gfg� |�| j | |tk|| j || j || | j fd�� |� tj|| || | gf� |d |d | | j g} || fS dS )zP Add an input to a path and return its tip and label locations. Nr r0 r r/ r �r6 r7 r r8 ) r" �RIGHT�extendr r1 r r �UP�DOWNr r: �append) r) �path�angle�flow�length�x�yZdipdepthZdip�label_location�signr6 r+ r+ r, � _add_input� sX � �� � �� zSankey._add_inputc C sv |dkrddgddgfS |d d \}}| j |d | j }|tkr�||7 }|| ||d g}|�tj||gftj||| j gftj|ftj||| j | gftj||| gftj|| j || gfg� |d | j |d g} �n�|| j7 }|tk�r d} nd} ||d || || g}|tk�r0d} nd} | j �rp|�| j | |tk| j || j || | j fd�� n|� tj||gf� |�tj||| | gftj|| j || | gftj|ftj|| j | || | gftj|| || | gfg� |�| j | |t k| j | || j || | j fd�� |� tj|| || | gf� |d |d | | j g} || fS dS ) z� Append an output to a path and return its tip and label locations. .. note:: *flow* is negative for an output. Nr r0 r r/ r r r; ) r r" r< r= r r1 r r r> r r: r@ r? ) r) rA rB rC rD rE rF Z tipheight�tiprG rH r6 r+ r+ r, � _add_output sh � �� � �� �� zSankey._add_outputc C s6 g }|}|ddd� D ]\}}|� ||f� |}q|S )z� A path is not simply reversible by path[::-1] since the code specifies an action to take from the **previous** point. Nr0 )r@ )r) rA Z first_actionZ reverse_pathZ next_code�codeZpositionr+ r+ r, �_revertL s zSankey._revertc 6 sT |dkrt �ddg�}n t �|�}|jd } �dkr:d�n�d �|dkrNd}zt �|| �}W n8 tk r� tdt �|�� dt �|�� d��d�Y nX zt �|| �}W n8 tk r� tdt �|�� d t �|�� d��d�Y nX |dk r�td ��t �t �|��| jk�r t� d t �|�|� | j | } td d � | D ��} tdd � | D ��}|dk �r�|dk �rhtd��t |�dk �r~td��|t | j �k�r�td|� dt | j �� d���|d t | j | j�k�r�td�|d t | j | j����|d | k�r td|d � d| � d���| j | j|d dk�r@td|d � d|� d���| j | j|d ||d }t|�| jk�r�td |� d | j� d ���dg| }t|�D ]J\}}|| jk�r�d ||< n*|| j k�r�d ||< nt� d!||| j� �q�dg| }tt||��D ]�\}\}}|dk�r4|�r$t||< n|�s�t||< n\|dk�rR|dk �r�t||< n>|d"k�rrtd#|� d$|� d%���|�r�t||< n|�s�t||< �q�t �|��r�t |�| k�r�td&| � d't |�� d(����n�|}|}|}|}t|d)���fd*d+�|D �}tt||| ��D ]R\}\}}}|tk�r8|�r8|||< ||7 }n |tk�r|�s|||< ||8 }�qtttt||| ����D ]b\}\}}}|tk�r�|�r�||| | d < ||7 }n(|tk�rt|�st||| | d < ||8 }�qtd }tttt||t| |�����D ]<\}\}}} |tk�r�|�r�|�r0d|| | d < nd }�q�d } tt||tt| |����D ]4\}\}}} |tk�rV|�sV| �r�d||< nd } �qVtj| j |d, | d, gftj | j |d, d, | d, gftj | j |d, d- | d, gftj |d, | j d- | d, gftj |d, | j d, | d, gftj |d, | j | d, gfg} tj |d, | j |d, gftj |d, | j d, |d, gftj |d, | j d- |d, gftj | j |d, d- | d, gftj | j |d, d, | d, gftj | j |d, | d, gfg} tj |d, | j |d, gfg} tj | j |d, | d, gfg}!t � | d.f�}"t � | d.f�}#tt||tt| |����D ]�\}\}}} |tk�r�|�r�| j |!|f| �� \|"|dd�f< |#|dd�f< n>|tk�rj|�sj| j!| |f| �� \|"|dd�f< |#|dd�f< �qjtttt||tt| |������D ]�\}\}}} |tk�r�|�r�| j | |f| �� \}$}%|$|"| | d dd�f< |%|#| | d dd�f< nV|tk�r |�s | j!| |f| �� \}$}%|$|"| | d dd�f< |%|#| | d dd�f< �q d }tttt||tt| |������D ]�\}\}}} |tk� r|� r|� sx| d" d d |!d" d d k� rt| �"tj |!d" d d | d" d d gf� d }| j | |f| �� \}$}%|$|"| | d dd�f< |%|#| | d dd�f< � qd } tt||tt| |����D ]�\}\}}} |tk� r�|� s�| � sV| d" d d | d" d d k � rR| �"tj | d" d d | d" d d gf� d } | j!| |f| �� \|"|dd�f< |#|dd�f< � q�|� s�|!�#� | �#� | � s�| �#� | �#� | | �$| � | | �$|!� tj%| d d fg }&t|&� \}'}(t �|(�}(d/d0� � |dk� rl�dk� rT� �fd1d+�|D �}t&� �'�d2 �j(})|)|"�}"|)|#�}#|)|(�}(| j)j*dd|d3d3d4�}*n�| j | j|d ||d �� �fd5d+�|D �}t&� �'�d2 �j(})|)|"�}"| j | j+|d |"|d }+t&� j,|+� j(},|,|"�}"|,|)|#��}#|,|)|(��}(t|d3d3d4�}-| j)j*|+|-�}*t-d6 � rX| �#d7| �#d8d9��}.| �#d:| �#d;d<��}/n(| �#d7| �#d8d��}.| �#d:| �#d;d��}/|.dk� r�t.| j)j/j0�d= }.t1t|(|'�f|.|/d>�| ��}0| j)�2|0� g }1t||||#�D ]�\}2}}3}4|3dk� s�|dk� r�d?}3n:| j3dk � r6| jt|2� | j3 }5|3d?k� r.|3d@7 }3|3|57 }3|1�"| j)j*|4d |4d |3d3d3dA�� � q�t t � |(dd�df �t � |#dd�df �| j4d �t5t �5|(dd�df �t �5|#dd�df �| j4d �t t � |(dd�df �t � |#dd�df �| j4d. �t5t �5|(dd�df �t �5|#dd�df �| j4dB �f| _4| j �"t6|0|||"|*|1dC�� | S )Da� Add a simple Sankey diagram with flows at the same hierarchical level. Parameters ---------- patchlabel : str Label to be placed at the center of the diagram. Note that *label* (not *patchlabel*) can be passed as keyword argument to create an entry in the legend. flows : list of float Array of flow values. By convention, inputs are positive and outputs are negative. Flows are placed along the top of the diagram from the inside out in order of their index within *flows*. They are placed along the sides of the diagram from the top down and along the bottom from the outside in. If the sum of the inputs and outputs is nonzero, the discrepancy will appear as a cubic Bezier curve along the top and bottom edges of the trunk. orientations : list of {-1, 0, 1} List of orientations of the flows (or a single orientation to be used for all flows). Valid values are 0 (inputs from the left, outputs to the right), 1 (from and to the top) or -1 (from and to the bottom). labels : list of (str or None) List of labels for the flows (or a single label to be used for all flows). Each label may be *None* (no label), or a labeling string. If an entry is a (possibly empty) string, then the quantity for the corresponding flow will be shown below the string. However, if the *unit* of the main diagram is None, then quantities are never shown, regardless of the value of this argument. trunklength : float Length between the bases of the input and output groups (in data-space units). pathlengths : list of float List of lengths of the vertical arrows before break-in or after break-away. If a single value is given, then it will be applied to the first (inside) paths on the top and bottom, and the length of all other arrows will be justified accordingly. The *pathlengths* are not applied to the horizontal inputs and outputs. prior : int Index of the prior diagram to which this diagram should be connected. connect : (int, int) A (prior, this) tuple indexing the flow of the prior diagram and the flow of this diagram which should be connected. If this is the first diagram or *prior* is *None*, *connect* will be ignored. rotation : float Angle of rotation of the diagram in degrees. The interpretation of the *orientations* argument will be rotated accordingly (e.g., if *rotation* == 90, an *orientations* entry of 1 means to/from the left). *rotation* is ignored if this diagram is connected to an existing one (using *prior* and *connect*). Returns ------- Sankey The current `.Sankey` instance. Other Parameters ---------------- **kwargs Additional keyword arguments set `matplotlib.patches.PathPatch` properties, listed below. For example, one may want to use ``fill=False`` or ``label="A legend entry"``. %(Patch)s See Also -------- Sankey.finish Nr g �r g �V@zThe shapes of 'flows' z and 'orientations' z are incompatiblez and 'labels' zR'trunklength' is negative, which is not allowed because it would cause poor layoutzWThe sum of the flows is nonzero (%f; patchlabel=%r); is the system not at steady state?c s s | ]}t |d �V qdS �r N)�max��.0rC r+ r+ r, � <genexpr>� s z Sankey.add.<locals>.<genexpr>c s s | ]}t |d �V qdS rN )�minrP r+ r+ r, rR � s z*The index of the prior diagram is negativez2At least one of the connection indices is negativez"The index of the prior diagram is z, but there are only z other diagramszTThe connection index to the source diagram is {}, but that diagram has only {} flowsr z(The connection index to this diagram is z , but this diagram has only z flowszHThe connection cannot be made, which may occur if the magnitude of flow z of diagram z% is less than the specified tolerancez)The scaled sum of the connected flows is z%, which is not within the tolerance (�)TFzwThe magnitude of flow %d (%f) is below the tolerance (%f). It will not be shown, and it cannot be used in a connection.r0 zThe value of orientations[z] is z , but it must be -1, 0, or 1zThe lengths of 'flows' (z) and 'pathlengths' (z) are incompatible)r< c s g | ]}� � |d ��qS )r )�get�rQ rB )�dr+ r, � <listcomp>( s z Sankey.add.<locals>.<listcomp>r g @r/ c S s | d kr d S | | S d S )Nr+ )�a�rr+ r+ r, � _get_angle� s z Sankey.add.<locals>._get_anglec s g | ]}� |���qS r+ r+ rV �r[ �rotationr+ r, rX � s �Z r8 )�s�ha�vac s g | ]}� |���qS r+ r+ rV r\ r+ r, rX � s z_internal.classic_mode�fcZ facecolorz#bfd1d4�lwZ linewidthg �?Zcolor)rb rc r � )rE rF r_ r` ra r )�patch�flows�angles�tips�text�texts)7r! r$ r5 Z broadcast_tor �abs�sumr# �_log�infor rS r' r rf r rg � enumerater4 r? r> r< �iterable�dict�reversedr3 r ZMOVETOr r1 r2 ZzerosrI rK r@ �poprM Z CLOSEPOLYr Z rotate_degZtransform_affiner ri rh � translater �nextZ_get_patches_for_fillZ prop_cyclerr Z add_patchr r& rO r )6r) Z patchlabelrf Z orientations�labelsZ trunklengthZ pathlengthsZpriorZconnectr] r* �nZ scaled_flowsZgainZlossZ flow_errorZ are_inputs�irC rg ZorientZis_inputZurlengthZullengthZlrlengthZlllengthrB Zhas_left_input�specZhas_right_outputZurpathZllpathZlrpathZulpathrh Zlabel_locationsrJ rG rA Zcodesr9 �rotateri r rt �kwdsrb rc re rj ZnumberZlabel�locationZquantityr+ )r[ rW r] r, r( ^ s� W �� ��� � �� ���� �� � � � � � � � ������� ������� �� � ��$ ��& � �"� �"� ��&� � � � ����� ��z Sankey.addc C sZ | j �| jd | j | jd | j | jd | j | jd | j g� | j jddd� | jS )a� Adjust the axes and return a list of information about the Sankey subdiagram(s). Return value is a list of subdiagrams represented with the following fields: =============== =================================================== Field Description =============== =================================================== *patch* Sankey outline (an instance of :class:`~matplotlib.patches.PathPatch`) *flows* values of the flows (positive for input, negative for output) *angles* list of angles of the arrows [deg/90] For example, if the diagram has not been rotated, an input to the top side will have an angle of 3 (DOWN), and an output from the top side will have an angle of 1 (UP). If a flow has been skipped (because its magnitude is less than *tolerance*), then its angle will be *None*. *tips* array in which each row is an [x, y] pair indicating the positions of the tips (or "dips") of the flow paths If the magnitude of a flow is less the *tolerance* for the instance of :class:`Sankey`, the flow is skipped and its tip will be at the center of the diagram. *text* :class:`~matplotlib.text.Text` instance for the label of the diagram *texts* list of :class:`~matplotlib.text.Text` instances for the labels of flows =============== =================================================== See Also -------- Sankey.add r r r/ r ZequalZdatalim)Z adjustable)r Zaxisr& r Z set_aspectr )r) r+ r+ r, �finish s '�z Sankey.finish) Nr r r r r r r r r r )r Tr r. ) r NNr r r Nr. r )�__name__� __module__� __qualname__�__doc__r- r: rI rK r r1 rM r Zdedent_interpdr( r} r+ r+ r+ r, r s2 � } 74: � +r )r� Zlogging�typesr Znumpyr! Zmatplotlib.pathr Zmatplotlib.patchesr Zmatplotlib.transformsr Z matplotlibr r Z getLoggerr~ rm � __author__� __credits__Z __license__� __version__r< r> r? �objectr r+ r+ r+ r, �<module> s"