WindowLooper

class auxjad.WindowLooper(contents: Container, *, window_size: int | float | str | tuple[int] | Duration | Meter, step_size: int | float | str | tuple[int] | Duration, max_steps: int = 1, repetition_chance: float = 0.0, forward_bias: float = 1.0, head_position: int | float | tuple[int] | Duration = 0, omit_time_signatures: bool = False, process_on_first_call: bool = False, fill_with_rests: bool = True, disable_rewrite_meter: bool = False, boundary_depth: int | None = None, maximum_dot_count: int | None = None, rewrite_tuplets: bool = True, prettify_rewrite_meter: bool = True, extract_trivial_tuplets: bool = True, fuse_across_groups_of_beats: bool = True, fuse_quadruple_meter: bool = True, fuse_triple_meter: bool = True, after_rest: int | float | str | tuple[int] | Duration | Rest = 0, after_rest_in_new_measure: bool = False, use_multimeasure_rests: bool = True)

Outputs slices of an abjad.Container (or child class) using the metaphor of a looping window of a constant size (given by an abjad.Duration).

Basic usage:

Calling the object will return an abjad.Selection generated by the looping process. Each call of the object will move the window forwards and output the sliced window. It requires an window_size and a step_size.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> abjad.show(container)

>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              )
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

The property current_window can be used to access the current window without moving the head forwards.

>>> notes = looper.current_window()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

process_on_first_call:

The very first call will output the input container without processing it. To disable this behaviour and have the looping window move on the very first call, initialise the class with the keyword argument process_on_first_call set to True.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              process_on_first_call=True,
...                              )
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

window_size and step_size:

The arguments window_size and step_size are used to set the sizes of the window and the process step. window_size can take a tuple or an abjad.Meter as input, while step_size takes a tuple or an abjad.Duration.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 8),
...                              )
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Using as iterator:

The instances of this class can also be used as an iterator, which can then be used in a for loop to exhaust all windows. Notice how it appends rests at the end of the container, until it is totally exhausted. Note that unlike the methods output_n() and output_all(), time signatures are added to each window returned by the shuffler. Use the function auxjad.mutate.remove_repeated_time_signatures() to clean the output when using this class in this way.

>>> container = abjad.Container(r"c'4 d'2 e'4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 8),
...                              )
>>> staff = abjad.Staff()
>>> for window in looper:
...     staff.append(window)
>>> auxjad.mutate.remove_repeated_time_signatures(staff[:])
>>> abjad.show(staff)

fill_with_rests:

In order to stop the process when the end of the looping window matches the end of the contents (and thus appending rests to the output), set the optional keyword argument fill_with_rests to True. Compare the two approaches below.

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 4),
...                              )
>>> staff = abjad.Staff()
>>> for window in looper:
...     staff.append(window)
>>> abjad.show(staff)

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 4),
...                              fill_with_rests=False,
...                              )
>>> staff = abjad.Staff()
>>> for window in looper:
...     staff.append(window)
>>> abjad.show(staff)

Arguments and properties:

This class can take many optional keyword arguments during its creation. max_steps sets the maximum number of steps that the window can advance when the object is called, ranging between 1 and the input value (default is also 1). repetition_chance sets the chance of a window result repeating itself (that is, the window not moving forwards when called). It should range from 0.0 to 1.0 (default 0.0, i.e. no repetition). forward_bias sets the chance of the window moving forward instead of backwards. It should range from 0.0 to 1.0 (default 1.0, which means the window can only move forwards. A value of 0.5 gives 50% chance of moving forwards while a value of 0.0 will move the window only backwards). head_position can be used to offset the starting position of the looping window. It must be a tuple or an abjad.Duration, and its default value is 0. The properties boundary_depth, maximum_dot_count, and rewrite_tuplets are passed as arguments to abjad.Meter.rewrite_meter(), see its documentation for more information. By default, calling the object will first return the original container and subsequent calls will process it; set process_on_first_call to True and the looping process will be applied on the very first call. The attribute after_rest sets the length of rests that separate consecutive iterations (default is abjad.Duration(0), i.e. no rest). When using after rests, after_rest_in_new_measure dictates whether or not rests are appended to the same output measure or to a new one. When in their own measure, use_multimeasure_rests sets if multi-measure rests should be used or not.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(5, 8),
...                              max_steps=2,
...                              repetition_chance=0.25,
...                              forward_bias=0.2,
...                              head_position=(2, 8),
...                              omit_time_signatures=False,
...                              fill_with_rests=False,
...                              boundary_depth=0,
...                              maximum_dot_count=1,
...                              rewrite_tuplets=False,
...                              process_on_first_call=True,
...                              after_rest=(1, 8),
...                              after_rest_in_new_measure=True,
...                              use_multimeasure_rests=False,
...                              )
>>> looper.window_size
3/4
>>> looper.step_size
5/8
>>> looper.repetition_chance
0.25
>>> looper.forward_bias
0.2
>>> looper.max_steps
2
>>> looper.head_position
1/4
>>> looper.omit_time_signatures
False
>>> looper.fill_with_rests
False
>>> looper.boundary_depth
0
>>> looper.maximum_dot_count
1
>>> looper.rewrite_tuplets
False
>>> looper.boundary_depth
0
>>> looper.maximum_dot_count
1
>>> looper.rewrite_tuplets
False
>>> looper.process_on_first_call
True
>>> looper.after_rest
abjad.Duration((1, 8))
>>> looper.after_rest_in_new_measure
True
>>> looper.use_multimeasure_rests
False

Use the properties below to change these values after initialisation.

>>> looper.window_size = (5, 4)
>>> looper.step_size = (1, 4)
>>> looper.max_steps = 3
>>> looper.repetition_chance = 0.1
>>> looper.forward_bias = 0.8
>>> looper.head_position = 0
>>> looper.omit_time_signatures = True
>>> looper.boundary_depth = 1
>>> looper.maximum_dot_count = 2
>>> looper.rewrite_tuplets = True
>>> looper.process_on_first_call = False
>>> looper.after_rest = 0
>>> looper.after_rest_in_new_measure = False
>>> looper.use_multimeasure_rests = True
>>> looper.window_size
5/4
>>> looper.step_size
1/4
>>> looper.max_steps
3
>>> looper.repetition_chance
0.1
>>> looper.forward_bias
0.8
>>> looper.head_position
0
>>> looper.omit_time_signatures
True
>>> looper.boundary_depth
1
>>> looper.maximum_dot_count
2
>>> looper.rewrite_tuplets
True
>>> looper.process_on_first_call
False
>>> looper.after_rest
abjad.Duration(0)
>>> looper.after_rest_in_new_measure
False
>>> looper.use_multimeasure_rests
True

Setting forward_bias to 0.0:

Set forward_bias to 0.0 to move backwards instead of forwards (default is 1.0). The initial head_position must be greater than 0 otherwise the contents will already be exhausted in the very first call (since it will not be able to move backwards from that position).

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4 g'4 a'4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 4),
...                              head_position=(3, 4),
...                              forward_bias=0.0,
...                              )
>>> notes = looper.output_n(3)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

forward_bias between 0.0 and 1.0:

Setingt forward_bias to a value in between 0.0 and 1.0 will result in random steps being taken forward or backward, according to the bias. The initial value of head_position will once gain play an important role here, as the contents might be exhausted if the looper attempts to move backwards after reaching the head position 0.

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4 g'4 a'4 b'4 c''4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 4),
...                              head_position=(3, 4),
...                              forward_bias=0.5,
...                              )
>>> notes = looper.output_n(5)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

max_steps:

Setting the keyword argument max_steps to a value larger than 1 will result in a random number of steps (between 1 and max_steps) being applied at each call.

>>> container = abjad.Container(
...     r"c'4 d'4 e'4 f'4 g'4 a'4 b'4 c''4 d''4 e''4 f''4"
... )
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 4),
...                              max_steps=4,
...                              )
>>> notes = looper.output_n(4)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

len():

The function len() can be used to get the total number of steps in the contents (always rounded up).

>>> container = abjad.Container(r"c'1")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              )
>>> len(looper)
16
>>> container = abjad.Container(r"c'1")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 4),
...                              )
>>> len(looper)
4
>>> container = abjad.Container(r"c'2..")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(2, 4),
...                              step_size=(1, 4),
...                              )
>>> len(looper)
4

output_all():

To run through the whole process and output it as a single container, from the initial head position until the process outputs the single last element, use the method output_all(). As shown above, set the optional keyword argument fill_with_rests to False if the process is to be stopped when the end of the looping window reaches the end of the contents (thus not appending rests).

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 4),
...                              )
>>> notes = looper.output_all()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

tie_identical_pitches:

When using output_all(), set the keyword argument tie_identical_pitches to True in order to tie identical notes or chords at the end and beginning of consecutive windows.

>>> container = abjad.Container(r"c'4 <e' f' g'>2 r4 f'2.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 4),
...                              )
>>> notes = looper.output_all(tie_identical_pitches=True)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

output_n():

To run through just part of the process and output it as a single container, starting from the initial head position, use the method output_n() and pass the number of iterations as argument. Similarly to output_all(), the optional keyword arguments tie_identical_pitches and fill_with_rests are available.

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 4),
...                              )
>>> notes = looper.output_n(2)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Tip

All methods that return an abjad.Selection will add an initial time signature to it. The output_n() and output_all() methods automatically remove repeated time signatures. When joining selections output by multiple method calls, use auxjad.mutate.remove_repeated_time_signatures() on the whole container after fusing the selections to remove any unecessary time signature changes.

omit_time_signatures:

To disable time signatures altogether, initialise this class with the keyword argument omit_time_signatures set to True (default is False), or use the omit_time_signatures property after initialisation.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              omit_time_signatures=True,
...                              )
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

after_rest:

To append rests after the output (useful to create separations between consecutive windows), set the keyword argument after_rest to an int, float, tuple, or abjad.Duration with the total length of the rests. Setting it to abjad.Duration(0) will disable rests (which is the default value).

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 16),
...                              after_rest=(1, 4),
...                              )
>>> notes = looper.output_n(3)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

after_rest_in_new_measure:

When using after rests, the keyword argument after_rest_in_new_measure controls whether or not the rests are appended to the same output measure or to a new one.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 16),
...                              after_rest=(1, 4),
...                              after_rest_in_new_measure=True,
...                              )
>>> notes = looper.output_n(3)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

use_multimeasure_rests:

When after rests are used and after_rest_in_new_measure is set to True, multi-measure rests are automatically used. To use regular rests, set use_multimeasure_rests to False.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 16),
...                              after_rest=(1, 4),
...                              after_rest_in_new_measure=True,
...                              use_multimeasure_rests=False,
...                              )
>>> notes = looper.output_n(3)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Note

Multi-measure rests will not be used if omit_time_signatures is True, regardless of the value of use_multimeasure_rests.

window_size:

To change the size of the looping window after instantiation, use the property window_size. In the example below, the initial window is of size (4, 4), but changes to (3, 8) after three calls.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              )
>>> notes = looper.output_n(3)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

>>> looper.window_size = (3, 8)
>>> notes = looper.output_n(3)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

contents:

Use the contents property to read as well as overwrite the contents of the looper. Notice that the head_position will remain on its previous value and must be reset to 0 if that’s required.

>>> container = abjad.Container(r"c'4 d'2 e'4 f'2 ~ f'8 g'4.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              )
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

>>> looper.contents = abjad.Container(r"c'16 d'16 e'16 f'16 g'2. a'1")
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

>>> looper.head_position = 0
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Indicators:

This class can handle dynamics, articulations and slurs. When a leaf is shortened by the looping window’s movement, the dynamics and articulations are still applied to it.

>>> container = abjad.Container(
...     r"c'4-.\p\< d'2--\f e'4->\ppp f'2 ~ f'8"
... )
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              )
>>> notes = looper.output_n(2)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Tip

The functions auxjad.mutate.remove_repeated_dynamics() and auxjad.mutate.reposition_clefs() can be used to clean the output and remove repeated dynamics and unnecessary clef changes.

Warning

Do note that some elements that span multiple notes (such as ottava indicators, manual beams, etc.) can become problematic when notes containing them are split into two. As a rule of thumb, it is always better to attach those to the music after the fading process has ended.

disable_rewrite_meter:

By default, this class uses the abjad.Meter.rewrite_meter() mutation.

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4 g'4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 16),
...                              )
>>> notes = looper.output_n(2)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Set disable_rewrite_meter to True in order to disable this behaviour.

>>> container = abjad.Container(r"c'4 d'4 e'4 f'4 g'4")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 16),
...                              disable_rewrite_meter=True,
...                              )
>>> notes = looper.output_n(2)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Tweaking abjad.Meter.rewrite_meter():

This class uses the default logical tie splitting algorithm from abjad.Meter.rewrite_meter().

>>> container = abjad.Container(r"c'4. d'8 e'2")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              )
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Set boundary_depth to a different number to change its behaviour.

>>> looper = auxjad.WindowLooper(container,
...                              window_size=(4, 4),
...                              step_size=(1, 16),
...                              boundary_depth=1,
...                              )
>>> notes = looper()
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Other arguments available for tweaking the output of abjad.Meter.rewrite_meter() are maximum_dot_count and rewrite_tuplets, which work exactly as the identically named arguments of abjad.Meter.rewrite_meter().

This class also accepts the arguments fuse_across_groups_of_beats, fuse_quadruple_meter, fuse_triple_meter, and extract_trivial_tuplets, which are passed on to auxjad.mutate.prettify_rewrite_meter() (the latter can be disabled by setting prettify_rewrite_meter to False). See the documentation of this function for more details on these arguments.

Warning

This class can handle tuplets, but the output is often quite complex. Although the result will be rhythmically correct, consecutive tuplets are not fused together, and tuplets may be output off-beat. This functionality should be considered experimental.

>>> container = abjad.Container(r"\times 2/3 {c'8 d'8 e'8} d'2.")
>>> looper = auxjad.WindowLooper(container,
...                              window_size=(3, 4),
...                              step_size=(1, 16),
...                              )
>>> notes = looper.output_n(3)
>>> staff = abjad.Staff(notes)
>>> abjad.show(staff)

Methods

__call__()	Calls the looping process for one iteration, returning an abjad.Selection.
__init__(contents, *, window_size, step_size)	Initialises self.
__iter__()	Returns an iterator, allowing instances to be used as iterators.
__len__()	Returns the length of contents in terms of step_size.
__next__()	Calls the looping process for one iteration, returning an abjad.Selection.
__repr__()	Returns interpreter representation of contents.
output_all(*[, tie_identical_pitches])	Goes through the whole looping process and outputs a single abjad.Selection.
output_n(n, *[, tie_identical_pitches])	Goes through n iterations of the looping process and outputs a single abjad.Selection.

Attributes

after_rest	Sets the length of the rest appended at the end of the window (default is 0).
after_rest_in_new_measure	If True, then after rests will be added to their own measure (default is False).
boundary_depth	Sets the argument boundary_depth of abjad.Meter.rewrite_meter().
contents	The abjad.Container to be sliced and looped.
current_window	Read-only property, returns the window at the current head position.
disable_rewrite_meter	When True, the durations of the notes in the output will not be rewritten by the abjad.Meter.rewrite_meter() mutation.
extract_trivial_tuplets	Sets the argument extract_trivial_tuplets of auxjad.mutate.prettify_rewrite_meter().
fill_with_rests	When True, the output will contain no time signatures.
forward_bias	The chance of the window moving forward instead of backwards.
fuse_across_groups_of_beats	Sets the argument fuse_across_groups_of_beats of auxjad.mutate.prettify_rewrite_meter().
fuse_quadruple_meter	Sets the argument fuse_quadruple_meter of auxjad.mutate.prettify_rewrite_meter().
fuse_triple_meter	Sets the argument fuse_triple_meter of auxjad.mutate.prettify_rewrite_meter().
head_position	The position of the head at the start of a looping window.
max_steps	The maximum number of steps per operation.
maximum_dot_count	Sets the argument maximum_dot_count of abjad.Meter.rewrite_meter().
omit_time_signatures	When True, the output will contain no time signatures.
prettify_rewrite_meter	Used to enable or disable the mutation auxjad.mutate.prettify_rewrite_meter() (default True).
process_on_first_call	If True then contents will be processed in the very first call.
repetition_chance	The chance of the head not moving, thus repeating the output.
rewrite_tuplets	Sets the argument rewrite_tuplets of abjad.Meter.rewrite_meter().
step_size	The size of each step when moving the head.
use_multimeasure_rests	If True, then multi-measure rests will be used for after rests when added to their own measure (default is True).
window_size	The length of the looping window.

__call__() → Selection

Calls the looping process for one iteration, returning an abjad.Selection.

__init__(contents: Container, *, window_size: int | float | str | tuple[int] | Duration | Meter, step_size: int | float | str | tuple[int] | Duration, max_steps: int = 1, repetition_chance: float = 0.0, forward_bias: float = 1.0, head_position: int | float | tuple[int] | Duration = 0, omit_time_signatures: bool = False, process_on_first_call: bool = False, fill_with_rests: bool = True, disable_rewrite_meter: bool = False, boundary_depth: int | None = None, maximum_dot_count: int | None = None, rewrite_tuplets: bool = True, prettify_rewrite_meter: bool = True, extract_trivial_tuplets: bool = True, fuse_across_groups_of_beats: bool = True, fuse_quadruple_meter: bool = True, fuse_triple_meter: bool = True, after_rest: int | float | str | tuple[int] | Duration | Rest = 0, after_rest_in_new_measure: bool = False, use_multimeasure_rests: bool = True) → None

Initialises self.

__iter__() → None

Returns an iterator, allowing instances to be used as iterators.

__len__() → int

Returns the length of contents in terms of step_size.

__next__() → Selection

Calls the looping process for one iteration, returning an abjad.Selection.

__repr__() → str

Returns interpreter representation of contents.

property after_rest: Duration

Sets the length of the rest appended at the end of the window (default is 0).

property after_rest_in_new_measure: bool

If True, then after rests will be added to their own measure (default is False).

property boundary_depth: int | None

Sets the argument boundary_depth of abjad.Meter.rewrite_meter().

property contents: Container

The abjad.Container to be sliced and looped.

property current_window: Selection | None

Read-only property, returns the window at the current head position.

property disable_rewrite_meter: bool

When True, the durations of the notes in the output will not be rewritten by the abjad.Meter.rewrite_meter() mutation. Rests will have the same duration as the logical ties they replaced.

property extract_trivial_tuplets: bool

Sets the argument extract_trivial_tuplets of auxjad.mutate.prettify_rewrite_meter().

property fill_with_rests: bool

When True, the output will contain no time signatures.

property forward_bias: float

The chance of the window moving forward instead of backwards. It should range from 0.0 to 1.0 (default 1.0, which means the window can only move forwards. A value of 0.5 gives \(50\%\) chance of moving forwards while a value of 0.0 will move the window only backwards).

property fuse_across_groups_of_beats: bool

Sets the argument fuse_across_groups_of_beats of auxjad.mutate.prettify_rewrite_meter().

property fuse_quadruple_meter: bool

Sets the argument fuse_quadruple_meter of auxjad.mutate.prettify_rewrite_meter().

property fuse_triple_meter: bool

Sets the argument fuse_triple_meter of auxjad.mutate.prettify_rewrite_meter().

property head_position: Duration

The position of the head at the start of a looping window.

property max_steps: int

The maximum number of steps per operation.

property maximum_dot_count: int | None

Sets the argument maximum_dot_count of abjad.Meter.rewrite_meter().

property omit_time_signatures: bool

When True, the output will contain no time signatures.

output_all(*, tie_identical_pitches: bool = False) → Selection

Goes through the whole looping process and outputs a single abjad.Selection.

output_n(n: int, *, tie_identical_pitches: bool = False) → Selection

Goes through n iterations of the looping process and outputs a single abjad.Selection.

property prettify_rewrite_meter: bool

Used to enable or disable the mutation auxjad.mutate.prettify_rewrite_meter() (default True).

property process_on_first_call: bool

If True then contents will be processed in the very first call.

property repetition_chance: float

The chance of the head not moving, thus repeating the output.

property rewrite_tuplets: bool

Sets the argument rewrite_tuplets of abjad.Meter.rewrite_meter().

property step_size: Duration

The size of each step when moving the head.

property use_multimeasure_rests: bool

If True, then multi-measure rests will be used for after rests when added to their own measure (default is True).

property window_size: Meter

The length of the looping window.