Skip to content

Adding Scalar as a Baseline Option #27308

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.

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 28 additions & 3 deletions lib/matplotlib/stackplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
stackplot(x, y) # where y has shape (M, N)
stackplot(x, y1, y2, y3) # where y1, y2, y3, y4 have length N

baseline : {'zero', 'sym', 'wiggle', 'weighted_wiggle'}
baseline : {'zero', 'sym', 'wiggle', 'weighted_wiggle', float,
datetime, timedelta}
Method used to calculate the baseline:

- ``'zero'``: Constant zero baseline, i.e. a simple stacked plot.
Expand All @@ -42,6 +43,12 @@
- ``'weighted_wiggle'``: Does the same but weights to account for
size of each layer. It is also called 'Streamgraph'-layout. More
details can be found at http://leebyron.com/streamgraph/.
- ``float``: Scalar baseline. Useful for cases where 0 is not sensible.
Any type that can be casted to float is accepted
(int, float, bool and custom data objects)
- ``datetime64``: Calculates de difference between the date and
'1970-01-01' in seconds.
- ``timedelta64``: Converts the timedelta to seconds

labels : list of str, optional
A sequence of labels to assign to each data series. If unspecified,
Expand Down Expand Up @@ -94,8 +101,9 @@
# We'll need a float buffer for the upcoming calculations.
stack = np.cumsum(y, axis=0, dtype=np.promote_types(y.dtype, np.float32))

_api.check_in_list(['zero', 'sym', 'wiggle', 'weighted_wiggle'],
baseline=baseline)
if isinstance(baseline, str):
_api.check_in_list(['zero', 'sym', 'wiggle', 'weighted_wiggle'],
baseline=baseline)
if baseline == 'zero':
first_line = 0.

Expand Down Expand Up @@ -125,6 +133,23 @@
first_line = center - 0.5 * total
stack += first_line

elif isinstance(baseline, np.datetime64):
first_date = np.datetime64('1970-01-01')
baseline = baseline - first_date
first_line = baseline / np.timedelta64(1, 's')
stack += first_line

Check warning on line 140 in lib/matplotlib/stackplot.py

View check run for this annotation

Codecov / codecov/patch

lib/matplotlib/stackplot.py#L137-L140

Added lines #L137 - L140 were not covered by tests

elif isinstance(baseline, np.timedelta64):
first_line = baseline / np.timedelta64(1, 's')
stack += first_line

Check warning on line 144 in lib/matplotlib/stackplot.py

View check run for this annotation

Codecov / codecov/patch

lib/matplotlib/stackplot.py#L143-L144

Added lines #L143 - L144 were not covered by tests

else:
"""
Here we are 100% certain that baseline is not a
string and not date-time/timedelta
"""
first_line = float(baseline)

# Color between x = 0 and the first array.
coll = axes.fill_between(x, first_line, stack[0, :],
facecolor=next(colors),
Expand Down
5 changes: 5 additions & 0 deletions lib/matplotlib/tests/test_axes.py
Original file line number Diff line number Diff line change
Expand Up @@ -3078,6 +3078,11 @@ def layers(n, m):

fig, axs = plt.subplots(2, 2)

# Attempt to use an integer value for 'baseline'
axs[0, 0].stackplot(range(100), d.T, baseline=5)

# Attempt to use a float value for 'baseline'
axs[0, 1].stackplot(range(100), d.T, baseline=2.5)
axs[0, 0].stackplot(range(100), d.T, baseline='zero')
axs[0, 1].stackplot(range(100), d.T, baseline='sym')
axs[1, 0].stackplot(range(100), d.T, baseline='wiggle')
Expand Down