

.. _sphx_glr_examples_stimuli:

.. _examples-stimuli:

Stimuli
=======

The :py:mod:`~pulse2percept.stimuli` module provides a number of common
electrical stimulus types, such as 
:py:class:`~pulse2percept.stimuli.BiphasicPulseTrain`,
which can be assigned to electrodes of a 
:py:class:`~pulse2percept.implants.ProsthesisSystem` object.

Stimuli can also be created from images 
(:py:class:`~pulse2percept.stimuli.ImageStimulus`) and videos
(:py:class:`~pulse2percept.stimuli.VideoStimulus`).


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use videos as input stimuli for a retinal implant.">

.. only:: html

  .. image:: /examples/stimuli/images/thumb/sphx_glr_plot_video_stim_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stimuli_plot_video_stim.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generating a stimulus from a video</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to build and visualize monophasic and biphasic stimuli.">

.. only:: html

  .. image:: /examples/stimuli/images/thumb/sphx_glr_plot_pulses_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stimuli_plot_pulses.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generating monophasic and biphasic pulses</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use :py~pulse2percept.stimuli.PulseTrain and its variants.">

.. only:: html

  .. image:: /examples/stimuli/images/thumb/sphx_glr_plot_pulse_trains_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stimuli_plot_pulse_trains.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generating pulse trains</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use drifting psychophysics-based stimuli for a retinal implant.">

.. only:: html

  .. image:: /examples/stimuli/images/thumb/sphx_glr_plot_psychophysics_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stimuli_plot_psychophysics.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generating a drifting sinusoidal grating or drifting bar stimulus</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use images as input stimuli for a retinal implant.">

.. only:: html

  .. image:: /examples/stimuli/images/thumb/sphx_glr_plot_image_stim_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stimuli_plot_image_stim.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generating a stimulus from an image</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to build a sinusoidal pulse train from scratch.">

.. only:: html

  .. image:: /examples/stimuli/images/thumb/sphx_glr_plot_sinusoidal_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stimuli_plot_sinusoidal.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generating a sinusoidal pulse train</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /examples/stimuli/plot_video_stim
   /examples/stimuli/plot_pulses
   /examples/stimuli/plot_pulse_trains
   /examples/stimuli/plot_psychophysics
   /examples/stimuli/plot_image_stim
   /examples/stimuli/plot_sinusoidal

