.. _moduleMedren:

music21.medren
==============

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

.. automodule:: music21.medren

Functions
---------

.. autofunction:: music21.medren.breakMensuralStreamIntoBrevisLengths

.. autofunction:: music21.medren.convertHouseStyle

.. autofunction:: music21.medren.cummingSchubertStrettoFuga

.. autofunction:: music21.medren.scaleDurations

.. autofunction:: music21.medren.setBarlineStyle

.. autofunction:: music21.medren.testStretto

.. autofunction:: music21.medren.transferTies

GeneralMensuralNote
-------------------

.. autoclass:: music21.medren.GeneralMensuralNote

.. rubric:: :class:`~music21.medren.GeneralMensuralNote` bases

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

.. rubric:: :class:`~music21.medren.GeneralMensuralNote` 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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.medren.GeneralMensuralNote` read/write properties

.. autoattribute:: music21.medren.GeneralMensuralNote.mensuralType

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.medren.GeneralMensuralNote` methods

.. automethod:: music21.medren.GeneralMensuralNote.updateDurationFromMensuration

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :meth:`~music21.base.Music21Object.isClassOrSubclass`
   - :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.removeLocationBySite`
   - :meth:`~music21.base.Music21Object.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.medren.GeneralMensuralNote` instance variables

.. attribute:: GeneralMensuralNote.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: GeneralMensuralNote.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: GeneralMensuralNote.hideObjectOnPrint

	if set to `True` will not print upon output (only used in MusicXML output at this point and Lilypond for notes, chords, and rests).

.. attribute:: GeneralMensuralNote.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: GeneralMensuralNote.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: GeneralMensuralNote.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: GeneralMensuralNote.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: GeneralMensuralNote.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isVariant`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isSpanner`
   - :attr:`~music21.base.Music21Object.xPosition`

Ligature
--------

.. autoclass:: music21.medren.Ligature

.. rubric:: :class:`~music21.medren.Ligature` bases

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

.. rubric:: :class:`~music21.medren.Ligature` read-only properties

.. autoattribute:: music21.medren.Ligature.notes

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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.medren.Ligature` read/write properties

.. autoattribute:: music21.medren.Ligature.pitches

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.medren.Ligature` methods

.. automethod:: music21.medren.Ligature.getColor

.. automethod:: music21.medren.Ligature.getFillStatus

.. automethod:: music21.medren.Ligature.getNoteheadShape

.. automethod:: music21.medren.Ligature.getStem

.. automethod:: music21.medren.Ligature.isCOP

.. automethod:: music21.medren.Ligature.isCumPerfectione

.. automethod:: music21.medren.Ligature.isCumProprietate

.. automethod:: music21.medren.Ligature.isMaxima

.. automethod:: music21.medren.Ligature.isReversed

.. automethod:: music21.medren.Ligature.makeOblique

.. automethod:: music21.medren.Ligature.makeSquare

.. automethod:: music21.medren.Ligature.setColor

.. automethod:: music21.medren.Ligature.setFillStatus

.. automethod:: music21.medren.Ligature.setMaxima

.. automethod:: music21.medren.Ligature.setReverse

.. automethod:: music21.medren.Ligature.setStem

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :meth:`~music21.base.Music21Object.isClassOrSubclass`
   - :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.removeLocationBySite`
   - :meth:`~music21.base.Music21Object.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.medren.Ligature` instance variables

.. attribute:: Ligature.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: Ligature.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: Ligature.hideObjectOnPrint

	if set to `True` will not print upon output (only used in MusicXML output at this point and Lilypond for notes, chords, and rests).

.. attribute:: Ligature.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: Ligature.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: Ligature.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: Ligature.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: Ligature.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isVariant`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isSpanner`
   - :attr:`~music21.base.Music21Object.xPosition`

MensuralClef
------------

.. autoclass:: music21.medren.MensuralClef

.. rubric:: :class:`~music21.medren.MensuralClef` bases

- :class:`~music21.clef.Clef`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.medren.MensuralClef` read-only properties

.. autoattribute:: music21.medren.MensuralClef.fontString

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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.medren.MensuralClef` read/write properties

.. autoattribute:: music21.medren.MensuralClef.line

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.medren.MensuralClef` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :meth:`~music21.base.Music21Object.isClassOrSubclass`
   - :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.removeLocationBySite`
   - :meth:`~music21.base.Music21Object.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.medren.MensuralClef` instance variables

.. attribute:: MensuralClef.classSortOrder

	Property which returns an number (int or otherwise)
	depending on the class of the Music21Object that
	represents a priority for an object based on its class alone --
	used as a tie for stream sorting in case two objects have the
	same offset and priority.  Lower numbers are sorted to the left
	of higher numbers.  For instance, Clef, KeySignature, TimeSignature
	all come (in that order) before Note.
	
	All undefined classes have classSortOrder of 20 -- same as note.Note
	
	
	>>> m21o = base.Music21Object()
	>>> m21o.classSortOrder
	20
	
	>>> tc = clef.TrebleClef()
	>>> tc.classSortOrder
	0
	
	>>> ks = key.KeySignature(3)
	>>> ks.classSortOrder
	1
	
	
	New classes can define their own default classSortOrder
	
	>>> class ExampleClass(base.Music21Object):
	...     classSortOrderDefault = 5
	...
	>>> ec1 = ExampleClass()
	>>> ec1.classSortOrder
	5
	

.. attribute:: MensuralClef.groups

	An instance of a :class:`~music21.base.Group` object which describes arbitrary `Groups` that this object belongs to.

.. attribute:: MensuralClef.hideObjectOnPrint

	if set to `True` will not print upon output (only used in MusicXML output at this point and Lilypond for notes, chords, and rests).

.. attribute:: MensuralClef.id

	A unique identification string (not to be confused with the default `.id()` method.

.. attribute:: MensuralClef.isSpanner

	Boolean value for quickly identifying :class:`~music21.spanner.Spanner` objects (False by default).

.. attribute:: MensuralClef.isStream

	Boolean value for quickly identifying :class:`~music21.stream.Stream` objects (False by default).

.. attribute:: MensuralClef.isVariant

	Boolean value for quickly identifying :class:`~music21.variant.Variant` objects (False by default).

.. attribute:: MensuralClef.xPosition

	if set, defines the display x-position from the start of the container (in musicxml "tenths" by default)

Instance variables inherited from :class:`~music21.clef.Clef`:

.. hlist::
   :columns: 3

   - :attr:`~music21.clef.Clef.isStream`
   - :attr:`~music21.clef.Clef.hideObjectOnPrint`
   - :attr:`~music21.clef.Clef.classSortOrder`
   - :attr:`~music21.clef.Clef.groups`
   - :attr:`~music21.clef.Clef.isVariant`
   - :attr:`~music21.clef.Clef.id`
   - :attr:`~music21.clef.Clef.isSpanner`
   - :attr:`~music21.clef.Clef.xPosition`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isVariant`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isSpanner`
   - :attr:`~music21.base.Music21Object.xPosition`

MensuralNote
------------

.. autoclass:: music21.medren.MensuralNote

.. rubric:: :class:`~music21.medren.MensuralNote` bases

- :class:`~music21.medren.GeneralMensuralNote`
- :class:`~music21.note.Note`
- :class:`~music21.note.NotRest`
- :class:`~music21.note.GeneralNote`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.medren.MensuralNote` read-only properties

.. autoattribute:: music21.medren.MensuralNote.fontString

.. autoattribute:: music21.medren.MensuralNote.fullName

Read-only properties inherited from :class:`~music21.note.Note`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.Note.diatonicNoteNum`

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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.medren.MensuralNote` read/write properties

.. autoattribute:: music21.medren.MensuralNote.color

.. autoattribute:: music21.medren.MensuralNote.mensuralType

Read/write properties inherited from :class:`~music21.note.Note`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.Note.accidental`
   - :attr:`~music21.note.Note.frequency`
   - :attr:`~music21.note.Note.microtone`
   - :attr:`~music21.note.Note.midi`
   - :attr:`~music21.note.Note.name`
   - :attr:`~music21.note.Note.nameWithOctave`
   - :attr:`~music21.note.Note.octave`
   - :attr:`~music21.note.Note.pitchClass`
   - :attr:`~music21.note.Note.pitchClassString`
   - :attr:`~music21.note.Note.pitches`
   - :attr:`~music21.note.Note.ps`
   - :attr:`~music21.note.Note.step`

Read/write properties inherited from :class:`~music21.note.NotRest`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.NotRest.notehead`
   - :attr:`~music21.note.NotRest.noteheadFill`
   - :attr:`~music21.note.NotRest.noteheadParenthesis`
   - :attr:`~music21.note.NotRest.stemDirection`
   - :attr:`~music21.note.NotRest.volume`

Read/write properties inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.GeneralNote.editorial`
   - :attr:`~music21.note.GeneralNote.lyric`
   - :attr:`~music21.note.GeneralNote.quarterLength`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.medren.MensuralNote` methods

.. automethod:: music21.medren.MensuralNote.getFlags

.. automethod:: music21.medren.MensuralNote.getNumDots

.. automethod:: music21.medren.MensuralNote.getStems

.. automethod:: music21.medren.MensuralNote.setFlag

.. automethod:: music21.medren.MensuralNote.setStem

Methods inherited from :class:`~music21.medren.GeneralMensuralNote`:

.. hlist::
   :columns: 3

   - :meth:`~music21.medren.GeneralMensuralNote.updateDurationFromMensuration`

Methods inherited from :class:`~music21.note.Note`:

.. hlist::
   :columns: 3

   - :meth:`~music21.note.Note.transpose`

Methods inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :meth:`~music21.note.GeneralNote.addLyric`
   - :meth:`~music21.note.GeneralNote.augmentOrDiminish`
   - :meth:`~music21.note.GeneralNote.getGrace`
   - :meth:`~music21.note.GeneralNote.hasLyrics`
   - :meth:`~music21.note.GeneralNote.insertLyric`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :meth:`~music21.base.Music21Object.isClassOrSubclass`
   - :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.removeLocationBySite`
   - :meth:`~music21.base.Music21Object.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.medren.MensuralNote` instance variables

.. attribute:: MensuralNote.beams

	A :class:`~music21.beam.Beams` object that contains information about the beaming of this note.

.. attribute:: MensuralNote.isNote

	Boolean read-only value describing if this Note is a Note (True).

.. attribute:: MensuralNote.isRest

	Boolean read-only value describing if this Note is a Rest (False).

.. attribute:: MensuralNote.isUnpitched

	Boolean read-only value describing if this Note is Unpitched (False).

.. attribute:: MensuralNote.pitch

	A :class:`~music21.pitch.Pitch` object containing all the information about the note's pitch.  Many `.pitch` properties and methods are also made `Note` properties also

Instance variables inherited from :class:`~music21.medren.GeneralMensuralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.medren.GeneralMensuralNote.isStream`
   - :attr:`~music21.medren.GeneralMensuralNote.hideObjectOnPrint`
   - :attr:`~music21.medren.GeneralMensuralNote.classSortOrder`
   - :attr:`~music21.medren.GeneralMensuralNote.groups`
   - :attr:`~music21.medren.GeneralMensuralNote.isVariant`
   - :attr:`~music21.medren.GeneralMensuralNote.id`
   - :attr:`~music21.medren.GeneralMensuralNote.isSpanner`
   - :attr:`~music21.medren.GeneralMensuralNote.xPosition`

Instance variables inherited from :class:`~music21.note.Note`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.Note.isUnpitched`
   - :attr:`~music21.note.Note.isNote`
   - :attr:`~music21.note.Note.pitch`
   - :attr:`~music21.note.Note.isRest`
   - :attr:`~music21.note.Note.beams`

Instance variables inherited from :class:`~music21.note.NotRest`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.NotRest.lyrics`
   - :attr:`~music21.note.NotRest.beams`
   - :attr:`~music21.note.NotRest.isRest`
   - :attr:`~music21.note.NotRest.tie`
   - :attr:`~music21.note.NotRest.isChord`
   - :attr:`~music21.note.NotRest.expressions`
   - :attr:`~music21.note.NotRest.isNote`
   - :attr:`~music21.note.NotRest.articulations`

Instance variables inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.GeneralNote.lyrics`
   - :attr:`~music21.note.GeneralNote.beams`
   - :attr:`~music21.note.GeneralNote.isRest`
   - :attr:`~music21.note.GeneralNote.tie`
   - :attr:`~music21.note.GeneralNote.isChord`
   - :attr:`~music21.note.GeneralNote.expressions`
   - :attr:`~music21.note.GeneralNote.isNote`
   - :attr:`~music21.note.GeneralNote.articulations`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isVariant`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isSpanner`
   - :attr:`~music21.base.Music21Object.xPosition`

MensuralRest
------------

.. autoclass:: music21.medren.MensuralRest

.. rubric:: :class:`~music21.medren.MensuralRest` bases

- :class:`~music21.medren.GeneralMensuralNote`
- :class:`~music21.note.Rest`
- :class:`~music21.note.GeneralNote`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.medren.MensuralRest` read-only properties

.. autoattribute:: music21.medren.MensuralRest.fontString

.. autoattribute:: music21.medren.MensuralRest.fullName

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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.medren.MensuralRest` read/write properties

Read/write properties inherited from :class:`~music21.medren.GeneralMensuralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.medren.GeneralMensuralNote.mensuralType`

Read/write properties inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.GeneralNote.color`
   - :attr:`~music21.note.GeneralNote.editorial`
   - :attr:`~music21.note.GeneralNote.lyric`
   - :attr:`~music21.note.GeneralNote.quarterLength`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.medren.MensuralRest` methods

Methods inherited from :class:`~music21.medren.GeneralMensuralNote`:

.. hlist::
   :columns: 3

   - :meth:`~music21.medren.GeneralMensuralNote.updateDurationFromMensuration`

Methods inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :meth:`~music21.note.GeneralNote.addLyric`
   - :meth:`~music21.note.GeneralNote.augmentOrDiminish`
   - :meth:`~music21.note.GeneralNote.getGrace`
   - :meth:`~music21.note.GeneralNote.hasLyrics`
   - :meth:`~music21.note.GeneralNote.insertLyric`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :meth:`~music21.base.Music21Object.isClassOrSubclass`
   - :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.removeLocationBySite`
   - :meth:`~music21.base.Music21Object.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.medren.MensuralRest` instance variables

.. attribute:: MensuralRest.isNote

	Boolean read-only value describing if this Rest is a Note (False).

.. attribute:: MensuralRest.isRest

	Boolean read-only value describing if this Rest is a Rest (True, obviously).

.. attribute:: MensuralRest.isUnpitched

	Boolean read-only value describing if this Rest is Unpitched (False -- only Unpitched objects are True).

.. attribute:: MensuralRest.name

	returns "rest" always.  It is here so that you can get `x.name` on all `.notesAndRests` objects

Instance variables inherited from :class:`~music21.medren.GeneralMensuralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.medren.GeneralMensuralNote.isStream`
   - :attr:`~music21.medren.GeneralMensuralNote.hideObjectOnPrint`
   - :attr:`~music21.medren.GeneralMensuralNote.classSortOrder`
   - :attr:`~music21.medren.GeneralMensuralNote.groups`
   - :attr:`~music21.medren.GeneralMensuralNote.isVariant`
   - :attr:`~music21.medren.GeneralMensuralNote.id`
   - :attr:`~music21.medren.GeneralMensuralNote.isSpanner`
   - :attr:`~music21.medren.GeneralMensuralNote.xPosition`

Instance variables inherited from :class:`~music21.note.Rest`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.Rest.isUnpitched`
   - :attr:`~music21.note.Rest.isNote`
   - :attr:`~music21.note.Rest.isRest`
   - :attr:`~music21.note.Rest.name`

Instance variables inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.GeneralNote.lyrics`
   - :attr:`~music21.note.GeneralNote.beams`
   - :attr:`~music21.note.GeneralNote.isRest`
   - :attr:`~music21.note.GeneralNote.tie`
   - :attr:`~music21.note.GeneralNote.isChord`
   - :attr:`~music21.note.GeneralNote.expressions`
   - :attr:`~music21.note.GeneralNote.isNote`
   - :attr:`~music21.note.GeneralNote.articulations`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isVariant`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isSpanner`
   - :attr:`~music21.base.Music21Object.xPosition`

Mensuration
-----------

.. autoclass:: music21.medren.Mensuration

.. rubric:: :class:`~music21.medren.Mensuration` bases

- :class:`~music21.meter.TimeSignature`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.medren.Mensuration` read-only properties

.. autoattribute:: music21.medren.Mensuration.fontString

Read-only properties inherited from :class:`~music21.meter.TimeSignature`:

.. hlist::
   :columns: 3

   - :attr:`~music21.meter.TimeSignature.beatCountName`
   - :attr:`~music21.meter.TimeSignature.beatDivisionCount`
   - :attr:`~music21.meter.TimeSignature.beatDivisionCountName`
   - :attr:`~music21.meter.TimeSignature.beatDivisionDurations`
   - :attr:`~music21.meter.TimeSignature.beatDuration`
   - :attr:`~music21.meter.TimeSignature.beatLengthToQuarterLengthRatio`
   - :attr:`~music21.meter.TimeSignature.beatSubDivisionDurations`
   - :attr:`~music21.meter.TimeSignature.classification`
   - :attr:`~music21.meter.TimeSignature.quarterLengthToBeatLengthRatio`
   - :attr:`~music21.meter.TimeSignature.totalLength`

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.classes`
   - :attr:`~music21.base.Music21Object.derivationHierarchy`
   - :attr:`~music21.base.Music21Object.fullyQualifiedClasses`
   - :attr:`~music21.base.Music21Object.isGrace`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.medren.Mensuration` read/write properties

.. autoattribute:: music21.medren.Mensuration.minimaPerBrevis

Read/write properties inherited from :class:`~music21.meter.TimeSignature`:

.. hlist::
   :columns: 3

   - :attr:`~music21.meter.TimeSignature.barDuration`
   - :attr:`~music21.meter.TimeSignature.beatCount`
   - :attr:`~music21.meter.TimeSignature.denominator`
   - :attr:`~music21.meter.TimeSignature.numerator`
   - :attr:`~music21.meter.TimeSignature.ratioString`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.medren.Mensuration` methods

Methods inherited from :class:`~music21.meter.TimeSignature`:

.. hlist::
   :columns: 3

   - :meth:`~music21.meter.TimeSignature.averageBeatStrength`
   - :meth:`~music21.meter.TimeSignature.getAccent`
   - :meth:`~music21.meter.TimeSignature.getAccentWeight`
   - :meth:`~music21.meter.TimeSignature.getBeams`
   - :meth:`~music21.meter.TimeSignature.getBeat`
   - :meth:`~music21.meter.TimeSignature.getBeatDepth`
   - :meth:`~music21.meter.TimeSignature.getBeatDuration`
   - :meth:`~music21.meter.TimeSignature.getBeatOffsets`
   - :meth:`~music21.meter.TimeSignature.getBeatProgress`
   - :meth:`~music21.meter.TimeSignature.getBeatProportion`
   - :meth:`~music21.meter.TimeSignature.getBeatProportionStr`
   - :meth:`~music21.meter.TimeSignature.getOffsetFromBeat`
   - :meth:`~music21.meter.TimeSignature.load`
   - :meth:`~music21.meter.TimeSignature.loadRatio`
   - :meth:`~music21.meter.TimeSignature.quarteroffsetToBeat`
   - :meth:`~music21.meter.TimeSignature.ratioEqual`
   - :meth:`~music21.meter.TimeSignature.resetValues`
   - :meth:`~music21.meter.TimeSignature.setAccentWeight`
   - :meth:`~music21.meter.TimeSignature.setDisplay`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :meth:`~music21.base.Music21Object.isClassOrSubclass`
   - :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.removeLocationBySite`
   - :meth:`~music21.base.Music21Object.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.medren.Mensuration` instance variables

.. attribute:: Mensuration.accentSequence

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

.. attribute:: Mensuration.beamSequence

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

.. attribute:: Mensuration.beatSequence

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

.. attribute:: Mensuration.displaySequence

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

.. attribute:: Mensuration.symbol

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

.. attribute:: Mensuration.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 don't expect proper output yet.

Instance variables inherited from :class:`~music21.meter.TimeSignature`:

.. hlist::
   :columns: 3

   - :attr:`~music21.meter.TimeSignature.symbolizeDenominator`
   - :attr:`~music21.meter.TimeSignature.displaySequence`
   - :attr:`~music21.meter.TimeSignature.beatSequence`
   - :attr:`~music21.meter.TimeSignature.accentSequence`
   - :attr:`~music21.meter.TimeSignature.symbol`
   - :attr:`~music21.meter.TimeSignature.beamSequence`

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

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isVariant`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isSpanner`
   - :attr:`~music21.base.Music21Object.xPosition`
