.. _moduleDynamics:

music21.dynamics
================

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

.. automodule:: music21.dynamics

Functions
---------

.. autofunction:: music21.dynamics.dynamicStrFromDecimal

Dynamic
-------

.. autoclass:: music21.dynamics.Dynamic

.. rubric:: :class:`~music21.dynamics.Dynamic` bases

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

.. rubric:: :class:`~music21.dynamics.Dynamic` read-only properties

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.dynamics.Dynamic` read/write properties

.. autoattribute:: music21.dynamics.Dynamic.positionVertical

.. autoattribute:: music21.dynamics.Dynamic.value

.. autoattribute:: music21.dynamics.Dynamic.volumeScalar

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

.. rubric:: :class:`~music21.dynamics.Dynamic` methods

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.dynamics.Dynamic` instance variables

.. attribute:: Dynamic.englishName

	
	the name of this dynamic in English.
	
	
	>>> d = dynamics.Dynamic('pp')
	>>> d.englishName
	'very soft'
	

.. attribute:: Dynamic.longName

	
	the name of this dynamic in Italian.
	
	
	>>> d = dynamics.Dynamic('pp')
	>>> d.longName
	'pianissimo'
	

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`

Crescendo
---------

.. autoclass:: music21.dynamics.Crescendo

.. rubric:: :class:`~music21.dynamics.Crescendo` bases

- :class:`~music21.dynamics.DynamicWedge`
- :class:`~music21.spanner.Spanner`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.dynamics.Crescendo` read-only properties

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.dynamics.Crescendo` read/write properties

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

.. rubric:: :class:`~music21.dynamics.Crescendo` methods

.. automethod:: music21.dynamics.Crescendo.getEndParameters

.. automethod:: music21.dynamics.Crescendo.getStartParameters

Methods inherited from :class:`~music21.spanner.Spanner`:

.. hlist::
   :columns: 3

   - :meth:`~music21.spanner.Spanner.addSpannedElements`
   - :meth:`~music21.spanner.Spanner.getDurationBySite`
   - :meth:`~music21.spanner.Spanner.getDurationSpanBySite`
   - :meth:`~music21.spanner.Spanner.getFirst`
   - :meth:`~music21.spanner.Spanner.getLast`
   - :meth:`~music21.spanner.Spanner.getOffsetSpanBySite`
   - :meth:`~music21.spanner.Spanner.getOffsetsBySite`
   - :meth:`~music21.spanner.Spanner.getSpannedElementIds`
   - :meth:`~music21.spanner.Spanner.getSpannedElements`
   - :meth:`~music21.spanner.Spanner.getSpannedElementsByClass`
   - :meth:`~music21.spanner.Spanner.getSpannerStorageId`
   - :meth:`~music21.spanner.Spanner.hasSpannedElement`
   - :meth:`~music21.spanner.Spanner.isFirst`
   - :meth:`~music21.spanner.Spanner.isLast`
   - :meth:`~music21.spanner.Spanner.purgeLocations`
   - :meth:`~music21.spanner.Spanner.purgeOrphans`
   - :meth:`~music21.spanner.Spanner.replaceSpannedElement`

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.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.dynamics.Crescendo` instance variables

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`

Diminuendo
----------

.. autoclass:: music21.dynamics.Diminuendo

.. rubric:: :class:`~music21.dynamics.Diminuendo` bases

- :class:`~music21.dynamics.DynamicWedge`
- :class:`~music21.spanner.Spanner`
- :class:`~music21.base.Music21Object`

.. rubric:: :class:`~music21.dynamics.Diminuendo` read-only properties

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.dynamics.Diminuendo` read/write properties

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

.. rubric:: :class:`~music21.dynamics.Diminuendo` methods

.. automethod:: music21.dynamics.Diminuendo.getEndParameters

.. automethod:: music21.dynamics.Diminuendo.getStartParameters

Methods inherited from :class:`~music21.spanner.Spanner`:

.. hlist::
   :columns: 3

   - :meth:`~music21.spanner.Spanner.addSpannedElements`
   - :meth:`~music21.spanner.Spanner.getDurationBySite`
   - :meth:`~music21.spanner.Spanner.getDurationSpanBySite`
   - :meth:`~music21.spanner.Spanner.getFirst`
   - :meth:`~music21.spanner.Spanner.getLast`
   - :meth:`~music21.spanner.Spanner.getOffsetSpanBySite`
   - :meth:`~music21.spanner.Spanner.getOffsetsBySite`
   - :meth:`~music21.spanner.Spanner.getSpannedElementIds`
   - :meth:`~music21.spanner.Spanner.getSpannedElements`
   - :meth:`~music21.spanner.Spanner.getSpannedElementsByClass`
   - :meth:`~music21.spanner.Spanner.getSpannerStorageId`
   - :meth:`~music21.spanner.Spanner.hasSpannedElement`
   - :meth:`~music21.spanner.Spanner.isFirst`
   - :meth:`~music21.spanner.Spanner.isLast`
   - :meth:`~music21.spanner.Spanner.purgeLocations`
   - :meth:`~music21.spanner.Spanner.purgeOrphans`
   - :meth:`~music21.spanner.Spanner.replaceSpannedElement`

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.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.dynamics.Diminuendo` instance variables

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`

DynamicWedge
------------

.. autoclass:: music21.dynamics.DynamicWedge

.. rubric:: :class:`~music21.dynamics.DynamicWedge` bases

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

.. rubric:: :class:`~music21.dynamics.DynamicWedge` read-only properties

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.dynamics.DynamicWedge` read/write properties

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

.. rubric:: :class:`~music21.dynamics.DynamicWedge` methods

Methods inherited from :class:`~music21.spanner.Spanner`:

.. hlist::
   :columns: 3

   - :meth:`~music21.spanner.Spanner.addSpannedElements`
   - :meth:`~music21.spanner.Spanner.getDurationBySite`
   - :meth:`~music21.spanner.Spanner.getDurationSpanBySite`
   - :meth:`~music21.spanner.Spanner.getFirst`
   - :meth:`~music21.spanner.Spanner.getLast`
   - :meth:`~music21.spanner.Spanner.getOffsetSpanBySite`
   - :meth:`~music21.spanner.Spanner.getOffsetsBySite`
   - :meth:`~music21.spanner.Spanner.getSpannedElementIds`
   - :meth:`~music21.spanner.Spanner.getSpannedElements`
   - :meth:`~music21.spanner.Spanner.getSpannedElementsByClass`
   - :meth:`~music21.spanner.Spanner.getSpannerStorageId`
   - :meth:`~music21.spanner.Spanner.hasSpannedElement`
   - :meth:`~music21.spanner.Spanner.isFirst`
   - :meth:`~music21.spanner.Spanner.isLast`
   - :meth:`~music21.spanner.Spanner.purgeLocations`
   - :meth:`~music21.spanner.Spanner.purgeOrphans`
   - :meth:`~music21.spanner.Spanner.replaceSpannedElement`

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.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.dynamics.DynamicWedge` instance variables

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`
