.. _moduleSearch:

music21.search
==============

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

.. automodule:: music21.search

Functions
---------

.. autofunction:: music21.search.approximateNoteSearch

.. autofunction:: music21.search.approximateNoteSearchNoRhythm

.. autofunction:: music21.search.approximateNoteSearchOnlyRhythm

.. autofunction:: music21.search.approximateNoteSearchWeighted

.. autofunction:: music21.search.mostCommonMeasureRythms

.. autofunction:: music21.search.rhythmicSearch

.. autofunction:: music21.search.translateDiatonicStreamToString

.. autofunction:: music21.search.translateDurationToBytes

.. autofunction:: music21.search.translateNoteTieToByte

.. autofunction:: music21.search.translateNoteToByte

.. autofunction:: music21.search.translateNoteWithDurationToBytes

.. autofunction:: music21.search.translateStreamToString

.. autofunction:: music21.search.translateStreamToStringNoRhythm

.. autofunction:: music21.search.translateStreamToStringOnlyRhythm

Wildcard
--------

.. autoclass:: music21.search.Wildcard

.. rubric:: :class:`~music21.search.Wildcard` bases

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

.. rubric:: :class:`~music21.search.Wildcard` 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.search.Wildcard` read/write properties

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.search.Wildcard` 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.search.Wildcard` instance variables

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`

WildcardDuration
----------------

.. autoclass:: music21.search.WildcardDuration

.. rubric:: :class:`~music21.search.WildcardDuration` bases

- :class:`~music21.duration.Duration`
- :class:`~music21.duration.DurationCommon`
- :class:`~music21.base.SlottedObject`

.. rubric:: :class:`~music21.search.WildcardDuration` 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.isLinked`
   - :attr:`~music21.duration.Duration.ordinal`

Read-only properties inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.DurationCommon.classes`

.. rubric:: :class:`~music21.search.WildcardDuration` 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.quarterLength`
   - :attr:`~music21.duration.Duration.tuplets`
   - :attr:`~music21.duration.Duration.type`

.. rubric:: :class:`~music21.search.WildcardDuration` methods

Methods inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.Duration.addDurationUnit`
   - :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.expand`
   - :meth:`~music21.duration.Duration.fill`
   - :meth:`~music21.duration.Duration.getGraceDuration`
   - :meth:`~music21.duration.Duration.link`
   - :meth:`~music21.duration.Duration.setQuarterLengthUnlinked`
   - :meth:`~music21.duration.Duration.setTypeUnlinked`
   - :meth:`~music21.duration.Duration.show`
   - :meth:`~music21.duration.Duration.sliceComponentAtPosition`
   - :meth:`~music21.duration.Duration.splitDotGroups`
   - :meth:`~music21.duration.Duration.unlink`
   - :meth:`~music21.duration.Duration.updateQuarterLength`
   - :meth:`~music21.duration.Duration.write`

Methods inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.DurationCommon.aggregateTupletRatio`
