:orphan:

Examples
---------------

Start here with a tutorial showing probeinterface.


.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example generates a probe from scratch.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_01_generate_probe_from_sratch_thumb.png
    :alt:

  :doc:`/examples/ex_01_generate_probe_from_sratch`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generate a Probe from scratch</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to manipulate a probe in 2d or 3d.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_02_probe_2d_probe_3d_thumb.png
    :alt:

  :doc:`/examples/ex_02_probe_2d_probe_3d`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">2d and 3d Probes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to assemble several Probe objects into a ProbeGroup object.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_03_generate_probe_group_thumb.png
    :alt:

  :doc:`/examples/ex_03_generate_probe_group`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generate a ProbeGroup</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to deal with multi-shank probes.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_04_multi_shank_probe_thumb.png
    :alt:

  :doc:`/examples/ex_04_multi_shank_probe`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Multi shank probes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Probes can have a complex contacts indexing system due to the probe layout. When they are plugged into a recording device like an Open Ephys with an Intan headstage, the channel order can be mixed again. So the physical contact channel index is rarely the channel index on the device.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_05_device_channel_indices_thumb.png
    :alt:

  :doc:`/examples/ex_05_device_channel_indices`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Handle channel indices</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="probeinterface has its own format based on JSON. The format can handle several probes in one file. It has a &#x27;probes&#x27; key that can contain a list of probes.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_06_import_export_to_file_thumb.png
    :alt:

  :doc:`/examples/ex_06_import_export_to_file`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Import/export functions</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="probeinterface have also basic function to generate simple contact layouts like:">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_07_probe_generator_thumb.png
    :alt:

  :doc:`/examples/ex_07_probe_generator`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Probe generator</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Here are some examples to showcase several plotting scenarios.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_08_more_plotting_examples_thumb.png
    :alt:

  :doc:`/examples/ex_08_more_plotting_examples`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">More plotting examples</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip=" This example demonstrates how to generate a more complicated probe with hybrid contacts shape and contact rotations within the contact_plane_axes attribute.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_09_more_complicated_probe_thumb.png
    :alt:

  :doc:`/examples/ex_09_more_complicated_probe`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">More complicated probes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="probeinterface provides a library of probes from several manufacturers on the GitHub platform: https://github.com/SpikeInterface/probeinterface_library">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_10_get_probe_from_library_thumb.png
    :alt:

  :doc:`/examples/ex_10_get_probe_from_library`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Get probe from library</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Here is an example on how to handle the wiring automatically and to get the device_channel_indices.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_11_automatic_wiring_thumb.png
    :alt:

  :doc:`/examples/ex_11_automatic_wiring`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Automatic wiring</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Here is an example of how to plot values with color scales. And also to plot an interpolated image.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_ex_12_plot_values_thumb.png
    :alt:

  :doc:`/examples/ex_12_plot_values`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot values</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /examples/ex_01_generate_probe_from_sratch
   /examples/ex_02_probe_2d_probe_3d
   /examples/ex_03_generate_probe_group
   /examples/ex_04_multi_shank_probe
   /examples/ex_05_device_channel_indices
   /examples/ex_06_import_export_to_file
   /examples/ex_07_probe_generator
   /examples/ex_08_more_plotting_examples
   /examples/ex_09_more_complicated_probe
   /examples/ex_10_get_probe_from_library
   /examples/ex_11_automatic_wiring
   /examples/ex_12_plot_values



.. only:: html

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

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