Get buffer size from device config

Author: t-sasatani

mio/data/config/process/denoise_example.yml

@@ -5,7 +5,7 @@ noise_patch:
   enable: true
   method: gradient # gradient or mean_error
   threshold: 20
-  buffer_size: 5032 # Better to get this from device configuration
+  device_config_id: wireless-200px
   buffer_split: 8
   diff_multiply: 1
   output_result: true

mio/models/process.py

@@ -8,6 +8,7 @@
 
 from mio.models import MiniscopeConfig
 from mio.models.mixins import ConfigYAMLMixin
+from mio.models.stream import StreamDevConfig
 
 
 class InteractiveDisplayConfig(BaseModel):
@@ -69,10 +70,9 @@ class NoisePatchConfig(BaseModel):
         default=20,
         description="Threshold for detecting noise.",
     )
-    buffer_size: int = Field(
-        default=5032,
-        description="Size of the buffers composing the image."
-        "This premises that the noisy area will appear in units of buffer_size.",
+    device_config_id: Optional[str] = Field(
+        default=None,
+        description="ID of the stream device configuration.",
     )
     buffer_split: int = Field(
         default=1,
@@ -99,6 +99,17 @@ class NoisePatchConfig(BaseModel):
         description="Whether to output the noisy frames as an independent video stream.",
     )
 
+    _device_config: Optional[StreamDevConfig] = None
+
+    @property
+    def device_config(self) -> StreamDevConfig:
+        """
+        Get the stream device configuration.
+        """
+        if self._device_config is None:
+            self._device_config = StreamDevConfig.from_any(self.device_config_id)
+        return self._device_config
+
 
 class FreqencyMaskingConfig(BaseModel):
     """

mio/models/stream.py

@@ -267,6 +267,8 @@ class StreamDevConfig(MiniscopeConfig, ConfigYAMLMixin):
     adc_scale: Optional[ADCScaling] = ADCScaling()
     runtime: StreamDevRuntime = StreamDevRuntime()
 
+    _px_per_buffer: int = None
+
     @field_validator("preamble", mode="before")
     def preamble_to_bytes(cls, value: Union[str, bytes, int]) -> bytes:
         """
@@ -304,3 +306,18 @@ def ensure_exists(cls, value: Optional[Path]) -> Optional[Path]:
                 value.exists()
             ), f"Configured to use bitstream file {value}, but it does not exist"
         return value
+
+    @property
+    def px_per_buffer(self) -> int:
+        """
+        Number of pixels per buffer
+        """
+
+        px_per_word = 32 / self.pix_depth
+        if self._px_per_buffer is None:
+            self._px_per_buffer = (
+                self.buffer_block_length * self.block_size * px_per_word
+                - self.header_len / self.pix_depth
+                - px_per_word * self.dummy_words
+            )
+        return self._px_per_buffer

mio/process/frame_helper.py

@@ -47,7 +47,14 @@ def detect_frame_with_noisy_buffer(
             Tuple[bool, np.ndarray]: A boolean indicating if the frame is noisy,
                 and a spatial mask showing noisy regions.
         """
-        logger.debug(f"Buffer size: {config.buffer_size}")
+        if config.device_config is not None:
+            px_per_buffer = config.device_config.px_per_buffer
+        else:
+            px_per_buffer = 1000
+            logger.warning(
+                f"Device configuration not found. Using default buffer size: {px_per_buffer}"
+            )
+        logger.debug(f"Buffer size: {px_per_buffer}")
 
         frame_width = current_frame.shape[1]
         frame_height = current_frame.shape[0]
@@ -63,7 +70,7 @@ def detect_frame_with_noisy_buffer(
             serialized_previous = previous_frame.flatten().astype(np.int16)
             logger.debug(f"Serialized previous frame size: {len(serialized_previous)}")
 
-            split_size = config.buffer_size // config.buffer_split + 1
+            split_size = px_per_buffer // config.buffer_split + 1
 
             split_shape = []