Repository navigation
This release brings several major features, more consistent rendering pipelines, and improved code quality and documentation.
What's Changed
⚠️ Breaking changes
nanmean = Trueis now default forcortex.quickshowandcortex.webshow- NaN values are treated consistently in the quickflat and WebGL viewers. A NaN anywhere at any channel of a voxel/vertex (data, either dimension of a 2D view, any RGB channel, or the alpha map) renders fully transparent; otherwise the alpha (2D colormap, alpha= kwarg, RGB alpha channel) is honored. (See more: #695)
New features
- NF bumpy flatmap redesign by @alexhuth in #720
- NF webgl views animation gui by @marklescroart in #752
- NF optimize 4D timeseries performance and add interactive timeseries panel by @jwparks in #745
Enhancements
- ENH automatically flatten surfaces with autoflatten in import_subj by @mvdoc in #735
- fix windows support by @candytaco in #701
- ENH {Vertex,Volume}.random uses low-frequency noise by @marklescroart in #716
- ENH item access support for subject/surface/transform names by @alexhuth in #709
- ENH Pure-python surf2surf matrix (direct nnfr construction) by @mvdoc in #651
- ENH Visualize HCP fs_LR 32k data and resample to fsaverage (cortex.hcp) by @mvdoc in #655
- NF: refactor webgl lighting by @mvdoc in #679
- webgl: bind an OS-assigned ephemeral port for the viewer server by @mvdoc in #676
- WebGL viewer: make opacity slider and
otoggle work for Vertex data by @mvdoc in #685 - Allow viewer data to be updated in real-time (supersedes #142) by @mvdoc in #675
- Add pinch-to-zoom support for trackpads and touchscreens by @alexhuth in #707
Bugfixes
- replace np.in1d with np.isin by @candytaco in #641
- FIX: change the way inkscape version is set by @marklescroart in #689
- FIX bumpy flatmap smoothing skipped on the left hemisphere by @mvdoc in #678
- webgl: fix interpreter-exit deadlock in headless_viewer by @mvdoc in #677
- FIX: updated two colormaps by @marklescroart in #649
- FIX: fix minor bug in handling of vmin and vmax by @marklescroart in #681
- WebGL viewer: fix help-menu shortcut display by @jackgallant in #642
- Fix shader problem that broke 2-D vertex data by @alexhuth in #715
- FIX unify NaN and alpha handling across quickflat, WebGL and RGB dataviews by @mvdoc in #695
- webgl: fix overlay/label async texture-bake races (complete) by @jackgallant in #653
Maintenance and CI
- MNT remove obsolete Python 2 syntax, add some types by @kroq-gar78 in #666
- ENH add types for Database and transforms by @kroq-gar78 in #667
- DOC fix build warnings by @kroq-gar78 in #673
- MNT replaced deprecated tempfile.mktemp with mkstemp by @AgarwalNilay in #690
- ENH add types for dataset classes (BrainData, Dataview, ...) by @kroq-gar78 in #669
- ENH add types and tests for quickflat by @kroq-gar78 in #682
- TST add visual regression tests by @kroq-gar78 in #672
- Open the webgl viewer at localhost rather than the machine's hostname by @marklescroart in #734
- Update S1 overlays.svg and documentation by @mvdoc in #751
- TST mock download_subject test to improve flakyness by @mvdoc in #640
- MNT ignore docs build outputs written into the source tree by @mvdoc in #680
Documentation
-
docs: add in-browser ROI drawing (pycortex-roidraw) page by @jackgallant in #652
-
docs: document in-browser sulcus drawing (pycortex-roidraw v0.4.0) by @jackgallant in #656
-
docs: correct the sulcus install instructions, which destroyed existing sulci by @jackgallant in #657
-
add get_mapper docstring by @AgarwalNilay in #686
-
Document Freesurfer import functionality and surface-info files by @alexhuth in #697
-
docs(utils): filled out docstrings by @AgarwalNilay in #710
-
docs(freesurfer): backfill missing docstrings across the module by @AgarwalNilay in #687
-
Docs/volume docstrings by @AgarwalNilay in #711
-
Docs/xfm docstrings by @AgarwalNilay in #713
-
polyutils: fill missing docstrings in Surface class by @AgarwalNilay in #691
-
DOC: add AGENTS.md and CLAUDE.md for AI coding agents by @mvdoc in #717
-
docs(quickflat): add missing Returns, fix stale kwargs docs in view.py by @AgarwalNilay in #692
-
docs(segment): added **kwargs in docstrings by @AgarwalNilay in #693
-
docs(surfinfo): add missing docstring for flat_border by @AgarwalNilay in #694
-
Docs/webgl view docstrings by @AgarwalNilay in #712
-
Docs/dataset docstrings by @AgarwalNilay in #688
New Contributors
- @jackgallant made their first contribution in #652
- @AgarwalNilay made their first contribution in #686
- @jwparks made their first contribution in #745
Full Changelog: v1.3.2...v1.4.0