

.. _sphx_glr_examples_models:

.. _examples-models:

Models
======

The :mod:`pulse2percept.models` module provides a number of published and
verified computational models that can be used to predict neural responses or
visual percepts resulting from electrical stimulation, such as
:py:class:`~pulse2percept.models.Nanduri2012Model` and
:py:class:`~pulse2percept.models.AxonMapModel`.

New models can be created by mixing-and-matching spatial and temporal models,
or by creating a new one from scratch.


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Neuropythy [Benson2018]_ is a python package that predicts patient-specific visuotopies based on MRI scans of the human visual cortex. It is possible to use Neuropythy within pulse2percept as the visual field map for cortical models.">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_neuropythy_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_neuropythy.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Neuropythy and Neuralink: Patient specific visual field maps based on MRI</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to apply the :py~pulse2percept.models.ScoreboardModel to a :py~pulse2percept.implants.PRIMA75 implant.">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_beyeler2019_scoreboard_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_beyeler2019_scoreboard.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Beyeler et al. (2019): Focal percepts with the scoreboard model</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the :py~pulse2percept.models.Thompson2003Model.">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_thompson2003_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_thompson2003.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Thompson et al. (2003): Circular phosphenes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to apply the :py~pulse2percept.models.AxonMapModel to an :py~pulse2percept.implants.ArgusII implant.">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_beyeler2019_axonmap_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_beyeler2019_axonmap.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Beyeler et al. (2019): Axonal streaks with the axon map model</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Every computational model needs to assume a mapping between retinal and visual field coordinates (``vfmap``). A number of these visual field maps are provided in the :py~pulse2percept.topography module:">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_visual_field_maps_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_visual_field_maps.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Predicting the perceptual effects of different visual field maps</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the :py~pulse2percept.models.BiphasicAxonMapModel to model the effects of  biphasic pulse train parameters phosphene appearance in an epiretinal implant such as :py~pulse2percept.implants.ArgusII. ">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_granley2021_biphasic_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_granley2021_biphasic.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Granley et al. (2021): Effects of Biphasic Pulse Parameters with the BiphasicAxonMapModel</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to apply the :py~pulse2percept.models.cortex.DynaphosModel (original and official  implementation available here) to an :py~pulse2percept.implants.cortex.Orion implant.">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_dynaphos_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_dynaphos.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">van der Grinten, de Ruyter van Steveninck, Lozano et al. (2023): Phosphene simulation using cortical prostheses</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the :py~pulse2percept.models.Horsager2009Model.">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_horsager2009_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_horsager2009.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Horsager et al. (2009): Predicting temporal sensitivity</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the :py~pulse2percept.models.Nanduri2012Model.">

.. only:: html

  .. image:: /examples/models/images/thumb/sphx_glr_plot_nanduri2012_thumb.png
    :alt:

  :ref:`sphx_glr_examples_models_plot_nanduri2012.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Nanduri et al. (2012): Frequency vs. amplitude modulation</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /examples/models/plot_neuropythy
   /examples/models/plot_beyeler2019_scoreboard
   /examples/models/plot_thompson2003
   /examples/models/plot_beyeler2019_axonmap
   /examples/models/plot_visual_field_maps
   /examples/models/plot_granley2021_biphasic
   /examples/models/plot_dynaphos
   /examples/models/plot_horsager2009
   /examples/models/plot_nanduri2012

