Skip to content

Albaem

AlbaemPacket = TypeAdapter(AlbaemStart | AlbaemData | AlbaemEnd) module-attribute

Union type for Albaem packets

AlbaemData

Bases: AlbaemBase

While the original stream sends 3 separate zmq frames (no multipart), this returns a single packet.

Example 
AlbaemImage(
    message_id=2,
    version=1,
    message_type='data',
    frame_number=0,
    timestamp=7.72645192,
    acquisition_timestamp=1704807770443944912,
    channel1=-2.8302592615927417e-11,
    channel2=-6.091210149949596e-11,
    channel3=2.5349278603830644e-10,
    channel4=4.80528800718246e-10
)
Source code in dranspose/data/albaem.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class AlbaemData(AlbaemBase):
    """
    While the original stream sends 3 separate zmq frames (no multipart), this returns a single packet.

    Example:
        ``` py
        AlbaemImage(
            message_id=2,
            version=1,
            message_type='data',
            frame_number=0,
            timestamp=7.72645192,
            acquisition_timestamp=1704807770443944912,
            channel1=-2.8302592615927417e-11,
            channel2=-6.091210149949596e-11,
            channel3=2.5349278603830644e-10,
            channel4=4.80528800718246e-10
        )
        ```
    """

    model_config = ConfigDict(extra="allow")

    message_type: Literal["data"]
    frame_number: int
    timestamp: float
    acquisition_timestamp: int

AlbaemEnd

Bases: AlbaemBase

Example 
AlbaemEnd(
    message_id=6,
    version=1,
    message_type='series-end',
    detector_specific={'read_overflow': False, 'memory_overflow': False})
Source code in dranspose/data/albaem.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
class AlbaemEnd(AlbaemBase):
    """
    Example:
        ``` py
        AlbaemEnd(
            message_id=6,
            version=1,
            message_type='series-end',
            detector_specific={'read_overflow': False, 'memory_overflow': False})
        ```
    """

    model_config = ConfigDict(extra="allow")

    message_type: Literal["series-end"]

AlbaemStart

Bases: AlbaemBase

Example 
AlbaemStart(
    message_id=1,
    version=1,
    message_type='series-start'
)
Source code in dranspose/data/albaem.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class AlbaemStart(AlbaemBase):
    """
    Example:
        ``` py
        AlbaemStart(
            message_id=1,
            version=1,
            message_type='series-start'
        )
        ```
    """

    model_config = ConfigDict(extra="allow")

    message_type: Literal["series-start"]