README.rst 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. freesurfer-stats
  2. ================
  3. .. image:: https://travis-ci.org/fphammerle/freesurfer-stats.svg?branch=master
  4. :target: https://travis-ci.org/fphammerle/freesurfer-stats
  5. .. image:: https://coveralls.io/repos/github/fphammerle/freesurfer-stats/badge.svg?branch=master
  6. :target: https://coveralls.io/github/fphammerle/freesurfer-stats?branch=master
  7. .. image:: https://img.shields.io/pypi/v/freesurfer-stats.svg
  8. :target: https://pypi.org/project/freesurfer-stats/#history
  9. .. image:: https://img.shields.io/pypi/pyversions/freesurfer-stats.svg
  10. :target: https://pypi.org/project/freesurfer-stats/
  11. Python Library to Read FreeSurfer's Cortical Parcellation Anatomical Statistics
  12. Freesurfer https://surfer.nmr.mgh.harvard.edu/
  13. Install
  14. -------
  15. .. code:: sh
  16. pip3 install --user freesurfer-stats
  17. Releases follow the `semantic versioning <https://semver.org/>` scheme.
  18. Usage
  19. -----
  20. .. code:: python
  21. >>> from freesurfer_stats import CorticalParcellationStats
  22. >>> stats = CorticalParcellationStats.read('tests/subjects/fabian/stats/lh.aparc.DKTatlas.stats')
  23. >>> stats.headers['subjectname']
  24. 'fabian'
  25. >>> stats.headers['CreationTime'].isoformat()
  26. '2019-05-09T21:05:54+00:00'
  27. >>> stats.headers['cvs_version']
  28. 'Id: mris_anatomical_stats.c,v 1.79 2016/03/14 15:15:34 greve Exp'
  29. >>> stats.headers['cmdline'][:64]
  30. 'mris_anatomical_stats -th3 -mgz -cortex ../label/lh.cortex.label'
  31. >>> stats.hemisphere
  32. 'left'
  33. >>> stats.whole_brain_measurements['estimated_total_intracranial_volume_mm^3']
  34. 0 1.670487e+06
  35. Name: estimated_total_intracranial_volume_mm^3, dtype: float64
  36. >>> stats.whole_brain_measurements['white_surface_total_area_mm^2']
  37. 0 98553
  38. Name: white_surface_total_area_mm^2, dtype: int64
  39. >>> stats.structural_measurements[['structure_name', 'surface_area_mm^2',
  40. ... 'gray_matter_volume_mm^3']].head()
  41. structure_name surface_area_mm^2 gray_matter_volume_mm^3
  42. 0 caudalanteriorcingulate 1472 4258
  43. 1 caudalmiddlefrontal 3039 8239
  44. 2 cuneus 2597 6722
  45. 3 entorhinal 499 2379
  46. 4 fusiform 3079 9064
  47. Load Multiple Stats Files
  48. ~~~~~~~~~~~~~~~~~~~~~~~~~
  49. .. code:: python
  50. >>> import glob, pandas
  51. >>> from freesurfer_stats import CorticalParcellationStats
  52. >>> def load_whole_brain_measurements(stats_path) -> pandas.DataFrame:
  53. ... stats = CorticalParcellationStats.read(stats_path)
  54. ... stats.whole_brain_measurements['subject'] = stats.headers['subjectname']
  55. ... stats.whole_brain_measurements['source_basename'] = os.path.basename(stats_path)
  56. ... stats.whole_brain_measurements['hemisphere'] = stats.hemisphere
  57. ... return stats.whole_brain_measurements
  58. ...
  59. >>> whole_brain_measurements = pandas.concat(
  60. ... map(load_whole_brain_measurements, glob.glob('tests/subjects/fabian/stats/*h.aparc*.stats')),
  61. ... sort=False)
  62. >>> whole_brain_measurements.reset_index(drop=True, inplace=True)
  63. >>> whole_brain_measurements[['subject', 'source_basename', 'hemisphere',
  64. ... 'white_surface_total_area_mm^2', 'pial_surface_total_area_mm^2']]
  65. subject source_basename hemisphere white_surface_total_area_mm^2 pial_surface_total_area_mm^2
  66. 0 fabian lh.aparc.DKTatlas.stats left 98553.0 NaN
  67. 1 fabian rh.aparc.stats right 99468.9 NaN
  68. 2 fabian rh.aparc.a2009s.stats right 99494.9 NaN
  69. 3 fabian rh.aparc.DKTatlas.stats right 99494.9 NaN
  70. 4 fabian lh.aparc.stats left 98536.5 NaN
  71. 5 fabian lh.aparc.pial.stats left NaN 118601.0
  72. 6 fabian rh.aparc.pial.stats right NaN 121260.0
  73. 7 fabian lh.aparc.a2009s.stats left 98553.0 NaN
  74. >>>