Struct Tpx3FileReader 

pub struct Tpx3FileReader { /* private fields */ }

A TPX3 file reader with memory-mapped I/O.

Implementations

impl Tpx3FileReader

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Opens a TPX3 file for reading with default configuration.

Errors

Returns an error if the file cannot be opened or memory-mapped.

pub fn with_config(self, config: DetectorConfig) -> Self

Sets the detector configuration.

pub fn file_size(&self) -> usize

Returns the file size in bytes.

pub fn packet_count(&self) -> usize

Returns the number of 8-byte packets in the file.

pub fn read_batch(&self) -> Result<HitBatch>

Reads and parses all hits from the file into a HitBatch (SoA).

This uses the pulse-based time-ordered stream to ensure correct temporal ordering across pulses and chips.

Errors

Returns an error if the file size is invalid or the data cannot be parsed.

pub fn read_batch_time_ordered(&self) -> Result<HitBatch>

Reads hits using the efficient time-ordered stream.

This uses a pulse-based K-way merge to produce time-ordered hits without loading the entire file or performing a global sort.

This is functionally equivalent to read_batch() and is retained for clarity.

Errors

Returns an error if the file size is invalid.

pub fn stream_time_ordered(&self) -> Result<TimeOrderedHitStream>

Returns a time-ordered stream of hit batches (pulse-merged).

Errors

Returns an error if the file size is invalid.

pub fn stream_time_ordered_events(&self) -> Result<TimeOrderedEventStream>

Returns a time-ordered stream of event batches (pulse-merged with TDC).

Errors

Returns an error if the file size is invalid.

pub fn iter_packets(&self) -> impl Iterator<Item = Tpx3Packet> + '_

Returns an iterator over raw packets.

Panics

Panics if a chunk is not exactly 8 bytes. This should be unreachable because chunks_exact(8) guarantees each chunk length.