spannertools.MeasuredComplexBeamSpanner

class abjad.tools.spannertools.MeasuredComplexBeamSpanner.MeasuredComplexBeamSpanner.MeasuredComplexBeamSpanner(components=None, lone=False, span=1, direction=None)

Abjad measured complex beam spanner:

abjad> staff = Staff([Measure((2, 16), "c'16 d'16"), Measure((2, 16), "e'16 f'16")])

abjad> spannertools.MeasuredComplexBeamSpanner(staff.leaves)
MeasuredComplexBeamSpanner(c'16, d'16, e'16, f'16)

abjad> f(staff)
\new Staff {
    {
        \time 2/16
        \set stemLeftBeamCount = #0
        \set stemRightBeamCount = #2
        c'16 [
        \set stemLeftBeamCount = #2
        \set stemRightBeamCount = #1
        d'16
    }
    {
        \time 2/16
        \set stemLeftBeamCount = #1
        \set stemRightBeamCount = #2
        e'16
        \set stemLeftBeamCount = #2
        \set stemRightBeamCount = #0
        f'16 ]
    }
}

Beam leaves in spanner explicitly.

Group leaves by measures.

Format top-level span beam between measures.

Return measured complex beam spanner.

Read-only Properties

MeasuredComplexBeamSpanner.components

Return read-only tuple of components in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:2])
abjad> spanner.components
(Note("c'8"), Note("d'8"))

Changed in version 1.1: Now returns an (immutable) tuple instead of a (mutable) list.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.duration_in_seconds

Sum of duration of all leaves in spanner, in seconds.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.leaves

Return read-only tuple of leaves in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:2])
abjad> spanner.leaves
(Note("c'8"), Note("d'8"))

Changed in version 1.1: Now returns an (immutable) tuple instead of a (mutable) list.

Note

When dealing with large, complex scores accessing this attribute can take some time. Best to make a local copy with leaves = spanner.leaves first. Or use spanner- specific iteration tools.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.offset

New in version 1.1.

Return read-only reference to spanner offset interface.

Spanner offset interface implements start and stop attributes.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[2:])
abjad> spanner
Spanner(e'8, f'8)

abjad> spanner._offset.start
Offset(1, 4)

abjad> spanner._offset.stop
Offset(1, 2)

Return duration.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.override

LilyPond grob override component plug-in.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.preprolated_duration

Sum of preprolated duration of all components in spanner.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.prolated_duration

Sum of prolated duration of all components in spanner.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.set

LilyPond context setting component plug-in.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.written_duration

Sum of written duration of all components in spanner.

Note

Inherited from spannertools.Spanner

Read/write Properties

MeasuredComplexBeamSpanner.direction

Note

Inherited from spannertools._DirectedSpanner

MeasuredComplexBeamSpanner.lone

Beam lone leaf and force beam nibs to left:

abjad> note = Note("c'16")

abjad> beam = spannertools.ComplexBeamSpanner([note], lone = 'left')

abjad> f(note)
\set stemLeftBeamCount = #2
\set stemRightBeamCount = #0
c'16 [ ]

Beam lone leaf and force beam nibs to right:

abjad> note = Note("c'16")

abjad> beam = spannertools.ComplexBeamSpanner([note], lone = 'right')

abjad> f(note)
\set stemLeftBeamCount = #0
\set stemRightBeamCount = #2
c'16 [ ]

Beam lone leaf and force beam nibs to both left and right:

abjad> note = Note("c'16")

abjad> beam = spannertools.ComplexBeamSpanner([note], lone = 'both')

abjad> f(note)
\set stemLeftBeamCount = #2
\set stemRightBeamCount = #2
c'16 [ ]

Beam lone leaf and accept LilyPond default nibs at both left and right:

abjad> note = Note("c'16")

abjad> beam = spannertools.ComplexBeamSpanner([note], lone = True)

abjad> f(note)
\set stemLeftBeamCount = #2
\set stemRightBeamCount = #2
c'16 [ ]

Do not beam lone leaf:

abjad> note = Note("c'16")

abjad> beam = spannertools.ComplexBeamSpanner([note], lone = False)

abjad> f(note)
c'16

Set to 'left', 'right', 'both', true or false as shown above.

Ignore this setting when spanner contains more than one leaf.

Note

Inherited from spannertools.ComplexBeamSpanner

MeasuredComplexBeamSpanner.span

Get top-level beam count:

abjad> staff = Staff([Measure((2, 16), "c'16 d'16"), Measure((2, 16), "e'16 f'16")])
abjad> beam = spannertools.MeasuredComplexBeamSpanner(staff.leaves)
abjad> beam.span
1

Set top-level beam count:

abjad> staff = Staff([Measure((2, 16), "c'16 d'16"), Measure((2, 16), "e'16 f'16")])
abjad> beam = spannertools.MeasuredComplexBeamSpanner(staff.leaves)
abjad> beam.span = 2
abjad> beam.span
2

Set nonnegative integer.

Methods

MeasuredComplexBeamSpanner.append(component)

Add component to right of spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:2])
abjad> spanner
Spanner(c'8, d'8)

abjad> spanner.append(voice[2])
abjad> spanner
Spanner(c'8, d'8, e'8)

Return none.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.append_left(component)

Add component to left of spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[2:])
abjad> spanner
Spanner(e'8, f'8)

abjad> spanner.append_left(voice[1])
abjad> spanner
Spanner(d'8, e'8, f'8)

Return none.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.clear()

Remove all components from spanner:

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

abjad> spanner.clear()
abjad> spanner
Spanner()

Return none.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.extend(components)

Add iterable components to right of spanner:

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:2])
abjad> spanner
Spanner(c'8, d'8)

abjad> spanner.extend(voice[2:])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

Return none.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.extend_left(components)

Add iterable components to left of spanner:

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[2:])
abjad> spanner
Spanner(e'8, f'8)

abjad> spanner.extend_left(voice[:2])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

Return none.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.fracture(i, direction='both')

Fracture spanner at direction of component at index i.

Valid values for direction are 'left', 'right' and 'both'.

Return original, left and right spanners.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> beam = spannertools.BeamSpanner(voice[:])
abjad> beam
BeamSpanner(c'8, d'8, e'8, f'8)

abjad> beam.fracture(1, direction = 'left')
(BeamSpanner(c'8, d'8, e'8, f'8), BeamSpanner(c'8), BeamSpanner(d'8, e'8, f'8))

abjad> print voice.format
\new Voice {
    c'8 [ ]
    d'8 [
    e'8
    f'8 ]
}

Return tuple.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.fuse(spanner)

Fuse contiguous spanners.

Return new spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> left_beam = spannertools.BeamSpanner(voice[:2])
abjad> right_beam = spannertools.BeamSpanner(voice[2:])

abjad> print voice.format
\new Voice {
    c'8 [
    d'8 ]
    e'8 [
    f'8 ]
}

abjad> left_beam.fuse(right_beam)
[(BeamSpanner(c'8, d'8), BeamSpanner(e'8, f'8), BeamSpanner(c'8, d'8, e'8, f'8))]

abjad> print voice.format
\new Voice {
    c'8 [
    d'8
    e'8
    f'8 ]
}

Todo

Return (immutable) tuple instead of (mutable) list.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.index(component)

Return nonnegative integer index of component in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[2:])
abjad> spanner
Spanner(e'8, f'8)

abjad> spanner.index(voice[-2])
0

Return nonnegative integer.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.pop()

Remove and return rightmost component in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

abjad> spanner.pop()
Note("f'8")

abjad> spanner
Spanner(c'8, d'8, e'8)

Return component.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.pop_left()

Remove and return leftmost component in spanner.

abjad> voice = Voice("c'8 d'8 e'8 f'8")
abjad> spanner = spannertools.Spanner(voice[:])
abjad> spanner
Spanner(c'8, d'8, e'8, f'8)

abjad> spanner.pop_left()
Note("c'8")

abjad> spanner
Spanner(d'8, e'8, f'8)

Return component.

Note

Inherited from spannertools.Spanner

Special Methods

MeasuredComplexBeamSpanner.__contains__(expr)

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.__delattr__()

x.__delattr__(‘name’) <==> del x.name

Note

Inherited from __builtin__.object

MeasuredComplexBeamSpanner.__eq__(arg)

True when id(self) equals id(arg).

Return boolean.

Note

Inherited from abctools.AbjadObject

MeasuredComplexBeamSpanner.__ge__(arg)

Abjad objects by default do not implement this method.

Raise exception.

Note

Inherited from abctools.AbjadObject

MeasuredComplexBeamSpanner.__getitem__(expr)

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.__gt__(arg)

Abjad objects by default do not implement this method.

Raise exception

Note

Inherited from abctools.AbjadObject

MeasuredComplexBeamSpanner.__hash__() <==> hash(x)

Note

Inherited from __builtin__.object

MeasuredComplexBeamSpanner.__le__(arg)

Abjad objects by default do not implement this method.

Raise exception.

Note

Inherited from abctools.AbjadObject

MeasuredComplexBeamSpanner.__len__()

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.__lt__(other)

Trivial comparison to allow doctests to work.

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.__ne__(arg)

True when id(self) does not equal id(arg).

Return boolean.

Note

Inherited from abctools.AbjadObject

MeasuredComplexBeamSpanner.__repr__()

Note

Inherited from spannertools.Spanner

MeasuredComplexBeamSpanner.__setattr__()

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

Note

Inherited from __builtin__.object

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

Note

Inherited from __builtin__.object