Abjad API¶

Functions

grace_corner_cases

Read these module-level examples.

Functions

`annotate`	Annotates `component` with `indicator`.
`attach`	Attaches `attachable` to `target`.
`detach`	Detaches indicators-equal-to-`argument` from `target`.

Internals

Wrapper

Wrapper.

abjad.configuration

Functions

`list_all_classes`	Lists all public classes defined in `path`.
`list_all_functions`	Lists all public functions defined in `modules`.
`yield_all_modules`	Yields all modules encountered in `path`.

System configuration

Configuration

Configuration.

abjad.contextmanagers

Classes

ContextManager

An abstract context manager class.

Context managers

`FilesystemState`	Filesystem state context manager.
`ForbidUpdate`	A context manager for forbidding score updates.
`NullContextManager`	A context manager that does nothing.
`ProgressIndicator`	A context manager for printing progress indications.
`RedirectedStreams`	A context manager for capturing stdout and stderr output.
`TemporaryDirectory`	A temporary directory context manager.
`TemporaryDirectoryChange`	A context manager for temporarily changing the current working directory.
`Timer`	A timing context manager.

abjad.contributions

Classes

ContributionsBySite

LilyPond format contributions.

Enumerations

`Sites`	Contribution sites.
`Types`	Contribution types.

abjad.cyclictuple

Classes

CyclicTuple

Cyclic tuple.

abjad.duration

Classes

`Duration`	Duration.
`Multiplier`	Multiplier.
`NonreducedFraction`	Nonreduced fraction.
`Offset`	Offset.

abjad.dynamic

Classes

Dynamic

Dynamic.

abjad.enumerate

Functions

`outer_product`	Yields outer product of sequences in `argument`.
`yield_combinations`	Yields combinations of sequence items.
`yield_pairs`	Yields pairs sequence items.
`yield_partitions`	Yields partitions of sequence.
`yield_permutations`	Yields permutations of sequence.
`yield_set_partitions`	Yields set partitions of sequence.
`yield_subsequences`	Yields subsequences of `sequence`.

abjad.enums

Enumerations.

Enumerations

`Comparison`	Enumeration of amount comparisons.
`Horizontal`	Enumeration of horizontal alignments.
`Vertical`	Enumeration of vertical alignments.

abjad.exceptions

Custom exceptions.

Exceptions

`AssignabilityError`	Duration can not be assigned to note, rest or chord.
`ImpreciseMetronomeMarkError`	MetronomeMark is imprecise.
`LilyPondParserError`	Can not parse input.
`MissingMetronomeMarkError`	No metronome mark found.
`ParentageError`	A parentage error.
`PersistentIndicatorError`	Persistent indicator already attached at same context.
`SchemeParserFinishedError`	SchemeParser has finished parsing.
`UnboundedTimeIntervalError`	Time interval has no bounds.
`WellformednessError`	Score not well formed.

abjad.ext

abjad.ext.sphinx

Classes

`HiddenDoctestDirective`	A hidden doctest directive.
`LilyPondExtension`
`ShellDirective`	A shell directive.
`ThumbnailDirective`	A thumbnail directive.
`thumbnail_block`

Functions

`embed_images`
`install_lightbox_static_files`
`on_builder_inited`
`on_html_collect_pages`
`setup`
`visit_thumbnail_block_html`
`visit_thumbnail_block_latex`

abjad.format

Functions

`format_component`	Formats `component`.
`remove_site_comments`	Removes site comments from `string`.

abjad.get

Classes

Lineage

Lineage of a component.

Functions

`after_grace_container`	Gets after grace containers attached to component.
`annotation`	Gets annotation.
`annotation_wrappers`	Gets annotation wrappers.
`bar_line_crossing`	Is true when `argument` crosses bar line.
`before_grace_container`	Gets before-grace container attached to leaf.
`contents`	Gets contents.
`descendants`	Gets descendants.
`duration`	Gets duration.
`effective`	Gets effective indicator.
`effective_staff`	Gets effective staff.
`effective_wrapper`	Gets effective wrapper.
`grace`	Is true when `argument` is grace music.
`has_effective_indicator`	Is true when `argument` has effective indicator.
`has_indicator`	Is true when `argument` has one or more indicators.
`indicator`	Gets indicator.
`indicators`	Get indicators.
`leaf`	Gets leaf `n`.
`lineage`	Gets lineage.
`logical_tie`	Gets logical tie.
`markup`	Gets markup.
`measure_number`	Gets measure number.
`parentage`	Gets parentage.
`pitches`	Gets pitches.
`sounding_pitch`	Gets sounding pitch of note.
`sounding_pitches`	Gets sounding pitches.
`sustained`	Is true when `argument` is sustained.
`timespan`	Gets timespan.
`wrapper`	Gets wrapper.
`wrappers`	Gets wrappers.

abjad.illustrators

Functions

`attach_markup_struts`	LilyPond workaround.
`illustrate`	Illustrates `item`.
`lilypond`	Gets LilyPond format of `argument`.
`make_piano_score`	Makes piano score from `leaves`.
`selection`	Wraps `components` in LilyPond file for doc examples.
`selection_to_score_markup_string`	Changes `selection` to score markup string.

abjad.indicators

Indicators

Classes

`Arpeggio`	Arpeggio.
`Articulation`	Articulation.
`BarLine`	Bar line.
`BeamCount`	LilyPond `\setLeftBeamCount`, `\setRightBeamCount` command.
`BendAfter`	Fall or doit.
`BreathMark`	Breath mark.
`Clef`	Clef.
`ColorFingering`	Color fingering.
`Fermata`	Fermata.
`Glissando`	LilyPond `\glissando` command.
`InstrumentName`	LilyPond `\instrumentName` setting.
`KeyCluster`	Key cluster.
`KeySignature`	Key signature.
`LaissezVibrer`	Laissez vibrer.
`LilyPondLiteral`	LilyPond literal.
`Markup`	LilyPond markup.
`MetronomeMark`	MetronomeMark.
`Mode`	Mode.
`Ottava`	LilyPond `\ottava` command.
`RehearsalMark`	Rehearsal mark.
`Repeat`	Repeat.
`RepeatTie`	LilyPond `\repeatTie` command.
`ShortInstrumentName`	LilyPond `\shortInstrumentName` command.
`StaffChange`	Staff change.
`StartBeam`	LilyPond `[` command.
`StartGroup`	LilyPond `\startGroup` command.
`StartHairpin`	Hairpin indicator.
`StartPhrasingSlur`	LilyPond `(` command.
`StartPianoPedal`	LilyPond `\sustainOn`, `\sostenutoOn`, `\unaCorda` commands.
`StartSlur`	LilyPond `(` command.
`StartTextSpan`	LilyPond `\startTextSpan` command.
`StartTrillSpan`	LilyPond `\startTrillSpan` command.
`StemTremolo`	Stem tremolo.
`StopBeam`	LilyPond `]` command.
`StopGroup`	LilyPond `\stopGroup` command.
`StopHairpin`	LilyPond `\!` command.
`StopPhrasingSlur`	LilyPond `\)` command.
`StopPianoPedal`	LilyPond `\sostenutoOff`, `\sustainOff`, `\treCorde` commands.
`StopSlur`	LilyPond `)` command.
`StopTextSpan`	LilyPond `\stopTextSpan` command.
`StopTrillSpan`	LilyPond `\stopTrillSpan` command.
`Tie`	LilyPond `~` command.
`TimeSignature`	Time signature.

abjad.instruments

Instruments.

Classes

`Accordion`
`AltoFlute`
`AltoSaxophone`
`AltoTrombone`
`AltoVoice`
`BaritoneSaxophone`
`BaritoneVoice`
`BassClarinet`
`BassFlute`
`BassSaxophone`
`BassTrombone`
`BassVoice`
`Bassoon`
`Cello`
`ClarinetInA`
`ClarinetInBFlat`
`ClarinetInEFlat`
`Contrabass`
`ContrabassClarinet`
`ContrabassFlute`
`ContrabassSaxophone`
`Contrabassoon`
`EnglishHorn`
`Flute`
`FrenchHorn`
`Glockenspiel`
`Guitar`
`Harp`
`Harpsichord`
`Instrument`	Instrument.
`Marimba`
`MezzoSopranoVoice`
`Oboe`
`Percussion`
`Piano`
`Piccolo`
`SopraninoSaxophone`
`SopranoSaxophone`
`SopranoVoice`
`StringNumber`	String number.
`TenorSaxophone`
`TenorTrombone`
`TenorVoice`
`Trumpet`
`Tuba`
`Tuning`	Tuning.
`Vibraphone`
`Viola`
`Violin`
`Xylophone`

abjad.io

Classes

`AbjadGrapher`	Abjad grapher.
`Illustrator`	Illustrator.
`LilyPondIO`	LilyPond IO.
`Player`	Player.

Functions

`compare_files`	Compares file `path_1` to file `path_2`.
`count_function_calls`	Counts function calls required to execute `argument`.
`execute_file`	Executes file `path`.
`execute_string`	Executes `string`.
`find_executable`	Finds executable `name`.
`graph`	Graphs `argument`.
`make_subprocess`	Makes Popen instance.
`open_file`	Opens `file_path`.
`open_last_log`	Opens LilyPond log file in operating system-specific text editor.
`profile`	Profiles `string`.
`run_command`	Runs command in subprocess.
`run_lilypond`	Runs LilyPond on `ly_path`.
`show`	Shows `argument`.
`spawn_subprocess`	Spawns subprocess and runs `command`.

abjad.iterate

Functions

`components`	Iterates components in `argument`.
`leaves`	Iterates leaves in `argument`.
`logical_ties`	Iterates logical ties in `argument`.
`pitches`	Iterates pitches in `argument`.
`timeline`	Iterates leaves in `argument` in timeline order.

abjad.iterpitches

Functions

`iterate_out_of_range`	Iterates out-of-range notes and chords in `argument`.
`respell_with_flats`	Respells pitches in `argument` with flats.
`respell_with_sharps`	Respells pitches in `argument` with sharps.
`sounding_pitches_are_in_range`	Returns true when all pitches in `argument` sound within `pitch_range`.
`transpose_from_sounding_pitch`	Transpose notes and chords in `argument` from sounding pitch to written pitch.
`transpose_from_written_pitch`	Transposes notes and chords in `argument` from sounding pitch to written pitch.

abjad.label

Classes

ColorMap

Color map.

Functions

`by_selector`	Colors leaves in `argument` by `selector`.
`color_container`	Colors contents of `container`.
`color_leaves`	Colors leaves in `argument`.
`color_note_heads`	Colors note note-heads.
`remove_markup`	Removes markup from leaves in `argument`.
`vertical_moments`	Labels vertical moments.
`with_durations`	Labels logical ties in `argument` with durations.
`with_indices`	Labels logical ties in `argument` with indices.
`with_intervals`	Labels consecutive notes in `argument` with intervals.
`with_pitches`	Labels logical ties in `argument` with pitches.
`with_set_classes`	Labels selections `argument` with set-classes.
`with_start_offsets`	Labels logical ties in `argument` with start offsets.

abjad.lilypondfile

Classes

`Block`	LilyPond file block.
`LilyPondFile`	LilyPond file.

abjad.lyproxy

Classes

`LilyPondContext`	LilyPond context.
`LilyPondEngraver`	LilyPond engraver.
`LilyPondGrob`	LilyPond grob.
`LilyPondGrobInterface`	LilyPond grob interface.

abjad.makers

Functions

`make_leaves`	Makes leaves from `pitches` and `durations`.
`make_notes`	Makes notes from `pitches` and `durations`.
`tuplet_from_duration_and_ratio`	Makes tuplet from `duration` and `ratio`.
`tuplet_from_leaf_and_ratio`	Makes tuplet from `leaf` and `ratio`.
`tuplet_from_ratio_and_pair`	Makes tuplet from nonreduced `ratio` and nonreduced `fraction`.

abjad.math

Abjad’s math library.

Classes

`Infinity`	Infinity.
`NegativeInfinity`	Negative infinity.

Functions

`all_are_equal`	Is true when `argument` is an iterable collection of equal items.
`all_are_integer_equivalent`	Is true when `argument` is an iterable collection with integer-equivalent items.
`all_are_integer_equivalent_numbers`	Is true when `argument` is an iterable collection with integer-equivalent items.
`all_are_nonnegative_integer_equivalent_numbers`	Is true when `argument` is an iterable collection of nonnegative integer-equivalent numbers.
`all_are_nonnegative_integer_powers_of_two`	Is true when `argument` is an iterable collection of nonnegative integer powers of two.
`all_are_nonnegative_integers`	Is true when `argument` is an iterable collection of nonnegative integers.
`all_are_pairs_of_types`	Is true when `argument` is an iterable collection whose members are all of length 2, and where the first member of each pair is an instance of `first_type` and where the second member of each pair is an instance of `second_type`.
`all_are_positive_integers`	Is true when `argument` is an iterable collection of positive integers.
`are_relatively_prime`	Is true when `argument` is an iterable collection of relative primes.
`arithmetic_mean`	Gets arithmetic mean of `argument`.
`binomial_coefficient`	Gets binomial coefficient of `n` choose `k`.
`cumulative_products`	Gets cumulative products of `argument`.
`cumulative_sums`	Gets cumulative sums of `argument`.
`difference_series`	Gets difference series of `argument`.
`divisors`	Gets positive divisors of `n` in increasing order.
`factors`	Gets prime factors less than or equal to `n` .
`fraction_to_proper_fraction`	Changes `rational` to proper fraction.
`greatest_common_divisor`	Calculates greatest common divisor of `integers`.
`greatest_power_of_two_less_equal`	Gets greatest integer power of two less than or equal to positive `n`.
`integer_equivalent_number_to_integer`	Changes integer-equivalent `number` to integer.
`integer_to_base_k_tuple`	Changes nonnegative integer `n` to base-k tuple.
`integer_to_binary_string`	Changes positive integer `n` to binary string.
`is_assignable_integer`	Is true when `argument` is equivalent to an integer that can be written without recourse to ties.
`is_integer_equivalent`	Is true when `argument` is an integer-equivalent number.
`is_integer_equivalent_n_tuple`	Is true when `argument` is a tuple of `n` integer-equivalent items.
`is_integer_equivalent_number`	Is true when `argument` is a number and `argument` is equivalent to an integer.
`is_nonnegative_integer`	Is true when `argument` equals a nonnegative integer.
`is_nonnegative_integer_equivalent_number`	Is true when `argument` is a nonnegative integer-equivalent number.
`is_nonnegative_integer_power_of_two`	Is true when `argument` is a nonnegative integer power of 2.
`is_positive_integer`	Is true when `argument` equals a positive integer.
`is_positive_integer_equivalent_number`	Is true when `argument` is a positive integer-equivalent number.
`is_positive_integer_power_of_two`	Is true when `argument` is a positive integer power of 2.
`least_common_multiple`	Gets least common multiple of positive `integers`.
`partition_integer_into_canonic_parts`	Partitions integer `n` into canonic parts.
`sign`	Gets sign of `n`.
`weight`	Gets weight of `argument`.
`yield_all_compositions_of_integer`	Yields all compositions of positive integer `n`.

abjad.meter

Tools for modeling musical meter.

Classes

`Meter`	Meter models a common practice understanding of beats and other levels of rhythmic organization structured as a tree.
`MetricAccentKernel`	Metric accent kernel.

Functions

illustrate_meter_list

Illustrates meters.

abjad.metricmodulation

Classes

MetricModulation

Metric modulation.

abjad.mutate

Functions

`copy`	Copies argument.
`eject_contents`	Ejects `container` contents.
`extract`	Extracts `argument` from score.
`fuse`	Fuses `argument`.
`logical_tie_to_tuplet`	Changes logical tie to tuplet.
`replace`	Replaces `argument` (and contents of `argument`) with `recipients`.
`scale`	Scales `argument` by `multiplier`.
`split`	Splits `argument` by `durations`.
`swap`	Swaps `argument` for empty `container`.
`transpose`	Transposes notes and chords in `argument` by `interval`.
`wrap`	Wraps `argument` in empty `container`.

abjad.obgc

Containers

OnBeatGraceContainer

On-beat grace container.

Functions

on_beat_grace_container

Makes on-beat grace container and wraps around selection.

abjad.overrides

Classes

`Interface`	Base class from which grob, setting and tweak interfaces inherit.
`LilyPondOverride`	LilyPond grob override.
`LilyPondSetting`	LilyPond context setting.
`OverrideInterface`	Override interface.
`SettingInterface`	LilyPond setting interface.

Functions

`override`	Makes LilyPond grob override interface.
`setting`	Makes LilyPond setting name interface.

abjad.parentage

Classes

Parentage

Parentage of a component.

abjad.parsers

Functions

parse

Parses LilyPond string.

abjad.parsers.base

Classes

Parser

Abstract base class for Abjad parsers.

abjad.parsers.parser

Classes

`ContextSpeccedMusic`	Abjad model of the LilyPond AST context-specced music node.
`GuileProxy`	Emulates LilyPond music functions.
`LilyPondDuration`	Model of a duration in LilyPond.
`LilyPondEvent`	Model of an arbitrary event in LilyPond.
`LilyPondFraction`	Model of a fraction in LilyPond.
`LilyPondGrammarGenerator`	Generates a syntax skeleton from LilyPond grammar files.
`LilyPondLexicalDefinition`	The lexical definition of LilyPond's syntax.
`LilyPondParser`	A LilyPond syntax parser.
`LilyPondSyntacticalDefinition`	The syntactical definition of LilyPond's syntax.
`MarkupCommand`	LilyPond markup command.
`Music`	Abjad model of the LilyPond AST music node.
`SequentialMusic`	Abjad model of the LilyPond AST sequential music node.
`SimultaneousMusic`	Abjad model of the LilyPond AST simultaneous music node.
`SyntaxNode`	A node in an abstract syntax tree (AST).

abjad.parsers.reduced

Classes

ReducedLyParser

Parses the "reduced-ly" syntax, a modified subset of LilyPond syntax.

Functions

parse_reduced_ly_syntax

Parse the reduced LilyPond rhythmic syntax:

abjad.parsers.scheme

Classes

`Scheme`	Abjad model of Scheme code.
`SchemeParser`	`SchemeParser` mimics how LilyPond's embedded Scheme parser behaves.

abjad.pattern

Classes

`Pattern`	Pattern.
`PatternTuple`	Pattern tuple.

abjad.pcollections

Classes

`PitchClassSegment`	Numbered pitch-class segment.
`PitchClassSet`	Numbered pitch-class set.
`PitchRange`	Pitch range.
`PitchSegment`	Named pitch segment.
`PitchSet`	Numbered pitch set.
`TwelveToneRow`	Twelve-tone row.

Functions

`make_interval_class_vector`	Makes interval-class vector.
`voice_horizontally`	Voices named `pcs` with each pitch as close to the previous pitch as possible.
`voice_vertically`	Voices named `pcs` with each pitch not lower than the previous.

abjad.persist

Functions

`as_ly`	Persists `argument` as LilyPond file.
`as_midi`	Persists `argument` as MIDI file.
`as_pdf`	Persists `argument` as PDF.
`as_png`	Persists `argument` as PNG.

abjad.pitch

Classes

`Accidental`	Accidental.
`Interval`	Abstract interval.
`IntervalClass`	Abstract interval-class.
`NamedInterval`	Named interval.
`NamedIntervalClass`	Named interval-class.
`NamedInversionEquivalentIntervalClass`	Named inversion-equivalent interval-class.
`NamedPitch`	Named pitch.
`NamedPitchClass`	Named pitch-class.
`NumberedInterval`	Numbered interval.
`NumberedIntervalClass`	Numbered interval-class.
`NumberedInversionEquivalentIntervalClass`	Numbered inversion-equivalent interval-class.
`NumberedPitch`	Numbered pitch.
`NumberedPitchClass`	Numbered pitch-class.
`Octave`	Octave.
`Pitch`	Abstract pitch.
`PitchClass`	Abstract pitch-class.
`StaffPosition`	Staff position.

abjad.ratio

Classes

`NonreducedRatio`	Nonreduced ratio.
`Ratio`	Ratio.

abjad.rhythmtrees

Tools for modeling IRCAM-style rhythm trees.

Classes

`RhythmTreeContainer`	Rhythm-tree container.
`RhythmTreeLeaf`	Rhythm-tree leaf.
`RhythmTreeMixin`	Abstract rhythm-tree node.
`RhythmTreeParser`	Rhythm-tree parser.

Functions

parse_rtm_syntax

Creates rhythm tree from RTM string; then calls rhythm tree on quarter-note pulse duration.

abjad.score

Classes

`Component`	Component baseclass.
`Leaf`	Leaf baseclass.

Containers

`AfterGraceContainer`	After grace container.
`BeforeGraceContainer`	Grace container.
`Cluster`	Cluster.
`Container`	Container.
`TremoloContainer`	Tremolo container.
`Tuplet`	Tuplet.

Contexts

`Context`	LilyPond context.
`Score`	Score.
`Staff`	Staff.
`StaffGroup`	Staff group.
`Voice`	Voice.

Leaves

`Chord`	Chord.
`MultimeasureRest`	Multimeasure rest.
`Note`	Note.
`Rest`	Rest.
`Skip`	LilyPond skip.

Note-heads

`DrumNoteHead`	Drum note-head.
`NoteHead`	Note-head.
`NoteHeadList`	Note-head list.

abjad.select

Classes

LogicalTie

Logical tie of a component.

Functions

`chord`	Selects chord `n` in `argument`.
`chords`	Selects chords in `argument`.
`components`	Selects components.
`exclude`	Excludes items at `indices` by `period`.
`filter`	Filters `argument` by `predicate`.
`flatten`	Flattens `argument`.
`get`	Gets items in `argument` at `indices` according to `period`.
`group`	Groups `argument` in selection.
`group_by`	Groups items in `argument` by `predicate`.
`group_by_contiguity`	Groups items in `argument` by contiguity.
`group_by_duration`	Groups items in `argument` by duration.
`group_by_length`	Groups items in `argument` by length.
`group_by_measure`	Groups items in `argument` by measure.
`group_by_pitch`	Groups items in `argument` by pitch.
`leaf`	Selects leaf n` in ``argument.
`leaves`	Selects leaves in `argument`.
`logical_tie`	Selects logical tie `n` in `argument`.
`logical_ties`	Selects logical ties in `argument`.
`nontrivial`	Selects nontrivial items in `argument`.
`note`	Selects note `n` in `argument`.
`notes`	Selects notes in `argument`.
`partition_by_counts`	Partitions items in `argument` by `counts`.
`partition_by_durations`	Partitions items in `argument` by `durations`.
`partition_by_ratio`	Partitions items in `argument` by `ratio`.
`rest`	Selects rest `n` in `argument`.
`rests`	Selects rests in `argument`.
`run`	Selects run `n` in `argument`.
`runs`	Selects runs in `argument`.
`top`	Selects top components in `argument`.
`tuplet`	Selects tuplet `n` in `argument`.
`tuplets`	Selects tuplets in `argument`.
`with_next_leaf`	Extends `argument` with next leaf.
`with_previous_leaf`	Extends `argument` with previous leaf.

abjad.sequence

Functions

`filter`	Filters sequence by `predicate`.
`flatten`	Flattens `sequence`.
`group_by`	Groups sequence items by value of items.
`has_duplicates`	Is true when `sequence` has duplicates.
`is_decreasing`	Is true when sequence decreases.
`is_increasing`	Is true when sequence increases.
`is_permutation`	Is true when sequence is a permutation.
`is_repetition_free`	Is true when sequence is repetition-free.
`join`	Join subsequences in `sequence`.
`map`	Maps `operand` to sequence items.
`nwise`	Iterates `sequence` `n` at a time.
`partition_by_counts`	Partitions sequence by `counts`.
`partition_by_ratio_of_lengths`	Partitions sequence by `ratio` of lengths.
`partition_by_ratio_of_weights`	Partitions sequence by ratio of `weights`.
`partition_by_weights`	Partitions sequence by `weights` exactly.
`permute`	Permutes sequence by `permutation`.
`remove`	Removes items at `indices`.
`remove_repeats`	Removes repeats from `sequence`.
`repeat`	Repeats sequence.
`repeat_to_length`	Repeats `sequence` to `length`.
`repeat_to_weight`	Repeats sequence to `weight`.
`replace`	Replaces `old` with `new`.
`replace_at`	Replaces items at `indices` with `new_material`.
`retain`	Retains items at `indices`.
`retain_pattern`	Retains items at indices matching `pattern`.
`reverse`	Reverses sequence.
`rotate`	Rotates `sequence` by index `n`.
`sort`	Sorts sequence.
`split`	Splits sequence by `weights`.
`sum`	Sums sequence.
`sum_by_sign`	Sums consecutive sequence items by `sign`.
`truncate`	Truncates sequence.
`weight`	Gets weight.
`zip`	Zips sequences in sequence.

abjad.setclass

Classes

SetClass

Set-class.

abjad.spanners

Classes and functions for modeling spanners: beams, hairpins, slurs, etc.

Functions

`beam`	Attaches beam indicators.
`glissando`	Attaches glissando indicators.
`hairpin`	Attaches hairpin indicators.
`horizontal_bracket`	Attaches group indicators.
`ottava`	Attaches ottava indicators.
`phrasing_slur`	Attaches phrasing slur indicators.
`piano_pedal`	Attaches piano pedal indicators.
`slur`	Attaches slur indicators.
`text_spanner`	Attaches text span indicators.
`tie`	Attaches tie indicators.
`trill_spanner`	Attaches trill spanner indicators.

abjad.string

Functions

`capitalize_start`	Capitalizes start of string.
`delimit_words`	Delimits words in string.
`from_roman`	Changes string from Roman numeral to digits.
`is_lilypond_identifier`	Is true when string starts with a letter and either 1.
`is_roman`	Is true when string is Roman numeral.
`is_shout_case`	Is true when string and is shoutcase.
`normalize`	Normalizes string.
`pluralize`	Pluralizes English string.
`sort_roman`	Sorts strings containing Roman numerals.
`strip_roman`	Strips roman numerals from right of string.
`to_shout_case`	Changes string to shout case.
`to_tridirectional_lilypond_symbol`	Changes `argument` to tridirectional LilyPond symbol.
`to_tridirectional_ordinal_constant`	Changes `argument` to tridirectional ordinal constant.
`to_upper_camel_case`	Changes string to upper camel case.

abjad.tag

Classes

Tag

Tag.

Functions

`activate`	Activates `tag` in `text`.
`deactivate`	Deactivates `tag` in `text`.
`double_tag`	Double tags `strings`.
`left_shift_tags`	Left shifts tags in `strings`.
`remove_tags`	Removes all tags from `string`.

abjad.timespan

Tools for modeling and manipulating timespans.

Classes

OffsetCounter

Offset counter.

Timespans

`Timespan`	Timespan.
`TimespanList`	Timespan list.

abjad.tweaks

Classes

`Bundle`	Bundled indicator.
`Tweak`	Tweak.

Functions

`bundle`	Bundles `indicator` with `tweaks`.
`tweak`	Appends `tweaks` to `indicator`.

abjad.verticalmoment

Classes

VerticalMoment

Vertical moment.

Functions

`iterate_leaf_pairs`	Iterates leaf pairs.
`iterate_pitch_pairs`	Iterates pitch pairs.
`iterate_vertical_moments`	Iterates vertical moments.

abjad.wf

Functions

`check_beamed_long_notes`	Checks beamed long notes.
`check_duplicate_ids`	Checks duplicate IDs.
`check_empty_containers`	Checks empty containers.
`check_missing_parents`	Checks missing parents.
`check_notes_on_wrong_clef`	Checks notes and chords on wrong clef.
`check_out_of_range_pitches`	Checks out-of-range notes.
`check_overlapping_text_spanners`	Checks overlapping text spanners.
`check_unmatched_stop_text_spans`	Checks unmatched stop text spans.
`check_unterminated_hairpins`	Checks unterminated hairpins.
`check_unterminated_text_spanners`	Checks unterminated text spanners.
`tabulate_wellformedness`	Tabulates wellformedness.
`wellformed`	Is true when `component` is wellformed.

abjadext

abjadext.nauert

Extension for quantizing rhythm, based on Paul Nauert’s Q-Grid technique.

abjadext.nauert.attackpointoptimizers

Abstract Classes

AttackPointOptimizer

Abstract attack-point optimizer.

Classes

`MeasurewiseAttackPointOptimizer`	Measurewise attack-point optimizer.
`NaiveAttackPointOptimizer`	Naive attack-point optimizer.
`NullAttackPointOptimizer`	Null attack-point optimizer.

abjadext.nauert.gracehandlers

Abstract Classes

GraceHandler

Abstract grace-handler.

Classes

`CollapsingGraceHandler`	Collapsing grace-handler.
`ConcatenatingGraceHandler`	Concatenating grace-handler.
`DiscardingGraceHandler`	Discarding grace-handler.

abjadext.nauert.heuristics

Abstract Classes

Heuristic

Abstract heuristic.

Classes

DistanceHeuristic

Distance heuristic.

abjadext.nauert.jobhandlers

Abstract Classes

JobHandler

Abstact job-handler.

Classes

`ParallelJobHandler`	Parallel job-handler.
`ParallelJobHandlerWorker`	Parallel job-handler worker.
`SerialJobHandler`	Serial job-handler.

abjadext.nauert.qeventproxy

Classes

QEventProxy

Q-event proxy.

abjadext.nauert.qevents

Abstract Classes

QEvent

Abstract Q-event.

Classes

`PitchedQEvent`	Pitched q-event.
`SilentQEvent`	Silent q-event.
`TerminalQEvent`	Terminal q-event.

abjadext.nauert.qeventsequence

Classes

QEventSequence

Q-event sequence.

abjadext.nauert.qgrid

Classes

`QGrid`	Q-grid.
`QGridContainer`	Q-grid container.
`QGridLeaf`	Q-grid leaf.

abjadext.nauert.qschemaitems

Abstract Classes

QSchemaItem

Abstract q-schema item.

Classes

`BeatwiseQSchemaItem`	Beatwise q-schema item.
`MeasurewiseQSchemaItem`	Measurewise q-schema item.

abjadext.nauert.qschemas

Abstract Classes

QSchema

Abstract Q-schema.

Classes

`BeatwiseQSchema`	Beatwise q-schema.
`MeasurewiseQSchema`	Measurewise q-schema.

abjadext.nauert.qtargetitems

Abstract Classes

QTargetItem

Abstract class for QTargetBeat and QTargetMeasure.

Classes

`QTargetBeat`	Q-target beat.
`QTargetMeasure`	Q-target measure.

abjadext.nauert.qtargets

Abstract Classes

QTarget

Abstract q-target.

Classes

`BeatwiseQTarget`	Beatwise q-target.
`MeasurewiseQTarget`	Measurewise quantization target.

abjadext.nauert.quantizationjob

Classes

QuantizationJob

Quantization job.

abjadext.nauert.quantizer

Functions

quantize

Quantizer function.

abjadext.nauert.searchtrees

Abstract Classes

SearchTree

Abstract search tree.

Classes

`UnweightedSearchTree`	Unweighted search tree based on Paul Nauert's model.
`WeightedSearchTree`	Weighted search tree.

abjadext.rmakers

Rhythm-makers.

abjadext.rmakers.rmakers

Functions

`accelerando`	Makes accelerando figures in `divisions`.
`after_grace_container`	Makes after-grace containers.
`beam`	Calls `abjad.beam()` on leaves in `argument`.
`beam_groups`	Beams `argument` groups.
`before_grace_container`	Makes before-grace containers.
`denominator`	Sets denominator of every tuplet in `argument` to `denominator`.
`duration_bracket`	Applies durtaion bracket to tuplets in `argument`.
`even_division`	Makes even-division tuplets in `divisions`.
`example`	Makes example LilyPond file for documentation examples.
`extract_trivial`	Extracts trivial tuplets from `argument`.
`feather_beam`	Feather-beams leaves in `argument`.
`force_augmentation`	Forces each tuplet in `argument` to notate as an augmentation.
`force_diminution`	Forces each tuplet in `argument` to notate as a diminution.
`force_fraction`	Sets `force_fraction=True` on all tuplets in `argument`.
`force_note`	Replaces leaves in `argument` with notes.
`force_repeat_tie`	Changes all ties in argument to repeat-ties.
`force_rest`	Replaces leaves in `argument` with rests.
`incised`	Makes incised tuplets in `divisions`.
`interpolate`	Makes interpolation.
`invisible_music`	Makes `argument` invisible.
`multiplied_duration`	Makes one multiplied duration for each division in `divisions`.
`nongrace_leaves_in_each_tuplet`	Selects nongrace leaves in each tuplet.
`note`	Makes one note for every division in `divisions`.
`on_beat_grace_container`	Makes on-beat grace containers.
`reduce_multiplier`	Reduces multipliers of tuplets in `argument`.
`repeat_tie`	Attaches repeat-tie to each leaf in `argument`.
`rewrite_dots`	Rewrites dots of tuplets in `argument`.
`rewrite_meter`	Rewrites meter of material in `voice`.
`rewrite_rest_filled`	Rewrites rest-filled tuplets in `argument`.
`rewrite_sustained`	Rewrites sustained tuplets in `argument`.
`split_measures`	Splits measures in `voice`.
`talea`	Reads `counts` cyclically and makes one tuplet for each division in `divisions`.
`tie`	Attaches one tie to each notes in `argument`.
`tremolo_container`	Replaces each note in `argument` with a tremolo container.
`trivialize`	Trivializes each tuplet in `argument`.
`tuplet`	Makes one tuplet for each division in `divisions`.
`unbeam`	Unbeams each leaf in `argument`.
`untie`	Deatches ties from each leaf in `argument`.
`wrap_in_time_signature_staff`	Makes staff with two voices: one voice for `music` and another voice with time signatures (equal to divisions).
`written_duration`	Sets written duration of each leaf in `argument` to `duration`.

Specifiers

`Incise`	See `rmakers.incised()` for examples.
`Interpolation`	See `rmakers.accelerando()` for examples.
`Spelling`	Duration spelling specifier.
`Talea`	Talea specifier.