.. _moduleFiguredBassSegment:

music21.figuredBass.segment
===========================

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

.. automodule:: music21.figuredBass.segment

OverlaidSegment
---------------

.. autoclass:: music21.figuredBass.segment.OverlaidSegment

.. rubric:: :class:`~music21.figuredBass.segment.OverlaidSegment` bases

- :class:`~music21.figuredBass.segment.Segment`

.. rubric:: :class:`~music21.figuredBass.segment.OverlaidSegment` methods

.. automethod:: music21.figuredBass.segment.OverlaidSegment.allSinglePossibilities

Methods inherited from :class:`~music21.figuredBass.segment.Segment`:

.. hlist::
   :columns: 3

   - :meth:`~music21.figuredBass.segment.Segment.allCorrectConsecutivePossibilities`
   - :meth:`~music21.figuredBass.segment.Segment.allCorrectSinglePossibilities`
   - :meth:`~music21.figuredBass.segment.Segment.consecutivePossibilityRules`
   - :meth:`~music21.figuredBass.segment.Segment.resolveAugmentedSixthSegment`
   - :meth:`~music21.figuredBass.segment.Segment.resolveDiminishedSeventhSegment`
   - :meth:`~music21.figuredBass.segment.Segment.resolveDominantSeventhSegment`
   - :meth:`~music21.figuredBass.segment.Segment.singlePossibilityRules`
   - :meth:`~music21.figuredBass.segment.Segment.specialResolutionRules`

.. rubric:: :class:`~music21.figuredBass.segment.OverlaidSegment` instance variables

Instance variables inherited from :class:`~music21.figuredBass.segment.Segment`:

.. hlist::
   :columns: 3

   - :attr:`~music21.figuredBass.segment.Segment.allPitchesAboveBass`
   - :attr:`~music21.figuredBass.segment.Segment.bassNote`
   - :attr:`~music21.figuredBass.segment.Segment.fbRules`
   - :attr:`~music21.figuredBass.segment.Segment.numParts`
   - :attr:`~music21.figuredBass.segment.Segment.pitchNamesInChord`
   - :attr:`~music21.figuredBass.segment.Segment.segmentChord`

Segment
-------

.. autoclass:: music21.figuredBass.segment.Segment

.. rubric:: :class:`~music21.figuredBass.segment.Segment` methods

.. automethod:: music21.figuredBass.segment.Segment.allCorrectConsecutivePossibilities

.. automethod:: music21.figuredBass.segment.Segment.allCorrectSinglePossibilities

.. automethod:: music21.figuredBass.segment.Segment.allSinglePossibilities

.. automethod:: music21.figuredBass.segment.Segment.consecutivePossibilityRules

.. automethod:: music21.figuredBass.segment.Segment.resolveAugmentedSixthSegment

.. automethod:: music21.figuredBass.segment.Segment.resolveDiminishedSeventhSegment

.. automethod:: music21.figuredBass.segment.Segment.resolveDominantSeventhSegment

.. automethod:: music21.figuredBass.segment.Segment.singlePossibilityRules

.. automethod:: music21.figuredBass.segment.Segment.specialResolutionRules

.. rubric:: :class:`~music21.figuredBass.segment.Segment` instance variables

.. attribute:: Segment.allPitchesAboveBass

	A list of allowable pitches in the upper parts of a possibility.
	This is derived using
	:meth:`~music21.figuredBass.segment.getPitches`, providing bassNote.pitch,
	:attr:`~music21.figuredBass.rules.Rules.maxPitch`
	from the Rules object, and
	:attr:`~music21.figuredBass.segment.Segment.pitchNamesInChord` as arguments.

.. attribute:: Segment.bassNote

	A :class:`~music21.note.Note` whose pitch
	forms the bass of each possibility.

.. attribute:: Segment.fbRules

	A deepcopy of the :class:`~music21.figuredBass.rules.Rules` object provided.

.. attribute:: Segment.numParts

	The number of parts (including the bass) that possibilities
	should contain, which
	comes directly from :attr:`~music21.figuredBass.rules.Rules.numParts`
	in the Rules object.

.. attribute:: Segment.pitchNamesInChord

	A list of allowable pitch names.
	This is derived from bassNote.pitch and notationString
	using :meth:`~music21.figuredBass.realizerScale.FiguredBassScale.getPitchNames`.

.. attribute:: Segment.segmentChord

	:attr:`~music21.figuredBass.segment.Segment.allPitchesAboveBass`
	represented as a :class:`~music21.chord.Chord`.

Functions
---------

.. autofunction:: music21.figuredBass.segment.getPitches

.. autofunction:: music21.figuredBass.segment.printRules