Skip to content

STINS

Stream1Packet = TypeAdapter(Stream1Start | Stream1Data | Stream1End) module-attribute

A union type for STINS packets

Stream1Data

Bases: Stream1

Example
Stream1Data(
    msg_number=375,
    htype='image',
    frame=0,
    shape=[831, 1475],
    type='float32',
    compression='none',
    data=array([[0., 0., 0., ..., 0., 0., 0.],
        [0., 0., 0., ..., 0., 0., 0.],
        [0., 0., 0., ..., 0., 0., 0.],
        ...,
        [0., 0., 0., ..., 0., 0., 0.],
        [0., 0., 0., ..., 0., 0., 0.],
        [0., 0., 0., ..., 0., 0., 0.]], dtype=float32)
)
Source code in dranspose/data/stream1.py
class Stream1Data(Stream1):
    """
    Example:
        ``` py
        Stream1Data(
            msg_number=375,
            htype='image',
            frame=0,
            shape=[831, 1475],
            type='float32',
            compression='none',
            data=array([[0., 0., 0., ..., 0., 0., 0.],
                [0., 0., 0., ..., 0., 0., 0.],
                [0., 0., 0., ..., 0., 0., 0.],
                ...,
                [0., 0., 0., ..., 0., 0., 0.],
                [0., 0., 0., ..., 0., 0., 0.],
                [0., 0., 0., ..., 0., 0., 0.]], dtype=float32)
        )
        ```
    """

    model_config = ConfigDict(extra="allow")

    htype: Literal["image"] = "image"
    frame: int
    shape: list[int]
    type: str
    compression: str

Stream1End

Bases: Stream1

Example
Stream1End(
    msg_number=376,
    htype='series_end'
)
Source code in dranspose/data/stream1.py
class Stream1End(Stream1):
    """
    Example:
        ``` py
        Stream1End(
            msg_number=376,
            htype='series_end'
        )
        ```
    """

    model_config = ConfigDict(extra="allow")

    htype: Literal["series_end"] = "series_end"

Stream1Start

Bases: Stream1

Example
Stream1Start(
    msg_number=374,
    htype='header',
    filename='/data/visitors/....test.h5'
)
Source code in dranspose/data/stream1.py
class Stream1Start(Stream1):
    """
    Example:
        ``` py
        Stream1Start(
            msg_number=374,
            htype='header',
            filename='/data/visitors/....test.h5'
        )
        ```
    """

    model_config = ConfigDict(extra="allow")

    htype: Literal["header"] = "header"
    filename: str