Struct TofEventSummary

pub struct TofEventSummary {

    pub status: EventStatus,
    pub version: ProtocolVersion,
    pub quality: u8,
    pub trigger_sources: u16,
    pub n_trigger_paddles: u8,
    pub event_id: u32,
    pub run_id: u16,
    pub timestamp32: u32,
    pub timestamp16: u16,
    pub primary_beta: u16,
    pub primary_charge: u16,
    pub drs_dead_lost_hits: u16,
    pub dsi_j_mask: u32,
    pub channel_mask: Vec<u16>,
    pub mtb_link_mask: u64,
    pub hits: Vec<TofHit>,
    pub n_hits_umb: u8,
    pub n_hits_cbe: u8,
    pub n_hits_cor: u8,
    pub tot_edep_umb: f32,
    pub tot_edep_cbe: f32,
    pub tot_edep_cor: f32,
}

De-facto the main event class

TofEventSummary provides a list of extracted hits from the ReadoutBoards as well as information about the trigger system.

Fields

status: EventStatus

version: ProtocolVersion

quality: u8

trigger_sources: u16

n_trigger_paddles: u8

the number of triggered paddles coming from the MTB directly. This might NOT be the same as the number of hits!

event_id: u32

run_id: u16

NEW - uses the space for primary_beta, which we won’t have anyway

timestamp32: u32

timestamp16: u16

primary_beta: u16

DEPRECATED, won’t get serialized reconstructed primary beta

primary_charge: u16

DEPRECATED, won’t get serialized reconstructed primary charge

drs_dead_lost_hits: u16

scalar number of hits missed in this event due to DRS on the RB being busy

dsi_j_mask: u32

channel_mask: Vec<u16>

mtb_link_mask: u64

hits: Vec<TofHit>

n_hits_umb: u8

n_hits_cbe: u8

n_hits_cor: u8

tot_edep_umb: f32

tot_edep_cbe: f32

tot_edep_cor: f32

Implementations

impl TofEventSummary

pub fn new() -> Self

pub fn get_missing_paddles_hg(&self, pid_map: &DsiJChPidMapping) -> Vec<u8>

Compare the MasterTriggerEvent::trigger_hits with the actual hits to determine from which paddles we should have received HG hits (from waveforms) but we did not get them

WARNING: The current implementation of this is rather slow and not fit for production use FIXME - rewrite as a closure

pub fn get_triggered_paddles(&self, pid_map: DsiJChPidMapping) -> Vec<u8>

Get the triggered paddle ids

Warning, this might be a bit slow

pub fn get_rb_link_ids(&self) -> Vec<u8>

Get the RB link IDs according to the mask

pub fn get_trigger_hits(&self) -> Vec<(u8, u8, (u8, u8), LTBThreshold)>

Get the combination of triggered DSI/J/CH on the MTB which formed the trigger. This does not include further hits which fall into the integration window. For those, se rb_link_mask

The returned values follow the TOF convention to start with 1, so that we can use them to look up LTB ids in the db.

Returns

Vec<(hit)> where hit is (DSI, J, CH)

pub fn get_trigger_sources(&self) -> Vec<TriggerType>

Get the trigger sources from trigger source byte

pub fn get_timestamp48(&self) -> u64

pub fn get_edep_umbrella(&self) -> f32

Ttotal energy depostion in the TOF - Umbrella

Utilizes Philip’s formula based on peak height

pub fn get_edep_cube(&self) -> f32

Ttotal energy depostion in the TOF - Umbrella

Utilizes Philip’s formula based on peak height

pub fn get_edep_cortina(&self) -> f32

Ttotal energy depostion in the Cortina

Utilizes Philip’s formula based on peak height

pub fn get_edep(&self) -> f32

Ttotal energy depostion in the complete TOF

Utilizes Philip’s formula based on peak height

Trait Implementations

impl Clone for TofEventSummary

fn clone(&self) -> TofEventSummary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TofEventSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TofEventSummary

fn default() -> Self

Returns the “default value” for a type.

impl Display for TofEventSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&TofEventSummary> for MasterTriggerEvent

fn from(tes: &TofEventSummary) -> Self

Converts to this type from the input type.

impl From<&TofEventSummary> for TofPacket

fn from(tsum: &TofEventSummary) -> Self

Converts to this type from the input type.

impl FromRandom for TofEventSummary

fn from_random() -> Self

impl Packable for TofEventSummary

const PACKET_TYPE: PacketType = PacketType::TofEventSummary

fn pack(&self) -> TofPacket

where Self: Serialization,

Wrap myself in a TofPacket

impl PartialEq for TofEventSummary

fn eq(&self, other: &TofEventSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialization for TofEventSummary

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

fn to_bytestream(&self) -> Vec<u8>

Encode a serializable to a bytestream

fn from_bytestream( stream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>

Decode a serializable from a bytestream

const SIZE: usize = 0usize

The SIZE is the size of the serialized bytestream INCLUDING 4 bytes for head and tail bytes. In case the struct does NOT HAVE a fixed size, SIZE will be 0 (so default value of the trait

fn verify_fixed( stream: &Vec<u8>, pos: &mut usize, ) -> Result<(), SerializationError>

Verify that the serialized representation of the struct has the correct size, including header + footer.

fn from_tofpacket(packet: &TofPacket) -> Result<Self, SerializationError>

where Self: Sized,

Decode a serializable directly from a TofPacket

fn from_slice( _slice: &[u8], _start_pos: usize, ) -> Result<Self, SerializationError>

where Self: Sized,

fn to_slice(&self) -> &[u8]

where Self: Sized,

Construct byte slice out of self.

impl StructuralPartialEq for TofEventSummary