8000 Improvements to Sankey class by kdavies4 · Pull Request #1574 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Improvements to Sankey class #1574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 7, 2012
Merged

Improvements to Sankey class #1574

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
80f3030
Added missing Sankey.__init__ method
kdavies4 Dec 7, 2012
f813278
In Sankey, prevented appended lists of labels
kdavies4 Dec 7, 2012
11737f3
Fixed typos in Sankey
kdavies4 Dec 7, 2012
a1c43f0
Improved margins in Sankey demo
kdavies4 Dec 7, 2012
5534044
Revert "Added missing Sankey.__init__ method" (it was simply moved)
kdavies4 Dec 7, 2012
de1f1f4
Removed unneccessary enumerate()
kdavies4 Dec 7, 2012
92575e2
Explicitly imported Python 3.0 printfunction
kdavies4 Dec 7, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revert "Added missing Sankey.__init__ method" (it was simply moved) 
This reverts commit 80f3030.
  • Loading branch information
@kdavies4
kdavies4 committed Dec 7, 2012
commit 5534044e21da5febc55b17e88ee82f1d614a684a
120 changes: 0 additions & 120 deletions lib/matplotlib/sankey.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -841,124 +841,4 @@ def finish(self):
self.ax.set_aspect('equal', adjustable='datalim')
return self.diagrams

def __init__(self, ax=None, scale=1.0, unit='', format='%G ', gap=0.25,
radius=0.1, shoulder=0.03, offset=0.15, head_angle=100,
margin=0.4, tolerance=1e-6, **kwargs):
"""
Create a new Sankey instance.

Optional keyword arguments:

=============== ===================================================
Field Description
=============== ===================================================
*ax* axes onto which the data should be plotted
If *ax* is not 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()

.. seealso::

:meth:`add`
:meth:`finish`


**Examples:**

.. plot:: mpl_examples/api/sankey_demo_basics.py
"""
# Check the arguments.
assert gap >= 0, (
"The gap is negative.\nThis isn't allowed because it "
"would cause the paths to overlap.")
assert radius <= gap, (
"The inner radius is greater than the path spacing.\n"
"This isn't allowed because it would cause the paths to overlap.")
assert head_angle >= 0, (
"The angle is negative.\nThis isn't allowed "
"because it would cause inputs to look like "
"outputs and vice versa.")
assert tolerance >= 0, (
"The tolerance is negative.\nIt must be a magnitude.")

# Create axes if necessary.
if ax is None:
import matplotlib.pyplot as plt
fig = plt.figure()
ax = fig.add_subplot(1, 1, 1, xticks=[], yticks=[])

self.diagrams = []

# Store the inputs.
self.ax = ax
self.unit = unit
self.format = format
self.scale = scale
self.gap = gap
self.radius = radius
self.shoulder = shoulder
self.offset = offset
self.margin = margin
self.pitch = np.tan(np.pi * (1 - head_angle / 180.0) / 2.0)
self.tolerance = tolerance

# Initialize the vertices of tight box around the diagram(s).
self.extent = np.array((np.inf, -np.inf, np.inf, -np.inf))

# If there are any kwargs, create the first subdiagram.
if len(kwargs):
self.add(**kwargs)
0