breaking: rename class VolumeFile -> SubfieldVolumeFile

examples/compare_ashs_freesurfer_hipposf.ipynb

@@ -115,9 +115,9 @@
    ],
    "source": [
     "import os, pandas\n",
-    "from freesurfer_volume_reader import VolumeFile, ashs, freesurfer\n",
+    "from freesurfer_volume_reader import SubfieldVolumeFile, ashs, freesurfer\n",
     "\n",
-    "def read_volume_file(volume_file: VolumeFile) -> pandas.DataFrame:\n",
+    "def read_volume_file(volume_file: SubfieldVolumeFile) -> pandas.DataFrame:\n",
     "    volume_frame = volume_file.read_volumes_dataframe()\n",
     "    volume_frame['source_basename'] = os.path.basename(volume_file.absolute_path)\n",
     "    return volume_frame\n",

freesurfer_volume_reader/__init__.py

@@ -36,7 +36,7 @@ def remove_group_names_from_regex(regex_pattern: str) -> str:
     return re.sub(r'\?P<.+?>', '', regex_pattern)
 
 
-class VolumeFile(metaclass=abc.ABCMeta):
+class SubfieldVolumeFile(metaclass=abc.ABCMeta):
 
     FILENAME_REGEX = NotImplemented
 
@@ -56,7 +56,7 @@ class VolumeFile(metaclass=abc.ABCMeta):
     @classmethod
     def find(cls, root_dir_path: str,
              filename_regex: typing.Optional[typing.Pattern] = None,
-             ) -> typing.Iterator['VolumeFile']:
+             ) -> typing.Iterator['SubfieldVolumeFile']:
         if not filename_regex:
             filename_regex = cls.FILENAME_REGEX
         for dirpath, _, filenames in os.walk(root_dir_path):

freesurfer_volume_reader/ashs.py

@@ -20,7 +20,7 @@ import pandas
 import freesurfer_volume_reader
 
 
-class HippocampalSubfieldsVolumeFile(freesurfer_volume_reader.VolumeFile):
+class HippocampalSubfieldsVolumeFile(freesurfer_volume_reader.SubfieldVolumeFile):
 
     # https://sites.google.com/site/hipposubfields/tutorial#TOC-Viewing-ASHS-Segmentation-Results
     FILENAME_PATTERN = r'^(?P<s>\w+)_(?P<h>left|right)' \

freesurfer_volume_reader/freesurfer.py

@@ -20,7 +20,7 @@ import pandas
 import freesurfer_volume_reader
 
 
-class HippocampalSubfieldsVolumeFile(freesurfer_volume_reader.VolumeFile):
+class HippocampalSubfieldsVolumeFile(freesurfer_volume_reader.SubfieldVolumeFile):
 
     # https://surfer.nmr.mgh.harvard.edu/fswiki/HippocampalSubfields
     FILENAME_PATTERN = r'^(?P<h>[lr])h\.hippoSfVolumes' \

tests/init_test.py

@@ -1,7 +1,7 @@
 import pytest
 
 from freesurfer_volume_reader import __version__, parse_version_string, \
-                                     remove_group_names_from_regex, VolumeFile
+                                     remove_group_names_from_regex, SubfieldVolumeFile
 
 
 def test_module_version():
@@ -37,7 +37,7 @@ def test_remove_group_names_from_regex(source_pattern, expected_pattern):
     assert expected_pattern == remove_group_names_from_regex(regex_pattern=source_pattern)
 
 
-class DummyVolumeFile(VolumeFile):
+class DummyVolumeFile(SubfieldVolumeFile):
 
     # pylint: disable=useless-super-delegation