Skip to content

Commit 64d1170

Browse files
kalwaltclaude
andcommitted
doc(kpm): mark box-filter Pyramid as kept-but-unused reference (#203)
Decision on #203: keep BoxFilterPyramid8u / Pyramid as a tested reference rather than remove or wire it in. Add a module note making clear it is not wired into any pipeline (the live KPM/FREAK detector uses GaussianScaleSpacePyramid) so future readers aren't misled. Closes #203. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent ec28cc9 commit 64d1170

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

crates/core/src/kpm/freak/pyramid.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@
3636

3737
//! Image pyramid built by repeated box-filter downsampling.
3838
//!
39+
//! **Not currently wired into any pipeline** (kept as reference — see #203).
40+
//! This is a faithful, SIMD-accelerated port of the C++ `BoxFilterPyramid8u`,
41+
//! which is itself unused in the original. The live KPM/FREAK detector builds
42+
//! its scale space with [`super::gaussian_pyramid::GaussianScaleSpacePyramid`]
43+
//! instead. Retained as a tested reference implementation.
44+
//!
3945
//! Ported from `WebARKitLib/lib/SRC/KPM/FreakMatcher/detectors/pyramid.{h,cpp}`
4046
//! (`BoxFilterPyramid8u` / `BoxFilterDecimate`).
4147
//!

0 commit comments

Comments
 (0)