rocket-welder-sdk 1.1.46__py3-none-any.whl → 1.2.0__py3-none-any.whl

rocket_welder_sdk/high_level/data_context.py

@@ -85,6 +85,7 @@ class ISegmentationDataContext(ABC):
         self,
         segment_class: SegmentClass,
         instance_id: int,
+        confidence: float,
         points: Union[Sequence[Point], npt.NDArray[np.int32]],
     ) -> None:
         """
@@ -93,6 +94,7 @@ class ISegmentationDataContext(ABC):
         Args:
             segment_class: SegmentClass from schema definition
             instance_id: Instance ID (for multiple instances of same class, 0-255)
+            confidence: Detection confidence score (0.0-1.0)
             points: Contour points defining the instance boundary
         """
         pass
@@ -150,6 +152,7 @@ class SegmentationDataContext(ISegmentationDataContext):
         self,
         segment_class: SegmentClass,
         instance_id: int,
+        confidence: float,
         points: Union[Sequence[Point], npt.NDArray[np.int32]],
     ) -> None:
         """Add a segmentation instance for this frame."""
@@ -162,7 +165,7 @@ class SegmentationDataContext(ISegmentationDataContext):
         else:
             points_array = np.array(points, dtype=np.int32)
 
-        self._writer.append(segment_class.class_id, instance_id, points_array)
+        self._writer.append(segment_class.class_id, instance_id, confidence, points_array)
 
     def commit(self) -> None:
         """Commit the context (called automatically when delegate returns)."""

rocket_welder_sdk/rocket_welder_client.py

@@ -85,6 +85,42 @@ class RocketWelderClient:
         with self._lock:
             return self._controller is not None and self._controller.is_running
 
+    @property
+    def ml_model_path(self) -> Optional[str]:
+        """
+        Path to the ML model file mounted in the container.
+
+        Reads from ML_MODEL_PATH environment variable set by RocketWelder
+        when a model is mapped to this container's pipeline element.
+
+        Returns:
+            The path to the model file (e.g., /var/models/model.hef),
+            or None if no model is configured.
+        """
+        import os
+
+        return os.environ.get("ML_MODEL_PATH")
+
+    @property
+    def ml_model_version(self) -> Optional[int]:
+        """
+        Version of the ML model.
+
+        Reads from ML_MODEL_VERSION environment variable set by RocketWelder.
+
+        Returns:
+            The model version as integer, or None if not set or not a valid number.
+        """
+        import os
+
+        value = os.environ.get("ML_MODEL_VERSION")
+        if value is None:
+            return None
+        try:
+            return int(value)
+        except ValueError:
+            return None
+
     def get_metadata(self) -> Optional[GstMetadata]:
         """
         Get the current GStreamer metadata.
@@ -577,6 +613,47 @@ class RocketWelderClient:
         """Context manager exit."""
         self.stop()
 
+    @staticmethod
+    def get_ml_model_path() -> Optional[str]:
+        """
+        Get the ML model path from environment (static method).
+
+        Convenience method to get the model path without creating a client instance.
+        Useful during initialization before the client is created.
+
+        Returns:
+            The path to the model file (e.g., /var/models/model.hef),
+            or None if no model is configured.
+
+        Example:
+            model_path = RocketWelderClient.get_ml_model_path()
+            if model_path:
+                model = load_model(model_path)
+            else:
+                raise RuntimeError("No ML model configured")
+        """
+        import os
+
+        return os.environ.get("ML_MODEL_PATH")
+
+    @staticmethod
+    def get_ml_model_version() -> Optional[int]:
+        """
+        Get the ML model version from environment (static method).
+
+        Returns:
+            The model version as integer, or None if not set or not a valid number.
+        """
+        import os
+
+        value = os.environ.get("ML_MODEL_VERSION")
+        if value is None:
+            return None
+        try:
+            return int(value)
+        except ValueError:
+            return None
+
     @classmethod
     def from_connection_string(cls, connection_string: str) -> RocketWelderClient:
         """
@@ -750,7 +827,13 @@ class _NoOpKeyPointsWriter(IKeyPointsWriter):
 class _NoOpSegmentationWriter(ISegmentationResultWriter):
     """No-op segmentation writer that discards all data."""
 
-    def append(self, class_id: int, instance_id: int, points: Any) -> None:
+    def append(
+        self,
+        class_id: int,
+        instance_id: int,
+        confidence: float,
+        points: Any,
+    ) -> None:
         """Discard segmentation data."""
         pass
 

rocket_welder_sdk/segmentation_result.py

@@ -6,8 +6,8 @@ Compatible with C# implementation for cross-platform interoperability.
 
 Protocol (per frame):
     [FrameId: 8B little-endian][Width: varint][Height: varint]
-    [classId: 1B][instanceId: 1B][pointCount: varint][points: delta+varint...]
-    [classId: 1B][instanceId: 1B][pointCount: varint][points: delta+varint...]
+    [classId: 1B][instanceId: 1B][confidence: 2B LE][pointCount: varint][points: delta+varint...]
+    [classId: 1B][instanceId: 1B][confidence: 2B LE][pointCount: varint][points: delta+varint...]
     ...
 
 Features:
@@ -104,6 +104,7 @@ class SegmentationInstance:
 
     class_id: int
     instance_id: int
+    confidence: float  # Detection confidence score (0.0-1.0)
     points: PointArray  # NumPy array of shape (N, 2) with dtype int32
 
     def to_normalized(self, width: int, height: int) -> npt.NDArray[np.float32]:
@@ -237,6 +238,7 @@ class SegmentationResultWriter:
         self,
         class_id: int,
         instance_id: int,
+        confidence: float,
         points: Union[List[Point], PointArray],
     ) -> None:
         """
@@ -245,6 +247,7 @@ class SegmentationResultWriter:
         Args:
             class_id: Object class ID (0-255)
             instance_id: Instance ID within class (0-255)
+            confidence: Detection confidence score (0.0-1.0)
             points: List of (x, y) tuples or NumPy array of shape (N, 2)
         """
         if class_id < 0 or class_id > 255:
@@ -266,6 +269,11 @@ class SegmentationResultWriter:
         # Write class_id and instance_id
         self._buffer.write(bytes([class_id, instance_id]))
 
+        # Write confidence as 2 bytes little-endian (ushort 0-65535)
+        confidence_clamped = max(0.0, min(1.0, confidence))
+        confidence_raw = int(confidence_clamped * 65535)
+        self._buffer.write(struct.pack("<H", confidence_raw))
+
         # Write point count
         point_count = len(points_array)
         _write_varint(self._buffer, point_count)
@@ -402,6 +410,13 @@ class SegmentationResultReader:
         class_id = header[0]
         instance_id = header[1]
 
+        # Read confidence (2 bytes little-endian)
+        confidence_bytes = self._stream.read(2)
+        if len(confidence_bytes) != 2:
+            raise EOFError("Unexpected end of stream reading confidence")
+        confidence_raw = struct.unpack("<H", confidence_bytes)[0]
+        confidence = confidence_raw / 65535.0
+
         # Read point count with validation
         point_count = _read_varint(self._stream)
         if point_count > self._max_points_per_instance:
@@ -412,7 +427,7 @@ class SegmentationResultReader:
         if point_count == 0:
             # Empty points array
             points = np.empty((0, 2), dtype=np.int32)
-            return SegmentationInstance(class_id, instance_id, points)
+            return SegmentationInstance(class_id, instance_id, confidence, points)
 
         # Allocate NumPy array for points
         points = np.empty((point_count, 2), dtype=np.int32)
@@ -430,7 +445,7 @@ class SegmentationResultReader:
             y += delta_y
             points[i] = [x, y]
 
-        return SegmentationInstance(class_id, instance_id, points)
+        return SegmentationInstance(class_id, instance_id, confidence, points)
 
     def read_all(self) -> List[SegmentationInstance]:
         """
@@ -472,6 +487,7 @@ class ISegmentationResultWriter(ABC):
         self,
         class_id: int,
         instance_id: int,
+        confidence: float,
         points: Union[List[Point], PointArray],
     ) -> None:
         """
@@ -480,6 +496,7 @@ class ISegmentationResultWriter(ABC):
         Args:
             class_id: Object class ID (0-255)
             instance_id: Instance ID within class (0-255)
+            confidence: Detection confidence score (0.0-1.0)
             points: List of (x, y) tuples or NumPy array of shape (N, 2)
         """
         pass
@@ -741,6 +758,7 @@ class SegmentationProtocol:
     Instance Format:
         [ClassId: 1 byte]
         [InstanceId: 1 byte]
+        [Confidence: 2 bytes, little-endian uint16]
         [PointCount: varint]
         [Point0: X zigzag-varint, Y zigzag-varint]  (absolute)
         [Point1+: deltaX zigzag-varint, deltaY zigzag-varint]
@@ -777,6 +795,12 @@ class SegmentationProtocol:
     def _write_instance_core(stream: BinaryIO, instance: SegmentationInstance) -> None:
         """Write a single instance to the stream."""
         stream.write(bytes([instance.class_id, instance.instance_id]))
+
+        # Write confidence as 2 bytes little-endian (ushort 0-65535)
+        confidence_clamped = max(0.0, min(1.0, instance.confidence))
+        confidence_raw = int(confidence_clamped * 65535)
+        stream.write(struct.pack("<H", confidence_raw))
+
         point_count = len(instance.points)
         _write_varint(stream, point_count)
 
@@ -823,6 +847,7 @@ class SegmentationProtocol:
         buffer: bytearray,
         class_id: int,
         instance_id: int,
+        confidence: float,
         points: Union[List[Point], PointArray],
     ) -> int:
         """
@@ -834,6 +859,7 @@ class SegmentationProtocol:
             buffer: Pre-allocated buffer to write to.
             class_id: Class identifier (0-255).
             instance_id: Instance identifier (0-255).
+            confidence: Detection confidence score (0.0-1.0).
             points: Polygon points.
 
         Returns:
@@ -845,7 +871,7 @@ class SegmentationProtocol:
         else:
             points_array = points.astype(np.int32)
 
-        instance = SegmentationInstance(class_id, instance_id, points_array)
+        instance = SegmentationInstance(class_id, instance_id, confidence, points_array)
 
         stream = io.BytesIO()
         SegmentationProtocol._write_instance_core(stream, instance)
@@ -864,8 +890,8 @@ class SegmentationProtocol:
         Returns:
             Maximum bytes needed.
         """
-        # classId(1) + instanceId(1) + pointCount(varint, max 5) + points(max 10 bytes each)
-        return 1 + 1 + 5 + (point_count * 10)
+        # classId(1) + instanceId(1) + confidence(2) + pointCount(varint, max 5) + points(max 10 bytes each)
+        return 1 + 1 + 2 + 5 + (point_count * 10)
 
     @staticmethod
     def read(data: bytes) -> SegmentationFrame:
@@ -899,6 +925,14 @@ class SegmentationProtocol:
 
             class_id = header[0]
             instance_id = header[1]
+
+            # Read confidence (2 bytes little-endian)
+            confidence_bytes = stream.read(2)
+            if len(confidence_bytes) != 2:
+                raise EOFError("Unexpected end of stream reading confidence")
+            confidence_raw = struct.unpack("<H", confidence_bytes)[0]
+            confidence = confidence_raw / 65535.0
+
             point_count = _read_varint(stream)
 
             if point_count == 0:
@@ -916,7 +950,7 @@ class SegmentationProtocol:
                     points[i] = [x, y]
                     prev_x, prev_y = x, y
 
-            instances.append(SegmentationInstance(class_id, instance_id, points))
+            instances.append(SegmentationInstance(class_id, instance_id, confidence, points))
 
         return SegmentationFrame(frame_id, width, height, instances)
 

{rocket_welder_sdk-1.1.46.dist-info → rocket_welder_sdk-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocket-welder-sdk
-Version: 1.1.46
+Version: 1.2.0
 Summary: High-performance video streaming SDK for RocketWelder services using ZeroBuffer IPC
 Home-page: https://github.com/modelingevolution/rocket-welder-sdk
 Author: ModelingEvolution

{rocket_welder_sdk-1.1.46.dist-info → rocket_welder_sdk-1.2.0.dist-info}/RECORD

@@ -12,8 +12,8 @@ rocket_welder_sdk/keypoints_protocol.py,sha256=kN8ok6Ptpgl4txoQE9DpKhMoI7zr73vTw
 rocket_welder_sdk/opencv_controller.py,sha256=MDM6_yFBB9BaMa5jnZRqw7xZZB-WuLr7EPrrfHQ2DK4,9905
 rocket_welder_sdk/periodic_timer.py,sha256=hnObybmrnf3J47QrNKJhYAytLKwria016123NvPRfQ0,9369
 rocket_welder_sdk/py.typed,sha256=0cXFZXmes4Y-vnl4lO3HtyyyWaFNw85B7tJdFeCtHDc,67
-rocket_welder_sdk/rocket_welder_client.py,sha256=4jfusvxMxAU5j2NXiOhYzgWEC1VNFFk_XXv7QEvwmSU,34481
-rocket_welder_sdk/segmentation_result.py,sha256=b3xpv6AZyWzm924cd1RfXwCuEwdkPL5TUA0gzT3HpBA,29153
+rocket_welder_sdk/rocket_welder_client.py,sha256=YJ6WwGuJ_R3HdVKmUcNuv8Fg4F54zNidBEgbihWTHaw,36770
+rocket_welder_sdk/segmentation_result.py,sha256=f1rJQFO7lJP5nqzdmFClvty0Z9m5-kvivJu-uK2wmXo,30807
 rocket_welder_sdk/session_id.py,sha256=YgnDwmdOcdJTXIObjkrzIkxU2gbMzNko1h1ms4lNIfU,1928
 rocket_welder_sdk/varint.py,sha256=SmffemQCXToRzs3lb7hWQWDY7NmKv4XG_Wb0oeMrb_I,5058
 rocket_welder_sdk/external_controls/__init__.py,sha256=ldOLGhLLS5BQL8m4VKFYV0SvsNNlV2tghlc7rkqadU8,699
@@ -28,7 +28,7 @@ rocket_welder_sdk/graphics/vector_graphics_encoder.py,sha256=lD3cIOAVL_JvKZayIQ_
 rocket_welder_sdk/high_level/__init__.py,sha256=OKbI3l0PFo1Cb_v0kbv16Wr05urz8heVGps0dJcTcG4,1507
 rocket_welder_sdk/high_level/client.py,sha256=rVnnrn68PEvc68p5acuOBZfEjobWWed8XcssTRzxNr8,11502
 rocket_welder_sdk/high_level/connection_strings.py,sha256=1Hp72V5qDngHGXyjBRFMckz365BMpGVjb3PMSGvCtow,12531
-rocket_welder_sdk/high_level/data_context.py,sha256=SXJvDpDBFi8Lm4XqSRSHK7YUUHuugXGo4ZRCb6_z5l0,4833
+rocket_welder_sdk/high_level/data_context.py,sha256=DuLwIjCBopr2Lyo_fLhRPCC8m7mPwyL8MHYSjrJVUT4,4960
 rocket_welder_sdk/high_level/frame_sink_factory.py,sha256=tLhMV_qnY-ZUtffIzhycM9znNjYguRumba4vphpNx7E,3493
 rocket_welder_sdk/high_level/schema.py,sha256=2Vv0rDwahtGswWB_ceaCdc7JDtmbkx4wE2jQePzeTpU,5367
 rocket_welder_sdk/high_level/transport_protocol.py,sha256=pdl7l1Tu9b7IYb95q6kzDY7-g1fbhSnhdV_gGhLeYzk,2943
@@ -45,7 +45,7 @@ rocket_welder_sdk/ui/icons.py,sha256=DcDklZkPmiEzlOD4IR7VTJOtGPCuuh_OM_WN7ScghWE
 rocket_welder_sdk/ui/ui_events_projection.py,sha256=siiNhjLEBOPfTKw1ZhOPGkwIN5rLDH7V9VCZTNrhEtQ,7836
 rocket_welder_sdk/ui/ui_service.py,sha256=uRdpyJGoCQmtOli_HKSrxLwhZYG-XRuHIYdkmFz1zNk,12026
 rocket_welder_sdk/ui/value_types.py,sha256=f7OA_9zgXEDPoITc8v8SfAR23I4XeFhE3E2_GcAbR6k,1616
-rocket_welder_sdk-1.1.46.dist-info/METADATA,sha256=SxDcR5ndRmpZSNO9fWlsVAns7NJ6h4aJCxlkl2Bq8ZA,24739
-rocket_welder_sdk-1.1.46.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-rocket_welder_sdk-1.1.46.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
-rocket_welder_sdk-1.1.46.dist-info/RECORD,,
+rocket_welder_sdk-1.2.0.dist-info/METADATA,sha256=GLfE2qHXoj5Yg42mKefTI59GBAmPSXjo3bUAo5zX2lY,24738
+rocket_welder_sdk-1.2.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+rocket_welder_sdk-1.2.0.dist-info/top_level.txt,sha256=2iZvBjnwVCUW-uDE23-eJld5PZ9-mlPI69QiXM5IrTA,18
+rocket_welder_sdk-1.2.0.dist-info/RECORD,,

{rocket_welder_sdk-1.1.46.dist-info → rocket_welder_sdk-1.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.1)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any