.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/ex_10_get_probe_from_library.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_ex_10_get_probe_from_library.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_ex_10_get_probe_from_library.py:


Get probe from library
----------------------

`probeinterface` provides a library of probes from several manufacturers on the GitHub platform:
https://github.com/SpikeInterface/probeinterface_library

Users and manufacturers are welcome to contribute to it.

The Python module provide a function to download and cache files locally
in the `probeinterface` json-based format.

.. GENERATED FROM PYTHON SOURCE LINES 15-23

.. code-block:: Python

    from pprint import pprint

    import numpy as np
    import matplotlib.pyplot as plt

    from probeinterface import Probe, get_probe
    from probeinterface.plotting import plot_probe








.. GENERATED FROM PYTHON SOURCE LINES 24-25

Download one probe:

.. GENERATED FROM PYTHON SOURCE LINES 25-32

.. code-block:: Python


    manufacturer = 'neuronexus'
    probe_name = 'A1x32-Poly3-10mm-50-177'

    probe = get_probe(manufacturer, probe_name)
    print(probe)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Probe - neuronexus - A1x32-Poly3-10mm-50-177 - 32ch




.. GENERATED FROM PYTHON SOURCE LINES 33-35

Files from the library also contain annotations specific to manufacturers.
We can see here that Neuronexus probes have contact indices starting at "1" (one-based)

.. GENERATED FROM PYTHON SOURCE LINES 35-38

.. code-block:: Python


    pprint(probe.annotations)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    {'first_index': 1,
     'manufacturer': 'neuronexus',
     'model_name': 'A1x32-Poly3-10mm-50-177'}




.. GENERATED FROM PYTHON SOURCE LINES 39-41

When plotting, the channel indices are automatically displayed with
one-based notation (even if internally everything is still zero based):

.. GENERATED FROM PYTHON SOURCE LINES 41-44

.. code-block:: Python


    plot_probe(probe, with_contact_id=True)




.. image-sg:: /examples/images/sphx_glr_ex_10_get_probe_from_library_001.png
   :alt: Probe - neuronexus - A1x32-Poly3-10mm-50-177 - 32ch
   :srcset: /examples/images/sphx_glr_ex_10_get_probe_from_library_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    (<matplotlib.collections.PolyCollection object at 0x72b45932e9e0>, <matplotlib.collections.PolyCollection object at 0x72b459832140>)



.. GENERATED FROM PYTHON SOURCE LINES 45-47

.. code-block:: Python


    plt.show()








.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.128 seconds)


.. _sphx_glr_download_examples_ex_10_get_probe_from_library.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: ex_10_get_probe_from_library.ipynb <ex_10_get_probe_from_library.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: ex_10_get_probe_from_library.py <ex_10_get_probe_from_library.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: ex_10_get_probe_from_library.zip <ex_10_get_probe_from_library.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_