Skip to content

pybes3.identifier

Parsing methods

These methods parse the given ID and return the corresponding components. They are useful for retrieving the components of an ID when you only have the ID itself.

parse_mdc_digi(mdc_digi)

Parse MDC raw digi array. The raw digi array should contain [m_intId, m_timeChannel, m_chargeChannel, m_overflow] fields.

Fields of the output:

  • gid: Global ID of the wire.
  • wire: Local wire number.
  • layer: Layer number.
  • is_stereo: Whether the wire is a stereo wire.
  • charge_channel: Charge channel.
  • time_channel: Time channel.
  • overflow: Overflow flag.
  • track_index: Track index.

Parameters:

Name Type Description Default
mdc_digi Array | dict[str, ndarray | int]

The MDC raw digi array.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed MDC digi array.
Source code in src/pybes3/identifier.py 
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
def parse_mdc_digi(
    mdc_digi: ak.Array | dict[str, np.ndarray | int],
) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse MDC raw digi array. The raw digi array should contain [`m_intId`,
    `m_timeChannel`, `m_chargeChannel`, `m_overflow`] fields.

    Fields of the output:

    - `gid`: Global ID of the wire.
    - `wire`: Local wire number.
    - `layer`: Layer number.
    - `is_stereo`: Whether the wire is a stereo wire.
    - `charge_channel`: Charge channel.
    - `time_channel`: Time channel.
    - `overflow`: Overflow flag.
    - `track_index`: Track index.

    Parameters:
        mdc_digi: The MDC raw digi array.

    Returns:
        The parsed MDC digi array.
    """
    parsed_id = parse_mdc_id(mdc_digi["m_intId"])

    charge_channel = mdc_digi["m_chargeChannel"]
    time_channel = mdc_digi["m_timeChannel"]
    overflow = mdc_digi["m_overflow"]

    res = {
        "gid": parsed_id["gid"],
        "wire": parsed_id["wire"],
        "layer": parsed_id["layer"],
        "is_stereo": parsed_id["is_stereo"],
        "charge_channel": charge_channel,
        "time_channel": time_channel,
        "overflow": overflow,
    }

    _add_field_if_exist(mdc_digi, res, "m_trackIndex", "track_index")

    if isinstance(mdc_digi, ak.Array):
        return ak.zip(res)
    else:
        return res

parse_tof_digi(tof_digi)

Parse TOF raw digi array. The raw digi array should contain [m_intId, m_timeChannel, m_chargeChannel, m_overflow] fields.

Fields of the output:

  • gid: Global ID of the strip. Note that it corresponds to the strip instead of readout end, so it is the same for both ends of the strip.
  • part: The part number. 0,1,2 for scintillator endcap0, barrel, endcap1; 3,4 for MRPC endcap0, endcap1.
  • layer_or_module: The scintillator layer or MRPC module number, based on the part number.
  • phi_or_strip: The scintillator phi or MRPC strip ID, based on the part number.
  • end: The readout end ID.
  • charge_channel: Charge channel.
  • time_channel: Time channel.
  • overflow: Overflow flag.

Parameters:

Name Type Description Default
tof_digi Array | dict[str, ndarray | int]

The TOF raw digi array.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed TOF digi array.
Source code in src/pybes3/identifier.py 
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
def parse_tof_digi(
    tof_digi: ak.Array | dict[str, np.ndarray | int],
) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse TOF raw digi array. The raw digi array should contain [`m_intId`,
    `m_timeChannel`, `m_chargeChannel`, `m_overflow`] fields.

    Fields of the output:

    - `gid`: Global ID of the strip. Note that it corresponds to the strip instead of readout end, so it is the same for both ends of the strip.
    - `part`: The part number. `0,1,2` for scintillator endcap0, barrel, endcap1; `3,4` for MRPC endcap0, endcap1.
    - `layer_or_module`: The scintillator layer or MRPC module number, based on the part number.
    - `phi_or_strip`: The scintillator phi or MRPC strip ID, based on the part number.
    - `end`: The readout end ID.
    - `charge_channel`: Charge channel.
    - `time_channel`: Time channel.
    - `overflow`: Overflow flag.

    Parameters:
        tof_digi: The TOF raw digi array.

    Returns:
        The parsed TOF digi array.
    """
    parsed_id = parse_tof_id(tof_digi["m_intId"])

    charge_channel = tof_digi["m_chargeChannel"]
    time_channel = tof_digi["m_timeChannel"]

    res = {
        "gid": parsed_id["gid"],
        "part": parsed_id["part"],
        "layer_or_module": parsed_id["layer_or_module"],
        "phi_or_strip": parsed_id["phi_or_strip"],
        "end": parsed_id["end"],
        "charge_channel": charge_channel,
        "time_channel": time_channel,
        "overflow": tof_digi["m_overflow"],
    }

    _add_field_if_exist(tof_digi, res, "m_trackIndex", "track_index")

    if isinstance(tof_digi, ak.Array):
        return ak.zip(res)
    else:
        return res

parse_emc_digi(emc_digi)

Parse EMC raw digi array. The raw digi array should contain [m_intId, m_timeChannel, m_chargeChannel, m_measure] fields.

Fields of the output:

  • gid: Global ID of the crystal.
  • part: Part number, 0 for endcap0, 1 for barrel, 2 for endcap1.
  • theta: Theta number.
  • phi: Phi number.
  • charge_channel: Charge channel.
  • time_channel: Time channel.
  • measure: Measure value.
  • track_index: Track index.

Parameters:

Name Type Description Default
emc_digi Array | dict[str, ndarray | int]

The EMC raw digi array.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed EMC digi array.
Source code in src/pybes3/identifier.py 
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
def parse_emc_digi(
    emc_digi: ak.Array | dict[str, np.ndarray | int],
) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse EMC raw digi array. The raw digi array should contain [`m_intId`,
    `m_timeChannel`, `m_chargeChannel`, `m_measure`] fields.

    Fields of the output:

    - `gid`: Global ID of the crystal.
    - `part`: Part number, 0 for endcap0, 1 for barrel, 2 for endcap1.
    - `theta`: Theta number.
    - `phi`: Phi number.
    - `charge_channel`: Charge channel.
    - `time_channel`: Time channel.
    - `measure`: Measure value.
    - `track_index`: Track index.

    Parameters:
        emc_digi: The EMC raw digi array.

    Returns:
        The parsed EMC digi array.
    """
    parsed_id = parse_emc_id(emc_digi["m_intId"])

    charge_channel = emc_digi["m_chargeChannel"]
    time_channel = emc_digi["m_timeChannel"]
    measure = emc_digi["m_measure"]

    res = {
        "gid": parsed_id["gid"],
        "part": parsed_id["part"],
        "theta": parsed_id["theta"],
        "phi": parsed_id["phi"],
        "charge_channel": charge_channel,
        "time_channel": time_channel,
        "measure": measure,
    }

    _add_field_if_exist(emc_digi, res, "m_trackIndex", "track_index")

    if isinstance(emc_digi, ak.Array):
        return ak.zip(res)
    else:
        return res

parse_cgem_digi(cgem_digi)

Parse CGEM raw digi array. The raw digi array should contain [m_intId, m_timeChannel, m_chargeChannel, m_overflow] fields.

Fields of the output:

  • gid: The global strip ID.
  • layer: The layer number.
  • sheet: The sheet ID.
  • strip_type: The strip type. 0 for X-strip, 1 for V-strip.
  • strip: The strip ID.
  • charge_channel: Charge channel.
  • time_channel: Time channel.
  • overflow: Overflow flag.
  • track_index: Track index.

Parameters:

Name Type Description Default
cgem_digi Array | dict[str, ndarray | int]

The CGEM raw digi array.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed CGEM digi array.
Source code in src/pybes3/identifier.py 
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
def parse_cgem_digi(
    cgem_digi: ak.Array | dict[str, np.ndarray | int],
) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse CGEM raw digi array. The raw digi array should contain [`m_intId`,
    `m_timeChannel`, `m_chargeChannel`, `m_overflow`] fields.

    Fields of the output:

    - `gid`: The global strip ID.
    - `layer`: The layer number.
    - `sheet`: The sheet ID.
    - `strip_type`: The strip type. 0 for X-strip, 1 for V-strip.
    - `strip`: The strip ID.
    - `charge_channel`: Charge channel.
    - `time_channel`: Time channel.
    - `overflow`: Overflow flag.
    - `track_index`: Track index.

    Parameters:
        cgem_digi: The CGEM raw digi array.

    Returns:
        The parsed CGEM digi array.
    """
    parsed_id = parse_cgem_id(cgem_digi["m_intId"])

    charge_channel = cgem_digi["m_chargeChannel"]
    time_channel = cgem_digi["m_timeChannel"]

    res = {
        "gid": parsed_id["gid"],
        "layer": parsed_id["layer"],
        "sheet": parsed_id["sheet"],
        "strip_type": parsed_id["strip_type"],
        "strip": parsed_id["strip"],
        "charge_channel": charge_channel,
        "time_channel": time_channel,
    }

    _add_field_if_exist(cgem_digi, res, "m_overflow", "overflow")
    _add_field_if_exist(cgem_digi, res, "m_trackIndex", "track_index")

    if isinstance(cgem_digi, ak.Array):
        return ak.zip(res)
    else:
        return res

parse_mdc_id(mdc_id)

Parse MDC digi ID.

Available keys of the output:

  • gid: Global ID of the wire.
  • layer: Layer number.
  • wire: Local wire number.
  • is_stereo: Whether the wire is a stereo wire.

Parameters:

Name Type Description Default
mdc_id IntLike

The MDC digi ID.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed MDC digi ID.
Source code in src/pybes3/identifier.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
def parse_mdc_id(mdc_id: IntLike) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse MDC digi ID.

    Available keys of the output:

    - `gid`: Global ID of the wire.
    - `layer`: Layer number.
    - `wire`: Local wire number.
    - `is_stereo`: Whether the wire is a stereo wire.

    Parameters:
        mdc_id: The MDC digi ID.

    Returns:
        The parsed MDC digi ID.
    """

    res = {
        "gid": mdc_id_to_gid(mdc_id),
        "layer": mdc_id_to_layer(mdc_id),
        "wire": mdc_id_to_wire(mdc_id),
        "is_stereo": mdc_id_to_is_stereo(mdc_id),
    }

    if isinstance(mdc_id, ak.Array):
        return ak.zip(res)
    else:
        return res

parse_emc_id(emc_id)

Parse EMC digi ID.

Available keys of the output:

  • gid: Global ID of the crystal.
  • part: Part number, 0 for endcap0, 1 for barrel, 2 for endcap1.
  • theta: Theta number.
  • phi: Phi number.

Parameters:

Name Type Description Default
emc_id IntLike

The EMC digi ID.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed EMC digi ID.
Source code in src/pybes3/identifier.py 
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
def parse_emc_id(emc_id: IntLike) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse EMC digi ID.

    Available keys of the output:

    - `gid`: Global ID of the crystal.
    - `part`: Part number, 0 for endcap0, 1 for barrel, 2 for endcap1.
    - `theta`: Theta number.
    - `phi`: Phi number.

    Parameters:
        emc_id: The EMC digi ID.

    Returns:
        The parsed EMC digi ID.
    """
    module = emc_id_to_module(emc_id)
    theta = emc_id_to_theta(emc_id)
    phi = emc_id_to_phi(emc_id)
    res = {
        "gid": det.get_emc_gid(module, theta, phi),
        "part": module,
        "theta": theta,
        "phi": phi,
    }

    if isinstance(emc_id, ak.Array):
        return ak.zip(res)
    else:
        return res

parse_tof_id(tof_id)

Parse TOF digi ID.

Available keys of the output:

  • gid: Global ID of the strip. Note that it corresponds to the strip instead of readout end, so it is the same for both ends of the strip.
  • part: The part number. 0,1,2 for scintillator endcap0, barrel, endcap1; 3,4 for MRPC endcap0, endcap1.
  • layer_or_module: The scintillator layer or MRPC module number, based on the part number.
  • phi_or_strip: The scintillator phi or MRPC strip ID, based on the part number.
  • end: The readout end ID.

The return value is based on the part number.

Rows where part < 3 are scintillator and layer_or_module represents layer number, phi_or_strip represents phi number.

Rows where part >= 3 are MRPC and layer_or_module represents module number, phi_or_strip represents strip ID.

Parameters:

Name Type Description Default
tof_id IntLike

The TOF ID.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed TOF ID.
Source code in src/pybes3/identifier.py 
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
def parse_tof_id(tof_id: IntLike) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse TOF digi ID.

    Available keys of the output:

    - `gid`: Global ID of the strip. Note that it corresponds to the strip instead of readout end, so it is the same for both ends of the strip.
    - `part`: The part number. `0,1,2` for scintillator endcap0, barrel, endcap1; `3,4` for MRPC endcap0, endcap1.
    - `layer_or_module`: The scintillator layer or MRPC module number, based on the part number.
    - `phi_or_strip`: The scintillator phi or MRPC strip ID, based on the part number.
    - `end`: The readout end ID.

    The return value is based on the part number.

    Rows where `part < 3` are scintillator and `layer_or_module` represents layer number, `phi_or_strip` represents phi number.

    Rows where `part >= 3` are MRPC and `layer_or_module` represents module number, `phi_or_strip` represents strip ID.

    Parameters:
        tof_id: The TOF ID.

    Returns:
        The parsed TOF ID.

    """

    part = tof_id_to_part(tof_id)
    layer_or_module = tof_id_to_layer_or_module(tof_id, part)
    phi_or_strip = tof_id_to_phi_or_strip(tof_id, part)
    end = tof_id_to_end(tof_id)
    gid = det.get_tof_gid(part, layer_or_module, phi_or_strip)

    res = {
        "gid": gid,
        "part": part,
        "layer_or_module": layer_or_module,
        "phi_or_strip": phi_or_strip,
        "end": end,
    }

    if isinstance(tof_id, ak.Array):
        return ak.zip(res)
    else:
        return res

parse_muc_id(muc_id)

Parse MUC digi ID.

Available keys of the output:

  • part: The part number.
  • segment: The segment number.
  • layer: The layer number.
  • channel: The channel number.
  • gap: The gap number, which is equivalent to layer number.
  • strip: The strip number, which is equivalent to channel number.

Parameters:

Name Type Description Default
muc_id IntLike

The MUC digi ID.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed MUC digi ID.
Source code in src/pybes3/identifier.py 
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
def parse_muc_id(muc_id: IntLike) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse MUC digi ID.

    Available keys of the output:

    - `part`: The part number.
    - `segment`: The segment number.
    - `layer`: The layer number.
    - `channel`: The channel number.
    - `gap`: The gap number, which is equivalent to layer number.
    - `strip`: The strip number, which is equivalent to channel number.

    Parameters:
        muc_id: The MUC digi ID.

    Returns:
        The parsed MUC digi ID.
    """
    part = muc_id_to_part(muc_id)
    segment = muc_id_to_segment(muc_id)
    layer = muc_id_to_layer(muc_id)
    channel = muc_id_to_channel(muc_id)

    res = {
        "part": part,
        "segment": segment,
        "layer": layer,
        "channel": channel,
        "gap": layer,
        "strip": channel,
    }

    if isinstance(muc_id, ak.Array):
        return ak.zip(res)
    else:
        return res

parse_cgem_id(cgem_id)

Parse CGEM digi ID.

Available keys of the output:

  • gid: The global strip ID.
  • layer: The layer number.
  • sheet: The sheet ID.
  • strip_type: The strip type. 0 for X-strip, 1 for V-strip.
  • strip: The strip ID.

Parameters:

Name Type Description Default
cgem_id IntLike

The CGEM digi ID.

 required

Returns:

Type Description
Array | dict[str, ndarray | int]

The parsed CGEM digi ID.
Source code in src/pybes3/identifier.py 
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
def parse_cgem_id(cgem_id: IntLike) -> ak.Array | dict[str, np.ndarray | int]:
    """
    Parse CGEM digi ID.

    Available keys of the output:

    - `gid`: The global strip ID.
    - `layer`: The layer number.
    - `sheet`: The sheet ID.
    - `strip_type`: The strip type. 0 for X-strip, 1 for V-strip.
    - `strip`: The strip ID.

    Parameters:
        cgem_id: The CGEM digi ID.

    Returns:
        The parsed CGEM digi ID.
    """
    layer = cgem_id_to_layer(cgem_id)
    sheet = cgem_id_to_sheet(cgem_id)
    strip_type = cgem_id_to_strip_type(cgem_id)
    strip = cgem_id_to_strip(cgem_id)
    gid = det.get_cgem_gid(layer, sheet, strip_type, strip)

    res = {
        "gid": gid,
        "layer": layer,
        "sheet": sheet,
        "strip_type": strip_type,
        "strip": strip,
    }

    if isinstance(cgem_id, ak.Array):
        return ak.zip(res)
    else:
        return res

MDC

check_mdc_id(mdc_id)

Check if the MDC digi ID is valid.

Parameters:

Name Type Description Default
mdc_id IntLike

The MDC digi ID array or value.

 required

Returns:

Type Description
BoolLike

Whether the digi ID is valid.
Source code in src/pybes3/identifier.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@nb.vectorize(cache=True)
def check_mdc_id(mdc_id: IntLike) -> BoolLike:
    """
    Check if the MDC digi ID is valid.

    Parameters:
        mdc_id: The MDC digi ID array or value.

    Returns:
        Whether the digi ID is valid.
    """
    return (mdc_id & DIGI_FLAG_MASK) >> DIGI_FLAG_OFFSET == DIGI_MDC_FLAG

mdc_id_to_gid(mdc_id)

Convert MDC digi ID to global wire ID (gid).

Parameters:

Name Type Description Default
mdc_id IntLike

The MDC digi ID array or value.

 required

Returns:

Type Description
IntLike

The global wire ID.
Source code in src/pybes3/identifier.py 
168
169
170
171
172
173
174
175
176
177
178
def mdc_id_to_gid(mdc_id: IntLike) -> IntLike:
    """
    Convert MDC digi ID to global wire ID (gid).

    Parameters:
        mdc_id: The MDC digi ID array or value.

    Returns:
        The global wire ID.
    """
    return det.get_mdc_gid(mdc_id_to_layer(mdc_id), mdc_id_to_wire(mdc_id))

mdc_id_to_wire(mdc_id)

Convert MDC digi ID to wire number.

Parameters:

Name Type Description Default
mdc_id IntLike

MDC digi ID array or value.

 required

Returns:

Type Description
IntLike

The wire number.
Source code in src/pybes3/identifier.py 
103
104
105
106
107
108
109
110
111
112
113
114
@nb.vectorize(cache=True)
def mdc_id_to_wire(mdc_id: IntLike) -> IntLike:
    """
    Convert MDC digi ID to wire number.

    Parameters:
        mdc_id: MDC digi ID array or value.

    Returns:
        The wire number.
    """
    return (mdc_id & DIGI_MDC_WIRE_MASK) >> DIGI_MDC_WIRE_OFFSET

mdc_id_to_layer(mdc_id)

Convert the MDC digi ID to the layer number.

Parameters:

Name Type Description Default
mdc_id IntLike

The MDC digi ID array or value.

 required

Returns:

Type Description
IntLike

The layer number.
Source code in src/pybes3/identifier.py 
117
118
119
120
121
122
123
124
125
126
127
128
@nb.vectorize(cache=True)
def mdc_id_to_layer(mdc_id: IntLike) -> IntLike:
    """
    Convert the MDC digi ID to the layer number.

    Parameters:
        mdc_id: The MDC digi ID array or value.

    Returns:
        The layer number.
    """
    return (mdc_id & DIGI_MDC_LAYER_MASK) >> DIGI_MDC_LAYER_OFFSET

mdc_id_to_is_stereo(mdc_id)

Convert the MDC digi ID to whether it is a stereo wire.

Parameters:

Name Type Description Default
mdc_id IntLike

The MDC digi ID array or value.

 required

Returns:

Type Description
BoolLike

Whether the wire is a stereo wire.
Source code in src/pybes3/identifier.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
@nb.vectorize(cache=True)
def mdc_id_to_is_stereo(mdc_id: IntLike) -> BoolLike:
    """
    Convert the MDC digi ID to whether it is a stereo wire.

    Parameters:
        mdc_id: The MDC digi ID array or value.

    Returns:
        Whether the wire is a stereo wire.
    """
    return (
        mdc_id & DIGI_MDC_WIRETYPE_MASK
    ) >> DIGI_MDC_WIRETYPE_OFFSET == DIGI_MDC_STEREO_WIRE

get_mdc_id(wire, layer, wire_type)

Generate MDC digi ID based on the wire number, layer number, and wire type.

Parameters:

Name Type Description Default
wire IntLike

The wire number.

 required
layer IntLike

The layer number.

 required
wire_type IntLike

The wire type.

 required

Returns:

Type Description
IntLike

The MDC digi ID.
Source code in src/pybes3/identifier.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
@nb.vectorize(cache=True)
def get_mdc_id(wire: IntLike, layer: IntLike, wire_type: IntLike) -> IntLike:
    """
    Generate MDC digi ID based on the wire number, layer number, and wire type.

    Parameters:
        wire: The wire number.
        layer: The layer number.
        wire_type: The wire type.

    Returns:
        The MDC digi ID.
    """
    return np.uint32(
        ((wire << DIGI_MDC_WIRE_OFFSET) & DIGI_MDC_WIRE_MASK)
        | ((layer << DIGI_MDC_LAYER_OFFSET) & DIGI_MDC_LAYER_MASK)
        | ((wire_type << DIGI_MDC_WIRETYPE_OFFSET) & DIGI_MDC_WIRETYPE_MASK)
        | (DIGI_MDC_FLAG << DIGI_FLAG_OFFSET)
    )

TOF

check_tof_id(tof_id)

Check if the TOF digi ID is valid.

Parameters:

Name Type Description Default
tof_id IntLike

The TOF digi ID array or value.

 required

Returns:

Type Description
BoolLike

Whether the digi ID is valid.
Source code in src/pybes3/identifier.py 
265
266
267
268
269
270
271
272
273
274
275
276
@nb.vectorize(cache=True)
def check_tof_id(tof_id: IntLike) -> BoolLike:
    """
    Check if the TOF digi ID is valid.

    Parameters:
        tof_id: The TOF digi ID array or value.

    Returns:
        Whether the digi ID is valid.
    """
    return (tof_id & DIGI_FLAG_MASK) >> DIGI_FLAG_OFFSET == DIGI_TOF_FLAG

tof_id_to_gid(tof_id)

Convert TOF digi ID to global strip ID (gid).

Parameters:

Name Type Description Default
tof_id IntLike

The TOF digi ID array or value.

 required

Returns:

Type Description
IntLike

The global strip ID.
Source code in src/pybes3/identifier.py 
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
def tof_id_to_gid(tof_id: IntLike) -> IntLike:
    """
    Convert TOF digi ID to global strip ID (gid).

    Parameters:
        tof_id: The TOF digi ID array or value.

    Returns:
        The global strip ID.
    """
    part = tof_id_to_part(tof_id)
    return det.get_tof_gid(
        part,
        tof_id_to_layer_or_module(tof_id, part),
        tof_id_to_phi_or_strip(tof_id, part),
    )

tof_id_to_part(tof_id)

Convert TOF digi ID to part number. 0, 1, 2 for scintillator endcap0/barrel/endcap1, 3, 4 for MRPC endcap0/endcap1.

Parameters:

Name Type Description Default
tof_id IntLike

TOF digi ID array or value.

 required

Returns:

Type Description
IntLike

The part number.
Source code in src/pybes3/identifier.py 
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
@nb.vectorize(cache=True)
def tof_id_to_part(tof_id: IntLike) -> IntLike:
    """
    Convert TOF digi ID to part number. 0, 1, 2 for scintillator endcap0/barrel/endcap1,
    3, 4 for MRPC endcap0/endcap1.

    Parameters:
        tof_id: TOF digi ID array or value.

    Returns:
        The part number.
    """
    part = (tof_id & DIGI_TOF_PART_MASK) >> DIGI_TOF_PART_OFFSET
    if part == 3:  # += MRPC endcap number
        part += (tof_id & DIGI_TOF_MRPC_ENDCAP_MASK) >> DIGI_TOF_MRPC_ENDCAP_OFFSET
    return part

tof_id_to_end(tof_id)

Convert the TOF digi ID to the readout end number.

Parameters:

Name Type Description Default
tof_id IntLike

The TOF digi ID array or value.

 required

Returns:

Type Description
IntLike

The readout end number.
Source code in src/pybes3/identifier.py 
297
298
299
300
301
302
303
304
305
306
307
308
@nb.vectorize(cache=True)
def tof_id_to_end(tof_id: IntLike) -> IntLike:
    """
    Convert the TOF digi ID to the readout end number.

    Parameters:
        tof_id: The TOF digi ID array or value.

    Returns:
        The readout end number.
    """
    return (tof_id & DIGI_TOF_END_MASK) >> DIGI_TOF_END_OFFSET

tof_id_to_layer_or_module(tof_id, part=None)

Convert the TOF digi ID to the scintillator layer or MRPC module number. If part < 3, it is scintillator and the return value is layer number. Otherwise, it is MRPC and the return value is module number.

Parameters:

Name Type Description Default
tof_id IntLike

The TOF digi ID array or value.

 required
part IntLike | None

The part number. If not provided, it will be calculated based on the TOF digi ID.

 None

Returns:

Type Description
IntLike

The scintillator layer or MRPC module number.
Source code in src/pybes3/identifier.py 
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
def tof_id_to_layer_or_module(
    tof_id: IntLike,
    part: IntLike | None = None,
) -> IntLike:
    """
    Convert the TOF digi ID to the scintillator layer or MRPC module number.
    If `part < 3`, it is scintillator and the return value is layer number. Otherwise, it is
    MRPC and the return value is module number.

    Parameters:
        tof_id: The TOF digi ID array or value.
        part: The part number. If not provided, it will be calculated based on the TOF digi ID.

    Returns:
        The scintillator layer or MRPC module number.
    """
    if part is None:
        return _tof_id_to_layer_or_module_1(tof_id)
    else:
        return _tof_id_to_layer_or_module_2(tof_id, part)

tof_id_to_phi_or_strip(tof_id, part=None)

Convert the TOF digi ID to the scintillator phi or MRPC strip number, based on the part number. If part < 3, it is scintillator and the return value is phi number. Otherwise, it is MRPC and the return value is strip number.

Parameters:

Name Type Description Default
tof_id IntLike

The TOF digi ID array or value.

 required
part IntLike | None

The part number. If not provided, it will be calculated based on the TOF digi ID.

 None

Returns:

Type Description
IntLike

The scintillator phi or MRPC strip number.
Source code in src/pybes3/identifier.py 
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
def tof_id_to_phi_or_strip(
    tof_id: IntLike,
    part: IntLike | None = None,
) -> IntLike:
    """
    Convert the TOF digi ID to the scintillator phi or MRPC strip number, based on the part number.
    If `part < 3`, it is scintillator and the return value is phi number. Otherwise, it is
    MRPC and the return value is strip number.

    Parameters:
        tof_id: The TOF digi ID array or value.
        part: The part number. If not provided, it will be calculated based on the TOF digi ID.

    Returns:
        The scintillator phi or MRPC strip number.
    """
    if part is None:
        return _tof_id_to_phi_or_strip_1(tof_id)
    else:
        return _tof_id_to_phi_or_strip_2(tof_id, part)

get_tof_id(part, layer_or_module, phi_or_strip, end)

Generate TOF scintillator ID based on the part number, layer number, phi number, and readout end number.

Parameters:

Name Type Description Default
part IntLike

The part number.

 required
layer_or_module IntLike

The scintillator layer or MRPC module number.

 required
phi_or_strip IntLike

The scintillator phi or MRPC strip number.

 required
end IntLike

The readout end number.

 required

Returns:

Type Description
IntLike

The TOF digi ID.
Source code in src/pybes3/identifier.py 
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
@nb.vectorize(cache=True)
def get_tof_id(
    part: IntLike, layer_or_module: IntLike, phi_or_strip: IntLike, end: IntLike
) -> IntLike:
    """
    Generate TOF scintillator ID based on the part number, layer number, phi number, and readout end number.

    Parameters:
        part: The part number.
        layer_or_module: The scintillator layer or MRPC module number.
        phi_or_strip: The scintillator phi or MRPC strip number.
        end: The readout end number.

    Returns:
        The TOF digi ID.
    """
    if part < 3:
        return np.uint32(
            ((part << DIGI_TOF_PART_OFFSET) & DIGI_TOF_PART_MASK)
            | ((layer_or_module << DIGI_TOF_SCINT_LAYER_OFFSET) & DIGI_TOF_SCINT_LAYER_MASK)
            | ((phi_or_strip << DIGI_TOF_SCINT_PHI_OFFSET) & DIGI_TOF_SCINT_PHI_MASK)
            | ((end << DIGI_TOF_END_OFFSET) & DIGI_TOF_END_MASK)
            | (DIGI_TOF_FLAG << DIGI_FLAG_OFFSET)
        )
    else:
        return np.uint32(
            ((3 << DIGI_TOF_PART_OFFSET) & DIGI_TOF_PART_MASK)
            | (((part - 3) << DIGI_TOF_MRPC_ENDCAP_OFFSET) & DIGI_TOF_MRPC_ENDCAP_MASK)
            | ((layer_or_module << DIGI_TOF_MRPC_MODULE_OFFSET) & DIGI_TOF_MRPC_MODULE_MASK)
            | ((phi_or_strip << DIGI_TOF_MRPC_STRIP_OFFSET) & DIGI_TOF_MRPC_STRIP_MASK)
            | ((end << DIGI_TOF_END_OFFSET) & DIGI_TOF_END_MASK)
            | (DIGI_TOF_FLAG << DIGI_FLAG_OFFSET)
        )

EMC

check_emc_id(emc_id)

Check if the EMC digi ID is valid.

Parameters:

Name Type Description Default
emc_id IntLike

The EMC digi ID array or value.

 required

Returns:

Type Description
BoolLike

Whether the digi ID is valid.
Source code in src/pybes3/identifier.py 
593
594
595
596
597
598
599
600
601
602
603
604
@nb.vectorize(cache=True)
def check_emc_id(emc_id: IntLike) -> BoolLike:
    """
    Check if the EMC digi ID is valid.

    Parameters:
        emc_id: The EMC digi ID array or value.

    Returns:
        Whether the digi ID is valid.
    """
    return (emc_id & DIGI_FLAG_MASK) >> DIGI_FLAG_OFFSET == DIGI_EMC_FLAG

emc_id_to_gid(emc_id)

Convert EMC digi ID to global crystal ID (gid).

Parameters:

Name Type Description Default
emc_id IntLike

The EMC digi ID array or value.

 required

Returns:

Type Description
IntLike

The global crystal ID.
Source code in src/pybes3/identifier.py 
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
def emc_id_to_gid(emc_id: IntLike) -> IntLike:
    """
    Convert EMC digi ID to global crystal ID (gid).

    Parameters:
        emc_id: The EMC digi ID array or value.

    Returns:
        The global crystal ID.
    """
    return det.get_emc_gid(
        emc_id_to_module(emc_id),
        emc_id_to_theta(emc_id),
        emc_id_to_phi(emc_id),
    )

emc_id_to_module(emc_id)

Convert EMC digi ID to module number

Parameters:

Name Type Description Default
emc_id IntLike

EMC digi ID array or value.

 required

Returns:

Type Description
IntLike

The module number.
Source code in src/pybes3/identifier.py 
607
608
609
610
611
612
613
614
615
616
617
618
@nb.vectorize(cache=True)
def emc_id_to_module(emc_id: IntLike) -> IntLike:
    """
    Convert EMC digi ID to module number

    Parameters:
        emc_id: EMC digi ID array or value.

    Returns:
        The module number.
    """
    return (emc_id & DIGI_EMC_MODULE_MASK) >> DIGI_EMC_MODULE_OFFSET

emc_id_to_theta(emc_id)

Convert the EMC digi ID to the theta number.

Parameters:

Name Type Description Default
emc_id IntLike

The EMC digi ID array or value.

 required

Returns:

Type Description
IntLike

The theta number.
Source code in src/pybes3/identifier.py 
621
622
623
624
625
626
627
628
629
630
631
632
@nb.vectorize(cache=True)
def emc_id_to_theta(emc_id: IntLike) -> IntLike:
    """
    Convert the EMC digi ID to the theta number.

    Parameters:
        emc_id: The EMC digi ID array or value.

    Returns:
        The theta number.
    """
    return (emc_id & DIGI_EMC_THETA_MASK) >> DIGI_EMC_THETA_OFFSET

emc_id_to_phi(emc_id)

Convert the EMC digi ID to the phi number.

Parameters:

Name Type Description Default
emc_id IntLike

The EMC digi ID array or value.

 required

Returns:

Type Description
IntLike

The phi number.
Source code in src/pybes3/identifier.py 
635
636
637
638
639
640
641
642
643
644
645
646
@nb.vectorize(cache=True)
def emc_id_to_phi(emc_id: IntLike) -> IntLike:
    """
    Convert the EMC digi ID to the phi number.

    Parameters:
        emc_id: The EMC digi ID array or value.

    Returns:
        The phi number.
    """
    return (emc_id & DIGI_EMC_PHI_MASK) >> DIGI_EMC_PHI_OFFSET

get_emc_id(module, theta, phi)

Generate EMC digi ID based on the module number, theta number, and phi number.

Parameters:

Name Type Description Default
module IntLike

The module number.

 required
theta IntLike

The theta number.

 required
phi IntLike

The phi number.

 required

Returns:

Type Description
IntLike

The EMC digi ID.
Source code in src/pybes3/identifier.py 
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
@nb.vectorize(cache=True)
def get_emc_id(module: IntLike, theta: IntLike, phi: IntLike) -> IntLike:
    """
    Generate EMC digi ID based on the module number, theta number, and phi number.

    Parameters:
        module: The module number.
        theta: The theta number.
        phi: The phi number.

    Returns:
        The EMC digi ID.
    """
    return np.uint32(
        ((module << DIGI_EMC_MODULE_OFFSET) & DIGI_EMC_MODULE_MASK)
        | ((theta << DIGI_EMC_THETA_OFFSET) & DIGI_EMC_THETA_MASK)
        | ((phi << DIGI_EMC_PHI_OFFSET) & DIGI_EMC_PHI_MASK)
        | (DIGI_EMC_FLAG << DIGI_FLAG_OFFSET)
    )

MUC

check_muc_id(muc_id)

Check if the MUC digi ID is valid.

Parameters:

Name Type Description Default
muc_id IntLike

The MUC digi ID array or value.

 required

Returns:

Type Description
BoolLike

Whether the digi ID is valid.
Source code in src/pybes3/identifier.py 
773
774
775
776
777
778
779
780
781
782
783
784
@nb.vectorize(cache=True)
def check_muc_id(muc_id: IntLike) -> BoolLike:
    """
    Check if the MUC digi ID is valid.

    Parameters:
        muc_id: The MUC digi ID array or value.

    Returns:
        Whether the digi ID is valid.
    """
    return (muc_id & DIGI_FLAG_MASK) >> DIGI_FLAG_OFFSET == DIGI_MUC_FLAG

muc_id_to_part(muc_id)

Convert MUC digi ID to part number

Parameters:

Name Type Description Default
muc_id IntLike

MUC digi ID array or value.

 required

Returns:

Type Description
IntLike

The part number.
Source code in src/pybes3/identifier.py 
787
788
789
790
791
792
793
794
795
796
797
798
@nb.vectorize(cache=True)
def muc_id_to_part(muc_id: IntLike) -> IntLike:
    """
    Convert MUC digi ID to part number

    Parameters:
        muc_id: MUC digi ID array or value.

    Returns:
        The part number.
    """
    return (muc_id & DIGI_MUC_PART_MASK) >> DIGI_MUC_PART_OFFSET

muc_id_to_segment(muc_id)

Convert the MUC digi ID to the segment number.

Parameters:

Name Type Description Default
muc_id IntLike

The MUC digi ID array or value.

 required

Returns:

Type Description
IntLike

The segment number.
Source code in src/pybes3/identifier.py 
801
802
803
804
805
806
807
808
809
810
811
812
@nb.vectorize(cache=True)
def muc_id_to_segment(muc_id: IntLike) -> IntLike:
    """
    Convert the MUC digi ID to the segment number.

    Parameters:
        muc_id: The MUC digi ID array or value.

    Returns:
        The segment number.
    """
    return (muc_id & DIGI_MUC_SEGMENT_MASK) >> DIGI_MUC_SEGMENT_OFFSET

muc_id_to_layer(muc_id)

Convert the MUC digi ID to the layer number.

Parameters:

Name Type Description Default
muc_id IntLike

The MUC digi ID array or value.

 required

Returns:

Type Description
IntLike

The layer number.
Source code in src/pybes3/identifier.py 
815
816
817
818
819
820
821
822
823
824
825
826
@nb.vectorize(cache=True)
def muc_id_to_layer(muc_id: IntLike) -> IntLike:
    """
    Convert the MUC digi ID to the layer number.

    Parameters:
        muc_id: The MUC digi ID array or value.

    Returns:
        The layer number.
    """
    return (muc_id & DIGI_MUC_LAYER_MASK) >> DIGI_MUC_LAYER_OFFSET

muc_id_to_channel(muc_id)

Convert the MUC digi ID to the channel number.

Parameters:

Name Type Description Default
muc_id IntLike

The MUC digi ID array or value.

 required

Returns:

Type Description
IntLike

The channel number.
Source code in src/pybes3/identifier.py 
829
830
831
832
833
834
835
836
837
838
839
840
@nb.vectorize(cache=True)
def muc_id_to_channel(muc_id: IntLike) -> IntLike:
    """
    Convert the MUC digi ID to the channel number.

    Parameters:
        muc_id: The MUC digi ID array or value.

    Returns:
        The channel number.
    """
    return (muc_id & DIGI_MUC_CHANNEL_MASK) >> DIGI_MUC_CHANNEL_OFFSET

get_muc_id(part, segment, layer, channel)

Generate MUC digi ID based on the part number, segment number, layer number, and channel number.

Parameters:

Name Type Description Default
part IntLike

The part number.

 required
segment IntLike

The segment number.

 required
layer IntLike

The layer number.

 required
channel IntLike

The channel number.

 required

Returns:

Type Description
IntLike

The MUC digi ID.
Source code in src/pybes3/identifier.py 
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
@nb.vectorize(cache=True)
def get_muc_id(part: IntLike, segment: IntLike, layer: IntLike, channel: IntLike) -> IntLike:
    """
    Generate MUC digi ID based on the part number, segment number, layer number, and channel number.

    Parameters:
        part: The part number.
        segment: The segment number.
        layer: The layer number.
        channel: The channel number.

    Returns:
        The MUC digi ID.
    """
    return np.uint32(
        ((part << DIGI_MUC_PART_OFFSET) & DIGI_MUC_PART_MASK)
        | ((segment << DIGI_MUC_SEGMENT_OFFSET) & DIGI_MUC_SEGMENT_MASK)
        | ((layer << DIGI_MUC_LAYER_OFFSET) & DIGI_MUC_LAYER_MASK)
        | ((channel << DIGI_MUC_CHANNEL_OFFSET) & DIGI_MUC_CHANNEL_MASK)
        | (DIGI_MUC_FLAG << DIGI_FLAG_OFFSET)
    )

muc_id_to_gap(muc_id)

Convert the MUC digi ID to the gap ID, which is equivalent to layer number.

Parameters:

Name Type Description Default
muc_id IntLike

The MUC digi ID array or value.

 required

Returns:

Type Description
IntLike

The gap ID.
Source code in src/pybes3/identifier.py 
866
867
868
869
870
871
872
873
874
875
876
def muc_id_to_gap(muc_id: IntLike) -> IntLike:
    """
    Convert the MUC digi ID to the gap ID, which is equivalent to layer number.

    Parameters:
        muc_id: The MUC digi ID array or value.

    Returns:
        The gap ID.
    """
    return muc_id_to_layer(muc_id)

muc_id_to_strip(muc_id)

Convert the MUC digi ID to the strip number, which is equivalent to channel number.

Parameters:

Name Type Description Default
muc_id IntLike

The MUC digi ID array or value.

 required

Returns:

Type Description
IntLike

The strip number.
Source code in src/pybes3/identifier.py 
879
880
881
882
883
884
885
886
887
888
889
def muc_id_to_strip(muc_id: IntLike) -> IntLike:
    """
    Convert the MUC digi ID to the strip number, which is equivalent to channel number.

    Parameters:
        muc_id: The MUC digi ID array or value.

    Returns:
        The strip number.
    """
    return muc_id_to_channel(muc_id)

CGEM

check_cgem_id(cgem_id)

Check if the CGEM digi ID is valid.

Parameters:

Name Type Description Default
cgem_id IntLike

The CGEM digi ID array or value.

 required

Returns:

Type Description
BoolLike

Whether the digi ID is valid.
Source code in src/pybes3/identifier.py 
936
937
938
939
940
941
942
943
944
945
946
947
@nb.vectorize(cache=True)
def check_cgem_id(cgem_id: IntLike) -> BoolLike:
    """
    Check if the CGEM digi ID is valid.

    Parameters:
        cgem_id: The CGEM digi ID array or value.

    Returns:
        Whether the digi ID is valid.
    """
    return (cgem_id & DIGI_FLAG_MASK) >> DIGI_FLAG_OFFSET == DIGI_CGEM_FLAG

cgem_id_to_gid(cgem_id)

Convert CGEM digi ID to global strip ID (gid).

Parameters:

Name Type Description Default
cgem_id IntLike

The CGEM digi ID array or value.

 required

Returns:

Type Description
IntLike

The global strip ID.
Source code in src/pybes3/identifier.py 
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
def cgem_id_to_gid(cgem_id: IntLike) -> IntLike:
    """
    Convert CGEM digi ID to global strip ID (gid).

    Parameters:
        cgem_id: The CGEM digi ID array or value.

    Returns:
        The global strip ID.
    """
    return det.get_cgem_gid(
        cgem_id_to_layer(cgem_id),
        cgem_id_to_sheet(cgem_id),
        cgem_id_to_strip_type(cgem_id),
        cgem_id_to_strip(cgem_id),
    )

cgem_id_to_layer(cgem_id)

Convert the CGEM digi ID to the layer number.

Parameters:

Name Type Description Default
cgem_id IntLike

The CGEM digi ID array or value.

 required

Returns:

Type Description
IntLike

The layer number.
Source code in src/pybes3/identifier.py 
950
951
952
953
954
955
956
957
958
959
960
961
@nb.vectorize(cache=True)
def cgem_id_to_layer(cgem_id: IntLike) -> IntLike:
    """
    Convert the CGEM digi ID to the layer number.

    Parameters:
        cgem_id: The CGEM digi ID array or value.

    Returns:
        The layer number.
    """
    return (cgem_id & DIGI_CGEM_LAYER_MASK) >> DIGI_CGEM_LAYER_OFFSET

cgem_id_to_sheet(cgem_id)

Convert the CGEM digi ID to the sheet number.

Parameters:

Name Type Description Default
cgem_id IntLike

The CGEM digi ID array or value.

 required

Returns:

Type Description
IntLike

The sheet number.
Source code in src/pybes3/identifier.py 
964
965
966
967
968
969
970
971
972
973
974
975
@nb.vectorize(cache=True)
def cgem_id_to_sheet(cgem_id: IntLike) -> IntLike:
    """
    Convert the CGEM digi ID to the sheet number.

    Parameters:
        cgem_id: The CGEM digi ID array or value.

    Returns:
        The sheet number.
    """
    return (cgem_id & DIGI_CGEM_SHEET_MASK) >> DIGI_CGEM_SHEET_OFFSET

cgem_id_to_strip_type(cgem_id)

Convert the CGEM digi ID to the strip type. 0 for X-strip, 1 for V-strip.

Parameters:

Name Type Description Default
cgem_id IntLike

The CGEM digi ID array or value.

 required

Returns:

Type Description
IntLike

The strip type. 0 for X-strip, 1 for V-strip.
Source code in src/pybes3/identifier.py 
978
979
980
981
982
983
984
985
986
987
988
989
@nb.vectorize(cache=True)
def cgem_id_to_strip_type(cgem_id: IntLike) -> IntLike:
    """
    Convert the CGEM digi ID to the strip type. 0 for X-strip, 1 for V-strip.

    Parameters:
        cgem_id: The CGEM digi ID array or value.

    Returns:
        The strip type. 0 for X-strip, 1 for V-strip.
    """
    return (cgem_id & DIGI_CGEM_STRIPTYPE_MASK) >> DIGI_CGEM_STRIPTYPE_OFFSET

cgem_id_to_strip(cgem_id)

Convert CGEM digi ID to strip number

Parameters:

Name Type Description Default
cgem_id IntLike

CGEM digi ID array or value.

 required

Returns:

Type Description
IntLike

The strip number.
Source code in src/pybes3/identifier.py 
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
@nb.vectorize(cache=True)
def cgem_id_to_strip(cgem_id: IntLike) -> IntLike:
    """
    Convert CGEM digi ID to strip number

    Parameters:
        cgem_id: CGEM digi ID array or value.

    Returns:
        The strip number.
    """
    return np.uint16((cgem_id & DIGI_CGEM_STRIP_MASK) >> DIGI_CGEM_STRIP_OFFSET)

get_cgem_id(layer, sheet, strip_type, strip)

Generate CGEM digi ID based on the strip number, strip type, sheet number, and layer number.

Parameters:

Name Type Description Default
layer IntLike

The layer number.

 required
sheet IntLike

The sheet number.

 required
strip_type IntLike

The strip type. 0 for X-strip, 1 for V-strip.

 required
strip IntLike

The strip number.

 required

Returns:

Type Description
IntLike

The CGEM digi ID.
Source code in src/pybes3/identifier.py 
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
@nb.vectorize(cache=True)
def get_cgem_id(
    layer: IntLike, sheet: IntLike, strip_type: IntLike, strip: IntLike
) -> IntLike:
    """
    Generate CGEM digi ID based on the strip number, strip type, sheet number, and layer number.

    Parameters:
        layer: The layer number.
        sheet: The sheet number.
        strip_type: The strip type. 0 for X-strip, 1 for V-strip.
        strip: The strip number.

    Returns:
        The CGEM digi ID.
    """
    return np.uint32(
        ((strip << DIGI_CGEM_STRIP_OFFSET) & DIGI_CGEM_STRIP_MASK)
        | ((strip_type << DIGI_CGEM_STRIPTYPE_OFFSET) & DIGI_CGEM_STRIPTYPE_MASK)
        | ((sheet << DIGI_CGEM_SHEET_OFFSET) & DIGI_CGEM_SHEET_MASK)
        | ((layer << DIGI_CGEM_LAYER_OFFSET) & DIGI_CGEM_LAYER_MASK)
        | ((DIGI_CGEM_FLAG << DIGI_FLAG_OFFSET) & 0xFF000000)
    )