CorticalParcellationStats: rename attribute `structure_measurements` to `structural_measurements`

README.rst

@@ -37,14 +37,14 @@ Usage
     >>> stats.whole_brain_measurements['white_surface_total_area_mm^2']
     0    98553
     Name: white_surface_total_area_mm^2, dtype: int64
-    >>> stats.structure_measurements[['Structure Name', 'Surface Area (mm^2)',
-    ...                               'Gray Matter Volume (mm^3)']].head()
-                Structure Name  Surface Area (mm^2)  Gray Matter Volume (mm^3)
-    0  caudalanteriorcingulate                 1472                       4258
-    1      caudalmiddlefrontal                 3039                       8239
-    2                   cuneus                 2597                       6722
-    3               entorhinal                  499                       2379
-    4                 fusiform                 3079                       9064
+    >>> stats.structural_measurements[['structure_name', 'surface_area_mm^2',
+    ...                                'gray_matter_volume_mm^3']].head()
+                structure_name  surface_area_mm^2  gray_matter_volume_mm^3
+    0  caudalanteriorcingulate               1472                     4258
+    1      caudalmiddlefrontal               3039                     8239
+    2                   cuneus               2597                     6722
+    3               entorhinal                499                     2379
+    4                 fusiform               3079                     9064
 
 Load Multiple Stats Files
 ~~~~~~~~~~~~~~~~~~~~~~~~~

freesurfer_stats/__init__.py

@@ -20,14 +20,14 @@ Name: estimated_total_intracranial_volume_mm^3, dtype: float64
 >>> stats.whole_brain_measurements['white_surface_total_area_mm^2']
 0    98553
 Name: white_surface_total_area_mm^2, dtype: int64
->>> stats.structure_measurements[['Structure Name', 'Surface Area (mm^2)',
-...                               'Gray Matter Volume (mm^3)']].head()
-            Structure Name  Surface Area (mm^2)  Gray Matter Volume (mm^3)
-0  caudalanteriorcingulate                 1472                       4258
-1      caudalmiddlefrontal                 3039                       8239
-2                   cuneus                 2597                       6722
-3               entorhinal                  499                       2379
-4                 fusiform                 3079                       9064
+>>> stats.structural_measurements[['structure_name', 'surface_area_mm^2',
+...                                'gray_matter_volume_mm^3']].head()
+            structure_name  surface_area_mm^2  gray_matter_volume_mm^3
+0  caudalanteriorcingulate               1472                     4258
+1      caudalmiddlefrontal               3039                     8239
+2                   cuneus               2597                     6722
+3               entorhinal                499                     2379
+4                 fusiform               3079                     9064
 """
 
 import datetime
@@ -51,7 +51,7 @@ class CorticalParcellationStats:
             = {}  # type: typing.Dict[str, typing.Union[str, datetime.datetime]]
         self.whole_brain_measurements \
             = {}  # type: typing.Dict[str, typing.Tuple[float, int]]
-        self.structure_measurements \
+        self.structural_measurements \
             = {}  # type: typing.Union[pandas.DataFrame, None]
 
     @property
@@ -139,7 +139,7 @@ class CorticalParcellationStats:
             int(line[len('NTableCols '):]), stream)
         assert self._read_header_line(stream) \
             == 'ColHeaders ' + ' '.join(c['ColHeader'] for c in columns)
-        self.structure_measurements = pandas.DataFrame(
+        self.structural_measurements = pandas.DataFrame(
             (line.rstrip().split() for line in stream),
             columns=[self._format_column_name(c['FieldName'], c['Units']) for c in columns]) \
             .apply(pandas.to_numeric, errors='ignore')

tests/test_cortical_parcellation_stats.py

@@ -10,7 +10,7 @@ from freesurfer_stats import CorticalParcellationStats
 
 @pytest.mark.parametrize(
     ('path', 'headers', 'hemisphere',
-     'whole_brain_measurements', 'structure_measurements'),
+     'whole_brain_measurements', 'structural_measurements'),
     [(os.path.join(SUBJECTS_DIR, 'fabian', 'stats', 'lh.aparc.DKTatlas.stats.short'),
       {'CreationTime': datetime.datetime(2019, 5, 9, 21, 5, 54, tzinfo=datetime.timezone.utc),
        'generating_program': 'mris_anatomical_stats',
@@ -119,7 +119,7 @@ from freesurfer_stats import CorticalParcellationStats
         'folding_index': 3,
         'intrinsic_curvature_index': 0.6}])],
 )
-def test_read(path, headers, hemisphere, whole_brain_measurements, structure_measurements):
+def test_read(path, headers, hemisphere, whole_brain_measurements, structural_measurements):
     stats = CorticalParcellationStats.read(path)
     assert headers == stats.headers
     assert hemisphere == stats.hemisphere
@@ -130,7 +130,7 @@ def test_read(path, headers, hemisphere, whole_brain_measurements, structure_mea
         check_dtype=True,
         check_names=True,
     )
-    assert list(stats.structure_measurements.columns) == [
+    assert list(stats.structural_measurements.columns) == [
         'structure_name',
         'number_of_vertices',
         'surface_area_mm^2',
@@ -143,8 +143,8 @@ def test_read(path, headers, hemisphere, whole_brain_measurements, structure_mea
         'intrinsic_curvature_index',
     ]
     pandas.util.testing.assert_frame_equal(
-        left=pandas.DataFrame(structure_measurements),
-        right=stats.structure_measurements,
+        left=pandas.DataFrame(structural_measurements),
+        right=stats.structural_measurements,
         check_like=True,  # ignore the order of index & columns
         check_dtype=True,
         check_names=True,