.. _moduleHumdrumSpineParser:

music21.humdrum.spineParser
===========================

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

.. automodule:: music21.humdrum.spineParser

Functions
---------

.. autofunction:: music21.humdrum.spineParser.hdStringToMeasure

.. autofunction:: music21.humdrum.spineParser.hdStringToNote

.. autofunction:: music21.humdrum.spineParser.kernTandemToObject

DynamSpine
----------

.. autoclass:: music21.humdrum.spineParser.DynamSpine

.. rubric:: :class:`~music21.humdrum.spineParser.DynamSpine` bases

- :class:`~music21.humdrum.spineParser.HumdrumSpine`

.. rubric:: :class:`~music21.humdrum.spineParser.DynamSpine` read/write properties

Read/write properties inherited from :class:`~music21.humdrum.spineParser.HumdrumSpine`:

.. hlist::
   :columns: 3

   - :attr:`~music21.humdrum.spineParser.HumdrumSpine.spineCollection`
   - :attr:`~music21.humdrum.spineParser.HumdrumSpine.spineType`

.. rubric:: :class:`~music21.humdrum.spineParser.DynamSpine` methods

.. automethod:: music21.humdrum.spineParser.DynamSpine.parse

Methods inherited from :class:`~music21.humdrum.spineParser.HumdrumSpine`:

.. hlist::
   :columns: 3

   - :meth:`~music21.humdrum.spineParser.HumdrumSpine.append`
   - :meth:`~music21.humdrum.spineParser.HumdrumSpine.moveElementsIntoMeasures`
   - :meth:`~music21.humdrum.spineParser.HumdrumSpine.next`

EventCollection
---------------

.. autoclass:: music21.humdrum.spineParser.EventCollection

.. rubric:: :class:`~music21.humdrum.spineParser.EventCollection` methods

.. automethod:: music21.humdrum.spineParser.EventCollection.addGlobalEvent

.. automethod:: music21.humdrum.spineParser.EventCollection.addLastSpineEvent

.. automethod:: music21.humdrum.spineParser.EventCollection.addSpineEvent

.. automethod:: music21.humdrum.spineParser.EventCollection.getAllOccurring

.. automethod:: music21.humdrum.spineParser.EventCollection.getSpineEvent

.. automethod:: music21.humdrum.spineParser.EventCollection.getSpineOccurring

GlobalComment
-------------

.. autoclass:: music21.humdrum.spineParser.GlobalComment

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalComment` bases

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

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalComment` 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.classSet`
   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalComment` 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.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalComment` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :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.setContextAttr`
   - :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`

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalComment` 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.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.xPosition`

GlobalCommentLine
-----------------

.. autoclass:: music21.humdrum.spineParser.GlobalCommentLine

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalCommentLine` bases

- :class:`~music21.humdrum.spineParser.HumdrumLine`

GlobalReference
---------------

.. autoclass:: music21.humdrum.spineParser.GlobalReference

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalReference` bases

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

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalReference` 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.classSet`
   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalReference` 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.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalReference` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :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.setContextAttr`
   - :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`

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalReference` 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.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.xPosition`

GlobalReferenceLine
-------------------

.. autoclass:: music21.humdrum.spineParser.GlobalReferenceLine

.. rubric:: :class:`~music21.humdrum.spineParser.GlobalReferenceLine` bases

- :class:`~music21.humdrum.spineParser.HumdrumLine`

HumdrumDataCollection
---------------------

.. autoclass:: music21.humdrum.spineParser.HumdrumDataCollection

.. rubric:: :class:`~music21.humdrum.spineParser.HumdrumDataCollection` read-only properties

.. autoattribute:: music21.humdrum.spineParser.HumdrumDataCollection.stream

.. rubric:: :class:`~music21.humdrum.spineParser.HumdrumDataCollection` methods

.. automethod:: music21.humdrum.spineParser.HumdrumDataCollection.createHumdrumSpines

.. automethod:: music21.humdrum.spineParser.HumdrumDataCollection.determineIfDataStreamIsOpus

.. automethod:: music21.humdrum.spineParser.HumdrumDataCollection.insertGlobalEvents

.. automethod:: music21.humdrum.spineParser.HumdrumDataCollection.parseEventListFromDataStream

.. automethod:: music21.humdrum.spineParser.HumdrumDataCollection.parseLines

.. automethod:: music21.humdrum.spineParser.HumdrumDataCollection.parseOpusDataCollections

.. automethod:: music21.humdrum.spineParser.HumdrumDataCollection.parseProtoSpinesAndEventCollections

HumdrumFile
-----------

.. autoclass:: music21.humdrum.spineParser.HumdrumFile

.. rubric:: :class:`~music21.humdrum.spineParser.HumdrumFile` bases

- :class:`~music21.humdrum.spineParser.HumdrumDataCollection`

.. rubric:: :class:`~music21.humdrum.spineParser.HumdrumFile` read-only properties

Read-only properties inherited from :class:`~music21.humdrum.spineParser.HumdrumDataCollection`:

.. hlist::
   :columns: 3

   - :attr:`~music21.humdrum.spineParser.HumdrumDataCollection.stream`

.. rubric:: :class:`~music21.humdrum.spineParser.HumdrumFile` methods

.. automethod:: music21.humdrum.spineParser.HumdrumFile.parseFH

Methods inherited from :class:`~music21.humdrum.spineParser.HumdrumDataCollection`:

.. hlist::
   :columns: 3

   - :meth:`~music21.humdrum.spineParser.HumdrumDataCollection.createHumdrumSpines`
   - :meth:`~music21.humdrum.spineParser.HumdrumDataCollection.determineIfDataStreamIsOpus`
   - :meth:`~music21.humdrum.spineParser.HumdrumDataCollection.insertGlobalEvents`
   - :meth:`~music21.humdrum.spineParser.HumdrumDataCollection.parseEventListFromDataStream`
   - :meth:`~music21.humdrum.spineParser.HumdrumDataCollection.parseLines`
   - :meth:`~music21.humdrum.spineParser.HumdrumDataCollection.parseOpusDataCollections`
   - :meth:`~music21.humdrum.spineParser.HumdrumDataCollection.parseProtoSpinesAndEventCollections`

HumdrumLine
-----------

.. autoclass:: music21.humdrum.spineParser.HumdrumLine

HumdrumSpine
------------

.. autoclass:: music21.humdrum.spineParser.HumdrumSpine

.. rubric:: :class:`~music21.humdrum.spineParser.HumdrumSpine` read/write properties

.. autoattribute:: music21.humdrum.spineParser.HumdrumSpine.spineCollection

.. autoattribute:: music21.humdrum.spineParser.HumdrumSpine.spineType

.. rubric:: :class:`~music21.humdrum.spineParser.HumdrumSpine` methods

.. automethod:: music21.humdrum.spineParser.HumdrumSpine.append

.. automethod:: music21.humdrum.spineParser.HumdrumSpine.moveElementsIntoMeasures

.. automethod:: music21.humdrum.spineParser.HumdrumSpine.next

.. automethod:: music21.humdrum.spineParser.HumdrumSpine.parse

KernSpine
---------

.. autoclass:: music21.humdrum.spineParser.KernSpine

.. rubric:: :class:`~music21.humdrum.spineParser.KernSpine` bases

- :class:`~music21.humdrum.spineParser.HumdrumSpine`

.. rubric:: :class:`~music21.humdrum.spineParser.KernSpine` read/write properties

Read/write properties inherited from :class:`~music21.humdrum.spineParser.HumdrumSpine`:

.. hlist::
   :columns: 3

   - :attr:`~music21.humdrum.spineParser.HumdrumSpine.spineCollection`
   - :attr:`~music21.humdrum.spineParser.HumdrumSpine.spineType`

.. rubric:: :class:`~music21.humdrum.spineParser.KernSpine` methods

.. automethod:: music21.humdrum.spineParser.KernSpine.parse

Methods inherited from :class:`~music21.humdrum.spineParser.HumdrumSpine`:

.. hlist::
   :columns: 3

   - :meth:`~music21.humdrum.spineParser.HumdrumSpine.append`
   - :meth:`~music21.humdrum.spineParser.HumdrumSpine.moveElementsIntoMeasures`
   - :meth:`~music21.humdrum.spineParser.HumdrumSpine.next`

MiscTandem
----------

.. autoclass:: music21.humdrum.spineParser.MiscTandem

.. rubric:: :class:`~music21.humdrum.spineParser.MiscTandem` bases

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

.. rubric:: :class:`~music21.humdrum.spineParser.MiscTandem` 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.classSet`
   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.humdrum.spineParser.MiscTandem` 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.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.humdrum.spineParser.MiscTandem` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :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.setContextAttr`
   - :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`

.. rubric:: :class:`~music21.humdrum.spineParser.MiscTandem` 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.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.xPosition`

ProtoSpine
----------

.. autoclass:: music21.humdrum.spineParser.ProtoSpine

SpineCollection
---------------

.. autoclass:: music21.humdrum.spineParser.SpineCollection

.. rubric:: :class:`~music21.humdrum.spineParser.SpineCollection` methods

.. automethod:: music21.humdrum.spineParser.SpineCollection.addSpine

.. automethod:: music21.humdrum.spineParser.SpineCollection.appendSpine

.. automethod:: music21.humdrum.spineParser.SpineCollection.assignIds

.. automethod:: music21.humdrum.spineParser.SpineCollection.createMusic21Streams

.. automethod:: music21.humdrum.spineParser.SpineCollection.getOffsetsAndPrioritiesByPosition

.. automethod:: music21.humdrum.spineParser.SpineCollection.getSpineById

.. automethod:: music21.humdrum.spineParser.SpineCollection.makeVoices

.. automethod:: music21.humdrum.spineParser.SpineCollection.moveDynamicsAndLyricsToStreams

.. automethod:: music21.humdrum.spineParser.SpineCollection.moveObjectsToMeasures

.. automethod:: music21.humdrum.spineParser.SpineCollection.next

.. automethod:: music21.humdrum.spineParser.SpineCollection.parseMusic21

.. automethod:: music21.humdrum.spineParser.SpineCollection.performInsertions

.. automethod:: music21.humdrum.spineParser.SpineCollection.performSpineInsertion

.. automethod:: music21.humdrum.spineParser.SpineCollection.reclassSpines

.. automethod:: music21.humdrum.spineParser.SpineCollection.removeSpineById

SpineComment
------------

.. autoclass:: music21.humdrum.spineParser.SpineComment

.. rubric:: :class:`~music21.humdrum.spineParser.SpineComment` bases

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

.. rubric:: :class:`~music21.humdrum.spineParser.SpineComment` 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.classSet`
   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.humdrum.spineParser.SpineComment` 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.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.humdrum.spineParser.SpineComment` methods

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :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.setContextAttr`
   - :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`

.. rubric:: :class:`~music21.humdrum.spineParser.SpineComment` 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.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.xPosition`

SpineEvent
----------

.. autoclass:: music21.humdrum.spineParser.SpineEvent

.. rubric:: :class:`~music21.humdrum.spineParser.SpineEvent` methods

.. automethod:: music21.humdrum.spineParser.SpineEvent.toNote

SpineLine
---------

.. autoclass:: music21.humdrum.spineParser.SpineLine

.. rubric:: :class:`~music21.humdrum.spineParser.SpineLine` bases

- :class:`~music21.humdrum.spineParser.HumdrumLine`
