Struct HaloWindow 

pub struct HaloWindow {
    pub index: usize,
    pub valid_global: Range<u64>,
    pub read_global: Range<u64>,
    pub valid_local: Range<usize>,
}

A single halo-padded window in a chunked streaming schedule.

Fields

index: usize

0-based window index in the schedule.

valid_global: Range<u64>

Non-overlapping global sample range [s0 .. s1) owned by this window.

read_global: Range<u64>

Halo-padded global sample range [read_start .. read_end) to read from RecordingSource.

valid_local: Range<usize>

Interior slice range [left_pad .. left_pad + valid_len) within the padded buffer.

Implementations

impl HaloWindow

pub fn read_len(&self) -> usize

Total number of samples in the padded read buffer (read_global).

pub fn valid_len(&self) -> usize

Number of valid interior samples (valid_global).

pub fn is_interior_local(&self, local_sample: usize) -> bool

Returns true if a local sample index (relative to the padded buffer) lies inside the valid interior owned by this window.

pub fn to_global_sample(&self, local_sample: usize) -> u64

Converts a local sample index (relative to the padded buffer) to a global recording sample index.

pub fn remap_event(&self, local_sample: usize) -> Option<u64>

Global sample of a local event (e.g. a spike found in the padded buffer) if this window owns it (it lies in the valid interior), None if it belongs to a neighbouring window.

pub fn around( index: usize, valid: Range<u64>, left_halo: u64, right_halo: u64, total_samples: u64, ) -> Self

The window owning valid (clamped to [0 .. total_samples)), read with left_halo and right_halo samples of context, also clamped to the recording.

Trait Implementations

impl Clone for HaloWindow

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HaloWindow

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

Formats the value using the given formatter.

impl Eq for HaloWindow

impl PartialEq for HaloWindow

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HaloWindow