README.rst 4.4 KB

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