axon-encoder 0.4.0

Flexible sensory encoding pipelines for spiking neural networks — rate, temporal, predictive, population, and neuromodulator-driven encoding for telemetry and cyber-physical data.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! Delta Encoding Example
//!
//! Demonstrates delta-based spike encoding. A spike fires when the absolute
//! difference between the current and last-encoded value exceeds a threshold.
//! Polarity indicates the direction of change (true = increase, false = decrease).
//!
//! ```
//! cargo run --example delta_encoding
//! ```

use axon_encoder::prelude::*;

fn main() {
    // Create a delta encoder:
    //   threshold    = 3.0  (minimum change magnitude to trigger a spike)
    //   num_channels = 2
    let mut encoder = DeltaEncoder::try_new(3.0, 2).expect("valid DeltaEncoder");

    // Simulated two-channel time series with occasional large jumps.
    let readings: Vec<[f32; 2]> = vec![
        [0.0, 10.0],
        [1.0, 10.5], // Small changes — no spikes
        [5.0, 10.2], // Channel 0 jumps +5.0 from last encoded (0.0)
        [5.5, 10.0], // Small change from 5.0
        [1.0, 20.0], // Channel 0 drops -4.5 from 5.0; channel 1 jumps +10.0
        [1.5, 20.5], // Small changes
    ];

    println!("=== Delta Encoding ===");
    println!("Threshold: 3.0\n");

    for (step, input) in readings.iter().enumerate() {
        let output = encoder.encode(input);
        if output.spikes.is_empty() {
            println!("Step {}: input {:?} -> no spikes", step, input);
        } else {
            for spike in &output.spikes {
                let direction = if spike.polarity { "↑" } else { "↓" };
                println!(
                    "Step {}: input {:?} -> SPIKE on channel {} {}",
                    step, input, spike.channel, direction
                );
            }
        }
    }

    // Also demonstrate the utility function for raw delta arrays.
    println!("\n--- encode_deltas_to_spikes utility ---");
    let deltas = [0.1, -0.5, 3.2, -4.0, 0.8];
    let threshold = 1.0;
    let spikes = encode_deltas_to_spikes(&deltas, threshold);
    println!("Deltas:    {:?}", deltas);
    println!("Threshold: {}", threshold);
    println!("Spikes:    {:?}", spikes);
}