pfnc 0.1.0__cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

dataspree/pfnc/__about__.py

@@ -0,0 +1,3 @@
+"""Package metadata."""
+
+__version__ = '0.1.0'

dataspree/pfnc/__init__.py

@@ -0,0 +1,122 @@
+"""Parse and model GenICam PFNC pixel format designations and decode image buffers via extensible decoders."""
+
+from dataspree.pfnc.decoder_registry import PixelFormatDecoder, DecoderRegistry
+from dataspree.pfnc.exceptions import (
+    PixelFormatDecodeNotSupportedError,
+    NotRegisteredError,
+    DuplicateRegistrationError,
+    InvalidRegistrationError,
+    PixelFormatDecodeAmbiguousError,
+    PixelFormatDecodeError,
+    PixelFormatError,
+    PixelFormatValueReject,
+    PixelFormatNotImplementedError,
+    PixelFormatImplementationError,
+    ParseReject,
+    PixelFormatNotSupportedError,
+    PixelFormatParseError,
+    PixelFormatRegistryError,
+    RegistryError,
+)
+from dataspree.pfnc.genicam.components import (
+    CHANNEL_REGISTRY,
+    Channels,
+    CompoundChannels,
+    CompoundChannel,
+    CoordinateChannel,
+    ChannelProperty,
+    ChannelRegistry,
+    Coord3D,
+    ColorSpaceStandard,
+    ItuRBt601,
+    ItuRBt709,
+    Bt601,
+    Bt709,
+    Location,
+    MonoLocation,
+    LMNLocation,
+    BayerLocation,
+    BiColor,
+    ColorFilterArray,
+    SquarePattern,
+    SparseColorFilterLocation,
+    Components,
+    GenicamComponents,
+    CustomComponents,
+    SizedColorSpaceStandard,
+    RGB10V1,
+    RGB12V1,
+)
+from dataspree.pfnc.genicam.data_types import DATA_TYPE_REGISTRY, DataTypes, CompoundDataTypes
+from dataspree.pfnc.genicam.interface_specifics import InterfaceSpecific, Planar, SemiPlanar, ComponentsSequencing
+from dataspree.pfnc.genicam.number_of_bits import Size
+from dataspree.pfnc.genicam.packing_types import PADDING_TYPE_NAME_REGISTRY, Packing, PaddingType
+from dataspree.pfnc.genicam.pixel_format import GenicamPixelFormat
+from dataspree.pfnc.pixel_format import PixelFormat
+
+__all__ = [
+    # decoder / registry
+    'PixelFormatDecoder',
+    'DecoderRegistry',
+    # exceptions
+    'PixelFormatDecodeNotSupportedError',
+    'NotRegisteredError',
+    'DuplicateRegistrationError',
+    'InvalidRegistrationError',
+    'PixelFormatDecodeAmbiguousError',
+    'PixelFormatDecodeError',
+    'PixelFormatError',
+    'PixelFormatValueReject',
+    'PixelFormatNotImplementedError',
+    'PixelFormatImplementationError',
+    'ParseReject',
+    'PixelFormatNotSupportedError',
+    'PixelFormatParseError',
+    'PixelFormatRegistryError',
+    'RegistryError',
+    # components / channels
+    'CHANNEL_REGISTRY',
+    'Channels',
+    'CompoundChannels',
+    'CompoundChannel',
+    'CoordinateChannel',
+    'ChannelProperty',
+    'ChannelRegistry',
+    'Coord3D',
+    'ColorSpaceStandard',
+    'ItuRBt601',
+    'ItuRBt709',
+    'Bt601',
+    'Bt709',
+    'Location',
+    'MonoLocation',
+    'LMNLocation',
+    'BayerLocation',
+    'BiColor',
+    'ColorFilterArray',
+    'SquarePattern',
+    'SparseColorFilterLocation',
+    'Components',
+    'GenicamComponents',
+    'CustomComponents',
+    'SizedColorSpaceStandard',
+    'RGB10V1',
+    'RGB12V1',
+    # data types
+    'DATA_TYPE_REGISTRY',
+    'DataTypes',
+    'CompoundDataTypes',
+    # interface specifics
+    'InterfaceSpecific',
+    'Planar',
+    'SemiPlanar',
+    'ComponentsSequencing',
+    # sizes / packing
+    'Size',
+    'PADDING_TYPE_NAME_REGISTRY',
+    'Packing',
+    'PaddingType',
+    # pixel formats
+    'PixelFormat',
+    'GenicamPixelFormat',
+]

dataspree/pfnc/_internal/registry.pyi

@@ -0,0 +1,43 @@
+from collections.abc import Iterator
+from dataclasses import dataclass
+from typing import Generic, TypeVar
+
+T = TypeVar('T')
+K = TypeVar('K')
+
+@dataclass(frozen=True)
+class MappingSnapshot(Generic[K, T]):
+    """Snapshot for a single mapping-based registry."""
+    mapping: dict[K, T]
+
+@dataclass
+class Registry(Generic[K, T]):
+    """Registry."""
+    def register(self, name: K, value: T) -> None:
+        """Register.
+
+        Args:
+            name: Alias string uniquely identifying the value
+            value: The registered value type.
+
+        Raises:
+            DuplicateRegistrationError: If already registered.
+        """
+    def snapshot(self) -> MappingSnapshot[K, T]:
+        """Snapshot current state."""
+    def restore(self, snap: MappingSnapshot[K, T]) -> None:
+        """Restore a snapshot."""
+    def resolve(self, name: K) -> T:
+        """Resolve alias to type."""
+    def get(self, key: K, default_value: T | None = None) -> T | None:
+        """Return the value for key if key is registered, else default_value.
+
+        Args:
+            key: Name to look up.
+            default_value: Value to return if key is not registered.
+
+        Returns:
+            The registered value or default_value if key is missing.
+        """
+    def __iter__(self) -> Iterator[K]:
+        """Iterate over registered names."""

dataspree/pfnc/_internal/utils.pyi

@@ -0,0 +1,8 @@
+from typing import TypeVar
+
+def join_designators(a: str, b: str) -> str:
+    """Join two pixel format designators according to the genicam naming conventions."""
+T = TypeVar('T', bound=object)
+
+def all_implementations(cls, allow_parent: bool = True) -> list[type[T]]:
+    """Yield all implementations of a subclass."""

dataspree/pfnc/decoder_registry.pyi

@@ -0,0 +1,84 @@
+import numpy as np
+from _typeshed import Incomplete
+from abc import ABCMeta, abstractmethod
+from dataclasses import dataclass
+from dataspree.pfnc.pixel_format import PixelFormat as PixelFormat
+from typing import Any
+
+logger: Incomplete
+
+@dataclass
+class PixelFormatDecoder(metaclass=ABCMeta):
+    """Base class for decoder backends.
+
+    Args:
+        name (str) name of the decoder.
+    """
+    name: str
+    @abstractmethod
+    def is_applicable(self, pixel_format: PixelFormat) -> bool:
+        """Return True if this decoder can handle the given pixel format."""
+    @abstractmethod
+    def decode(self, pixel_format: PixelFormat, buffer: bytes, *, width: int, height: int, stride: int, copy: bool = False) -> np.ndarray[Any, Any]:
+        """Decode a frame buffer into a numpy array."""
+
+@dataclass(frozen=True)
+class DecoderRegistration:
+    """Single decoder registration entry.
+
+    Args:
+        priority (int) priority. The higher, the more priority.
+
+        decoder (PixelFormatDecoder) The decoder.
+    """
+    decoder: PixelFormatDecoder
+    priority: int
+
+@dataclass(frozen=True)
+class DecoderRegistrySnapshot:
+    """Snapshot of registry state for test isolation."""
+    registrations: tuple[DecoderRegistration, ...]
+
+@dataclass
+class DecoderRegistry:
+    """Registry that resolves a decoder for a given GenICam pixel format."""
+    def register(self, priority: int, decoder: PixelFormatDecoder) -> None:
+        """Register a decoder backend.
+
+        Args:
+            priority (int): priority. The higher, the more priority.
+
+            decoder (PixelFormatDecoder): The decoder.
+        """
+    def snapshot(self) -> DecoderRegistrySnapshot:
+        """Create a snapshot of the registry state."""
+    def restore(self, snap: DecoderRegistrySnapshot) -> None:
+        """Restore the registry state from a snapshot."""
+    def resolve(self, pixel_format: PixelFormat) -> PixelFormatDecoder:
+        """Resolve the best decoder for a pixel format.
+
+        If multiple decoders exist that have got the same priority, take the first one registered.
+
+        Args:
+            pixel_format: Parsed GenICam pixel format instance.
+
+        Returns:
+            PixelFormatDecoder: The selected decoder.
+
+        Raises:
+            PixelFormatDecodeNotSupportedError: If no decoder matches.
+        """
+    def decode(self, pixel_format: PixelFormat, buffer: bytes, *, width: int, height: int, stride: int, copy: bool = False) -> np.ndarray[Any, Any]:
+        """Decode using the resolved decoder.
+
+        Args:
+            pixel_format: Parsed GenICam pixel format instance.
+            buffer: Raw frame bytes (one image).
+            width: Image width in pixels.
+            height: Image height in pixels.
+            stride: Bytes per line (can be > width * bytes_per_pixel).
+            copy: If True, return a contiguous copy without line padding.
+
+        Returns:
+            np.ndarray: Decoded array.
+        """

dataspree/pfnc/exceptions.pyi

@@ -0,0 +1,30 @@
+class PixelFormatError(Exception):
+    """Base error for pixel format handling."""
+class PixelFormatParseError(PixelFormatError):
+    """Raised when a designation cannot be parsed."""
+class PixelFormatNotSupportedError(PixelFormatError):
+    """Raised when the format is valid but not supported by a feature."""
+class PixelFormatNotImplementedError(PixelFormatNotSupportedError):
+    """Raised when the format is not implemented / supported."""
+class PixelFormatRegistryError(PixelFormatError):
+    """Raised on invalid or conflicting registrations."""
+class PixelFormatValueReject(PixelFormatError):
+    """Pixel format was parsed but values were rejected."""
+class PixelFormatImplementationError(PixelFormatError):
+    """Internal implementation error."""
+class ParseReject(ValueError):
+    """Internal: implementation does not match this input."""
+class PixelFormatDecodeError(PixelFormatError):
+    """Base class for pixel format decoding errors."""
+class PixelFormatDecodeNotSupportedError(PixelFormatDecodeError):
+    """Raised when no decoder supports a pixel format."""
+class PixelFormatDecodeAmbiguousError(PixelFormatDecodeError):
+    """Raised when multiple decoders match the same pixel format."""
+class RegistryError(Exception):
+    """Base class for registry errors."""
+class DuplicateRegistrationError(RegistryError):
+    """Raised when a key is registered more than once."""
+class InvalidRegistrationError(RegistryError):
+    """Raised when registration input is invalid."""
+class NotRegisteredError(RegistryError):
+    """Raised when a key is registered more than once."""

dataspree/pfnc/genicam/__init__.py

@@ -0,0 +1 @@
+"""Genicam module."""