From a203c17b88b25452e22863b90d3cac9b8481ce6b Mon Sep 17 00:00:00 2001 From: Alessio Buccino Date: Tue, 27 Jun 2023 12:58:49 +0200 Subject: [PATCH 1/2] Small docs improvement for set_contacts plane_Axes --- src/probeinterface/probe.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/probeinterface/probe.py b/src/probeinterface/probe.py index eccc7e0..c605e30 100644 --- a/src/probeinterface/probe.py +++ b/src/probeinterface/probe.py @@ -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. From efd70302880ca577b7b1452a5027734395c017c9 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 27 Jun 2023 10:59:45 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- src/probeinterface/probe.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/probeinterface/probe.py b/src/probeinterface/probe.py index c605e30..ba2548c 100644 --- a/src/probeinterface/probe.py +++ b/src/probeinterface/probe.py @@ -164,7 +164,7 @@ def set_contacts(self, positions, shapes="circle", shape_params={"radius": 10}, shape_params : dict or list of dict Contains kwargs for shapes ("radius" for circle, "width" for square, "width/height" for rect) plane_axes : np.array (num_contacts, 2, ndim) - Defines the two axes of the contact plane for each electrode. + 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