docs: document in-browser sulcus drawing (pycortex-roidraw v0.4.0)#656
docs: document in-browser sulcus drawing (pycortex-roidraw v0.4.0)#656jackgallant wants to merge 2 commits into
Conversation
pycortex-roidraw v0.4.0 draws sulci as well as ROIs. Unlike its ROI vertex-set JSON, sulci export as overlays.svg markup -- open, unfilled paths in a sulci layer, one inkscape-labeled group per name, same-named strokes merged one path per hemisphere. So drawn sulci ARE read by pycortex's own machinery once the fragment is merged into a subject's overlay file, which the note now says. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The seealso block hardcoded the roidraw page's old title as link text. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to introduce the new in-browser sulcus drawing feature alongside the existing ROI drawing functionality. It details the differences between ROIs (closed curves exported as JSON) and sulci (open curves exported as SVG), and explains how to draw, edit, and export them. Feedback is provided to clarify a sentence in the documentation regarding how the exported SVG fragment is used by pycortex tools like quickflat.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| stored. Merge the fragment into the subject's ``overlays.svg`` and ``quickflat``, the WebGL viewer, | ||
| and Inkscape all read it. |
There was a problem hiding this comment.
The current phrasing "Merge the fragment into the subject's overlays.svg and quickflat..." can be slightly confusing because quickflat is a Python module/function rather than a file or destination to merge into. Rephrasing this with a semicolon clarifies that quickflat, the WebGL viewer, and Inkscape are the tools that will read the updated overlays.svg file.
| stored. Merge the fragment into the subject's ``overlays.svg`` and ``quickflat``, the WebGL viewer, | |
| and Inkscape all read it. | |
| stored. Merge the fragment into the subject's ``overlays.svg``; then ``quickflat``, the WebGL viewer, | |
| and Inkscape will all read it. |
pycortex-roidraw v0.4.0 draws sulci as well as ROIs. This updates
docs/roidraw.rstto cover it, and fixes a stale cross-link title indocs/rois.rst.Why sulci are worth calling out separately
Drawn ROIs export as a roidraw-native JSON vertex set, independent of the Inkscape ROI-mask system — the existing
.. note::already says so.Sulci are different, and the docs now say why: they are exported as
overlays.svgmarkup, so they are read by pycortex's own machinery (quickflat's sulci overlay, the WebGL viewer, Inkscape) once the fragment is merged into a subject's overlay file.The format matches what pycortex already stores, rather than inventing one:
<path>elements in asulcilayer — the missing trailingzis the only on-disk marker separating a sulcus from an ROI, since both arefill:none;<path>per hemisphere, exactly asCaSis stored infilestore/db/S1/overlays.svg;get_sulci_verts, and the only path→vertex mapping insvgoverlay.pyisset_coords'data-ptidxon label text.Changes
docs/roidraw.rst— retitled "In-browser ROI and sulcus drawing"; new gesture rows for theROI | Sulcusselector; open-curve editing behavior (endpoints show one handle and are always corners); an "Export formats" section covering bothrois.jsonandsulci.svg; the.. note::now distinguishes the two export paths.docs/rois.rst— the.. seealso::block hardcoded the roidraw page's old title as link text.Docs-only; no code changes. Simple-table column widths and section underlines checked.
🤖 Generated with Claude Code