.. _modulePitch:

music21.pitch
=============

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

.. automodule:: music21.pitch

Pitch
-----

.. autoclass:: music21.pitch.Pitch

.. rubric:: :class:`~music21.pitch.Pitch` bases

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

.. rubric:: :class:`~music21.pitch.Pitch` read-only properties

.. autoattribute:: music21.pitch.Pitch.alter

.. autoattribute:: music21.pitch.Pitch.dutch

.. autoattribute:: music21.pitch.Pitch.french

.. autoattribute:: music21.pitch.Pitch.fullName

.. autoattribute:: music21.pitch.Pitch.german

.. autoattribute:: music21.pitch.Pitch.implicitOctave

.. autoattribute:: music21.pitch.Pitch.italian

.. autoattribute:: music21.pitch.Pitch.spanish

.. autoattribute:: music21.pitch.Pitch.unicodeName

.. autoattribute:: music21.pitch.Pitch.unicodeNameWithOctave

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

.. rubric:: :class:`~music21.pitch.Pitch` read/write properties

.. autoattribute:: music21.pitch.Pitch.accidental

.. autoattribute:: music21.pitch.Pitch.diatonicNoteNum

.. autoattribute:: music21.pitch.Pitch.freq440

.. autoattribute:: music21.pitch.Pitch.frequency

.. autoattribute:: music21.pitch.Pitch.microtone

.. autoattribute:: music21.pitch.Pitch.midi

.. autoattribute:: music21.pitch.Pitch.name

.. autoattribute:: music21.pitch.Pitch.nameWithOctave

.. autoattribute:: music21.pitch.Pitch.octave

.. autoattribute:: music21.pitch.Pitch.pitchClass

.. autoattribute:: music21.pitch.Pitch.pitchClassString

.. autoattribute:: music21.pitch.Pitch.ps

.. autoattribute:: music21.pitch.Pitch.step

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.seconds`

.. rubric:: :class:`~music21.pitch.Pitch` methods

.. automethod:: music21.pitch.Pitch.convertMicrotonesToQuarterTones

.. automethod:: music21.pitch.Pitch.convertQuarterTonesToMicrotones

.. automethod:: music21.pitch.Pitch.getAllCommonEnharmonics

.. automethod:: music21.pitch.Pitch.getCentShiftFromMidi

.. automethod:: music21.pitch.Pitch.getEnharmonic

.. automethod:: music21.pitch.Pitch.getHarmonic

.. automethod:: music21.pitch.Pitch.getHigherEnharmonic

.. automethod:: music21.pitch.Pitch.getLowerEnharmonic

.. automethod:: music21.pitch.Pitch.getMidiPreCentShift

.. automethod:: music21.pitch.Pitch.getStringHarmonic

.. automethod:: music21.pitch.Pitch.harmonicAndFundamentalFromPitch

.. automethod:: music21.pitch.Pitch.harmonicAndFundamentalStringFromPitch

.. automethod:: music21.pitch.Pitch.harmonicFromFundamental

.. automethod:: music21.pitch.Pitch.harmonicString

.. automethod:: music21.pitch.Pitch.isEnharmonic

.. automethod:: music21.pitch.Pitch.isTwelveTone

.. automethod:: music21.pitch.Pitch.simplifyEnharmonic

.. automethod:: music21.pitch.Pitch.transpose

.. automethod:: music21.pitch.Pitch.transposeAboveTarget

.. automethod:: music21.pitch.Pitch.transposeBelowTarget

.. automethod:: music21.pitch.Pitch.updateAccidentalDisplay

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

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.addContext`
   - :meth:`~music21.base.Music21Object.addLocation`
   - :meth:`~music21.base.Music21Object.findAttributeInHierarchy`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextAttr`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getSiteIds`
   - :meth:`~music21.base.Music21Object.getSites`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.hasContext`
   - :meth:`~music21.base.Music21Object.hasSite`
   - :meth:`~music21.base.Music21Object.hasSpannerSite`
   - :meth:`~music21.base.Music21Object.hasVariantSite`
   - :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.removeLocationBySiteId`
   - :meth:`~music21.base.Music21Object.setContextAttr`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.unwrapWeakref`
   - :meth:`~music21.base.Music21Object.wrapWeakref`
   - :meth:`~music21.base.Music21Object.write`

.. rubric:: :class:`~music21.pitch.Pitch` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.hideObjectOnPrint`
   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isVariant`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.isSpanner`
   - :attr:`~music21.base.Music21Object.xPosition`

Accidental
----------

.. autoclass:: music21.pitch.Accidental

.. rubric:: :class:`~music21.pitch.Accidental` bases

- :class:`~music21.base.SlottedObject`

.. rubric:: :class:`~music21.pitch.Accidental` read-only properties

.. autoattribute:: music21.pitch.Accidental.fullName

.. autoattribute:: music21.pitch.Accidental.unicode

.. rubric:: :class:`~music21.pitch.Accidental` read/write properties

.. autoattribute:: music21.pitch.Accidental.alter

.. autoattribute:: music21.pitch.Accidental.displayStatus

.. autoattribute:: music21.pitch.Accidental.displayType

.. autoattribute:: music21.pitch.Accidental.modifier

.. autoattribute:: music21.pitch.Accidental.name

.. rubric:: :class:`~music21.pitch.Accidental` methods

.. automethod:: music21.pitch.Accidental.inheritDisplay

.. automethod:: music21.pitch.Accidental.isTwelveTone

.. automethod:: music21.pitch.Accidental.set

.. rubric:: :class:`~music21.pitch.Accidental` instance variables

.. attribute:: Accidental.alter

	A signed decimal representing the number of half-steps shifted
	by this Accidental, such as 1.0 for a sharp and -.5 for a quarter tone flat.

.. attribute:: Accidental.displayLocation

	Location of accidental: "normal", "above", "below".

.. attribute:: Accidental.displaySize

	Size in display: "cue", "large", or a percentage.

.. attribute:: Accidental.displayStatus

	Determines if this Accidental is to be displayed; can be None (for not set), True, or False.

.. attribute:: Accidental.displayStyle

	Style of display: "parentheses", "bracket", "both".

.. attribute:: Accidental.modifier

	A string symbol used to modify the pitch name, such as "#" or
	"-" for sharp and flat, respectively.

.. attribute:: Accidental.name

	A string name of the Accidental, such as "sharp" or
	"double-flat".

Microtone
---------

.. autoclass:: music21.pitch.Microtone

.. rubric:: :class:`~music21.pitch.Microtone` bases

- :class:`~music21.base.SlottedObject`

.. rubric:: :class:`~music21.pitch.Microtone` read-only properties

.. autoattribute:: music21.pitch.Microtone.alter

.. autoattribute:: music21.pitch.Microtone.cents

.. rubric:: :class:`~music21.pitch.Microtone` read/write properties

.. autoattribute:: music21.pitch.Microtone.harmonicShift
