Struct SpotDetector 

pub struct SpotDetector { /* private fields */ }

Main SPOT detector for streaming anomaly detection

The SpotDetector implements the SPOT (Streaming Peaks Over Threshold) algorithm for real-time anomaly detection in streaming time series data.

Serialization

When the serde feature is enabled, the detector can be serialized and deserialized, allowing you to save trained models and restore them later without re-training.

Example

use libspot_rs::{SpotConfig, SpotDetector, SpotStatus};

let config = SpotConfig::default();
let mut spot = SpotDetector::new(config).unwrap();

// Fit with training data
let data: Vec<f64> = (0..1000).map(|i| (i as f64) / 100.0).collect();
spot.fit(&data).unwrap();

// Process new data points
match spot.step(15.0).unwrap() {
    SpotStatus::Normal => println!("Normal"),
    SpotStatus::Excess => println!("Excess"),
    SpotStatus::Anomaly => println!("Anomaly detected!"),
}

Implementations

impl SpotDetector

pub fn new(config: SpotConfig) -> SpotResult<Self>

Create a new SPOT detector with the given configuration

pub fn fit(&mut self, data: &[f64]) -> SpotResult<()>

Fit the model using initial training data

pub fn step(&mut self, value: f64) -> SpotResult<SpotStatus>

Process a single data point and return its classification

pub fn quantile(&self, q: f64) -> f64

Get the quantile for a given probability

pub fn probability(&self, z: f64) -> f64

Get the probability for a given value

pub fn anomaly_threshold(&self) -> f64

Get the current anomaly threshold

pub fn excess_threshold(&self) -> f64

Get the current excess threshold

pub fn config(&self) -> Option<SpotConfig>

Get the current configuration (reconstructed)

pub fn n(&self) -> usize

Get the total number of data points seen

pub fn nt(&self) -> usize

Get the total number of excesses

pub fn tail_parameters(&self) -> (f64, f64)

Get the current tail parameters

pub fn tail_size(&self) -> usize

Get the current size of the tail data

pub fn peaks_min(&self) -> f64

Get the minimum value in the peaks

pub fn peaks_max(&self) -> f64

Get the maximum value in the peaks

pub fn peaks_mean(&self) -> f64

Get the mean of the peaks

pub fn peaks_variance(&self) -> f64

Get the variance of the peaks

pub fn peaks_data(&self) -> Vec<f64>

Get the peaks data as a vector (for debugging and export)

Trait Implementations

impl Debug for SpotDetector

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpotDetector

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SpotDetector

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.