No Description

Fabian Peter Hammerle c11d56330e script: exit with code 66/EX_NOINPUT in case no matching volume files were found 4 years ago
examples 1abafc1ed8 test `python -m` module call to increase coverage 4 years ago
freesurfer_volume_reader a17baf9db2 script: exit with code 66/EX_NOINPUT in case no matching volume files were found 4 years ago
tests a17baf9db2 script: exit with code 66/EX_NOINPUT in case no matching volume files were found 4 years ago
.coveragerc 6b2c883982 coverage: enable branch management 4 years ago
.gitignore 904501c765 set module version string via setuptools_scm's `write_to` option 4 years ago
.pylintrc 0ca4226d54 added ashs.HippocampalSubfieldsVolumeFile.read_volumes_mm3() 4 years ago
.travis.yml 6d0b5d6766 travis-ci: send coverage report to coveralls 4 years ago
Pipfile 863bbde9ed set upper version constraint for dependencies to prevent unexpected breaking changes 4 years ago
Pipfile.lock 863bbde9ed set upper version constraint for dependencies to prevent unexpected breaking changes 4 years ago
README.md 3c7fbbe980 Merge branch 'coverage-badge' 4 years ago
setup.py 4b7481f697 version.py: rename version string variable `version` -> `__version__` to fix pylint C0103 4 years ago

README.md

freesurfer-volume-reader

Build Status Coverage Status Python Versions

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

Install

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

Releases follow the semantic versioning scheme.

Usage

Freesurfer

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 freesurfer

for volume_file in freesurfer.HippocampalSubfieldsVolumeFile.find('/my/freesurfer/subjects'):
    print(volume_file.subject, volume_file.hemisphere, volume_file.analysis_id)
    print(volume_file.read_volumes_mm3())
    print(volume_file.read_volumes_dataframe())

ASHS

export SUBJECTS_DIR=/my/ashs/subjects
freesurfer-volume-reader --source-types ashs

or

freesurfer-volume-reader --source-types ashs -- /my/ashs/subjects
freesurfer-volume-reader --source-types ashs -- /my/ashs/subjects /other/ashs/subjects

or

from freesurfer_volume_reader import ashs

for volume_file in ashs.HippocampalSubfieldsVolumeFile.find('/my/ashs/subjects'):
    print(volume_file.subject, volume_file.hemisphere, volume_file.correction)
    print(volume_file.read_volumes_mm3())
    print(volume_file.read_volumes_dataframe())

Freesurfer & ASHS

freesurfer-volume-reader --source-types ashs freesurfer-hipposf -- /my/subjects
freesurfer-volume-reader --source-types ashs freesurfer-hipposf -- /my/ashs/subjects /my/freesurfer/subjects /other/subjects

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