npc-sync 0.2.4__tar.gz → 0.2.6__tar.gz

{npc_sync-0.2.4/src/npc_sync.egg-info → npc_sync-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: npc-sync
-Version: 0.2.4
+Version: 0.2.6
 Summary: Repackaging of AllenSDK.SyncDataset with extra functionality, compatible with data in the cloud.
 Author-email: Ben Hardcastle <ben.hardcastle@alleninstitue.org>
 License: MIT

{npc_sync-0.2.4 → npc_sync-0.2.6}/pyproject.toml

@@ -16,7 +16,7 @@ dependencies = [
     "scipy>=1.13.1",
     "npc-stim>=0.1.14",
 ]
-version = "0.2.4"
+version = "0.2.6"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Programming Language :: Python :: 3",

{npc_sync-0.2.4 → npc_sync-0.2.6}/src/npc_sync/sync.py

@@ -1104,6 +1104,31 @@ class SyncDataset:
             result[block_idx] = npc_stim.get_total_stim_frames(stim_data)
         return result
 
+    def _get_diode_box_frame_interval(self, block_idx: int) -> int:
+        """Return the number of frames between diode-box flips for a block.
+
+        Stim files created before ``diodeBoxFrameInterval`` was added always
+        flipped the diode box every frame, so missing metadata defaults to 1.
+        """
+        path = self.block_index_to_stim_path[block_idx]
+        if path is None:
+            return 1
+        stim_data = None
+        try:
+            stim_data = npc_stim.get_stim_data(path)
+            value = stim_data.get("diodeBoxFrameInterval", 1)
+            if isinstance(value, h5py.Dataset):
+                value = value[()]
+            return int(value)
+        except Exception as exc:
+            logger.warning(
+                f"Failed to load diodeBoxFrameInterval for block {block_idx} at {path}: {exc}"
+            )
+            return 1
+        finally:
+            if isinstance(stim_data, h5py.File):
+                stim_data.close()
+
     @npc_io.cached_property
     def frame_display_time_blocks(self) -> tuple[npt.NDArray[np.floating], ...]:
         """Blocks of adjusted diode times: one block per stimulus."""
@@ -1252,12 +1277,7 @@ class SyncDataset:
                 """Concatenate the rising and falling edges into a single array."""
                 return np.sort(np.concatenate((rising, falling)))
 
-            # July 2025 we updated the photodiode interval from every frame to every 3 frames
-            vsyncs_per_diode_flip: int = (
-                1
-                if self.start_time < datetime.datetime(2025, 7, 15)
-                else round(np.mean(np.diff(concat_flips(rising, falling))) * FRAME_RATE)
-            )
+            vsyncs_per_diode_flip = self._get_diode_box_frame_interval(block_idx)
 
             if (
                 vsyncs_per_diode_flip == 1
@@ -1312,6 +1332,14 @@ class SyncDataset:
 
             rising, falling = split_flips(flips, is_first_frame_on)
 
+            if self.block_index_to_stim_path[block_idx] is None and os.getenv(
+                "SYNC_ALLOW_MISSING_STIM_FILES"
+            ):
+                logger.debug(
+                    f"Block {block_idx} has no stim file available to verify number of vsyncs. Skipping."
+                )
+                frame_display_time_blocks.append(fallback_or_none)
+                continue
             assert self.block_index_to_stim_path[block_idx] is not None
 
             # script_frame_intervals = h5py.File(self.block_index_to_stim_path[block_idx])['frameIntervals'][:]

{npc_sync-0.2.4 → npc_sync-0.2.6/src/npc_sync.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: npc-sync
-Version: 0.2.4
+Version: 0.2.6
 Summary: Repackaging of AllenSDK.SyncDataset with extra functionality, compatible with data in the cloud.
 Author-email: Ben Hardcastle <ben.hardcastle@alleninstitue.org>
 License: MIT

{npc_sync-0.2.4 → npc_sync-0.2.6}/tests/test_core.py

@@ -1,3 +1,7 @@
+import pathlib
+
+import h5py
+
 import npc_sync
 
 
@@ -28,3 +32,26 @@ def test_init_from_instance_and_meta_data() -> None:
     meta = s2.meta_data
     assert isinstance(meta, dict)
     assert "line_labels" in meta
+
+
+def test_diode_box_frame_interval_is_read_from_stim_file(
+    tmp_path: pathlib.Path,
+) -> None:
+    current_stim = tmp_path / "current.hdf5"
+    with h5py.File(current_stim, "w") as stim_data:
+        stim_data["diodeBoxFrameInterval"] = 3
+
+    old_stim = tmp_path / "old.hdf5"
+    with h5py.File(old_stim, "w"):
+        pass
+
+    sync = object.__new__(npc_sync.SyncDataset)
+    sync.block_index_to_stim_path = {
+        0: current_stim,
+        1: old_stim,
+        2: None,
+    }
+
+    assert sync._get_diode_box_frame_interval(0) == 3
+    assert sync._get_diode_box_frame_interval(1) == 1
+    assert sync._get_diode_box_frame_interval(2) == 1