.. _moduleRoman:

music21.roman
=============

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

.. automodule:: music21.roman

Functions
---------

.. autofunction:: music21.roman.expandShortHand

.. autofunction:: music21.roman.figureFromChordAndKey

.. autofunction:: music21.roman.figureTupletSolo

.. autofunction:: music21.roman.figureTuplets

.. autofunction:: music21.roman.identifyAsTonicOrDominant

.. autofunction:: music21.roman.romanInversionName

.. autofunction:: music21.roman.romanNumeralFromChord

RomanNumeral
------------

.. autoclass:: music21.roman.RomanNumeral

.. rubric:: :class:`~music21.roman.RomanNumeral` bases

- :class:`~music21.harmony.Harmony`
- :class:`~music21.chord.Chord`
- :class:`~music21.note.NotRest`
- :class:`~music21.note.GeneralNote`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.roman.RomanNumeral` read-only properties

.. autoattribute:: music21.roman.RomanNumeral.figureAndKey

.. autoattribute:: music21.roman.RomanNumeral.romanNumeral

Read-only properties inherited from :class:`~music21.chord.Chord`:

.. hlist::
   :columns: 3

   - :attr:`~music21.chord.Chord.chordTablesAddress`
   - :attr:`~music21.chord.Chord.commonName`
   - :attr:`~music21.chord.Chord.fifth`
   - :attr:`~music21.chord.Chord.forteClass`
   - :attr:`~music21.chord.Chord.forteClassNumber`
   - :attr:`~music21.chord.Chord.forteClassTn`
   - :attr:`~music21.chord.Chord.forteClassTnI`
   - :attr:`~music21.chord.Chord.fullName`
   - :attr:`~music21.chord.Chord.hasZRelation`
   - :attr:`~music21.chord.Chord.intervalVector`
   - :attr:`~music21.chord.Chord.intervalVectorString`
   - :attr:`~music21.chord.Chord.isPrimeFormInversion`
   - :attr:`~music21.chord.Chord.multisetCardinality`
   - :attr:`~music21.chord.Chord.normalForm`
   - :attr:`~music21.chord.Chord.normalFormString`
   - :attr:`~music21.chord.Chord.orderedPitchClasses`
   - :attr:`~music21.chord.Chord.orderedPitchClassesString`
   - :attr:`~music21.chord.Chord.pitchClassCardinality`
   - :attr:`~music21.chord.Chord.pitchClasses`
   - :attr:`~music21.chord.Chord.pitchedCommonName`
   - :attr:`~music21.chord.Chord.primeForm`
   - :attr:`~music21.chord.Chord.primeFormString`
   - :attr:`~music21.chord.Chord.quality`
   - :attr:`~music21.chord.Chord.scaleDegrees`
   - :attr:`~music21.chord.Chord.seventh`
   - :attr:`~music21.chord.Chord.third`

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.classSet`
   - :attr:`~music21.base.Music21Object.classes`
   - :attr:`~music21.base.Music21Object.measureNumber`

.. rubric:: :class:`~music21.roman.RomanNumeral` read/write properties

.. autoattribute:: music21.roman.RomanNumeral.figure

.. autoattribute:: music21.roman.RomanNumeral.functionalityScore

.. autoattribute:: music21.roman.RomanNumeral.key

.. autoattribute:: music21.roman.RomanNumeral.scaleDegreeWithAlteration

Read/write properties inherited from :class:`~music21.harmony.Harmony`:

.. hlist::
   :columns: 3

   - :attr:`~music21.harmony.Harmony.writeAsChord`

Read/write properties inherited from :class:`~music21.chord.Chord`:

.. hlist::
   :columns: 3

   - :attr:`~music21.chord.Chord.color`
   - :attr:`~music21.chord.Chord.duration`
   - :attr:`~music21.chord.Chord.pitchNames`
   - :attr:`~music21.chord.Chord.pitches`
   - :attr:`~music21.chord.Chord.tie`
   - :attr:`~music21.chord.Chord.volume`

Read/write properties inherited from :class:`~music21.note.NotRest`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.NotRest.notehead`
   - :attr:`~music21.note.NotRest.noteheadFill`
   - :attr:`~music21.note.NotRest.noteheadParenthesis`
   - :attr:`~music21.note.NotRest.stemDirection`

Read/write properties inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.GeneralNote.editorial`
   - :attr:`~music21.note.GeneralNote.lyric`

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.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.roman.RomanNumeral` methods

.. automethod:: music21.roman.RomanNumeral.bassScaleDegreeFromNotation

Methods inherited from :class:`~music21.harmony.Harmony`:

.. hlist::
   :columns: 3

   - :meth:`~music21.harmony.Harmony.addChordStepModification`
   - :meth:`~music21.harmony.Harmony.findFigure`
   - :meth:`~music21.harmony.Harmony.getChordStepModifications`

Methods inherited from :class:`~music21.chord.Chord`:

.. hlist::
   :columns: 3

   - :meth:`~music21.chord.Chord.annotateIntervals`
   - :meth:`~music21.chord.Chord.areZRelations`
   - :meth:`~music21.chord.Chord.bass`
   - :meth:`~music21.chord.Chord.canBeDominantV`
   - :meth:`~music21.chord.Chord.canBeTonic`
   - :meth:`~music21.chord.Chord.closedPosition`
   - :meth:`~music21.chord.Chord.containsSeventh`
   - :meth:`~music21.chord.Chord.containsTriad`
   - :meth:`~music21.chord.Chord.findRoot`
   - :meth:`~music21.chord.Chord.geometricNormalForm`
   - :meth:`~music21.chord.Chord.getChordStep`
   - :meth:`~music21.chord.Chord.getColor`
   - :meth:`~music21.chord.Chord.getNotehead`
   - :meth:`~music21.chord.Chord.getNoteheadFill`
   - :meth:`~music21.chord.Chord.getStemDirection`
   - :meth:`~music21.chord.Chord.getTie`
   - :meth:`~music21.chord.Chord.getVolume`
   - :meth:`~music21.chord.Chord.getZRelation`
   - :meth:`~music21.chord.Chord.hasAnyRepeatedDiatonicNote`
   - :meth:`~music21.chord.Chord.hasComponentVolumes`
   - :meth:`~music21.chord.Chord.hasRepeatedChordStep`
   - :meth:`~music21.chord.Chord.intervalFromChordStep`
   - :meth:`~music21.chord.Chord.inversion`
   - :meth:`~music21.chord.Chord.inversionName`
   - :meth:`~music21.chord.Chord.isAugmentedSixth`
   - :meth:`~music21.chord.Chord.isAugmentedTriad`
   - :meth:`~music21.chord.Chord.isConsonant`
   - :meth:`~music21.chord.Chord.isDiminishedSeventh`
   - :meth:`~music21.chord.Chord.isDiminishedTriad`
   - :meth:`~music21.chord.Chord.isDominantSeventh`
   - :meth:`~music21.chord.Chord.isFalseDiminishedSeventh`
   - :meth:`~music21.chord.Chord.isFrenchAugmentedSixth`
   - :meth:`~music21.chord.Chord.isGermanAugmentedSixth`
   - :meth:`~music21.chord.Chord.isHalfDiminishedSeventh`
   - :meth:`~music21.chord.Chord.isIncompleteMajorTriad`
   - :meth:`~music21.chord.Chord.isIncompleteMinorTriad`
   - :meth:`~music21.chord.Chord.isItalianAugmentedSixth`
   - :meth:`~music21.chord.Chord.isMajorTriad`
   - :meth:`~music21.chord.Chord.isMinorTriad`
   - :meth:`~music21.chord.Chord.isSeventh`
   - :meth:`~music21.chord.Chord.isSwissAugmentedSixth`
   - :meth:`~music21.chord.Chord.isTriad`
   - :meth:`~music21.chord.Chord.removeRedundantPitchClasses`
   - :meth:`~music21.chord.Chord.removeRedundantPitchNames`
   - :meth:`~music21.chord.Chord.removeRedundantPitches`
   - :meth:`~music21.chord.Chord.root`
   - :meth:`~music21.chord.Chord.seekChordTablesAddress`
   - :meth:`~music21.chord.Chord.semiClosedPosition`
   - :meth:`~music21.chord.Chord.semitonesFromChordStep`
   - :meth:`~music21.chord.Chord.setColor`
   - :meth:`~music21.chord.Chord.setNotehead`
   - :meth:`~music21.chord.Chord.setNoteheadFill`
   - :meth:`~music21.chord.Chord.setStemDirection`
   - :meth:`~music21.chord.Chord.setTie`
   - :meth:`~music21.chord.Chord.setVolume`
   - :meth:`~music21.chord.Chord.simplifyEnharmonics`
   - :meth:`~music21.chord.Chord.sortAscending`
   - :meth:`~music21.chord.Chord.sortChromaticAscending`
   - :meth:`~music21.chord.Chord.sortDiatonicAscending`
   - :meth:`~music21.chord.Chord.sortFrequencyAscending`
   - :meth:`~music21.chord.Chord.transpose`

Methods inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :meth:`~music21.note.GeneralNote.addLyric`
   - :meth:`~music21.note.GeneralNote.augmentOrDiminish`
   - :meth:`~music21.note.GeneralNote.getGrace`
   - :meth:`~music21.note.GeneralNote.hasLyrics`
   - :meth:`~music21.note.GeneralNote.insertLyric`

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :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.setContextAttr`
   - :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`

.. rubric:: :class:`~music21.roman.RomanNumeral` instance variables

.. attribute:: RomanNumeral.caseMatters

	
	Boolean to determine whether the case (upper or lowercase) of the
	figure determines whether it is major or minor.  Defaults to True;
	not everything has been tested with False yet.
	

.. attribute:: RomanNumeral.pivotChord

	
	Defaults to None; if not None, stores another interpretation of the
	same RN in a different key; stores a RomanNumeral object.
	

.. attribute:: RomanNumeral.scaleCardinality

	
	Probably you should not need to change this, but stores how many
	notes are in the scale; defaults to 7 for diatonic, obviously.
	

Instance variables inherited from :class:`~music21.note.NotRest`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.NotRest.beams`
   - :attr:`~music21.note.NotRest.isChord`
   - :attr:`~music21.note.NotRest.isNote`
   - :attr:`~music21.note.NotRest.isRest`

Instance variables inherited from :class:`~music21.note.GeneralNote`:

.. hlist::
   :columns: 3

   - :attr:`~music21.note.GeneralNote.articulations`
   - :attr:`~music21.note.GeneralNote.expressions`
   - :attr:`~music21.note.GeneralNote.isChord`
   - :attr:`~music21.note.GeneralNote.lyrics`
   - :attr:`~music21.note.GeneralNote.tie`

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.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.xPosition`
