-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
FIX: eventplot 'colors' kwarg (#8193) #8204
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
Changes from all commits
e4fe239
c03df1f
c49a4c8
c0c6bc9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1243,15 +1243,15 @@ class EventCollection(LineCollection): | |
''' | ||
A collection of discrete events. | ||
|
||
An event is a 1-dimensional value, usually the position of something along | ||
an axis, such as time or length. Events do not have an amplitude. They | ||
are displayed as v | ||
The events are given by a 1-dimensional array, usually the position of | ||
something along an axis, such as time or length. They do not have an | ||
amplitude and are displayed as vertical or horizontal parallel bars. | ||
''' | ||
|
||
_edge_default = True | ||
|
||
def __init__(self, | ||
positions, # Can be None. | ||
positions, # Cannot be None. | ||
orientation=None, | ||
lineoffset=0, | ||
linelength=1, | ||
|
@@ -1262,62 +1262,60 @@ def __init__(self, | |
**kwargs | ||
): | ||
""" | ||
*positions* | ||
a sequence of numerical values or a 1D numpy array. Can be None | ||
|
||
*orientation* [ 'horizontal' | 'vertical' | None ] | ||
defaults to 'horizontal' if not specified or None | ||
Parameters | ||
---------- | ||
positions : 1D array-like object | ||
Each value is an event. | ||
|
||
*lineoffset* | ||
a single numerical value, corresponding to the offset of the center | ||
of the markers from the origin | ||
orientation : {None, 'horizontal', 'vertical'}, optional | ||
The orientation of the **collection** (the event bars are along | ||
the orthogonal direction). Defaults to 'horizontal' if not | ||
specified or None. | ||
|
||
*linelength* | ||
a single numerical value, corresponding to the total height of the | ||
marker (i.e. the marker stretches from lineoffset+linelength/2 to | ||
lineoffset-linelength/2). Defaults to 1 | ||
lineoffset : scalar, optional, default: 0 | ||
The offset of the center of the markers from the origin, in the | ||
direction orthogonal to *orientation*. | ||
|
||
*linewidth* | ||
a single numerical value | ||
linelength : scalar, optional, default: 1 | ||
The total height of the marker (i.e. the marker stretches from | ||
``lineoffset - linelength/2`` to ``lineoffset + linelength/2``). | ||
|
||
*color* | ||
must be a sequence of RGBA tuples (e.g., arbitrary color | ||
strings, etc, not allowed). | ||
linewidth : scalar or None, optional, default: None | ||
If it is None, defaults to its rcParams setting, in sequence form. | ||
|
||
*linestyle* [ 'solid' | 'dashed' | 'dashdot' | 'dotted' ] | ||
color : color, sequence of colors or None, optional, default: None | ||
If it is None, defaults to its rcParams setting, in sequence form. | ||
|
||
*antialiased* | ||
1 or 2 | ||
linestyle : str or tuple, optional, default: 'solid' | ||
Valid strings are ['solid', 'dashed', 'dashdot', 'dotted', | ||
'-', '--', '-.', ':']. Dash tuples should be of the form:: | ||
|
||
If *linewidth*, *color*, or *antialiased* is None, they | ||
default to their rcParams setting, in sequence form. | ||
(offset, onoffseq), | ||
|
||
*norm* | ||
None (optional for :class:`matplotlib.cm.ScalarMappable`) | ||
*cmap* | ||
None (optional for :class:`matplotlib.cm.ScalarMappable`) | ||
where *onoffseq* is an even length tuple of on and off ink | ||
in points. | ||
|
||
*pickradius* is the tolerance for mouse clicks picking a line. | ||
The default is 5 pt. | ||
antialiased : {None, 1, 2}, optional | ||
If it is None, defaults to its rcParams setting, in sequence form. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can antialiased really be a sequence? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. TBH I have no idea of what this parameter is doing except that it has to do with AA. So I tried to avoid changing the original sentence as much as possible. From a very quick look at other docstrings in |
||
|
||
The use of :class:`~matplotlib.cm.ScalarMappable` is optional. | ||
If the :class:`~matplotlib.cm.ScalarMappable` array | ||
:attr:`~matplotlib.cm.ScalarMappable._A` is not None (i.e., a call to | ||
:meth:`~matplotlib.cm.ScalarMappable.set_array` has been made), at | ||
draw time a call to scalar mappable will be made to set the colors. | ||
**kwargs : optional | ||
Other keyword arguments are line collection properties. See | ||
:class:`~matplotlib.collections.LineCollection` for a list of | ||
the valid properties. | ||
|
||
**Example:** | ||
Example | ||
------- | ||
|
||
.. plot:: mpl_examples/pylab_examples/eventcollection_demo.py | ||
""" | ||
|
||
segment = (lineoffset + linelength / 2., | ||
lineoffset - linelength / 2.) | ||
if len(positions) == 0: | ||
if positions is None or len(positions) == 0: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. would just write There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. (and then you know for sure it has an ndim attribute) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The docstring does not say that one should expect scalars to be supported, and the other collections classes does not seem to support it either. So I would say => There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Now using There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Reverted on a @tacaswell's comment. |
||
segments = [] | ||
elif hasattr(positions, 'ndim') and positions.ndim > 1: | ||
raise ValueError('if positions is an ndarry it cannot have ' | ||
'dimensionality great than 1 ') | ||
raise ValueError('positions cannot be an array with more than ' | ||
'one dimension.') | ||
elif (orientation is None or orientation.lower() == 'none' or | ||
orientation.lower() == 'horizontal'): | ||
positions.sort() | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we had a consensus to drop the "*".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See discussion starting here: #8172 (comment)
ref http://matplotlib.org/devdocs/devel/documenting_mpl.html#formatting
ref https://docs.python.org/devguide/documenting.html#id3
Let's keep the asterisks unless there is agreement to switch to double backquotes (which I would not favor). If we go with such a switch the documenting matplotlib guide should be updated first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently still using
*
. I will change it if a consensus emerges that it is not the proper markup to use (i.e. if the dev guidelines are updated :) ).