Skip to content

hardware_id Module

The Spyral definition of a AT-TPC pad

HardwareID dataclass

Dataclass for AT-TPC pad hardware information

Attributes:

Name Type Description
pad_id int

The pad id number
cobo_id int

The CoBo id number
asad_id int

The AsAd id number
aget_id int

The AGET id number
aget_channel int

The AGET channel number

Methods:

Name Description
__str__

Convert the HardwareID to a string
Source code in src/spyral/core/hardware_id.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
@dataclass
class HardwareID:
    """Dataclass for AT-TPC pad hardware information

    Attributes
    ----------
    pad_id: int
        The pad id number
    cobo_id: int
        The CoBo id number
    asad_id: int
        The AsAd id number
    aget_id: int
        The AGET id number
    aget_channel: int
        The AGET channel number

    Methods
    -------
    __str__() -> str
        Convert the HardwareID to a string

    """

    pad_id: int = INVALID_PAD_ID
    cobo_id: int = INVALID_PAD_ID
    asad_id: int = INVALID_PAD_ID
    aget_id: int = INVALID_PAD_ID
    aget_channel: int = INVALID_PAD_ID

    def __str__(self) -> str:
        """Convert the HardwareID to a string

        Returns
        -------
        str
            The HardwareID string
        """
        return f"HardwareID -> pad: {self.pad_id} cobo: {self.cobo_id} asad: {self.asad_id} aget: {self.aget_id} channel: {self.aget_channel}"

__str__()

Convert the HardwareID to a string

Returns:

Type Description
str

The HardwareID string
Source code in src/spyral/core/hardware_id.py 
43
44
45
46
47
48
49
50
51
def __str__(self) -> str:
    """Convert the HardwareID to a string

    Returns
    -------
    str
        The HardwareID string
    """
    return f"HardwareID -> pad: {self.pad_id} cobo: {self.cobo_id} asad: {self.asad_id} aget: {self.aget_id} channel: {self.aget_channel}"

generate_electronics_id(hardware)

Get a UUID for a given HardwareID

Parameters:

Name Type Description Default
hardware HardwareID
required

Returns:

Type Description
int

a single value UUID
Source code in src/spyral/core/hardware_id.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def generate_electronics_id(hardware: HardwareID) -> int:
    """Get a UUID for a given HardwareID

    Parameters
    ----------
    hardware: HardwareID

    Returns
    -------
    int
        a single value UUID

    """
    return (
        hardware.aget_channel
        + hardware.aget_id * 100
        + hardware.asad_id * 10000
        + hardware.cobo_id * 1000000
    )

hardware_id_from_array(array)

Convert an array of id numbers to a HardwareID

Typically used with the raw hdf5 data from the AT-TPC merger.

Parameters:

Name Type Description Default
array ndarray

An array of hardware id's in the appropriate order

 required

Returns:

Type Description
HardwareID

The HardwareID object
Source code in src/spyral/core/hardware_id.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def hardware_id_from_array(array: np.ndarray) -> HardwareID:
    """Convert an array of id numbers to a HardwareID

    Typically used with the raw hdf5 data from the AT-TPC merger.

    Parameters
    ----------
    array: ndarray
        An array of hardware id's in the appropriate order

    Returns
    -------
    HardwareID
        The HardwareID object
    """
    hw_id = HardwareID()
    hw_id.pad_id = array[GET_DATA_PAD_INDEX]
    hw_id.cobo_id = array[GET_DATA_COBO_INDEX]
    hw_id.asad_id = array[GET_DATA_ASAD_INDEX]
    hw_id.aget_id = array[GET_DATA_AGET_INDEX]
    hw_id.aget_channel = array[GET_DATA_CHANNEL_INDEX]
    return hw_id