TrillSpanner

class spannertools.TrillSpanner(interval=None, is_harmonic=None, overrides=None, pitch=None)

Trill spanner.

Example 1. Attaches unpitched trill spanner to all notes in staff:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> trill = spannertools.TrillSpanner()
>>> attach(trill, staff[:])
>>> show(staff) 

Example 2. Attaches pitched trill spanner to all notes in staff:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> trill = spannertools.TrillSpanner(pitch=NamedPitch("cs'"))
>>> attach(trill, staff[:])
>>> show(staff) 

Example 3. Requires at least two leaves:

>>> staff = Staff("c'4 d' e' f'")
>>> trill = spannertools.TrillSpanner()
>>> attach(trill, staff[:1])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/joberholtzer/Development/abjad/abjad/tools/topleveltools/attach.py", line 29, in attach
    raise Exception(message)
Exception: TrillSpanner() attachment test fails for Selection([Note("c'4")]).
>>> 

Formats LilyPond \startTrillSpan on first leaf in spanner.

Formats LilyPond \stopTrillSpan on last leaf in spanner.

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.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_spannertools { graph [label=spannertools]; "abjad.tools.spannertools.Spanner.Spanner" [color=3, group=2, label=Spanner, shape=box]; "abjad.tools.spannertools.TrillSpanner.TrillSpanner" [color=black, fontcolor=white, group=2, label=<<B>TrillSpanner</B>>, shape=box, style="filled, rounded"]; "abjad.tools.spannertools.Spanner.Spanner" -> "abjad.tools.spannertools.TrillSpanner.TrillSpanner"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.spannertools.Spanner.Spanner"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

components Gets components in spanner.
interval Gets interval of trill.
is_harmonic Is true when trill pitch note head should print as a white diamond.
name Gets spanner name.
overrides Gets overrides.
pitch Gets optional pitch of trill spanner.
written_pitch Gets written pitch of trill spanner.
__contains__(expr) Is true when spanner contains expr.
__copy__(\*args) Copies spanner.
__eq__(expr) Is true when ID of expr equals ID of Abjad object.
__format__([format_specification]) Formats Abjad object.
__getitem__(expr) Gets item from spanner.
__hash__() Hashes Abjad object.
__len__() Gets number of components in spanner.
__lt__(expr) Is true when spanner is less than expr.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

(Spanner).components

Gets components in spanner.

Returns selection.

TrillSpanner.interval

Gets interval of trill.

Example 1. Attaches semitone trill:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> trill = spannertools.TrillSpanner(
...     interval=pitchtools.NamedInterval('m2'),
...     )
>>> attach(trill, staff[:])
>>> show(staff) 

Example 2. Attaches whole tone trill:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> trill = spannertools.TrillSpanner(
...     interval=pitchtools.NamedInterval('M2'),
...     )
>>> attach(trill, staff[:])
>>> show(staff) 

Defaults to none.

Set to interval or none.

Returns interval or none.

TrillSpanner.is_harmonic

Is true when trill pitch note head should print as a white diamond. Otherwise false.

Example 1. Attaches harmonic trill:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> trill = spannertools.TrillSpanner(
...     is_harmonic=True,
...     pitch=NamedPitch("d'"),
...     )
>>> attach(trill, staff[:])
>>> show(staff) 

Defaults to false.

Set to true or false.

Returns true or false.

(Spanner).name

Gets spanner name.

Returns string.

(Spanner).overrides

Gets overrides.

Returns dict.

TrillSpanner.pitch

Gets optional pitch of trill spanner.

Example 1. Returns pitch when trill spanner is pitched:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> pitch = NamedPitch('C#4')
>>> trill = spannertools.TrillSpanner(pitch=pitch)
>>> attach(trill, staff[:2])
>>> show(staff) 
>>> trill.pitch
NamedPitch("cs'")

Example 2. Returns none when trill spanner is unpitched:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> trill = spannertools.TrillSpanner()
>>> attach(trill, staff[:2])
>>> show(staff) 
>>> trill.pitch is None
True

Formats LilyPond \pitchedTrill command on first leaf in spanner.

Defaults to none.

Set to named pitch or none.

Returns named pitch or none.

TrillSpanner.written_pitch

Gets written pitch of trill spanner.

Example 1. Returns pitch when trill spanner is pitched:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> pitch = NamedPitch('C#4')
>>> trill = spannertools.TrillSpanner(pitch=pitch)
>>> attach(trill, staff[:2])
>>> show(staff) 
>>> trill.written_pitch
NamedPitch("cs'")

Example 2. Returns none when trill spanner is unpitched:

>>> staff = Staff("c'8 d'8 e'8 f'8")
>>> trill = spannertools.TrillSpanner()
>>> attach(trill, staff[:2])
>>> show(staff) 
>>> trill.written_pitch is None
True

Alias defined equal to pitch of trill spanner.

Defaults to none.

Property can not be set.

Returns named pitch or none.

Special methods

(Spanner).__contains__(expr)

Is true when spanner contains expr. Otherwise false.

Returns true or false.

(Spanner).__copy__(*args)

Copies spanner.

Does not copy spanner components.

Returns new spanner.

(AbjadObject).__eq__(expr)

Is true when ID of expr equals ID of Abjad object. Otherwise false.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

(Spanner).__getitem__(expr)

Gets item from spanner.

Returns component.

(AbjadObject).__hash__()

Hashes Abjad object.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

(Spanner).__len__()

Gets number of components in spanner.

Returns nonnegative integer.

(Spanner).__lt__(expr)

Is true when spanner is less than expr. Otherwise false.

Trivial comparison to allow doctests to work.

Returns true or false.

(AbjadObject).__ne__(expr)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.