.. _moduleMeterBase:

music21.meter.base
==================

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.meter.base

TimeSignature
-------------

.. autoclass:: music21.meter.base.TimeSignature

.. rubric:: :class:`~music21.meter.base.TimeSignature` bases

- :class:`~music21.meter.base.TimeSignatureBase`
- :class:`~music21.base.Music21Object`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.meter.base.TimeSignature` read-only properties

.. autoattribute:: music21.meter.base.TimeSignature.beatCountName

.. autoattribute:: music21.meter.base.TimeSignature.beatDivisionCount

.. autoattribute:: music21.meter.base.TimeSignature.beatDivisionCountName

.. autoattribute:: music21.meter.base.TimeSignature.beatDivisionDurations

.. autoattribute:: music21.meter.base.TimeSignature.beatDuration

.. autoattribute:: music21.meter.base.TimeSignature.beatLengthToQuarterLengthRatio

.. autoattribute:: music21.meter.base.TimeSignature.beatSubDivisionDurations

.. autoattribute:: music21.meter.base.TimeSignature.classification

.. autoattribute:: music21.meter.base.TimeSignature.quarterLengthToBeatLengthRatio

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.hasEditorialInformation`
   - :attr:`~music21.base.Music21Object.hasStyleInformation`
   - :attr:`~music21.base.Music21Object.measureNumber`

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.meter.base.TimeSignature` read/write properties

.. autoattribute:: music21.meter.base.TimeSignature.barDuration

.. autoattribute:: music21.meter.base.TimeSignature.beatCount

.. autoattribute:: music21.meter.base.TimeSignature.denominator

.. autoattribute:: music21.meter.base.TimeSignature.numerator

.. autoattribute:: music21.meter.base.TimeSignature.ratioString

.. autoattribute:: music21.meter.base.TimeSignature.summedNumerator

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.editorial`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`
   - :attr:`~music21.base.Music21Object.style`

.. rubric:: :class:`~music21.meter.base.TimeSignature` methods

.. automethod:: music21.meter.base.TimeSignature.averageBeatStrength

.. automethod:: music21.meter.base.TimeSignature.getAccent

.. automethod:: music21.meter.base.TimeSignature.getAccentWeight

.. automethod:: music21.meter.base.TimeSignature.getBeams

.. automethod:: music21.meter.base.TimeSignature.getBeat

.. automethod:: music21.meter.base.TimeSignature.getBeatDepth

.. automethod:: music21.meter.base.TimeSignature.getBeatDuration

.. automethod:: music21.meter.base.TimeSignature.getBeatOffsets

.. automethod:: music21.meter.base.TimeSignature.getBeatProgress

.. automethod:: music21.meter.base.TimeSignature.getBeatProportion

.. automethod:: music21.meter.base.TimeSignature.getBeatProportionStr

.. automethod:: music21.meter.base.TimeSignature.getMeasureOffsetOrMeterModulusOffset

.. automethod:: music21.meter.base.TimeSignature.getOffsetFromBeat

.. automethod:: music21.meter.base.TimeSignature.load

.. automethod:: music21.meter.base.TimeSignature.ratioEqual

.. automethod:: music21.meter.base.TimeSignature.resetValues

.. automethod:: music21.meter.base.TimeSignature.setAccentWeight

.. automethod:: music21.meter.base.TimeSignature.setDisplay

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.clearCache`
   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getOffsetInHierarchy`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.next`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.meter.base.TimeSignature` instance variables

.. attribute:: TimeSignature.accentSequence

	A :class:`~music21.meter.MeterSequence` governing accent partitioning.

.. attribute:: TimeSignature.beamSequence

	A :class:`~music21.meter.MeterSequence` governing automatic beaming.

.. attribute:: TimeSignature.beatSequence

	A :class:`~music21.meter.MeterSequence` governing beat partitioning.

.. attribute:: TimeSignature.displaySequence

	
	A :class:`~music21.meter.MeterSequence` governing the display of the TimeSignature.

.. attribute:: TimeSignature.symbol

	
	A string representation of how to display the TimeSignature.
	can be "common", "cut", "single-number" (i.e.,
	no denominator), or "normal" or "".

.. attribute:: TimeSignature.symbolizeDenominator

	
	If set to `True` (default is `False`) then the denominator
	will be displayed as a symbol rather than
	a number.  Hindemith uses this in his scores.
	Finale and other MusicXML readers do not support this
	so do not expect proper output yet.

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.sites`

SenzaMisuraTimeSignature
------------------------

.. autoclass:: music21.meter.base.SenzaMisuraTimeSignature

.. rubric:: :class:`~music21.meter.base.SenzaMisuraTimeSignature` bases

- :class:`~music21.meter.base.TimeSignatureBase`
- :class:`~music21.base.Music21Object`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.meter.base.SenzaMisuraTimeSignature` read-only properties

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatDuration`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.hasEditorialInformation`
   - :attr:`~music21.base.Music21Object.hasStyleInformation`
   - :attr:`~music21.base.Music21Object.measureNumber`

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.meter.base.SenzaMisuraTimeSignature` read/write properties

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.editorial`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`
   - :attr:`~music21.base.Music21Object.style`

.. rubric:: :class:`~music21.meter.base.SenzaMisuraTimeSignature` methods

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.clearCache`
   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getOffsetInHierarchy`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.next`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.meter.base.SenzaMisuraTimeSignature` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.sites`

TimeSignatureBase
-----------------

.. autoclass:: music21.meter.base.TimeSignatureBase

.. rubric:: :class:`~music21.meter.base.TimeSignatureBase` bases

- :class:`~music21.base.Music21Object`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.meter.base.TimeSignatureBase` read-only properties

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatDuration`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.hasEditorialInformation`
   - :attr:`~music21.base.Music21Object.hasStyleInformation`
   - :attr:`~music21.base.Music21Object.measureNumber`

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.meter.base.TimeSignatureBase` read/write properties

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.editorial`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`
   - :attr:`~music21.base.Music21Object.style`

.. rubric:: :class:`~music21.meter.base.TimeSignatureBase` methods

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.clearCache`
   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getOffsetInHierarchy`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.next`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.meter.base.TimeSignatureBase` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.sites`

Functions
---------

.. autofunction:: music21.meter.base.bestTimeSignature
