Struct TofEvent

pub struct TofEvent {
    pub compression_level: CompressionLevel,
    pub quality: EventQuality,
    pub header: TofEventHeader,
    pub mt_event: MasterTriggerEvent,
    pub rb_events: Vec<RBEvent>,
    pub creation_time: Instant,
    pub write_to_disk: bool,
    pub paddles_set: bool,
}

Fields

compression_level: CompressionLevel

quality: EventQuality

header: TofEventHeader

mt_event: MasterTriggerEvent

rb_events: Vec<RBEvent>

creation_time: Instant

write_to_disk: bool

paddles_set: bool

Implementations

impl TofEvent

pub fn new() -> Self

pub fn set_paddles(&mut self, paddles: &HashMap<u8, Paddle>)

pub fn get_pointcloud(&self) -> Option<Vec<(f32, f32, f32, f32, f32)>>

Get the pointcloud of this event, sorted by time

Returns

(f32, f32, f32, f32, f32) : (x,y,z,t,edep)

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_extra_paddles_hg(&self, pid_map: &DsiJChPidMapping) -> Vec<u8>

Compare the MasterTriggerEvent::trigger_hits with the actual hits to determine from which paddles we have received more hits than we were supposed to. These hits are neither in the trigger hits nor rb_link_ids

FIXME - this can be hits which are exclusively within the RB integration window

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

Compare the MasterTriggerEvent::trigger_hits with the actual recorded waveforms to determine from which paddles we should have received waveforms from. This is independent of the hits, which additionally required that the hit extraction algorithm worked.

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 extract_event_id_from_stream( stream: &Vec<u8>, ) -> Result<u32, SerializationError>

pub fn age(&self) -> u64

pub fn is_complete(&self) -> bool

Simple check if the event contains as much RBEvents as expected from the provided boards masks by the MTB

pub fn is_complete_masked(&self, mtb_link_ids_excluded: &Vec<u8>) -> bool

A more advanced check, where events which are not in the provided mtb_link_id list don’t count for completion

pub fn construct_sizes_header(&self) -> u32

Encode the sizes of the vectors holding the into an u32

We have one byte (256) max length per vector.

pub fn decode_size_header(mask: &u32) -> (usize, usize)

pub fn get_combined_vector_sizes(&self) -> usize

pub fn get_rbwaveforms(&self) -> Vec<RBWaveform>

Get all waveforms of all RBEvents in this event

pub fn get_waveforms(&self) -> Vec<RBWaveform>

Get all waveforms of all RBEvents in this event ISSUE - Performance, Memory FIXME - reimplement this things where this returns only a reference

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

Get all the paddles which have waveforms

pub fn get_hits(&self) -> Vec<TofHit>

Get all hits of all RBEvents in this event

pub fn has_any_mangling(&self) -> bool

Check if th eassociated RBEvents have any of their mangling stati set

pub fn get_summary(&self) -> TofEventSummary

pub fn get_lost_hits(&self) -> u16

The number of hits we did not get becaue of the DRS busy

pub fn get_nhits_umb(&self) -> usize

pub fn get_nhits(&self) -> usize

Trait Implementations

impl Clone for TofEvent

fn clone(&self) -> TofEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TofEvent

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

Formats the value using the given formatter.

impl Default for TofEvent

fn default() -> Self

Returns the “default value” for a type.

impl Display for TofEvent

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

Formats the value using the given formatter.

impl From<&TofEvent> for TofPacket

fn from(event: &TofEvent) -> Self

Converts to this type from the input type.

impl From<&mut TofEvent> for TofPacket

fn from(event: &mut TofEvent) -> Self

Converts to this type from the input type.

impl From<MasterTriggerEvent> for TofEvent

fn from(mte: MasterTriggerEvent) -> Self

Converts to this type from the input type.

impl FromRandom for TofEvent

fn from_random() -> Self

impl Packable for TofEvent

const PACKET_TYPE: PacketType = PacketType::TofEvent

fn pack(&self) -> TofPacket

where Self: Serialization,

Wrap myself in a TofPacket

impl Serialization for TofEvent

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.