.. _moduleDuration: music21.duration ================ .. WARNING: DO NOT EDIT THIS FILE: AUTOMATICALLY GENERATED. PLEASE EDIT THE .py FILE DIRECTLY. .. automodule:: music21.duration Duration -------- .. autoclass:: music21.duration.Duration .. rubric:: :class:`~music21.duration.Duration` bases - :class:`~music21.prebase.ProtoM21Object` - :class:`~music21.common.objects.SlottedObjectMixin` .. rubric:: :class:`~music21.duration.Duration` read-only properties .. autoattribute:: music21.duration.Duration.fullName .. autoattribute:: music21.duration.Duration.isComplex .. autoattribute:: music21.duration.Duration.ordinal .. autoattribute:: music21.duration.Duration.quarterLengthNoTuplets Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :attr:`~music21.prebase.ProtoM21Object.classSet` - :attr:`~music21.prebase.ProtoM21Object.classes` .. rubric:: :class:`~music21.duration.Duration` read/write properties .. autoattribute:: music21.duration.Duration.components .. autoattribute:: music21.duration.Duration.dotGroups .. autoattribute:: music21.duration.Duration.dots .. autoattribute:: music21.duration.Duration.linked .. autoattribute:: music21.duration.Duration.quarterLength .. autoattribute:: music21.duration.Duration.tuplets .. autoattribute:: music21.duration.Duration.type .. rubric:: :class:`~music21.duration.Duration` methods .. automethod:: music21.duration.Duration.__eq__ .. automethod:: music21.duration.Duration.addDurationTuple .. automethod:: music21.duration.Duration.aggregateTupletMultiplier .. automethod:: music21.duration.Duration.appendTuplet .. automethod:: music21.duration.Duration.augmentOrDiminish .. automethod:: music21.duration.Duration.clear .. automethod:: music21.duration.Duration.componentIndexAtQtrPosition .. automethod:: music21.duration.Duration.componentStartTime .. automethod:: music21.duration.Duration.consolidate .. automethod:: music21.duration.Duration.currentComponents .. automethod:: music21.duration.Duration.getGraceDuration .. automethod:: music21.duration.Duration.informClient .. automethod:: music21.duration.Duration.sliceComponentAtPosition .. automethod:: music21.duration.Duration.splitDotGroups Methods inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass` .. rubric:: :class:`~music21.duration.Duration` instance variables .. attribute:: Duration.client A duration's "client" is the object that holds this duration as a property. It is informed whenever the duration changes. >>> n = note.Note('C#5', type='whole') >>> d = n.duration >>> d.client is n True .. attribute:: Duration.expressionIsInferred Boolean indicating whether this duration was created from a number rather than a type and thus can be changed to another expression. For instance the duration of 0.5 is generally an eighth note, but in the middle of a triplet group might be better written as a dotted-eighth triplet. If expressionIsInferred is True then `music21` can change it according to complex. If False, then the type, dots, and tuplets are considered immutable. >>> d = duration.Duration(0.5) >>> d.expressionIsInferred True >>> d = duration.Duration('eighth') >>> d.expressionIsInferred False Tuplet ------ .. autoclass:: music21.duration.Tuplet .. rubric:: :class:`~music21.duration.Tuplet` bases - :class:`~music21.prebase.ProtoM21Object` .. rubric:: :class:`~music21.duration.Tuplet` read-only properties .. autoattribute:: music21.duration.Tuplet.fullName Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :attr:`~music21.prebase.ProtoM21Object.classSet` - :attr:`~music21.prebase.ProtoM21Object.classes` .. rubric:: :class:`~music21.duration.Tuplet` read/write properties .. autoattribute:: music21.duration.Tuplet.durationActual .. autoattribute:: music21.duration.Tuplet.durationNormal .. autoattribute:: music21.duration.Tuplet.tupletActual .. autoattribute:: music21.duration.Tuplet.tupletNormal .. rubric:: :class:`~music21.duration.Tuplet` methods .. automethod:: music21.duration.Tuplet.__eq__ .. automethod:: music21.duration.Tuplet.augmentOrDiminish .. automethod:: music21.duration.Tuplet.setDurationType .. automethod:: music21.duration.Tuplet.setRatio .. automethod:: music21.duration.Tuplet.totalTupletLength .. automethod:: music21.duration.Tuplet.tupletMultiplier Methods inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass` GraceDuration ------------- .. autoclass:: music21.duration.GraceDuration .. rubric:: :class:`~music21.duration.GraceDuration` bases - :class:`~music21.duration.Duration` - :class:`~music21.prebase.ProtoM21Object` - :class:`~music21.common.objects.SlottedObjectMixin` .. rubric:: :class:`~music21.duration.GraceDuration` read-only properties Read-only properties inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.fullName` - :attr:`~music21.duration.Duration.isComplex` - :attr:`~music21.duration.Duration.ordinal` - :attr:`~music21.duration.Duration.quarterLengthNoTuplets` Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :attr:`~music21.prebase.ProtoM21Object.classSet` - :attr:`~music21.prebase.ProtoM21Object.classes` .. rubric:: :class:`~music21.duration.GraceDuration` read/write properties .. autoattribute:: music21.duration.GraceDuration.makeTime .. autoattribute:: music21.duration.GraceDuration.slash Read/write properties inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.components` - :attr:`~music21.duration.Duration.dotGroups` - :attr:`~music21.duration.Duration.dots` - :attr:`~music21.duration.Duration.linked` - :attr:`~music21.duration.Duration.quarterLength` - :attr:`~music21.duration.Duration.tuplets` - :attr:`~music21.duration.Duration.type` .. rubric:: :class:`~music21.duration.GraceDuration` methods Methods inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :meth:`~music21.duration.Duration.__eq__` - :meth:`~music21.duration.Duration.addDurationTuple` - :meth:`~music21.duration.Duration.aggregateTupletMultiplier` - :meth:`~music21.duration.Duration.appendTuplet` - :meth:`~music21.duration.Duration.augmentOrDiminish` - :meth:`~music21.duration.Duration.clear` - :meth:`~music21.duration.Duration.componentIndexAtQtrPosition` - :meth:`~music21.duration.Duration.componentStartTime` - :meth:`~music21.duration.Duration.consolidate` - :meth:`~music21.duration.Duration.currentComponents` - :meth:`~music21.duration.Duration.getGraceDuration` - :meth:`~music21.duration.Duration.informClient` - :meth:`~music21.duration.Duration.sliceComponentAtPosition` - :meth:`~music21.duration.Duration.splitDotGroups` Methods inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass` .. rubric:: :class:`~music21.duration.GraceDuration` instance variables .. attribute:: GraceDuration.stealTimeFollowing Float number from 0.0 to 1.0 or None (default) for the proportion of the following duration to steal from the following note. .. attribute:: GraceDuration.stealTimePrevious Float number from 0.0 to 1.0, or None (default) for the proportion of the previous duration to steal from the previous note. Instance variables inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.client` - :attr:`~music21.duration.Duration.expressionIsInferred` TupletFixer ----------- .. autoclass:: music21.duration.TupletFixer .. rubric:: :class:`~music21.duration.TupletFixer` methods .. automethod:: music21.duration.TupletFixer.findTupletGroups .. automethod:: music21.duration.TupletFixer.fixBrokenTupletDuration .. automethod:: music21.duration.TupletFixer.setStream AppoggiaturaDuration -------------------- .. autoclass:: music21.duration.AppoggiaturaDuration .. rubric:: :class:`~music21.duration.AppoggiaturaDuration` bases - :class:`~music21.duration.GraceDuration` - :class:`~music21.duration.Duration` - :class:`~music21.prebase.ProtoM21Object` - :class:`~music21.common.objects.SlottedObjectMixin` .. rubric:: :class:`~music21.duration.AppoggiaturaDuration` read-only properties Read-only properties inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.fullName` - :attr:`~music21.duration.Duration.isComplex` - :attr:`~music21.duration.Duration.ordinal` - :attr:`~music21.duration.Duration.quarterLengthNoTuplets` Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :attr:`~music21.prebase.ProtoM21Object.classSet` - :attr:`~music21.prebase.ProtoM21Object.classes` .. rubric:: :class:`~music21.duration.AppoggiaturaDuration` read/write properties Read/write properties inherited from :class:`~music21.duration.GraceDuration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.GraceDuration.makeTime` - :attr:`~music21.duration.GraceDuration.slash` Read/write properties inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.components` - :attr:`~music21.duration.Duration.dotGroups` - :attr:`~music21.duration.Duration.dots` - :attr:`~music21.duration.Duration.linked` - :attr:`~music21.duration.Duration.quarterLength` - :attr:`~music21.duration.Duration.tuplets` - :attr:`~music21.duration.Duration.type` .. rubric:: :class:`~music21.duration.AppoggiaturaDuration` methods Methods inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :meth:`~music21.duration.Duration.__eq__` - :meth:`~music21.duration.Duration.addDurationTuple` - :meth:`~music21.duration.Duration.aggregateTupletMultiplier` - :meth:`~music21.duration.Duration.appendTuplet` - :meth:`~music21.duration.Duration.augmentOrDiminish` - :meth:`~music21.duration.Duration.clear` - :meth:`~music21.duration.Duration.componentIndexAtQtrPosition` - :meth:`~music21.duration.Duration.componentStartTime` - :meth:`~music21.duration.Duration.consolidate` - :meth:`~music21.duration.Duration.currentComponents` - :meth:`~music21.duration.Duration.getGraceDuration` - :meth:`~music21.duration.Duration.informClient` - :meth:`~music21.duration.Duration.sliceComponentAtPosition` - :meth:`~music21.duration.Duration.splitDotGroups` Methods inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass` .. rubric:: :class:`~music21.duration.AppoggiaturaDuration` instance variables Instance variables inherited from :class:`~music21.duration.GraceDuration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.GraceDuration.stealTimeFollowing` - :attr:`~music21.duration.GraceDuration.stealTimePrevious` Instance variables inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.client` - :attr:`~music21.duration.Duration.expressionIsInferred` DurationTuple ------------- .. autoclass:: music21.duration.DurationTuple .. rubric:: :class:`~music21.duration.DurationTuple` read-only properties .. autoattribute:: music21.duration.DurationTuple.ordinal .. rubric:: :class:`~music21.duration.DurationTuple` methods .. automethod:: music21.duration.DurationTuple.augmentOrDiminish FrozenDuration -------------- .. autoclass:: music21.duration.FrozenDuration .. rubric:: :class:`~music21.duration.FrozenDuration` bases - :class:`~music21.common.objects.FrozenObject` - :class:`~music21.common.objects.EqualSlottedObjectMixin` - :class:`~music21.duration.Duration` - :class:`~music21.prebase.ProtoM21Object` - :class:`~music21.common.objects.SlottedObjectMixin` .. rubric:: :class:`~music21.duration.FrozenDuration` read-only properties Read-only properties inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.fullName` - :attr:`~music21.duration.Duration.isComplex` - :attr:`~music21.duration.Duration.ordinal` - :attr:`~music21.duration.Duration.quarterLengthNoTuplets` Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :attr:`~music21.prebase.ProtoM21Object.classSet` - :attr:`~music21.prebase.ProtoM21Object.classes` .. rubric:: :class:`~music21.duration.FrozenDuration` read/write properties Read/write properties inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.components` - :attr:`~music21.duration.Duration.dotGroups` - :attr:`~music21.duration.Duration.dots` - :attr:`~music21.duration.Duration.linked` - :attr:`~music21.duration.Duration.quarterLength` - :attr:`~music21.duration.Duration.tuplets` - :attr:`~music21.duration.Duration.type` .. rubric:: :class:`~music21.duration.FrozenDuration` methods Methods inherited from :class:`~music21.common.objects.EqualSlottedObjectMixin`: .. hlist:: :columns: 3 - :meth:`~music21.common.objects.EqualSlottedObjectMixin.__eq__` Methods inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :meth:`~music21.duration.Duration.addDurationTuple` - :meth:`~music21.duration.Duration.aggregateTupletMultiplier` - :meth:`~music21.duration.Duration.appendTuplet` - :meth:`~music21.duration.Duration.augmentOrDiminish` - :meth:`~music21.duration.Duration.clear` - :meth:`~music21.duration.Duration.componentIndexAtQtrPosition` - :meth:`~music21.duration.Duration.componentStartTime` - :meth:`~music21.duration.Duration.consolidate` - :meth:`~music21.duration.Duration.currentComponents` - :meth:`~music21.duration.Duration.getGraceDuration` - :meth:`~music21.duration.Duration.informClient` - :meth:`~music21.duration.Duration.sliceComponentAtPosition` - :meth:`~music21.duration.Duration.splitDotGroups` Methods inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass` .. rubric:: :class:`~music21.duration.FrozenDuration` instance variables Instance variables inherited from :class:`~music21.duration.Duration`: .. hlist:: :columns: 3 - :attr:`~music21.duration.Duration.client` - :attr:`~music21.duration.Duration.expressionIsInferred` QuarterLengthConversion ----------------------- .. autoclass:: music21.duration.QuarterLengthConversion Functions --------- .. autofunction:: music21.duration.convertQuarterLengthToType .. autofunction:: music21.duration.convertTypeToNumber .. autofunction:: music21.duration.convertTypeToQuarterLength .. autofunction:: music21.duration.dottedMatch .. autofunction:: music21.duration.durationTupleFromQuarterLength .. autofunction:: music21.duration.durationTupleFromTypeDots .. autofunction:: music21.duration.nextLargerType .. autofunction:: music21.duration.nextSmallerType .. autofunction:: music21.duration.quarterLengthToClosestType .. autofunction:: music21.duration.quarterLengthToNonPowerOf2Tuplet .. autofunction:: music21.duration.quarterLengthToTuplet .. autofunction:: music21.duration.unitSpec