No Description

Fabian Peter Hammerle 124f351260 rename class freesurfer.FreesurferHippocampalVolumeFile -> freesurfer.HippocampalSubfieldsVolumeFile 5 years ago
examples 124f351260 rename class freesurfer.FreesurferHippocampalVolumeFile -> freesurfer.HippocampalSubfieldsVolumeFile 5 years ago
freesurfer_volume_reader 124f351260 rename class freesurfer.FreesurferHippocampalVolumeFile -> freesurfer.HippocampalSubfieldsVolumeFile 5 years ago
tests 124f351260 rename class freesurfer.FreesurferHippocampalVolumeFile -> freesurfer.HippocampalSubfieldsVolumeFile 5 years ago
.gitignore 5af1308d8e git ignore build/ & dist/ 5 years ago
.pylintrc 07b02d4e5b pylint: disable missing-docstring 5 years ago
.travis.yml 9f97bd4982 travis-ci: exclude pandas-version<=0.23 && python>=3.7 due to compile error 5 years ago
Pipfile 8fd97e7d69 added failing test covering invalid root path '/' 5 years ago
Pipfile.lock 8fd97e7d69 added failing test covering invalid root path '/' 5 years ago
README.md dc771c0829 accept multiple args for positional param `root_dir_paths` 5 years ago
setup.py f00fbdee19 setup.py: fix description (1 line only), added long description 5 years ago

README.md

freesurfer-volume-reader

Build Status

Python script & library to read hippocampal subfield volumes computed by Freesurfer

https://surfer.nmr.mgh.harvard.edu/fswiki/HippocampalSubfields

Install

pip3 install --user freesurfer-volume-reader
freesurfer-volume-reader --help

Usage

export SUBJECTS_DIR=/my/freesurfer/subjects
freesurfer-volume-reader

or

freesurfer-volume-reader /my/freesurfer/subjects
freesurfer-volume-reader /my/freesurfer/subjects /other/freesurfer/subjects

or

from freesurfer_volume_reader import find_hippocampal_volume_files, \
                                     read_hippocampal_volume_file_dataframe

for volume_file_path in find_hippocampal_volume_files('/my/freesurfer/subjects'):
    print(read_hippocampal_volume_file_dataframe(volume_file_path))

Tests

pip3 install --user pipenv
git clone https://github.com/fphammerle/freesurfer-volume-reader.git
cd freesurfer-volume-reader
pipenv run pylint freesurfer_volume_reader
pipenv run pytest