.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/ex_07_probe_generator.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_07_probe_generator.py>`
        to download the full example code.

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

.. _sphx_glr_examples_ex_07_probe_generator.py:


Probe generator
---------------

`probeinterface` have also basic function to generate simple contact layouts like:

  * tetrodes
  * linear probes
  * multi-column probes

.. GENERATED FROM PYTHON SOURCE LINES 14-15

Import

.. GENERATED FROM PYTHON SOURCE LINES 15-22

.. code-block:: Python


    import numpy as np
    import matplotlib.pyplot as plt

    from probeinterface import Probe, ProbeGroup
    from probeinterface.plotting import plot_probe, plot_probegroup








.. GENERATED FROM PYTHON SOURCE LINES 23-25

Generate 4 tetrodes:


.. GENERATED FROM PYTHON SOURCE LINES 25-40

.. code-block:: Python


    from probeinterface import generate_tetrode

    probegroup = ProbeGroup()
    for i in range(4):
        tetrode = generate_tetrode()
        tetrode.move([i * 50, 0])
        probegroup.add_probe(tetrode)
    probegroup.set_global_device_channel_indices(np.arange(16))

    df = probegroup.to_dataframe()
    df

    plot_probegroup(probegroup, with_contact_id=True, same_axes=True)




.. image-sg:: /examples/images/sphx_glr_ex_07_probe_generator_001.png
   :alt: ex 07 probe generator
   :srcset: /examples/images/sphx_glr_ex_07_probe_generator_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 41-43

Generate a linear probe:


.. GENERATED FROM PYTHON SOURCE LINES 43-49

.. code-block:: Python


    from probeinterface import generate_linear_probe

    linear_probe = generate_linear_probe(num_elec=16, ypitch=20)
    plot_probe(linear_probe, with_contact_id=True)




.. image-sg:: /examples/images/sphx_glr_ex_07_probe_generator_002.png
   :alt: Probe - 16ch
   :srcset: /examples/images/sphx_glr_ex_07_probe_generator_002.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    (<matplotlib.collections.PolyCollection object at 0x72b467d27910>, <matplotlib.collections.PolyCollection object at 0x72b4595ab100>)



.. GENERATED FROM PYTHON SOURCE LINES 50-52

Generate a multi-column probe:


.. GENERATED FROM PYTHON SOURCE LINES 52-62

.. code-block:: Python


    from probeinterface import generate_multi_columns_probe

    multi_columns = generate_multi_columns_probe(num_columns=3,
                                                 num_contact_per_column=[10, 12, 10],
                                                 xpitch=22, ypitch=20,
                                                 y_shift_per_column=[0, -10, 0],
                                                 contact_shapes='square', contact_shape_params={'width': 12})
    plot_probe(multi_columns, with_contact_id=True, )




.. image-sg:: /examples/images/sphx_glr_ex_07_probe_generator_003.png
   :alt: Probe - 32ch
   :srcset: /examples/images/sphx_glr_ex_07_probe_generator_003.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    (<matplotlib.collections.PolyCollection object at 0x72b45954a590>, <matplotlib.collections.PolyCollection object at 0x72b459549b70>)



.. GENERATED FROM PYTHON SOURCE LINES 63-65

Generate a square probe:


.. GENERATED FROM PYTHON SOURCE LINES 65-74

.. code-block:: Python


    square_probe = generate_multi_columns_probe(num_columns=12,
                                                num_contact_per_column=12,
                                                xpitch=10, ypitch=10,
                                                contact_shapes='square', contact_shape_params={'width': 8})
    square_probe.create_auto_shape('rect')
    plot_probe(square_probe)

    plt.show()



.. image-sg:: /examples/images/sphx_glr_ex_07_probe_generator_004.png
   :alt: Probe - 144ch
   :srcset: /examples/images/sphx_glr_ex_07_probe_generator_004.png
   :class: sphx-glr-single-img






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

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


.. _sphx_glr_download_examples_ex_07_probe_generator.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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