Envelopes
==========

Available Envelopes
-------------------

``graph-pes`` exposes the :class:`~graph_pes.models.components.distances.Envelope`
base class, together with implementations of a few common envelope functions:

.. autoclass:: graph_pes.models.components.distances.PolynomialEnvelope
    :show-inheritance:

.. autoclass:: graph_pes.models.components.distances.SmoothOnsetEnvelope
    :show-inheritance:

.. autoclass:: graph_pes.models.components.distances.CosineEnvelope
    :show-inheritance:

Implementing a new Envelope
---------------------------

.. autoclass:: graph_pes.models.components.distances.Envelope
    :members: