.. _moduleFiguredBassNotation:

music21.figuredBass.notation
============================

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

.. automodule:: music21.figuredBass.notation

Notation
--------

.. autoclass:: music21.figuredBass.notation.Notation

.. rubric:: :class:`~music21.figuredBass.notation.Notation` bases

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

.. rubric:: :class:`~music21.figuredBass.notation.Notation` read-only properties

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.figuredBass.notation.Notation` methods

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.figuredBass.notation.Notation` instance variables

.. attribute:: Notation.figureStrings

	
	A list of figures derived from the original
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

.. attribute:: Notation.figures

	
	A list of :class:`~music21.figuredBass.notation.Figure` objects
	associated with figures in the expanded
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

.. attribute:: Notation.modifierStrings

	
	The modifiers associated with the expanded
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`, as strings.
	

.. attribute:: Notation.modifiers

	
	A list of :class:`~music21.figuredBass.notation.Modifier`
	objects associated with the expanded
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

.. attribute:: Notation.notationColumn

	
	A string of figures delimited by commas,
	each associated with a number and an optional modifier.
	

.. attribute:: Notation.numbers

	
	The numbers associated with the expanded
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

.. attribute:: Notation.origModStrings

	
	The modifiers associated with the original
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`, as strings.
	

.. attribute:: Notation.origNumbers

	
	The numbers associated with the original
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

Figure
------

.. autoclass:: music21.figuredBass.notation.Figure

.. rubric:: :class:`~music21.figuredBass.notation.Figure` bases

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

.. rubric:: :class:`~music21.figuredBass.notation.Figure` read-only properties

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.figuredBass.notation.Figure` methods

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.figuredBass.notation.Figure` instance variables

.. attribute:: Figure.modifier

	
	A :class:`~music21.figuredBass.notation.Modifier`
	associated with an expanded
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

.. attribute:: Figure.modifierString

	
	A modifier string associated with an
	expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

.. attribute:: Figure.number

	
	A number associated with an expanded
	:attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

Modifier
--------

.. autoclass:: music21.figuredBass.notation.Modifier

.. rubric:: :class:`~music21.figuredBass.notation.Modifier` bases

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

.. rubric:: :class:`~music21.figuredBass.notation.Modifier` read-only properties

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.figuredBass.notation.Modifier` methods

.. automethod:: music21.figuredBass.notation.Modifier.modifyPitch

.. automethod:: music21.figuredBass.notation.Modifier.modifyPitchName

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.figuredBass.notation.Modifier` instance variables

.. attribute:: Modifier.accidental

	
	A :class:`~music21.pitch.Accidental` corresponding to
	:attr:`~music21.figuredBass.notation.Modifier.modifierString`.
	

.. attribute:: Modifier.modifierString

	
	A modifier string associated with an
	expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`.
	

Functions
---------

.. autofunction:: music21.figuredBass.notation.convertToPitch