.. _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.prebase.ProtoM21Object`

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

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

.. 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.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. 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.groups

.. 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

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

.. automethod:: music21.pitch.Pitch.__eq__

.. 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.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.informClient

.. 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.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

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

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

.. attribute:: Pitch.spellingIsInferred

	
	Returns True or False about whether enharmonic spelling
	Has been inferred on pitch creation or whether it has
	been specified directly.
	
	MIDI 61 is C# or D- equally.
	
	>>> p = pitch.Pitch('C4')
	>>> p.spellingIsInferred
	False
	>>> p.ps = 61
	>>> p.spellingIsInferred
	True
	>>> p.name
	'C#'
	>>> p.name = 'C#'
	>>> p.spellingIsInferred
	False
	
	This makes a difference in transposing.  For instance:
	
	>>> pInferred = pitch.Pitch(61)
	>>> pNotInferred = pitch.Pitch('C#4')
	>>> pInferred.nameWithOctave, pNotInferred.nameWithOctave
	('C#4', 'C#4')
	>>> pInferred.spellingIsInferred, pNotInferred.spellingIsInferred
	(True, False)
	
	>>> inferredTransposed = pInferred.transpose('A1')
	>>> inferredTransposed.nameWithOctave
	'D4'
	>>> notInferredTransposed = pNotInferred.transpose('A1')
	>>> notInferredTransposed.nameWithOctave
	'C##4'
	
	An operation like diatonic transposition should retain the spelling is inferred
	for the resulting object
	
	>>> inferredTransposed.spellingIsInferred, notInferredTransposed.spellingIsInferred
	(True, False)
	
	But Chromatic transposition can change an object to inferred spelling:
	
	>>> p3 = notInferredTransposed.transpose(1)  # C## -> E- not to C###
	>>> p3.nameWithOctave
	'E-4'
	>>> p3.spellingIsInferred
	True
	

Accidental
----------

.. autoclass:: music21.pitch.Accidental

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

- :class:`~music21.prebase.ProtoM21Object`
- :class:`~music21.style.StyleMixin`
- :class:`~music21.common.objects.SlottedObjectMixin`

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

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

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

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

Read-only properties inherited from :class:`~music21.style.StyleMixin`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.StyleMixin.hasEditorialInformation`
   - :attr:`~music21.style.StyleMixin.hasStyleInformation`

.. 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

Read/write properties inherited from :class:`~music21.style.StyleMixin`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.StyleMixin.editorial`
   - :attr:`~music21.style.StyleMixin.style`

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

.. automethod:: music21.pitch.Accidental.__eq__

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

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

.. automethod:: music21.pitch.Accidental.listNames

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

.. automethod:: music21.pitch.Accidental.setAttributeIndependently

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

.. hlist::
   :columns: 3

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

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

.. attribute:: Accidental.displayLocation

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

.. attribute:: Accidental.displaySize

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

.. attribute:: Accidental.displayStyle

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

Microtone
---------

.. autoclass:: music21.pitch.Microtone

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

- :class:`~music21.prebase.ProtoM21Object`
- :class:`~music21.common.objects.SlottedObjectMixin`

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

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

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

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.pitch.Microtone` read/write properties

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

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

.. automethod:: music21.pitch.Microtone.__eq__

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

.. hlist::
   :columns: 3

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

Functions
---------

.. autofunction:: music21.pitch.convertPitchClassToStr

.. autofunction:: music21.pitch.isValidAccidentalName

.. autofunction:: music21.pitch.simplifyMultipleEnharmonics

.. autofunction:: music21.pitch.standardizeAccidentalName