Percussion

class instrumenttools.Percussion(instrument_name='percussion', short_instrument_name='perc.', instrument_name_markup=None, short_instrument_name_markup=None, allowable_clefs=('percussion', ), pitch_range=None, sounding_pitch_of_written_middle_c=None)

Percussion instrument.

>>> import abjad
>>> staff = abjad.Staff("c'4 d'4 e'4 fs'4")
>>> percussion = abjad.instrumenttools.Percussion()
>>> abjad.attach(percussion, staff[0])
>>> show(staff) 

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_instrumenttools { graph [label=instrumenttools]; "abjad.tools.instrumenttools.Instrument.Instrument" [color=3, group=2, label=Instrument, shape=box]; "abjad.tools.instrumenttools.Percussion.Percussion" [color=black, fontcolor=white, group=2, label=<<B>Percussion</B>>, shape=box, style="filled, rounded"]; "abjad.tools.instrumenttools.Instrument.Instrument" -> "abjad.tools.instrumenttools.Percussion.Percussion"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.instrumenttools.Instrument.Instrument"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Attribute summary

allowable_clefs Gets percussion’s allowable clefs.
instrument_name Gets percussion’s name.
instrument_name_markup Gets percussion’s instrument name markup.
pitch_range Gets percussion’s range.
short_instrument_name Gets percussion’s short instrument name.
short_instrument_name_markup Gets percussion’s short instrument name markup.
sounding_pitch_of_written_middle_c Gets sounding pitch of percussion’s written middle C.
transpose_from_sounding_pitch(argument) Transpose notes and chords in argument from sounding pitch
transpose_from_written_pitch(argument) Transposes notes and chords in argument from sounding pitch to written pitch.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad value object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

Percussion.allowable_clefs

Gets percussion’s allowable clefs.

>>> percussion.allowable_clefs
ClefList([Clef(name='percussion')])
>>> show(percussion.allowable_clefs) 

Returns clef list.

Percussion.instrument_name

Gets percussion’s name.

>>> percussion.instrument_name
'percussion'

Returns string.

Percussion.instrument_name_markup

Gets percussion’s instrument name markup.

>>> percussion.instrument_name_markup
Markup(contents=['Percussion'])
>>> show(percussion.instrument_name_markup) 

Returns markup.

Percussion.pitch_range

Gets percussion’s range.

>>> percussion.pitch_range
PitchRange('[A0, C8]')
>>> show(percussion.pitch_range) 

Returns pitch range.

Percussion.short_instrument_name

Gets percussion’s short instrument name.

>>> percussion.short_instrument_name
'perc.'

Returns string.

Percussion.short_instrument_name_markup

Gets percussion’s short instrument name markup.

>>> percussion.short_instrument_name_markup
Markup(contents=['Perc.'])
>>> show(percussion.short_instrument_name_markup) 

Returns markup.

Percussion.sounding_pitch_of_written_middle_c

Gets sounding pitch of percussion’s written middle C.

>>> percussion.sounding_pitch_of_written_middle_c
NamedPitch("c'")
>>> show(percussion.sounding_pitch_of_written_middle_c) 

Returns named pitch.

Class & static methods

(Instrument).transpose_from_sounding_pitch(argument)

Transpose notes and chords in argument from sounding pitch to written pitch:

>>> staff = abjad.Staff("<c' e' g'>4 d'4 r4 e'4")
>>> clarinet = abjad.instrumenttools.ClarinetInBFlat()
>>> abjad.attach(clarinet, staff[0])
>>> show(staff) 
>>> abjad.Instrument.transpose_from_sounding_pitch(staff)
>>> show(staff) 

Returns none.

(Instrument).transpose_from_written_pitch(argument)

Transposes notes and chords in argument from sounding pitch to written pitch.

>>> staff = abjad.Staff("<c' e' g'>4 d'4 r4 e'4")
>>> clarinet = abjad.instrumenttools.ClarinetInBFlat()
>>> abjad.attach(clarinet, staff[0])
>>> show(staff) 
>>> abjad.Instrument.transpose_from_written_pitch(staff)
>>> show(staff) 

Returns none.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(argument)

Is true when Abjad object does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.