pyFSViz
Description
Python tools for FreeSurfer visualization and quality assurance. pyFSViz builds HTML reports
from existing recon-all output (individual screenshots and group metric
summaries). It does not run FreeSurfer reconstructions.
While manual QA of FreeSurfer data is always recommended, this workflow become untenable with larger datasets, especially longitudinal ones. Several tools are available (some of which are utilized by this package), however, after doing manual QA myself for years, I've found a few key pieces missing.
- The ability to check Talairach registrations (an important first step as this affects downstream processing and brain volume calculations)
- An easy way to check for outliers at a glance (can be done statistically later on but also useful in catching errors earlier on in the process, especially for large datasets)
- Comparison between groups (especially helpful for multi-site data that may have different scanner characteristics)
pyFSViz relies on code from Deep-MI's fsqc, as well as other neuroimaging python packages such as nipype and nireports.
FreeSurfer and FSL are not part of this install. Install those tools separately and source their setup scripts in the same shell or job before using pyFSViz. See Prerequisites.
Installation
Requires Python 3.10 or newer. This installs the Python package only.
pip install pyfsviz
With uv:
uv tool install pyfsviz
Usage
After FreeSurfer and FSL are initialized:
from pyfsviz import FreeSurfer
fs = FreeSurfer()
fs.gen_batch_reports("reports/")
fs.gen_group_report("reports/")
See the quick start for output layout, group comparisons, and batch flags.
Acknowledgements
Thanks to pawamoy's copier project for package templates!
AI Disclosure
Please note that the default Cursor Agent was used in this project. This included models suchs as Grok-4.6 and Composer-2.5. The agent was used to improve base code, add testing, help with html development, and documentation.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyfsviz-0.6.4.tar.gz.
File metadata
- Download URL: pyfsviz-0.6.4.tar.gz
- Upload date:
- Size: 8.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c19e41c35a512a0867cd90d05de32cfcb01dd23c15404fc0a794fdbab56962b0
|
|
| MD5 |
05a8f3e7cbc0f07b57ee5de9d9bfc8ba
|
|
| BLAKE2b-256 |
8280c06275393852e9c41f7ca8690aa27eb9dca323d29dfbf20191af36419f12
|
File details
Details for the file pyfsviz-0.6.4-py3-none-any.whl.
File metadata
- Download URL: pyfsviz-0.6.4-py3-none-any.whl
- Upload date:
- Size: 6.6 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c02f7eabace4ac8bcf29f6b583ce4359001b4c96ce0b76fd2539aab680531222
|
|
| MD5 |
b8494a4afb8f3519e041e37c312636eb
|
|
| BLAKE2b-256 |
31d509dd04012ce74fe2b6e5f8a186f83b3157ebd856d037b474f5041d346d29
|
