fast-canny 0.1.0

Industrial-grade Zero-Allocation SIMD Canny Edge Detector
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
// =====================================================================
// 补充测试用例 —— 追加到 tests/integration.rs 末尾
// =====================================================================

// =====================================================================
// canny_u8():u8 输入路径测试
// =====================================================================
#[cfg(test)]
mod canny_u8_tests {
    use fast_canny::{CannyConfig, CannyError, CannyWorkspace, canny_u8};

    fn init_logger() {
        let _ = env_logger::builder()
            .is_test(true)
            .filter_level(log::LevelFilter::Trace)
            .try_init();
    }

    fn make_workspace(w: usize, h: usize) -> CannyWorkspace {
        CannyWorkspace::new(w, h).expect("workspace creation should succeed")
    }

    // ── 正常路径 ──────────────────────────────────────────────────

    #[test]
    fn test_canny_u8_uniform_no_edges() {
        init_logger();
        let (w, h) = (64, 64);
        let mut ws = make_workspace(w, h);
        let cfg = CannyConfig::builder()
            .sigma(1.0)
            .thresholds(30.0, 90.0)
            .build()
            .unwrap();
        let src = vec![128u8; w * h];

        let edge_map = canny_u8(&src, &mut ws, &cfg).expect("canny_u8 should succeed");
        assert_eq!(edge_map.len(), w * h);
        let edge_count = edge_map.iter().filter(|&&v| v == 255).count();
        assert_eq!(edge_count, 0, "uniform u8 image should produce no edges");
        log::info!("[test] test_canny_u8_uniform_no_edges PASSED");
    }

    #[test]
    fn test_canny_u8_output_binary() {
        init_logger();
        let (w, h) = (32, 32);
        let mut ws = make_workspace(w, h);
        let cfg = CannyConfig::builder()
            .sigma(1.0)
            .thresholds(30.0, 90.0)
            .build()
            .unwrap();
        let src = vec![0u8; w * h];

        let edge_map = canny_u8(&src, &mut ws, &cfg).unwrap();
        for &v in edge_map {
            assert!(v == 0 || v == 255, "canny_u8 output must be binary, got {}", v);
        }
        log::info!("[test] test_canny_u8_output_binary PASSED");
    }

    #[test]
    fn test_canny_u8_step_image_has_edges() {
        init_logger();
        let (w, h) = (64, 64);
        let mut ws = make_workspace(w, h);
        let cfg = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(10.0, 30.0)
            .build()
            .unwrap();
        // 左半黑右半白的阶跃图像
        let src: Vec<u8> = (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0u8 } else { 255u8 })
            .collect();

        let edge_map = canny_u8(&src, &mut ws, &cfg).unwrap();
        let edge_count = edge_map.iter().filter(|&&v| v == 255).count();
        assert!(edge_count > 0, "u8 step image should produce edges");
        log::info!("[test] test_canny_u8_step_image_has_edges PASSED — edges={}", edge_count);
    }

    /// f32 和 u8 路径对同一图像应产生相同结果
    #[test]
    fn test_canny_u8_matches_f32_path() {
        init_logger();
        let (w, h) = (64, 64);
        let cfg = CannyConfig::builder()
            .sigma(0.0) // 跳过高斯,消除浮点精度差异
            .thresholds(10.0, 30.0)
            .build()
            .unwrap();

        let src_u8: Vec<u8> = (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0u8 } else { 255u8 })
            .collect();
        let src_f32: Vec<f32> = src_u8.iter().map(|&v| v as f32).collect();

        let mut ws_u8 = make_workspace(w, h);
        let mut ws_f32 = make_workspace(w, h);

        let edge_u8 = canny_u8(&src_u8, &mut ws_u8, &cfg).unwrap().to_vec();
        let edge_f32 = fast_canny::canny(&src_f32, &mut ws_f32, &cfg).unwrap().to_vec();

        assert_eq!(
            edge_u8, edge_f32,
            "canny_u8 and canny(f32) must produce identical results for same input"
        );
        log::info!("[test] test_canny_u8_matches_f32_path PASSED");
    }

    // ── 错误路径 ──────────────────────────────────────────────────

    #[test]
    fn test_canny_u8_length_mismatch() {
        init_logger();
        let (w, h) = (32, 32);
        let mut ws = make_workspace(w, h);
        let cfg = CannyConfig::builder()
            .sigma(1.0)
            .thresholds(30.0, 90.0)
            .build()
            .unwrap();
        let src = vec![0u8; w * h - 1];

        let err = canny_u8(&src, &mut ws, &cfg).unwrap_err();
        assert_eq!(
            err,
            CannyError::InputLengthMismatch { expected: w * h, actual: w * h - 1 }
        );
        log::info!("[test] test_canny_u8_length_mismatch PASSED");
    }

    #[test]
    fn test_canny_u8_invalid_thresholds() {
        init_logger();
        let (w, h) = (32, 32);
        let mut ws = make_workspace(w, h);
        let cfg = CannyConfig {
            sigma: 1.0,
            low_thresh: 200.0,
            high_thresh: 50.0,
        };
        let src = vec![0u8; w * h];

        let err = canny_u8(&src, &mut ws, &cfg).unwrap_err();
        assert_eq!(
            err,
            CannyError::InvalidThresholds { low: 200.0, high: 50.0 }
        );
        log::info!("[test] test_canny_u8_invalid_thresholds PASSED");
    }
}

// =====================================================================
// NMS 边界行为测试
// =====================================================================
#[cfg(test)]
mod nms_boundary_tests {
    use fast_canny::{CannyConfig, CannyWorkspace, canny};

    fn init_logger() {
        let _ = env_logger::builder()
            .is_test(true)
            .filter_level(log::LevelFilter::Trace)
            .try_init();
    }

    /// 边界像素(第 0/最后一行/列)在 hysteresis 后必须为 0
    #[test]
    fn test_boundary_pixels_always_zero() {
        init_logger();
        let (w, h) = (32, 32);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        let cfg = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(1.0, 10.0)
            .build()
            .unwrap();
        // 全白图像,梯度为 0,边界应全为 0
        let src = vec![255.0f32; w * h];
        let edge_map = canny(&src, &mut ws, &cfg).unwrap();

        // 检查四条边界
        for x in 0..w {
            assert_eq!(edge_map[x], 0, "top row pixel [{}] must be 0", x);
            assert_eq!(edge_map[(h - 1) * w + x], 0, "bottom row pixel [{}] must be 0", x);
        }
        for y in 0..h {
            assert_eq!(edge_map[y * w], 0, "left col pixel [{}] must be 0", y);
            assert_eq!(edge_map[y * w + w - 1], 0, "right col pixel [{}] must be 0", y);
        }
        log::info!("[test] test_boundary_pixels_always_zero PASSED");
    }

    /// 阶跃图像的边缘必须在内部区域(非边界)
    #[test]
    fn test_step_edges_not_on_boundary() {
        init_logger();
        let (w, h) = (64, 64);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        let cfg = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(10.0, 30.0)
            .build()
            .unwrap();
        let src: Vec<f32> = (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0.0 } else { 255.0 })
            .collect();

        let edge_map = canny(&src, &mut ws, &cfg).unwrap();

        // 边界行列必须为 0
        for x in 0..w {
            assert_eq!(edge_map[x], 0);
            assert_eq!(edge_map[(h - 1) * w + x], 0);
        }
        for y in 0..h {
            assert_eq!(edge_map[y * w], 0);
            assert_eq!(edge_map[y * w + w - 1], 0);
        }
        log::info!("[test] test_step_edges_not_on_boundary PASSED");
    }
}

// =====================================================================
// Hysteresis 连通性测试
// =====================================================================
#[cfg(test)]
mod hysteresis_tests {
    use fast_canny::{CannyConfig, CannyWorkspace, canny};

    fn init_logger() {
        let _ = env_logger::builder()
            .is_test(true)
            .filter_level(log::LevelFilter::Trace)
            .try_init();
    }

    /// 高阈值极高时,弱边缘应全部被丢弃(无强边缘种子)
    #[test]
    fn test_no_strong_seeds_yields_no_edges() {
        init_logger();
        let (w, h) = (64, 64);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        // low=1, high=极大值:所有像素都是弱边缘,没有强边缘种子
        let cfg = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(1.0, f32::MAX)
            .build()
            .unwrap();
        let src: Vec<f32> = (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0.0 } else { 255.0 })
            .collect();

        let edge_map = canny(&src, &mut ws, &cfg).unwrap();
        let edge_count = edge_map.iter().filter(|&&v| v == 255).count();
        assert_eq!(edge_count, 0, "no strong seeds should yield no edges");
        log::info!("[test] test_no_strong_seeds_yields_no_edges PASSED");
    }

    /// 输出中不应存在值为 127 的弱边缘(hysteresis 必须清除所有弱边缘)
    #[test]
    fn test_no_weak_edges_in_output() {
        init_logger();
        let (w, h) = (64, 64);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        let cfg = CannyConfig::builder()
            .sigma(1.0)
            .thresholds(20.0, 60.0)
            .build()
            .unwrap();
        let src: Vec<f32> = (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0.0 } else { 255.0 })
            .collect();

        let edge_map = canny(&src, &mut ws, &cfg).unwrap();
        let weak_count = edge_map.iter().filter(|&&v| v == 127).count();
        assert_eq!(weak_count, 0, "hysteresis must eliminate all weak edges (127)");
        log::info!("[test] test_no_weak_edges_in_output PASSED");
    }

    /// 低阈值 == 高阈值时,所有超过阈值的像素直接为强边缘,无弱边缘
    #[test]
    fn test_equal_thresholds_no_weak_edges() {
        init_logger();
        let (w, h) = (64, 64);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        let cfg = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(50.0, 50.0)
            .build()
            .unwrap();
        let src: Vec<f32> = (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0.0 } else { 255.0 })
            .collect();

        let edge_map = canny(&src, &mut ws, &cfg).unwrap();
        for &v in edge_map {
            assert!(v == 0 || v == 255, "equal thresholds: output must be binary, got {}", v);
        }
        log::info!("[test] test_equal_thresholds_no_weak_edges PASSED");
    }
}

// =====================================================================
// 多帧确定性测试
// =====================================================================
#[cfg(test)]
mod determinism_tests {
    use fast_canny::{CannyConfig, CannyWorkspace, canny};

    fn init_logger() {
        let _ = env_logger::builder()
            .is_test(true)
            .filter_level(log::LevelFilter::Trace)
            .try_init();
    }

    /// 同一输入多次调用必须产生完全相同的输出
    #[test]
    fn test_deterministic_output() {
        init_logger();
        let (w, h) = (64, 64);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        let cfg = CannyConfig::builder()
            .sigma(1.0)
            .thresholds(30.0, 90.0)
            .build()
            .unwrap();
        let src: Vec<f32> = (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0.0 } else { 255.0 })
            .collect();

        let result1 = canny(&src, &mut ws, &cfg).unwrap().to_vec();
        let result2 = canny(&src, &mut ws, &cfg).unwrap().to_vec();
        let result3 = canny(&src, &mut ws, &cfg).unwrap().to_vec();

        assert_eq!(result1, result2, "run 1 and 2 must be identical");
        assert_eq!(result2, result3, "run 2 and 3 must be identical");
        log::info!("[test] test_deterministic_output PASSED");
    }

    /// 不同输入交替调用,每次结果应与单独调用一致
    #[test]
    fn test_interleaved_inputs_deterministic() {
        init_logger();
        let (w, h) = (32, 32);
        let cfg = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(10.0, 30.0)
            .build()
            .unwrap();

        let src_a: Vec<f32> = (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0.0 } else { 255.0 })
            .collect();
        let src_b: Vec<f32> = vec![128.0f32; w * h];

        // 先单独获取参考结果
        let mut ws_ref = CannyWorkspace::new(w, h).unwrap();
        let ref_a = canny(&src_a, &mut ws_ref, &cfg).unwrap().to_vec();
        let ref_b = canny(&src_b, &mut ws_ref, &cfg).unwrap().to_vec();

        // 交替调用
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        for _ in 0..3 {
            let out_a = canny(&src_a, &mut ws, &cfg).unwrap().to_vec();
            let out_b = canny(&src_b, &mut ws, &cfg).unwrap().to_vec();
            assert_eq!(out_a, ref_a, "interleaved src_a must match reference");
            assert_eq!(out_b, ref_b, "interleaved src_b must match reference");
        }
        log::info!("[test] test_interleaved_inputs_deterministic PASSED");
    }
}

// =====================================================================
// 阈值边界行为测试
// =====================================================================
#[cfg(test)]
mod threshold_behavior_tests {
    use fast_canny::{CannyConfig, CannyWorkspace, canny};

    fn init_logger() {
        let _ = env_logger::builder()
            .is_test(true)
            .filter_level(log::LevelFilter::Trace)
            .try_init();
    }

    fn step_src(w: usize, h: usize) -> Vec<f32> {
        (0..w * h)
            .map(|i| if (i % w) < w / 2 { 0.0 } else { 255.0 })
            .collect()
    }

    /// 阈值越高,边缘数量应单调不增
    #[test]
    fn test_higher_threshold_fewer_or_equal_edges() {
        init_logger();
        let (w, h) = (64, 64);
        let src = step_src(w, h);

        let thresholds = [(5.0f32, 15.0f32), (20.0, 60.0), (50.0, 150.0), (100.0, 300.0)];
        let mut prev_count = usize::MAX;

        for (low, high) in thresholds {
            let mut ws = CannyWorkspace::new(w, h).unwrap();
            let cfg = CannyConfig::builder()
                .sigma(0.0)
                .thresholds(low, high)
                .build()
                .unwrap();
            let edge_map = canny(&src, &mut ws, &cfg).unwrap();
            let count = edge_map.iter().filter(|&&v| v == 255).count();
            assert!(
                count <= prev_count,
                "higher threshold should not increase edge count: prev={}, curr={} (low={}, high={})",
                prev_count, count, low, high
            );
            prev_count = count;
        }
        log::info!("[test] test_higher_threshold_fewer_or_equal_edges PASSED");
    }

    /// low_thresh=0 时,所有有梯度的像素都应被保留为候选
    #[test]
    fn test_zero_low_thresh_keeps_all_gradient_pixels() {
        init_logger();
        let (w, h) = (64, 64);
        let mut ws_zero = CannyWorkspace::new(w, h).unwrap();
        let mut ws_normal = CannyWorkspace::new(w, h).unwrap();
        let src = step_src(w, h);

        let cfg_zero = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(0.0, 1000.0)
            .build()
            .unwrap();
        let cfg_normal = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(50.0, 1000.0)
            .build()
            .unwrap();

        let count_zero = canny(&src, &mut ws_zero, &cfg_zero)
            .unwrap()
            .iter()
            .filter(|&&v| v == 255)
            .count();
        let count_normal = canny(&src, &mut ws_normal, &cfg_normal)
            .unwrap()
            .iter()
            .filter(|&&v| v == 255)
            .count();

        assert!(
            count_zero >= count_normal,
            "low_thresh=0 should produce >= edges than low_thresh=50: {} vs {}",
            count_zero, count_normal
        );
        log::info!(
            "[test] test_zero_low_thresh_keeps_all_gradient_pixels PASSED — zero={}, normal={}",
            count_zero, count_normal
        );
    }
}

// =====================================================================
// 特殊输入测试
// =====================================================================
#[cfg(test)]
mod special_input_tests {
    use fast_canny::{CannyConfig, CannyWorkspace, canny};

    fn init_logger() {
        let _ = env_logger::builder()
            .is_test(true)
            .filter_level(log::LevelFilter::Trace)
            .try_init();
    }

    /// 全零输入不应 panic,输出全为 0
    #[test]
    fn test_all_zero_input() {
        init_logger();
        let (w, h) = (32, 32);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        let cfg = CannyConfig::builder()
            .sigma(1.0)
            .thresholds(10.0, 30.0)
            .build()
            .unwrap();
        let src = vec![0.0f32; w * h];

        let edge_map = canny(&src, &mut ws, &cfg).unwrap();
        let edge_count = edge_map.iter().filter(|&&v| v == 255).count();
        assert_eq!(edge_count, 0, "all-zero input should produce no edges");
        log::info!("[test] test_all_zero_input PASSED");
    }

    /// 全最大值输入不应 panic,输出全为 0(无梯度)
    #[test]
    fn test_all_max_input() {
        init_logger();
        let (w, h) = (32, 32);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        let cfg = CannyConfig::builder()
            .sigma(1.0)
            .thresholds(10.0, 30.0)
            .build()
            .unwrap();
        let src = vec![255.0f32; w * h];

        let edge_map = canny(&src, &mut ws, &cfg).unwrap();
        let edge_count = edge_map.iter().filter(|&&v| v == 255).count();
        assert_eq!(edge_count, 0, "all-max input should produce no edges");
        log::info!("[test] test_all_max_input PASSED");
    }

    /// 单像素宽水平线:梯度集中在线的上下边缘
    #[test]
    fn test_horizontal_line_has_edges() {
        init_logger();
        let (w, h) = (64, 32);
        let mut ws = CannyWorkspace::new(w, h).unwrap();
        let cfg = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(10.0, 30.0)
            .build()
            .unwrap();

        // 中间一行为白,其余为黑
        let mid = h / 2;
        let src: Vec<f32> = (0..w * h)
            .map(|i| if i / w == mid { 255.0 } else { 0.0 })
            .collect();

        let edge_map = canny(&src, &mut ws, &cfg).unwrap();
        let edge_count = edge_map.iter().filter(|&&v| v == 255).count();
        assert!(edge_count > 0, "horizontal line should produce edges");
        log::info!("[test] test_horizontal_line_has_edges PASSED — edges={}", edge_count);
    }

    /// 棋盘格图像:边缘数量应随格子尺寸增大而减少
    #[test]
    fn test_checkerboard_edge_count_vs_cell_size() {
        init_logger();
        let (w, h) = (128, 128);
        let cfg = CannyConfig::builder()
            .sigma(0.0)
            .thresholds(10.0, 30.0)
            .build()
            .unwrap();

        let mut prev_count = usize::MAX;
        for cell in [4usize, 8, 16, 32] {
            let src: Vec<f32> = (0..w * h)
                .map(|i| {
                    let x = i % w;
                    let y = i / w;
                    if (x / cell + y / cell) % 2 == 0 { 0.0 } else { 255.0 }
                })
                .collect();
            let mut ws = CannyWorkspace::new(w, h).unwrap();
            let edge_map = canny(&src, &mut ws, &cfg).unwrap();
            let count = edge_map.iter().filter(|&&v| v == 255).count();
            assert!(
                count <= prev_count,
                "larger cell should produce fewer edges: cell={}, count={}, prev={}",
                cell, count, prev_count
            );
            prev_count = count;
        }
        log::info!("[test] test_checkerboard_edge_count_vs_cell_size PASSED");
    }

    /// sigma 越大,边缘数量应单调不增(更强的平滑抑制噪声边缘)
    #[test]
    fn test_larger_sigma_fewer_or_equal_edges() {
        init_logger();
        let (w, h) = (64, 64);
        // 使用噪声图,sigma 影响更明显
        let src: Vec<f32> = {
            let mut state = 12345u64;
            (0..w * h)
                .map(|_| {
                    state = state
                        .wrapping_mul(6364136223846793005)
                        .wrapping_add(1442695040888963407);
                    ((state >> 33) & 0xFF) as f32
                })
                .collect()
        };

        let cfg_base = CannyConfig::builder()
            .thresholds(30.0, 90.0)
            .build()
            .unwrap();

        let mut prev_count = usize::MAX;
        for sigma in [0.5f32, 1.0, 2.0, 4.0] {
            let mut ws = CannyWorkspace::new(w, h).unwrap();
            let cfg = CannyConfig { sigma, ..cfg_base.clone() };
            let edge_map = canny(&src, &mut ws, &cfg).unwrap();
            let count = edge_map.iter().filter(|&&v| v == 255).count();
            assert!(
                count <= prev_count,
                "larger sigma should not increase edge count: sigma={}, count={}, prev={}",
                sigma, count, prev_count
            );
            prev_count = count;
        }
        log::info!("[test] test_larger_sigma_fewer_or_equal_edges PASSED");
    }
}