Skip to main content

Python Library to Read FreeSurfer's cortical parcellation anatomical statistics

Project description

Python Library to Read FreeSurfer’s Cortical Parcellation Anatomical Statistics subject/stats/[rl]h.aparc.*.stats



pip3 install --user freesurfer-stats

Releases follow the semantic versioning <> scheme.


>>> from freesurfer_stats import CorticalParcellationStats
>>> stats ='tests/subjects/fabian/stats/lh.aparc.DKTatlas.stats')
>>> stats.headers['subjectname']
>>> stats.headers['CreationTime'].isoformat()
>>> stats.headers['cvs_version']
'Id: mris_anatomical_stats.c,v 1.79 2016/03/14 15:15:34 greve Exp'
>>> stats.headers['cmdline'][:64]
'mris_anatomical_stats -th3 -mgz -cortex ../label/lh.cortex.label'
>>> stats.hemisphere
>>> stats.whole_brain_measurements['estimated_total_intracranial_volume_mm^3']
0    1.670487e+06
Name: estimated_total_intracranial_volume_mm^3, dtype: float64
>>> stats.whole_brain_measurements['white_surface_total_area_mm^2']
0    98553
Name: white_surface_total_area_mm^2, dtype: int64
>>> stats.structural_measurements[['structure_name', 'surface_area_mm^2',
...                                'gray_matter_volume_mm^3']].head()
            structure_name  surface_area_mm^2  gray_matter_volume_mm^3
0  caudalanteriorcingulate               1472                     4258
1      caudalmiddlefrontal               3039                     8239
2                   cuneus               2597                     6722
3               entorhinal                499                     2379
4                 fusiform               3079                     9064

Load Multiple Stats Files

>>> import glob, pandas
>>> from freesurfer_stats import CorticalParcellationStats
>>> def load_whole_brain_measurements(stats_path) -> pandas.DataFrame:
...     stats =
...     stats.whole_brain_measurements['subject'] = stats.headers['subjectname']
...     stats.whole_brain_measurements['source_basename'] = os.path.basename(stats_path)
...     stats.whole_brain_measurements['hemisphere'] = stats.hemisphere
...     return stats.whole_brain_measurements
>>> whole_brain_measurements = pandas.concat(
...     map(load_whole_brain_measurements, glob.glob('tests/subjects/fabian/stats/*h.aparc*.stats')),
...     sort=False)
>>> whole_brain_measurements.reset_index(drop=True, inplace=True)
>>> whole_brain_measurements[['subject', 'source_basename', 'hemisphere',
...                           'white_surface_total_area_mm^2', 'pial_surface_total_area_mm^2']]
  subject          source_basename hemisphere  white_surface_total_area_mm^2  pial_surface_total_area_mm^2
0  fabian  lh.aparc.DKTatlas.stats       left                        98553.0                           NaN
1  fabian           rh.aparc.stats      right                        99468.9                           NaN
2  fabian    rh.aparc.a2009s.stats      right                        99494.9                           NaN
3  fabian  rh.aparc.DKTatlas.stats      right                        99494.9                           NaN
4  fabian           lh.aparc.stats       left                        98536.5                           NaN
5  fabian      lh.aparc.pial.stats       left                            NaN                      118601.0
6  fabian      rh.aparc.pial.stats      right                            NaN                      121260.0
7  fabian    lh.aparc.a2009s.stats       left                        98553.0                           NaN

Load Stats File From Webserver, Amazon S3 or Google Cloud Storage

>>> from freesurfer_stats import CorticalParcellationStats
>>> stats ='https://[...]/stats/rh.aparc.stats')
>>> stats.whole_brain_measurements['total_cortical_gray_matter_volume_mm^3']
0    553998.311189
Name: total_cortical_gray_matter_volume_mm^3, dtype: float64

Replace https:// with s3:// or gcs://.

Credentials for S3 may be provided in ~/.aws/credentials or via environment variables. See S3Fs docs.


pip3 install --user pipenv
git clone
cd freesurfer-stats
pipenv sync --dev
pipenv run pylint freesurfer_stats
pipenv run pytest

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for freesurfer-stats, version 1.2.1
Filename, size File type Python version Upload date Hashes
Filename, size freesurfer_stats-1.2.1-py3-none-any.whl (19.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size freesurfer-stats-1.2.1.tar.gz (79.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page