----------
ax : :class:`matplotlib.axes.Axes`
Axes to plot the piano roll on.
- pianoroll : ndarray, shape=(?, 128) or (?, 128, 3) or (?, 128, 4)
+ pianoroll : ndarray, shape=(?, 128), (?, 128, 3) or (?, 128, 4)
Piano roll to plot. For a 3D piano-roll array, the last axis can
be either RGB or RGBA.
is_drum : bool
diff --git a/docs/_sources/track.rst.txt b/docs/_sources/track.rst.txt
index c06ff8d..3ef3b30 100644
--- a/docs/_sources/track.rst.txt
+++ b/docs/_sources/track.rst.txt
@@ -2,7 +2,7 @@
Track Class
===========
-Pypianoroll provides the `pypianoroll.Track`, `pypianoroll.BinaryTrack` and `pypianoroll.StandardTrack` classes for handling single-track piano rolls.
+Pypianoroll provides three classes (`pypianoroll.Track`, `pypianoroll.BinaryTrack` and `pypianoroll.StandardTrack`) for handling single-track piano rolls.
.. autoclass:: pypianoroll.Track
:noindex:
diff --git a/docs/_sources/visualization.rst.txt b/docs/_sources/visualization.rst.txt
index e878855..55d747c 100644
--- a/docs/_sources/visualization.rst.txt
+++ b/docs/_sources/visualization.rst.txt
@@ -2,9 +2,7 @@
Visualization
=============
-Pypianoroll supports visualizing piano rolls.
-
-Here are some examples.
+Pypianoroll provides tools for visualizing piano rolls. Here are some examples.
.. image:: images/visualization_track.png
:alt: Track visualization
@@ -15,9 +13,6 @@ Here are some examples.
.. image:: images/visualization_multitrack_closeup.png
:alt: Multitrack visualization closeup
-.. note::
- We assume the piano roll is in symbolic timing. You may visualize traditional piano rolls in absolute timing by setting up x-axis properties in the plotting function.
-
Functions
=========
diff --git a/docs/doc.html b/docs/doc.html
index 9b6dd2d..de6a77b 100644
--- a/docs/doc.html
+++ b/docs/doc.html
@@ -1580,7 +1580,7 @@ FeaturesParameters
ax (matplotlib.axes.Axes) – Axes to plot the piano roll on.
pianoroll (ndarray, shape=(?, 128) or (?, 128, 3) or (?, 128, 4)) – Piano roll to plot. For a 3D piano-roll array, the last axis can
+
pianoroll (ndarray, shape=(?, 128), (?, 128, 3) or (?, 128, 4)) – Piano roll to plot. For a 3D piano-roll array, the last axis can
be either RGB or RGBA.
is_drum (bool) – Whether it is a percussion track. Defaults to False.
resolution (int) – Time steps per quarter note. Required if xtick is ‘beat’.
Track Class¶
-Pypianoroll provides the pypianoroll.Track, pypianoroll.BinaryTrack and pypianoroll.StandardTrack classes for handling single-track piano rolls.
+Pypianoroll provides three classes (pypianoroll.Track, pypianoroll.BinaryTrack and pypianoroll.StandardTrack) for handling single-track piano rolls.
-
class
pypianoroll.Track(name: Optional[str] = None, program: Optional[int] = None, is_drum: Optional[bool] = None, pianoroll: Optional[numpy.ndarray] = None)[source]
diff --git a/docs/visualization.html b/docs/visualization.html
index 61d9e3c..7ccd01e 100644
--- a/docs/visualization.html
+++ b/docs/visualization.html
@@ -162,15 +162,10 @@
Visualization¶
-Pypianoroll supports visualizing piano rolls.
-Here are some examples.
+Pypianoroll provides tools for visualizing piano rolls. Here are some examples.
-
-Note
-We assume the piano roll is in symbolic timing. You may visualize traditional piano rolls in absolute timing by setting up x-axis properties in the plotting function.
-
Functions¶
@@ -249,7 +244,7 @@ FunctionsParameters
ax (matplotlib.axes.Axes) – Axes to plot the piano roll on.
pianoroll (ndarray, shape=(?, 128) or (?, 128, 3) or (?, 128, 4)) – Piano roll to plot. For a 3D piano-roll array, the last axis can
+
pianoroll (ndarray, shape=(?, 128), (?, 128, 3) or (?, 128, 4)) – Piano roll to plot. For a 3D piano-roll array, the last axis can
be either RGB or RGBA.
is_drum (bool) – Whether it is a percussion track. Defaults to False.
resolution (int) – Time steps per quarter note. Required if xtick is ‘beat’.