BeamSpecifier

class rhythmmakertools.BeamSpecifier(beam_each_division=True, beam_divisions_together=None, beam_rests=None, stemlet_length=None, use_feather_beams=None)

Beam specifier.

Example 1. Beams notes in each division together but does not beam between divisions:

>>> specifier = rhythmmakertools.BeamSpecifier(
...     beam_each_division=True,
...     beam_divisions_together=False
...     )

Example 2. Beams everything:

>>> specifier = rhythmmakertools.BeamSpecifier(
...     beam_each_division=True,
...     beam_divisions_together=True
...     )

Example 3. Beams nothing:

>>> specifier = rhythmmakertools.BeamSpecifier(
...     beam_each_division=False,
...     beam_divisions_together=False
...     )

Beam specifiers are immutable.

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

Bases

Attribute summary

beam_divisions_together Is true when divisions should beam together.
beam_each_division Is true when each division should be beamed.
beam_rests Is true when beams should include rests.
stemlet_length Gets stemlet length.
use_feather_beams Is true when multiple beams should feather.
__call__(selections) Calls beam specifier on selections.
__copy__(\*args) Copies Abjad value object.
__eq__(expr) Is true when all initialization values of Abjad value object equal the initialization values of expr.
__format__([format_specification]) Formats beam specifier.
__hash__() Hashes Abjad value object.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation.

Read-only properties

BeamSpecifier.beam_divisions_together

Is true when divisions should beam together. Otherwise false.

>>> specifier = rhythmmakertools.BeamSpecifier()
>>> specifier.beam_divisions_together is None
True

Defaults to none.

Set to true, false or none.

Returns true, false or none.

BeamSpecifier.beam_each_division

Is true when each division should be beamed. Otherwise false.

>>> specifier = rhythmmakertools.BeamSpecifier()
>>> specifier.beam_each_division
True

Defaults to true.

Set to true or false.

Returns true or false.

BeamSpecifier.beam_rests

Is true when beams should include rests. Otherwise false.

>>> specifier = rhythmmakertools.BeamSpecifier()
>>> specifier.beam_rests is None
True

Defaults to none.

Set to true, false or none.

Returns true, false or none.

BeamSpecifier.stemlet_length

Gets stemlet length.

>>> specifier = rhythmmakertools.BeamSpecifier()
>>> specifier.stemlet_length is None
True

Defaults to none.

Set to none, integer or float.

Note that stemlets appear only when beam_rests is set to true.

Returns none, integer or float.

BeamSpecifier.use_feather_beams

Is true when multiple beams should feather. Otherwise false.

>>> specifier = rhythmmakertools.BeamSpecifier()
>>> specifier.use_feather_beams is None
True

Defaults to none.

Set to true, false or none.

Returns true, false or none.

Special methods

BeamSpecifier.__call__(selections)

Calls beam specifier on selections.

Returns none.

(AbjadValueObject).__copy__(*args)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(expr)

Is true when all initialization values of Abjad value object equal the initialization values of expr.

Returns true or false.

BeamSpecifier.__format__(format_specification='')

Formats beam specifier.

>>> specifier = rhythmmakertools.BeamSpecifier()
>>> print(format(specifier))
rhythmmakertools.BeamSpecifier(
    beam_each_division=True,
    )

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(expr)

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

Returns true or false.

BeamSpecifier.__repr__()

Gets interpreter representation.

>>> rhythmmakertools.BeamSpecifier()
BeamSpecifier(beam_each_division=True)

Returns string.