Skip to content

Commit

Permalink
Merge pull request #198 from SpikeInterface/set-contacts-docs
Browse files Browse the repository at this point in the history
Small docs improvement for set_contacts plane_Axes
  • Loading branch information
alejoe91 authored Jun 27, 2023
2 parents 7daa68c + efd7030 commit 59598c2
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/probeinterface/probe.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,9 @@ def set_contacts(self, positions, shapes="circle", shape_params={"radius": 10},
Shape of each contact ('circle'/'square'/'rect').
shape_params : dict or list of dict
Contains kwargs for shapes ("radius" for circle, "width" for square, "width/height" for rect)
plane_axes : (num_contacts, 2, ndim)
Defines the axes of the contact plane (2d or 3d)
plane_axes : np.array (num_contacts, 2, ndim)
Defines the two axes of the contact plane for each electrode.
The third dimension corresponds to the probe `ndim` (2d or 3d).
shank_ids : None or array of str
Defines the shank ids for the contacts. If None, then
these are assigned to a unique Shank.
Expand Down

0 comments on commit 59598c2

Please sign in to comment.