.. _moduleFiguredBassRealizer:

music21.figuredBass.realizer
============================

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

.. automodule:: music21.figuredBass.realizer

FiguredBassLine
---------------

.. autoclass:: music21.figuredBass.realizer.FiguredBassLine

.. rubric:: :class:`~music21.figuredBass.realizer.FiguredBassLine` methods

.. automethod:: music21.figuredBass.realizer.FiguredBassLine.addElement

.. automethod:: music21.figuredBass.realizer.FiguredBassLine.generateBassLine

.. automethod:: music21.figuredBass.realizer.FiguredBassLine.overlayPart

.. automethod:: music21.figuredBass.realizer.FiguredBassLine.realize

.. automethod:: music21.figuredBass.realizer.FiguredBassLine.retrieveSegments

.. rubric:: :class:`~music21.figuredBass.realizer.FiguredBassLine` instance variables

.. attribute:: FiguredBassLine.inKey

	
	A :class:`~music21.key.Key` which implies a scale value,
	scale mode, and key signature for a
	:class:`~music21.figuredBass.realizerScale.FiguredBassScale`.
	

.. attribute:: FiguredBassLine.inTime

	
	A :class:`~music21.meter.TimeSignature` which specifies the
	time signature of realizations outputted to a
	:class:`~music21.stream.Score`.
	

Realization
-----------

.. autoclass:: music21.figuredBass.realizer.Realization

.. rubric:: :class:`~music21.figuredBass.realizer.Realization` methods

.. automethod:: music21.figuredBass.realizer.Realization.generateAllRealizations

.. automethod:: music21.figuredBass.realizer.Realization.generateRandomRealization

.. automethod:: music21.figuredBass.realizer.Realization.generateRandomRealizations

.. automethod:: music21.figuredBass.realizer.Realization.generateRealizationFromPossibilityProgression

.. automethod:: music21.figuredBass.realizer.Realization.getAllPossibilityProgressions

.. automethod:: music21.figuredBass.realizer.Realization.getNumSolutions

.. automethod:: music21.figuredBass.realizer.Realization.getRandomPossibilityProgression

.. rubric:: :class:`~music21.figuredBass.realizer.Realization` instance variables

.. attribute:: Realization.keyboardStyleOutput

	
	True by default. If True, generated realizations
	are represented in keyboard style, with two staves. If False,
	realizations are represented in chorale style with n staves,
	where n is the number of parts. SATB if n = 4.

Functions
---------

.. autofunction:: music21.figuredBass.realizer.figuredBassFromStream

.. autofunction:: music21.figuredBass.realizer.addLyricsToBassNote