Improved documentation of the surface measures extraction.

Author: mfmachado

nipype/interfaces/cat12/surface.py

@@ -73,16 +73,16 @@ class ExtractAdditionalSurfaceParameters(SPMCommand):
 
     Examples
     --------
-     # Set the left surface files, both will be processed
-     lh_path_central = ...
-
-     # Put here all surface files generated by CAT12 Segment, this is only required if the this approach is putted in
-     # a Node
-     surf_files = [rh.sphere..., lh.sphere..., etc]
-
-     extract_additional_measures = ExtractAdditionalSurfaceParameters(left_central_surfaces=lh_path_central,
-                                                                       surface_files=surf_files)
-     extract_additional_measures.run()
+    >>> # Set the left surface files, both will be processed
+    >>> lh_path_central = 'lh.central.subject_filename.gii'
+    >>> # Put here all surface files generated by CAT12 Segment, this is only required if the this approach is putted in
+    >>> surf_files = ["lh.sphere.reg.subject_filename.gii", "rh.sphere.reg.subject_filename.gii", \
+                      "lh.sphere.subject_filename.gii", "rh.sphere.subject_filename.gii", \
+                      'rh.central.subject_filename.gii', \
+                      'lh.pbt.subject_filename', 'rh.pbt.subject_filename']
+    >>> extract_additional_measures = ExtractAdditionalSurfaceParameters(left_central_surfaces=lh_path_central, \
+                                                                         surface_files=surf_files)
+    >>> extract_additional_measures.run() # doctest: +SKIP
 
     """
     input_spec = ExtractAdditionalSurfaceParametersInputSpec
@@ -164,22 +164,23 @@ class ExtractROIBasedSurfaceMeasures(SPMCommand):
 
      Examples
      --------
-     # Template surface files
-     lh_atlas = sys.argv[2]
-     rh_atlas = sys.argv[3]
-
-     # Put here all surface files generated by CAT12 Segment, this is only required if the this approach is putted in
-     # a Node
-     surf_files = [rh.sphere..., lh.sphere..., etc]
-
+    >>> # Template surface files
+    >>> lh_atlas = "lh.aparc_a2009s.freesurfer.annot"
+    >>> rh_atlas = "rh.aparc_a2009s.freesurfer.annot"
+
+    >>> # Put here all surface files generated by CAT12 Segment, this is only required if the this approach is putted in a Node
+    >>> surf_files = ["lh.sphere.reg.subject_filename.gii", "rh.sphere.reg.subject_filename.gii", \
+                      "lh.sphere.subject_filename.gii", "rh.sphere.subject_filename.gii", \
+                      'lh.central.subject_filename.gii', 'rh.central.subject_filename.gii', \
+                      'lh.pbt.subject_filename', 'rh.pbt.subject_filename']
      # Set the path to the left hemisphere measure file, both will be processed
-     lh_measure = ....
+    >>> lh_measure = "lh.area.subject_filename"
 
-     extract_additional_measures = ExtractROIBasedSurfaceMeasures(surface_files=surf_files,
-                                                                 lh_surface_measure=lh_measure,
-                                                                 lh_roi_atlas=lh_atlas,
+    >>> extract_additional_measures = ExtractROIBasedSurfaceMeasures(surface_files=surf_files, \
+                                                                 lh_surface_measure=lh_measure, \
+                                                                 lh_roi_atlas=lh_atlas, \
                                                                  rh_roi_atlas=rh_atlas)
-     extract_additional_measures.run()
+    >>> extract_additional_measures.run() # doctest: +SKIP
 
 
     """