Skip to content

Commit 12d823b

Browse files
committed
Better docs for plot mode (line, map, auto)
1 parent 80ba2e5 commit 12d823b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/spikeinterface/widgets/motion.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ class MotionWidget(BaseWidget):
1919
segment_index : int | None, default: None
2020
If Motion is multi segment, the must be not None.
2121
mode : "auto" | "line" | "map", default: "line"
22-
How to plot map or lines. "auto" makes it automatic if the number of motion depths is too high.
22+
How to plot the motion.
23+
"line" plots estimated motion at different depths as lines.
24+
"map" plots estimated motion at different depths as a heatmap.
25+
"auto" makes it automatic depending on the number of motion depths.
2326
"""
2427

2528
def __init__(

0 commit comments

Comments
 (0)