BeamSpecifier

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0]; edge [color=lightslategrey, penwidth=1]; subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=1]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjadext/rmakers/../../abjad/system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", label="Abjad\nObject", target=_top]; "abjad.system.AbjadValueObject.AbjadValueObject" [URL="../api/abjadext/rmakers/../../abjad/system/AbjadValueObject.html#abjad.system.AbjadValueObject.AbjadValueObject", label="Abjad\nValue\nObject", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.AbjadValueObject.AbjadValueObject"; } subgraph "cluster_abjadext.rmakers" { graph [label="abjadext.rmakers"]; node [color=2]; "abjadext.rmakers.BeamSpecifier.BeamSpecifier" [URL="../api/abjadext/rmakers/BeamSpecifier.html#abjadext.rmakers.BeamSpecifier.BeamSpecifier", color=black, fontcolor=white, label="Beam\nSpecifier", target=_top]; } subgraph cluster_builtins { graph [label=builtins]; node [color=3]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", label=object, target=_top]; } "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.rmakers.BeamSpecifier.BeamSpecifier"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }

class abjadext.rmakers.BeamSpecifier.BeamSpecifier(*, beam_each_division=True, beam_divisions_together=None, beam_rests=None, hide_nibs=None, stemlet_length=None, use_feather_beams=None)

Beam specifier.

Beams each division by default:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 c' c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> specifier(selections)
>>> abjad.show(staff) 

Attributes Summary

__call__ Calls beam specifier on selections.
__format__ Formats beam specifier.
__repr__ Gets interpreter representation of beam specifier.
beam_divisions_together Is true when divisions should beam together.
beam_each_division Is true when specifier beams each division.
beam_rests Is true when beams should include rests.
hide_nibs Is true when specifier hides nibs.
stemlet_length Gets stemlet length.
use_feather_beams Is true when multiple beams should feather.

Special methods

__call__(selections)

Calls beam specifier on selections.

Return type:None
(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.

__format__(format_specification='')

Formats beam specifier.

>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> abjad.f(specifier)
abjadext.rmakers.BeamSpecifier(
    beam_each_division=True,
    )
Return type:str
(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

__repr__()

Gets interpreter representation of beam specifier.

>>> abjadext.rmakers.BeamSpecifier()
BeamSpecifier(beam_each_division=True)
Return type:str

Read-only properties

beam_divisions_together

Is true when divisions should beam together.

Does not beam divisions together:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 c' c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> specifier(selections)
>>> abjad.show(staff) 

Beams divisions together (but excludes rests):

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_divisions_together=True,
...     beam_rests=False,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Beams divisions together (and includes rests):

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_divisions_together=True,
...     beam_rests=True,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Defaults to none:

>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> specifier.beam_divisions_together is None
True
Return type:Optional[bool]
beam_each_division

Is true when specifier beams each division.

Beams nothing:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 c' c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_each_division=False,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Beams each division (but excludes rests):

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_each_division=True,
...     beam_rests=False,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Beams each division (and includes rests):

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_each_division=True,
...     beam_rests=True,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Defaults to true:

>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> specifier.beam_each_division
True
Return type:Optional[bool]
beam_rests

Is true when beams should include rests.

Does not beam rests:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> specifier(selections)
>>> abjad.show(staff) 

Beams rests:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_rests=True,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Beams skips:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 s c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_rests=True,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Defaults to none:

>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> specifier.beam_rests is None
True
Return type:Optional[bool]
hide_nibs

Is true when specifier hides nibs.

Does not hide nibs:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 r c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_divisions_together=True,
...     beam_rests=False,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Hides nibs:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 r c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_divisions_together=True,
...     beam_rests=False,
...     hide_nibs=True,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 
Return type:Optional[bool]
stemlet_length

Gets stemlet length.

Beams rests without stemlets:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_rests=True,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Beams rests with stemlets:

>>> staff = abjad.Staff(name='RhythmicStaff')
>>> staff.extend("c'8 c' c'16 c' c' c' c'8 r c' c'")
>>> abjad.setting(staff).auto_beaming = False
>>> selections = [staff[:4], staff[4:]]
>>> specifier = abjadext.rmakers.BeamSpecifier(
...     beam_rests=True,
...     stemlet_length=2,
...     )
>>> specifier(selections)
>>> abjad.show(staff) 

Stemlets appear only when beam_rests is set to true.

Defaults to none:

>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> specifier.stemlet_length is None
True
Return type:Union[int, float, None]
use_feather_beams

Is true when multiple beams should feather.

>>> specifier = abjadext.rmakers.BeamSpecifier()
>>> specifier.use_feather_beams is None
True
Return type:Optional[bool]