Struct Spike Sequence &nbsp; Copy item path

impl SpikeSequence

pub fn new() -> Self

Create a new empty spike sequence

pub fn from_events(events: Vec<SpikeEvent>) -> Self

Create a spike sequence from a vector of events

§Arguments

events - Vector of spike events

§Returns

A new SpikeSequence containing the events

pub fn add_event(&mut self, event: SpikeEvent)

Add a spike event to the sequence

§Arguments

event - Spike event to add

pub fn events(&self) -> &[SpikeEvent]

Get all spike events

pub fn len(&self) -> usize

Get the number of spike events

pub fn is_empty(&self) -> bool

Check if the sequence is empty

pub fn sort_by_time(&mut self)

Sort events by timestamp

pub fn events_in_window( &self, start_time: f64, end_time: f64, ) -> Vec<&SpikeEvent>

Get events within a time window

§Arguments

start_time - Start of time window
end_time - End of time window

§Returns

Vector of spike events within the time window

pub fn events_from_neuron(&self, neuron_id: usize) -> Vec<&SpikeEvent>

Get events from a specific neuron

§Arguments

neuron_id - ID of the neuron

§Returns

Vector of spike events from the specified neuron

pub fn firing_rate(&self, neuron_id: usize, time_window: f64) -> f64

Calculate average firing rate for a neuron

§Arguments

neuron_id - ID of the neuron
time_window - Duration of the time window

§Returns

Average firing rate in spikes per time unit

pub fn time_span(&self) -> Option<(f64, f64)>

Get the time span of the sequence

§Returns

Tuple of (earliest_time, latest_time), or None if sequence is empty

Trait Implementations§

impl Clone for SpikeSequence

fn clone(&self) -> SpikeSequence

Returns a duplicate of the value. Read more

1.0.0§

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

Performs copy-assignment from source. Read more

impl Debug for SpikeSequence

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

Formats the value using the given formatter. Read more

impl Default for SpikeSequence

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl UnwindSafe for SpikeSequence

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more