.. _moduleSearchSerial:

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

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

.. automodule:: music21.search.serial

ContiguousSegmentOfNotes
------------------------

.. autoclass:: music21.search.serial.ContiguousSegmentOfNotes

.. rubric:: :class:`~music21.search.serial.ContiguousSegmentOfNotes` bases

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

.. rubric:: :class:`~music21.search.serial.ContiguousSegmentOfNotes` read-only properties

.. autoattribute:: music21.search.serial.ContiguousSegmentOfNotes.originalCenteredTransformationsFromMatched

.. autoattribute:: music21.search.serial.ContiguousSegmentOfNotes.startMeasureNumber

.. autoattribute:: music21.search.serial.ContiguousSegmentOfNotes.startOffset

.. autoattribute:: music21.search.serial.ContiguousSegmentOfNotes.zeroCenteredTransformationsFromMatched

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.search.serial.ContiguousSegmentOfNotes` 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.search.serial.ContiguousSegmentOfNotes` methods

.. automethod:: music21.search.serial.ContiguousSegmentOfNotes.getActiveMatchedRows

.. automethod:: music21.search.serial.ContiguousSegmentOfNotes.getDistinctPitchClasses

.. automethod:: music21.search.serial.ContiguousSegmentOfNotes.readPitchClassesFromBottom

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.__eq__`
   - :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.search.serial.ContiguousSegmentOfNotes` instance variables

.. attribute:: ContiguousSegmentOfNotes.activeSegment

	
	A list of pitch classes representing the way the contiguous
	segment of notes is being read as a sequence of single pitches. Set to None
	unless the container stream is being searched for segments or multisets
	(for example, using :meth:`~music21.search.serial.SegmentMatcher.find`), in which case
	the representation depends on the segments or multisets being searched for.
	If there are no chords in the segment, this attribute will simply give the
	pitch classes of the notes in the segment.

.. attribute:: ContiguousSegmentOfNotes.containerStream

	
	The stream containing the contiguous segment -
	all contiguous segments must have a container stream.

.. attribute:: ContiguousSegmentOfNotes.matchedSegment

	
	A list of pitch classes representing the segment to which
	the contiguous segment of notes is matched when segments or multisets are
	searched for (for example, using :func:`~music21.search.serial.findSegments`);
	otherwise set to None. Note that the contiguous segment will only be
	matched to one of the segments or multisets being searched for.

.. attribute:: ContiguousSegmentOfNotes.partNumber

	
	The part number in which the segment appears, or None
	(if the container stream has no parts). Note that this attribute is zero-indexed,
	so the top (e.g. soprano) part is labeled 0.

.. attribute:: ContiguousSegmentOfNotes.segment

	The list of notes and chords in the contiguous segment.

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`

ContiguousSegmentSearcher
-------------------------

.. autoclass:: music21.search.serial.ContiguousSegmentSearcher

.. rubric:: :class:`~music21.search.serial.ContiguousSegmentSearcher` methods

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.addActiveChords

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.byLength

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.getSearchBoundMethod

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.searchIgnoreAllExclude

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.searchIgnoreAllInclude

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.searchIncludeAllExclude

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.searchIncludeAllInclude

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.searchRowsOnlyExclude

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.searchRowsOnlyInclude

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.searchSkipConsecutiveExclude

.. automethod:: music21.search.serial.ContiguousSegmentSearcher.searchSkipConsecutiveInclude

MultisetSegmentMatcher
----------------------

.. autoclass:: music21.search.serial.MultisetSegmentMatcher

.. rubric:: :class:`~music21.search.serial.MultisetSegmentMatcher` bases

- :class:`~music21.search.serial.SegmentMatcher`

.. rubric:: :class:`~music21.search.serial.MultisetSegmentMatcher` read/write properties

Read/write properties inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :attr:`~music21.search.serial.SegmentMatcher.includeChords`
   - :attr:`~music21.search.serial.SegmentMatcher.reps`

.. rubric:: :class:`~music21.search.serial.MultisetSegmentMatcher` methods

.. automethod:: music21.search.serial.MultisetSegmentMatcher.equalSubset

Methods inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :meth:`~music21.search.serial.SegmentMatcher.checkSearchedAlready`
   - :meth:`~music21.search.serial.SegmentMatcher.find`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneIgnoreAll`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneOtherReps`
   - :meth:`~music21.search.serial.SegmentMatcher.getContiguousSegmentsByLength`
   - :meth:`~music21.search.serial.SegmentMatcher.normalize`

SegmentMatcher
--------------

.. autoclass:: music21.search.serial.SegmentMatcher

.. rubric:: :class:`~music21.search.serial.SegmentMatcher` read/write properties

.. autoattribute:: music21.search.serial.SegmentMatcher.includeChords

.. autoattribute:: music21.search.serial.SegmentMatcher.reps

.. rubric:: :class:`~music21.search.serial.SegmentMatcher` methods

.. automethod:: music21.search.serial.SegmentMatcher.checkSearchedAlready

.. automethod:: music21.search.serial.SegmentMatcher.equalSubset

.. automethod:: music21.search.serial.SegmentMatcher.find

.. automethod:: music21.search.serial.SegmentMatcher.findOneIgnoreAll

.. automethod:: music21.search.serial.SegmentMatcher.findOneOtherReps

.. automethod:: music21.search.serial.SegmentMatcher.getContiguousSegmentsByLength

.. automethod:: music21.search.serial.SegmentMatcher.normalize

TransformedSegmentMatcher
-------------------------

.. autoclass:: music21.search.serial.TransformedSegmentMatcher

.. rubric:: :class:`~music21.search.serial.TransformedSegmentMatcher` bases

- :class:`~music21.search.serial.SegmentMatcher`

.. rubric:: :class:`~music21.search.serial.TransformedSegmentMatcher` read/write properties

Read/write properties inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :attr:`~music21.search.serial.SegmentMatcher.includeChords`
   - :attr:`~music21.search.serial.SegmentMatcher.reps`

.. rubric:: :class:`~music21.search.serial.TransformedSegmentMatcher` methods

.. automethod:: music21.search.serial.TransformedSegmentMatcher.checkSearchedAlready

.. automethod:: music21.search.serial.TransformedSegmentMatcher.equalSubset

.. automethod:: music21.search.serial.TransformedSegmentMatcher.getTransformations

.. automethod:: music21.search.serial.TransformedSegmentMatcher.normalize

Methods inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :meth:`~music21.search.serial.SegmentMatcher.find`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneIgnoreAll`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneOtherReps`
   - :meth:`~music21.search.serial.SegmentMatcher.getContiguousSegmentsByLength`

TransposedInvertedMultisetMatcher
---------------------------------

.. autoclass:: music21.search.serial.TransposedInvertedMultisetMatcher

.. rubric:: :class:`~music21.search.serial.TransposedInvertedMultisetMatcher` bases

- :class:`~music21.search.serial.TransposedMultisetMatcher`
- :class:`~music21.search.serial.SegmentMatcher`

.. rubric:: :class:`~music21.search.serial.TransposedInvertedMultisetMatcher` read/write properties

Read/write properties inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :attr:`~music21.search.serial.SegmentMatcher.includeChords`
   - :attr:`~music21.search.serial.SegmentMatcher.reps`

.. rubric:: :class:`~music21.search.serial.TransposedInvertedMultisetMatcher` methods

.. automethod:: music21.search.serial.TransposedInvertedMultisetMatcher.checkSearchedAlready

.. automethod:: music21.search.serial.TransposedInvertedMultisetMatcher.equalSubset

Methods inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :meth:`~music21.search.serial.SegmentMatcher.find`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneIgnoreAll`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneOtherReps`
   - :meth:`~music21.search.serial.SegmentMatcher.getContiguousSegmentsByLength`
   - :meth:`~music21.search.serial.SegmentMatcher.normalize`

TransposedMultisetMatcher
-------------------------

.. autoclass:: music21.search.serial.TransposedMultisetMatcher

.. rubric:: :class:`~music21.search.serial.TransposedMultisetMatcher` bases

- :class:`~music21.search.serial.SegmentMatcher`

.. rubric:: :class:`~music21.search.serial.TransposedMultisetMatcher` read/write properties

Read/write properties inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :attr:`~music21.search.serial.SegmentMatcher.includeChords`
   - :attr:`~music21.search.serial.SegmentMatcher.reps`

.. rubric:: :class:`~music21.search.serial.TransposedMultisetMatcher` methods

.. automethod:: music21.search.serial.TransposedMultisetMatcher.checkSearchedAlready

.. automethod:: music21.search.serial.TransposedMultisetMatcher.equalSubset

Methods inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :meth:`~music21.search.serial.SegmentMatcher.find`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneIgnoreAll`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneOtherReps`
   - :meth:`~music21.search.serial.SegmentMatcher.getContiguousSegmentsByLength`
   - :meth:`~music21.search.serial.SegmentMatcher.normalize`

TransposedSegmentMatcher
------------------------

.. autoclass:: music21.search.serial.TransposedSegmentMatcher

.. rubric:: :class:`~music21.search.serial.TransposedSegmentMatcher` bases

- :class:`~music21.search.serial.SegmentMatcher`

.. rubric:: :class:`~music21.search.serial.TransposedSegmentMatcher` read/write properties

Read/write properties inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :attr:`~music21.search.serial.SegmentMatcher.includeChords`
   - :attr:`~music21.search.serial.SegmentMatcher.reps`

.. rubric:: :class:`~music21.search.serial.TransposedSegmentMatcher` methods

.. automethod:: music21.search.serial.TransposedSegmentMatcher.normalize

Methods inherited from :class:`~music21.search.serial.SegmentMatcher`:

.. hlist::
   :columns: 3

   - :meth:`~music21.search.serial.SegmentMatcher.checkSearchedAlready`
   - :meth:`~music21.search.serial.SegmentMatcher.equalSubset`
   - :meth:`~music21.search.serial.SegmentMatcher.find`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneIgnoreAll`
   - :meth:`~music21.search.serial.SegmentMatcher.findOneOtherReps`
   - :meth:`~music21.search.serial.SegmentMatcher.getContiguousSegmentsByLength`

Functions
---------

.. autofunction:: music21.search.serial.labelMultisets

.. autofunction:: music21.search.serial.labelSegments

.. autofunction:: music21.search.serial.labelTransformedSegments

.. autofunction:: music21.search.serial.labelTransposedAndInvertedMultisets

.. autofunction:: music21.search.serial.labelTransposedMultisets

.. autofunction:: music21.search.serial.labelTransposedSegments