Browse Source

added IntracranialVolumeFile to module docstring

Fabian Peter Hammerle 4 years ago
parent
commit
eadd42c2bd
1 changed files with 7 additions and 0 deletions
  1. 7 0
      freesurfer_volume_reader/ashs.py

+ 7 - 0
freesurfer_volume_reader/ashs.py

@@ -9,6 +9,13 @@ https://sites.google.com/site/hipposubfields/home
 >>>     print(volume_file.subject, volume_file.hemisphere, volume_file.correction)
 >>>     print(volume_file.read_volumes_mm3())
 >>>     print(volume_file.read_volumes_dataframe())
+
+>>> from freesurfer_volume_reader.ashs import IntracranialVolumeFile
+>>>
+>>> for volume_file in IntracranialVolumeFile('/my/ashs/subjects'):
+>>>     print(volume_file.subject)
+>>>     print(volume_file.read_volume_mm3())
+>>>     print(volume_file.read_volume_series())
 """
 
 import os