Instrument

class instrumenttools.Instrument(instrument_name=None, short_instrument_name=None, instrument_name_markup=None, short_instrument_name_markup=None, allowable_clefs=None, pitch_range=None, sounding_pitch_of_written_middle_c=None)

A musical instrument.

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=black, fontcolor=white, group=2, label=<<B>Instrument</B>>, shape=box, style="filled, rounded"]; } 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"; }

Bases

Attribute summary

allowable_clefs Gets allowable clefs of instrument.
instrument_name Gets instrument name.
instrument_name_markup Gets instrument name markup.
pitch_range Gets pitch range of instrument.
short_instrument_name Gets short instrument name.
short_instrument_name_markup Gets short instrument name markup.
sounding_pitch_of_written_middle_c Gets sounding pitch of written middle C.
transpose_from_sounding_pitch_to_written_pitch(...) Transposes note_or_chord from sounding pitch of instrument to written pitch of instrument.
transpose_from_written_pitch_to_sounding_pitch(...) Transposes argument from written pitch of instrument to sounding pitch of instrument.
__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

Instrument.allowable_clefs

Gets allowable clefs of instrument.

Returns clef list.

Instrument.instrument_name

Gets instrument name.

Returns string.

Instrument.instrument_name_markup

Gets instrument name markup.

Returns markup.

Instrument.pitch_range

Gets pitch range of instrument.

Returns pitch range.

Instrument.short_instrument_name

Gets short instrument name.

Returns string.

Instrument.short_instrument_name_markup

Gets short instrument name markup.

Returns markup.

Instrument.sounding_pitch_of_written_middle_c

Gets sounding pitch of written middle C.

Returns named pitch.

Methods

Instrument.transpose_from_sounding_pitch_to_written_pitch(note_or_chord)

Transposes note_or_chord from sounding pitch of instrument to written pitch of instrument.

Returns note_or_chord with adjusted pitches.

Instrument.transpose_from_written_pitch_to_sounding_pitch(note_or_chord)

Transposes argument from written pitch of instrument to sounding pitch of instrument.

Returns note_or_chord with adjusted pitches.

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.