.. _evans--pitch:

pitch
=====

.. automodule:: evans.pitch

.. currentmodule:: evans.pitch

.. container:: svg-container

   .. inheritance-diagram:: evans
      :lineage: evans.pitch

.. raw:: html

   <hr/>

.. rubric:: Classes
   :class: section-header

.. autosummary::
   :nosignatures:

   ~JIPitch

.. autoclass:: JIPitch

   .. raw:: html

      <hr/>

   .. rubric:: Attributes Summary
      :class: class-header

   .. autosummary::
      :nosignatures:

      __add__
      __lt__
      __lte__
      __mod__
      __mul__
      __str__
      __sub__
      __truediv__
      name
      octave
      pitch_class

   .. raw:: html

      <hr/>

   .. rubric:: Special methods
      :class: class-header

   .. automethod:: JIPitch.__add__

   .. container:: inherited

      .. automethod:: JIPitch.__eq__

   .. container:: inherited

      .. automethod:: JIPitch.__float__

   .. container:: inherited

      .. automethod:: JIPitch.__ge__

   .. container:: inherited

      .. automethod:: JIPitch.__gt__

   .. container:: inherited

      .. automethod:: JIPitch.__hash__

   .. container:: inherited

      .. automethod:: JIPitch.__le__

   .. automethod:: JIPitch.__lt__

   .. automethod:: JIPitch.__lte__

   .. automethod:: JIPitch.__mod__

   .. automethod:: JIPitch.__mul__

   .. container:: inherited

      .. automethod:: JIPitch.__repr__

   .. automethod:: JIPitch.__str__

   .. automethod:: JIPitch.__sub__

   .. automethod:: JIPitch.__truediv__

   .. raw:: html

      <hr/>

   .. rubric:: Methods
      :class: class-header

   .. container:: inherited

      .. automethod:: JIPitch.get_name

   .. container:: inherited

      .. automethod:: JIPitch.invert

   .. container:: inherited

      .. automethod:: JIPitch.multiply

   .. container:: inherited

      .. automethod:: JIPitch.transpose

   .. raw:: html

      <hr/>

   .. rubric:: Class & static methods
      :class: class-header

   .. container:: inherited

      .. automethod:: JIPitch.from_hertz

   .. raw:: html

      <hr/>

   .. rubric:: Read-only properties
      :class: class-header

   .. container:: inherited

      .. autoattribute:: JIPitch.arrow

   .. container:: inherited

      .. autoattribute:: JIPitch.hertz

   .. autoattribute:: JIPitch.name

   .. container:: inherited

      .. autoattribute:: JIPitch.number

   .. autoattribute:: JIPitch.octave

   .. autoattribute:: JIPitch.pitch_class

.. raw:: html

   <hr/>

.. rubric:: Functions
   :class: section-header

.. autosummary::
   :nosignatures:

   ~combination_tones
   ~herz_combination_tone_ratios
   ~return_cent_markup
   ~return_vertical_moment_ties
   ~to_nearest_eighth_tone
   ~to_nearest_quarter_tone
   ~to_nearest_sixth_tone
   ~to_nearest_third_tone
   ~to_nearest_twelfth_tone
   ~tonnetz
   ~tune_to_ratio

.. autofunction:: combination_tones

.. autofunction:: herz_combination_tone_ratios

.. autofunction:: return_cent_markup

.. autofunction:: return_vertical_moment_ties

.. autofunction:: to_nearest_eighth_tone

.. autofunction:: to_nearest_quarter_tone

.. autofunction:: to_nearest_sixth_tone

.. autofunction:: to_nearest_third_tone

.. autofunction:: to_nearest_twelfth_tone

.. autofunction:: tonnetz

.. autofunction:: tune_to_ratio