Marimba

class instrumenttools.Marimba(instrument_name='marimba', short_instrument_name='mb.', instrument_name_markup=None, short_instrument_name_markup=None, allowable_clefs=('treble', 'bass'), pitch_range='[F2, C7]', sounding_pitch_of_written_middle_c=None)

A marimba.

>>> staff = Staff("c'4 d'4 e'4 fs'4")
>>> marimba = instrumenttools.Marimba()
>>> attach(marimba, staff)
>>> 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.Marimba.Marimba" [color=black, fontcolor=white, group=2, label=<<B>Marimba</B>>, shape=box, style="filled, rounded"]; "abjad.tools.instrumenttools.Instrument.Instrument" -> "abjad.tools.instrumenttools.Marimba.Marimba"; } 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 marimba’s allowable clefs.
instrument_name Gets marimba’s name.
instrument_name_markup Gets marimba’s instrument name markup.
pitch_range Gets marimba’s range.
short_instrument_name Gets marimba’s short instrument name.
short_instrument_name_markup Gets marimba’s short instrument name markup.
sounding_pitch_of_written_middle_c Gets sounding pitch of marimba’s 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 expr 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

Marimba.allowable_clefs

Gets marimba’s allowable clefs.

>>> marimba.allowable_clefs
ClefList([Clef(name='treble'), Clef(name='bass')])
>>> show(marimba.allowable_clefs) 

Returns clef inventory.

Marimba.instrument_name

Gets marimba’s name.

>>> marimba.instrument_name
'marimba'

Returns string.

Marimba.instrument_name_markup

Gets marimba’s instrument name markup.

>>> marimba.instrument_name_markup
Markup(contents=['Marimba'])
>>> show(marimba.instrument_name_markup) 

Returns markup.

Marimba.pitch_range

Gets marimba’s range.

>>> marimba.pitch_range
PitchRange(range_string='[F2, C7]')
>>> show(marimba.pitch_range) 

Returns pitch range.

Marimba.short_instrument_name

Gets marimba’s short instrument name.

>>> marimba.short_instrument_name
'mb.'

Returns string.

Marimba.short_instrument_name_markup

Gets marimba’s short instrument name markup.

>>> marimba.short_instrument_name_markup
Markup(contents=['Mb.'])
>>> show(marimba.short_instrument_name_markup) 

Returns markup.

Marimba.sounding_pitch_of_written_middle_c

Gets sounding pitch of marimba’s written middle C.

>>> marimba.sounding_pitch_of_written_middle_c
NamedPitch("c'")
>>> show(marimba.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 expr 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.