Visualization¶
MusPy supports two visualization tools. Both use Matplotlib as the backend for flexibility.
Piano-roll Visualization¶
The piano-roll visualization is made possible with the Pypianoroll library.
-
muspy.show_pianoroll(music: Music, **kwargs)[source] Show pianoroll visualization.
Score Visualization¶
The score visualization is made possible with the Bravura font.
-
muspy.show_score(music: Music, figsize: Optional[Tuple[float, float]] = None, clef: str = 'treble', clef_octave: Optional[int] = 0, note_spacing: Optional[int] = None, font_path: Union[str, pathlib.Path, None] = None, font_scale: Optional[float] = None) → muspy.visualization.score.ScorePlotter[source] Show score visualization.
Parameters: - music (
muspy.Music) – Music object to show. - figsize ((float, float), optional) – Width and height in inches. Defaults to Matplotlib configuration.
- clef (str, {'treble', 'alto', 'bass'}) – Clef type. Defaults to a treble clef.
- clef_octave (int) – Clef octave. Defaults to zero.
- note_spacing (int, optional) – Spacing of notes. Defaults to 4.
- font_path (str or Path, optional) – Path to the music font. Defaults to the path to the built-in Bravura font.
- font_scale (float, optional) – Font scaling factor for finetuning. Defaults to 140, optimized for the Bravura font.
Returns: A ScorePlotter object that handles the score.
Return type: - music (
-
muspy.ScorePlotter(fig: matplotlib.figure.Figure, ax: matplotlib.axes._axes.Axes, resolution: int, note_spacing: Optional[int] = None, font_path: Union[str, pathlib.Path, None] = None, font_scale: Optional[float] = None)[source] A plotter that handles the score visualization.
-
muspy.fig¶ Figure object to plot the score on.
Type: matplotlib.figure.Figure
-
muspy.axes¶ Axes object to plot the score on.
Type: matplotlib.axes.Axes
-