muspy.visualization

Visualization tools.

This module provides functions for visualizing a Music object.

Classes

• ScorePlotter

Functions

• show
• show_pianoroll
• show_score

muspy.visualization.show(music: Music, kind: str, **kwargs)

Show visualization.

Parameters:

• music (muspy.Music) – Music object to convert.
• kind (str, {'piano-roll', 'score'}) – Target representation.

muspy.visualization.show_pianoroll(music: Music, **kwargs)

Show pianoroll visualization.

muspy.visualization.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

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:

muspy.ScorePlotter

class muspy.visualization.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)

A plotter that handles the score visualization.

fig

Figure object to plot the score on.

Type:matplotlib.figure.Figure

axes

Axes object to plot the score on.

Type:matplotlib.axes.Axes

resolution

Time steps per quarter note.

Type:int

note_spacing

Spacing of notes. Defaults to 4.

Type:int, optional

font_path

Path to the music font. Defaults to the path to the downloaded Bravura font.

Type:str or Path, optional

font_scale

Font scaling factor for finetuning. Defaults to 140, optimized for the Bravura font.

Type:float, optional

adjust_fonts(scale: Optional[float] = None)

Adjust the fonts.

plot_bar_line() → matplotlib.lines.Line2D

Plot a bar line.

plot_clef(kind='treble', octave=0) → matplotlib.text.Text

Plot a clef.

plot_final_bar_line() → List[matplotlib.artist.Artist]

Plot an ending bar line.

plot_key_signature(root: int, mode: str)

Plot a key signature. Supports only major and minor keys.

plot_note(time, duration, pitch) → Optional[Tuple[List[matplotlib.text.Text], List[matplotlib.patches.Arc]]]

Plot a note.

plot_object(obj)

Plot an object.

plot_staffs(start: Optional[float] = None, end: Optional[float] = None) → List[matplotlib.lines.Line2D]

Plot the staffs.

plot_tempo(qpm) → List[matplotlib.artist.Artist]

Plot a tempo as a metronome mark.

plot_time_signature(numerator: int, denominator: int) → List[matplotlib.text.Text]

Plot a time signature.

set_baseline(y)

Set baseline position (y-coordinate of first staff line).

update_boundaries(left: Optional[float] = None, right: Optional[float] = None, bottom: Optional[float] = None, top: Optional[float] = None)

Update boundaries.