Struct TelemetryEvent 

pub struct TelemetryEvent {

    pub header: TelemetryPacketHeader,
    pub creation_time: u64,
    pub event_id: u32,
    pub tracker_hits: Vec<TrackerHit>,
    pub tracker_oscillators: Vec<u64>,
    pub tof_event: TofEvent,
    pub raw_data: Vec<u8>,
    pub flags0: u8,
    pub flags1: u8,
    pub version: u8,
    pub osc_flags: u8,
    pub oscillator_idx: Vec<u8>,
    pub expected_tr_hits: u8,
}

The basic event type as sent over telemetry, often also dubbed as “merged event”.

This event type contains tof as well as tracker hits, and comes in several flavors, depending on the suspected signalness of the online system determined by a specific algorith. For that, please see the TelemetryPacketHeader, which identifiers these different flavors.

For most purposes, this event is the to-go data to start any analysis.

Fields

header: TelemetryPacketHeader

creation_time: u64

event_id: u32

tracker_hits: Vec<TrackerHit>

tracker_oscillators: Vec<u64>

tof_event: TofEvent

raw_data: Vec<u8>

flags0: u8

flags1: u8

version: u8

osc_flags: u8

oscillator_idx: Vec<u8>

expected_tr_hits: u8

Implementations

impl TelemetryEvent

pub fn new() -> Self

pub fn pack(&self) -> TelemetryPacket

Create a TelemetryPacket from the TelemetryEvent.

CAVEAT: Currently the checksum does not get re-evaluated

pub fn calibrate_trk_hits( &mut self, cali: &TrackerOfflineCalibration, ) -> Result<(), CalibrationError>

pub fn hydrate( &mut self, tof_paddles: &HashMap<u8, TofPaddle>, trk_strips: &HashMap<u32, TrackerStrip>, )

Restore position information from database

pub fn delete_all_tracker_hits(&mut self)

Delete tracker hits (e.g. in case they are supposed to be replaced by packet type 80 tracker hits)

pub fn add_tracker_hits(&mut self, hits: &Vec<TrackerHit>)

Add tracker hits (e.g. hits from packet type 80)

pub fn mask_strips(&mut self, masks: &HashMap<u32, TrackerStripMask>)

Trait Implementations

impl Clone for TelemetryEvent

fn clone(&self) -> TelemetryEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TelemetryEvent

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

Formats the value using the given formatter.

impl Display for TelemetryEvent

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

Formats the value using the given formatter.

impl FromRandom for TelemetryEvent

Available on crate feature random only.

fn from_random() -> Self

impl PartialEq for TelemetryEvent

fn eq(&self, other: &TelemetryEvent) -> 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 TelemetryEvent

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

Decode a serializable from a bytestream

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

Encode a serializable to a bytestream

const HEAD: u16 = 0xAAAA

Byte marker to mark beginning of payload

const TAIL: u16 = 0x5555

Byte marker to mark end of payload

const SIZE: usize = 0

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 guess_size( stream: &Vec<u8>, pos: usize, offset: usize, ) -> Result<(usize, usize, usize), SerializationError>

Guess the size of te packet. This can be a preformance issue if te offset position is far off

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_bytestream_alt( bytestream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>

where Self: Sized,

Decode a serializable from a bytestream. This provides an alternative method to get the packet. If not implemented, it will be the same as from_bytestream.

impl TelemetryPackable for TelemetryEvent

const TEL_PACKET_TYPE: TelemetryPacketType = TelemetryPacketType::Unknown

packet type for any kind of telemetry packet which is NOT an event

const TEL_PACKET_TYPES_EVENT: [TelemetryPacketType; 4] = _

TelemetryEvents can “occupy” several packet types, e.g. GapsTrigger, Boring, etc

impl StructuralPartialEq for TelemetryEvent