instrumenttools.Piano

class abjad.tools.instrumenttools.Piano.Piano.Piano(target_context=None, **kwargs)

New in version 2.0.

Abjad model of the piano:

abjad> piano_staff = scoretools.PianoStaff([Staff("c'8 d'8 e'8 f'8"), Staff("c'4 b4")])

abjad> instrumenttools.Piano()(piano_staff)
Piano()(PianoStaff<<2>>)

abjad> f(piano_staff)
\new PianoStaff <<
    \set PianoStaff.instrumentName = \markup { Piano }
    \set PianoStaff.shortInstrumentName = \markup { Pf. }
    \new Staff {
        c'8
        d'8
        e'8
        f'8
    }
    \new Staff {
        c'4
        b4
    }
>>

The piano targets piano staff context by default.

Read-only Properties

Piano.default_instrument_name

Read-only default instrument name.

Return string.

Note

Inherited from contexttools.InstrumentMark

Piano.default_short_instrument_name

Read-only default short instrument name.

Return string.

Note

Inherited from contexttools.InstrumentMark

Piano.effective_context

Read-only reference to effective context of context mark:

abjad> note = Note("c'4")
abjad> context_mark = contexttools.ContextMark()(note)

abjad> context_mark.effective_context is None
True

Return context mark or none.

Note

Inherited from contexttools.ContextMark

Piano.format

Read-only LilyPond input format of instrument mark:

abjad> instrument = contexttools.InstrumentMark('Flute', 'Fl.')
abjad> instrument.format
['\set Staff.instrumentName = \markup { Flute }', '\set Staff.shortInstrumentName = \markup { Fl. }']

Return list.

Note

Inherited from contexttools.InstrumentMark

Piano.interval_of_transposition

Read-only interval of transposition.

Return melodic diatonic interval.

Note

Inherited from instrumenttools._Instrument

Piano.is_primary_instrument

Note

Inherited from instrumenttools._Instrument

Piano.is_secondary_instrument

Note

Inherited from instrumenttools._Instrument

Piano.is_transposing

True when instrument is transposing. False otherwise.

Return boolean.

Note

Inherited from instrumenttools._Instrument

Piano.start_component

Read-only reference to mark start component:

abjad> note = Note("c'4")
abjad> mark = marktools.Mark()(note)

abjad> mark.start_component
Note("c'4")

Return component or none.

Note

Inherited from marktools.Mark

Piano.target_context

Read-only reference to target context of context mark:

abjad> note = Note("c'4")
abjad> context_mark = contexttools.ContextMark()(note)

abjad> context_mark.target_context is None
True

Return context mark or none.

Note

Inherited from contexttools.ContextMark

Piano.traditional_pitch_range

Read-only traditional pitch range.

Return pitch range.

Note

Inherited from instrumenttools._Instrument

Read/write Properties

Piano.all_clefs

Note

Inherited from instrumenttools._Instrument

Piano.instrument_name

Get instrument name:

abjad> instrument = contexttools.InstrumentMark('Flute', 'Fl.')
abjad> instrument.instrument_name
'Flute'

Set instrument name:

abjad> instrument.instrument_name = 'Alto Flute'
abjad> instrument.instrument_name
'Alto Flute'

Return string.

Note

Inherited from contexttools.InstrumentMark

Piano.instrument_name_markup

Get instrument name:

abjad> instrument = contexttools.InstrumentMark('Flute', 'Fl.')
abjad> instrument.instrument_name_markup
Markup('Flute')

Set instrument name:

abjad> instrument.instrument_name_markup = 'Alto Flute'
abjad> instrument.instrument_name_markup
Markup('Alto Flute')

Return markup.

Note

Inherited from contexttools.InstrumentMark

Piano.pitch_range

Note

Inherited from instrumenttools._Instrument

Piano.primary_clefs

Note

Inherited from instrumenttools._Instrument

Piano.short_instrument_name

Get short instrument name:

abjad> instrument = contexttools.InstrumentMark('Flute', 'Fl.')
abjad> instrument.short_instrument_name
'Fl.'

Set short instrument name:

abjad> instrument.short_instrument_name = 'Alto Fl.'
abjad> instrument.short_instrument_name
'Alto Fl.'

Return string.

Note

Inherited from contexttools.InstrumentMark

Piano.short_instrument_name_markup

Get short instrument name:

abjad> instrument = contexttools.InstrumentMark('Flute', 'Fl.')
abjad> instrument.short_instrument_name_markup
Markup('Fl.')

Set short instrument name:

abjad> instrument.short_instrument_name_markup = 'Alto Fl.'
abjad> instrument.short_instrument_name_markup
Markup('Alto Fl.')

Return markup.

Note

Inherited from contexttools.InstrumentMark

Piano.sounding_pitch_of_fingered_middle_c

Note

Inherited from instrumenttools._Instrument

Methods

Piano.attach(start_component)

Make sure no context mark of same type is already attached to start component.

Note

Inherited from contexttools.ContextMark

Piano.detach()

Detach mark:

abjad> note = Note("c'4")
abjad> context_mark = contexttools.ContextMark()(note)

abjad> context_mark.start_component
Note("c'4")

abjad> context_mark.detach()
ContextMark()

abjad> context_mark.start_component is None
True

Return context mark.

Note

Inherited from contexttools.ContextMark

Piano.get_default_performer_name(locale=None)

New in version 2.5.

Get default player name.

Available values for locale are 'en-us' and 'en-uk'.

Note

Inherited from instrumenttools._Instrument

Piano.get_performer_names()

New in version 2.5.

Get performer names.

Note

Inherited from instrumenttools._Instrument

Special Methods

Piano.__call__(*args)

Note

Inherited from marktools.Mark

Piano.__delattr__(*args)

Note

Inherited from marktools.Mark

Piano.__eq__(arg)

Note

Inherited from contexttools.InstrumentMark

Piano.__ge__(arg)

Abjad objects by default do not implement this method.

Raise exception.

Note

Inherited from abctools.AbjadObject

Piano.__gt__(arg)

Abjad objects by default do not implement this method.

Raise exception

Note

Inherited from abctools.AbjadObject

Piano.__hash__()

Note

Inherited from contexttools.InstrumentMark

Piano.__le__(arg)

Abjad objects by default do not implement this method.

Raise exception.

Note

Inherited from abctools.AbjadObject

Piano.__lt__(arg)

Abjad objects by default do not implement this method.

Raise exception.

Note

Inherited from abctools.AbjadObject

Piano.__ne__(arg)

Note

Inherited from marktools.Mark

Piano.__repr__()

Note

Inherited from marktools.Mark

Piano.__setattr__()

x.__setattr__(‘name’, value) <==> x.name = value

Note

Inherited from __builtin__.object

Piano.__str__() <==> str(x)

Note

Inherited from __builtin__.object