scamp.score.Staff

class scamp.score.Staff(measures: Sequence[Measure], name: str = None)

Bases: scamp.score.ScoreComponent, scamp.score.ScoreContainer

Representation of a single staff of a western-notated score

Parameters

• measures – Chronological list of Measure objects contained in this staff

• name – Name of this staff in the score

Methods

length()	Length of this Staff in beats.
to_music_xml()	Convert this score component to its corresponding pymusicxml component

Inherited Methods

append(item)	Add a child ScoreComponent of the appropriate type
export_lilypond(file_path)	Convert and wrap as a LilyPond (.ly) file, and save to the given path.
export_music_xml(file_path[, pretty_print])	Convert and wrap as a MusicXML score, and save to the given path.
extend(items)	Add several child ScoreComponents of the appropriate type
index(item)	Get the index of the given child ScoreComponent
insert(index, item)	Insert a child ScoreComponent at the given index.
pop([i])	Pop and return the child ScoreComponent at the given index.
print_lilypond([wrap_as_file])	Convert and print LilyPond code.
print_music_xml([pretty_print])	Convert and wrap as a MusicXML score, and print the resulting XML.
remove(item)	Remove the given child ScoreComponent.
show()	Using the abjad.show command, generates and opens a PDF of the music represented by this component
show_xml()	Convert and wrap as a MusicXML score, and open it up in notation software.
to_abjad()	Convert this score component to its corresponding abjad component
to_abjad_lilypond_file()	Convert and wrap as a abjad.LilyPondFile object
to_lilypond([wrap_as_file])	Convert to LilyPond code.

Attributes

measures

Chronological list of Measure objects contained in this staff

property measures

Chronological list of Measure objects contained in this staff

length() → float

Length of this Staff in beats. (i.e. end beat of its last measure)

to_music_xml() → pymusicxml.music_xml_objects.Part

Convert this score component to its corresponding pymusicxml component

append(item: scamp.score.ScoreComponent) → None

Add a child ScoreComponent of the appropriate type

export_lilypond(file_path) → None

Convert and wrap as a LilyPond (.ly) file, and save to the given path.

Parameters

file_path – file path to save to

export_music_xml(file_path: str, pretty_print: bool = True) → None

Convert and wrap as a MusicXML score, and save to the given path.

Parameters

• file_path – file path to save to

• pretty_print – whether or not to take the extra space and format the file with indentations, etc.

extend(items) → None

Add several child ScoreComponents of the appropriate type

index(item) → int

Get the index of the given child ScoreComponent

insert(index, item) → None

Insert a child ScoreComponent at the given index.

pop(i=- 1) → scamp.score.ScoreComponent

Pop and return the child ScoreComponent at the given index.

print_lilypond(wrap_as_file=False) → None

Convert and print LilyPond code.

Parameters

wrap_as_file – if True, wraps this object up as a full LilyPond file, ready for compilation. If False, we just get the code for the component itself.

print_music_xml(pretty_print: bool = True) → None

Convert and wrap as a MusicXML score, and print the resulting XML.

Parameters

pretty_print – whether or not to take the extra space and format the file with indentations, etc.

remove(item) → None

Remove the given child ScoreComponent.

show() → None

Using the abjad.show command, generates and opens a PDF of the music represented by this component

show_xml() → None

Convert and wrap as a MusicXML score, and open it up in notation software. (The software to use is defined in engraving_settings.show_music_xml_command_line.)

to_abjad() → abjad.core.Component.Component

Convert this score component to its corresponding abjad component

to_abjad_lilypond_file() → abjad.lilypondfile.LilyPondFile.LilyPondFile

Convert and wrap as a abjad.LilyPondFile object

to_lilypond(wrap_as_file=False) → str

Convert to LilyPond code.

Parameters

wrap_as_file – if True, wraps this object up as a full LilyPond file, ready for compilation. If False, we just get the code for the component itself.

Returns

a string containing the LilyPond code