.. _moduleTreeTrees:

music21.tree.trees
==================

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

.. automodule:: music21.tree.trees

ElementTree
-----------

.. autoclass:: music21.tree.trees.ElementTree

.. rubric:: :class:`~music21.tree.trees.ElementTree` bases

- :class:`~music21.tree.core.AVLTree`

.. rubric:: :class:`~music21.tree.trees.ElementTree` read-only properties

.. autoattribute:: music21.tree.trees.ElementTree.endTime

.. rubric:: :class:`~music21.tree.trees.ElementTree` read/write properties

.. autoattribute:: music21.tree.trees.ElementTree.source

.. rubric:: :class:`~music21.tree.trees.ElementTree` methods

.. automethod:: music21.tree.trees.ElementTree.getNodeByIndex

.. automethod:: music21.tree.trees.ElementTree.getPositionFromElementUnsafe

.. automethod:: music21.tree.trees.ElementTree.highestPosition

.. automethod:: music21.tree.trees.ElementTree.index

.. automethod:: music21.tree.trees.ElementTree.insert

.. automethod:: music21.tree.trees.ElementTree.lowestPosition

.. automethod:: music21.tree.trees.ElementTree.populateFromSortedList

Methods inherited from :class:`~music21.tree.core.AVLTree`:

.. hlist::
   :columns: 3

   - :meth:`~music21.tree.core.AVLTree.createNodeAtPosition`
   - :meth:`~music21.tree.core.AVLTree.debug`
   - :meth:`~music21.tree.core.AVLTree.getNodeAfter`
   - :meth:`~music21.tree.core.AVLTree.getNodeBefore`
   - :meth:`~music21.tree.core.AVLTree.getNodeByPosition`
   - :meth:`~music21.tree.core.AVLTree.getPositionAfter`
   - :meth:`~music21.tree.core.AVLTree.getPositionBefore`
   - :meth:`~music21.tree.core.AVLTree.removeNode`

OffsetTree
----------

.. autoclass:: music21.tree.trees.OffsetTree

.. rubric:: :class:`~music21.tree.trees.OffsetTree` bases

- :class:`~music21.tree.trees.ElementTree`
- :class:`~music21.tree.core.AVLTree`

.. rubric:: :class:`~music21.tree.trees.OffsetTree` read-only properties

Read-only properties inherited from :class:`~music21.tree.trees.ElementTree`:

.. hlist::
   :columns: 3

   - :attr:`~music21.tree.trees.ElementTree.endTime`

.. rubric:: :class:`~music21.tree.trees.OffsetTree` read/write properties

Read/write properties inherited from :class:`~music21.tree.trees.ElementTree`:

.. hlist::
   :columns: 3

   - :attr:`~music21.tree.trees.ElementTree.source`

.. rubric:: :class:`~music21.tree.trees.OffsetTree` methods

.. automethod:: music21.tree.trees.OffsetTree.allOffsets

.. automethod:: music21.tree.trees.OffsetTree.allTimePoints

.. automethod:: music21.tree.trees.OffsetTree.append

.. automethod:: music21.tree.trees.OffsetTree.copy

.. automethod:: music21.tree.trees.OffsetTree.elementsOverlappingOffset

.. automethod:: music21.tree.trees.OffsetTree.elementsStartingAt

.. automethod:: music21.tree.trees.OffsetTree.elementsStoppingAt

.. automethod:: music21.tree.trees.OffsetTree.getPositionFromElementUnsafe

.. automethod:: music21.tree.trees.OffsetTree.index

.. automethod:: music21.tree.trees.OffsetTree.removeElements

Methods inherited from :class:`~music21.tree.trees.ElementTree`:

.. hlist::
   :columns: 3

   - :meth:`~music21.tree.trees.ElementTree.getNodeByIndex`
   - :meth:`~music21.tree.trees.ElementTree.highestPosition`
   - :meth:`~music21.tree.trees.ElementTree.insert`
   - :meth:`~music21.tree.trees.ElementTree.lowestPosition`
   - :meth:`~music21.tree.trees.ElementTree.populateFromSortedList`

Methods inherited from :class:`~music21.tree.core.AVLTree`:

.. hlist::
   :columns: 3

   - :meth:`~music21.tree.core.AVLTree.createNodeAtPosition`
   - :meth:`~music21.tree.core.AVLTree.debug`
   - :meth:`~music21.tree.core.AVLTree.getNodeAfter`
   - :meth:`~music21.tree.core.AVLTree.getNodeBefore`
   - :meth:`~music21.tree.core.AVLTree.getNodeByPosition`
   - :meth:`~music21.tree.core.AVLTree.getPositionAfter`
   - :meth:`~music21.tree.core.AVLTree.getPositionBefore`
   - :meth:`~music21.tree.core.AVLTree.removeNode`

TimespanTree
------------

.. autoclass:: music21.tree.trees.TimespanTree

.. rubric:: :class:`~music21.tree.trees.TimespanTree` bases

- :class:`~music21.tree.trees.OffsetTree`
- :class:`~music21.tree.trees.ElementTree`
- :class:`~music21.tree.core.AVLTree`

.. rubric:: :class:`~music21.tree.trees.TimespanTree` read-only properties

Read-only properties inherited from :class:`~music21.tree.trees.ElementTree`:

.. hlist::
   :columns: 3

   - :attr:`~music21.tree.trees.ElementTree.endTime`

.. rubric:: :class:`~music21.tree.trees.TimespanTree` read/write properties

.. autoattribute:: music21.tree.trees.TimespanTree.element

Read/write properties inherited from :class:`~music21.tree.trees.ElementTree`:

.. hlist::
   :columns: 3

   - :attr:`~music21.tree.trees.ElementTree.source`

.. rubric:: :class:`~music21.tree.trees.TimespanTree` methods

.. automethod:: music21.tree.trees.TimespanTree.allParts

.. automethod:: music21.tree.trees.TimespanTree.findNextPitchedTimespanInSameStreamByClass

.. automethod:: music21.tree.trees.TimespanTree.findPreviousPitchedTimespanInSameStreamByClass

.. automethod:: music21.tree.trees.TimespanTree.getVerticalityAt

.. automethod:: music21.tree.trees.TimespanTree.getVerticalityAtOrBefore

.. automethod:: music21.tree.trees.TimespanTree.iterateConsonanceBoundedVerticalities

.. automethod:: music21.tree.trees.TimespanTree.iterateVerticalities

.. automethod:: music21.tree.trees.TimespanTree.iterateVerticalitiesNwise

.. automethod:: music21.tree.trees.TimespanTree.maximumOverlap

.. automethod:: music21.tree.trees.TimespanTree.offset

.. automethod:: music21.tree.trees.TimespanTree.removeTimespan

.. automethod:: music21.tree.trees.TimespanTree.removeTimespanList

.. automethod:: music21.tree.trees.TimespanTree.splitAt

.. automethod:: music21.tree.trees.TimespanTree.toPartwiseTimespanTrees

.. automethod:: music21.tree.trees.TimespanTree.unwrapVerticalities

Methods inherited from :class:`~music21.tree.trees.OffsetTree`:

.. hlist::
   :columns: 3

   - :meth:`~music21.tree.trees.OffsetTree.allOffsets`
   - :meth:`~music21.tree.trees.OffsetTree.allTimePoints`
   - :meth:`~music21.tree.trees.OffsetTree.append`
   - :meth:`~music21.tree.trees.OffsetTree.copy`
   - :meth:`~music21.tree.trees.OffsetTree.elementsOverlappingOffset`
   - :meth:`~music21.tree.trees.OffsetTree.elementsStartingAt`
   - :meth:`~music21.tree.trees.OffsetTree.elementsStoppingAt`
   - :meth:`~music21.tree.trees.OffsetTree.getPositionFromElementUnsafe`
   - :meth:`~music21.tree.trees.OffsetTree.index`
   - :meth:`~music21.tree.trees.OffsetTree.removeElements`

Methods inherited from :class:`~music21.tree.trees.ElementTree`:

.. hlist::
   :columns: 3

   - :meth:`~music21.tree.trees.ElementTree.getNodeByIndex`
   - :meth:`~music21.tree.trees.ElementTree.highestPosition`
   - :meth:`~music21.tree.trees.ElementTree.insert`
   - :meth:`~music21.tree.trees.ElementTree.lowestPosition`
   - :meth:`~music21.tree.trees.ElementTree.populateFromSortedList`

Methods inherited from :class:`~music21.tree.core.AVLTree`:

.. hlist::
   :columns: 3

   - :meth:`~music21.tree.core.AVLTree.createNodeAtPosition`
   - :meth:`~music21.tree.core.AVLTree.debug`
   - :meth:`~music21.tree.core.AVLTree.getNodeAfter`
   - :meth:`~music21.tree.core.AVLTree.getNodeBefore`
   - :meth:`~music21.tree.core.AVLTree.getNodeByPosition`
   - :meth:`~music21.tree.core.AVLTree.getPositionAfter`
   - :meth:`~music21.tree.core.AVLTree.getPositionBefore`
   - :meth:`~music21.tree.core.AVLTree.removeNode`
