enh: identifier indexing now starts at 1 instead of 0

CHANGELOG

@@ -1,3 +1,6 @@
+0.4.2
+ - fix: implement `get_name` method for SeriesFolder format
+ - enh: start identifier/name indexing at 1 instead of 0
 0.4.1
  - fix: do not allow intensity values less than zero for SingleTifPhasics
 0.4.0

qpformat/file_formats/__init__.py

@@ -129,9 +129,20 @@ def storage_type(self):
         return ds.storage_type
 
     def get_identifier(self, idx):
-        """Return an identifier for the data at index `idx`"""
+        """Return an identifier for the data at index `idx`
+
+        .. versionchanged:: 0.4.2
+            indexing starts at 1 instead of 0
+        """
         name = self._get_cropped_file_names()[idx]
-        return "{}:{}:{}".format(self.identifier, name, idx)
+        return "{}:{}:{}".format(self.identifier, name, idx + 1)
+
+    def get_name(self, idx):
+        """Return name of data at index `idx`
+
+        .. versionadded:: 0.4.2
+        """
+        return "{}".format(self.path / self.files[idx])
 
     def get_qpimage_raw(self, idx):
         """Return QPImage without background correction"""

qpformat/file_formats/dataset.py

@@ -142,12 +142,20 @@ def identifier(self):
         return idsum
 
     def get_identifier(self, idx):
-        """Return an identifier for the data at index `idx`"""
-        return "{}:{}".format(self.identifier, idx)
+        """Return an identifier for the data at index `idx`
+
+        .. versionchanged:: 0.4.2
+            indexing starts at 1 instead of 0
+        """
+        return "{}:{}".format(self.identifier, idx + 1)
 
     def get_name(self, idx):
-        """Return name of data at index `idx`"""
-        return "{}:{}".format(self.path, idx)
+        """Return name of data at index `idx`
+
+        .. versionchanged:: 0.4.2
+            indexing starts at 1 instead of 0
+        """
+        return "{}:{}".format(self.path, idx + 1)
 
     def get_qpimage(self, idx):
         """Return background-corrected QPImage of data at index `idx`"""

tests/test_dataset.py

@@ -20,8 +20,8 @@ def test_identifier():
 
     bg_data = ds1.get_qpimage(0)
     ds2 = qpformat.load_data(path=path, bg_data=bg_data)
-    assert ds2.background_identifier == "3f328"
-    assert ds2.identifier == "1e92f"
+    assert ds2.background_identifier == "26461"
+    assert ds2.identifier == "67213"
 
 
 def test_meta():