Browse Source

extend docstring sample: chain Freesurfer & ASHS find() iterator

Fabian Peter Hammerle 5 years ago
parent
commit
898d71570b
1 changed files with 8 additions and 3 deletions
  1. 8 3
      freesurfer_volume_reader/__init__.py

+ 8 - 3
freesurfer_volume_reader/__init__.py

@@ -1,11 +1,16 @@
 """
-Read hippocampal subfield volumes computed by Freesurfer
+Read hippocampal subfield volumes computed by Freesurfer and/or ASHS
 
+https://sites.google.com/site/hipposubfields/home
 https://surfer.nmr.mgh.harvard.edu/fswiki/HippocampalSubfields
 
->>> from freesurfer_volume_reader.freesurfer import HippocampalSubfieldsVolumeFile
+>>> from freesurfer_volume_reader import ashs, freesurfer
 >>>
->>> for volume_file in HippocampalSubfieldsVolumeFile.find('/my/freesurfer/subjects'):
+>>> for volume_file in itertools.chain(
+>>>         ashs.HippocampalSubfieldsVolumeFile.find('/my/ashs/subjects'),
+>>>         freesurfer.HippocampalSubfieldsVolumeFile.find('/my/freesurfer/subjects')):
+>>>     print(volume_file.absolute_path)
+>>>     print(volume_file.subject, volume_file.hemisphere)
 >>>     print(volume_file.read_volumes_mm3())
 >>>     print(volume_file.read_volumes_dataframe())
 """