Struct Detector 

pub struct Detector { /* private fields */ }

High-level chessboard-corner detector.

Owns the pyramid and detector-specific scratch buffers so the caller can reuse them across successive frames.

Implementations

impl Detector

pub fn new(cfg: DetectorConfig) -> Result<Self, ChessError>

Build a detector with the given config.

Errors

Returns ChessError::Upscale when the DetectorConfig::upscale configuration is invalid.

pub fn with_default() -> Self

Build a detector with the default config.

pub fn config(&self) -> &DetectorConfig

Borrow the active config.

pub fn set_config(&mut self, cfg: DetectorConfig) -> Result<(), ChessError>

Replace the active config.

Errors

Returns ChessError::Upscale when the new config’s upscale section is invalid.

pub fn config_mut(&mut self) -> &mut DetectorConfig

Mutable access to the active config for ad-hoc tweaks. The caller is responsible for keeping the config valid; callers that change DetectorConfig::upscale should use Self::set_config instead so the upscale invariants are re-validated.

pub fn detect_u8( &mut self, img: &[u8], width: u32, height: u32, ) -> Result<Vec<CornerDescriptor>, ChessError>

Detect chessboard corners from a raw 8-bit grayscale buffer.

Errors

Returns ChessError::DimensionMismatch if img.len() != width * height. Returns ChessError::Upscale if the upscale configuration becomes invalid (this should not normally happen — Detector::new / Detector::set_config validate up-front).

pub fn detect( &mut self, img: &GrayImage, ) -> Result<Vec<CornerDescriptor>, ChessError>

Detect chessboard corners from an image::GrayImage.

Errors

Returns ChessError::Upscale if the upscale configuration becomes invalid.

pub fn diagnostics(&self) -> DetectorDiagnostics<'_>

Borrow a detector-bound diagnostics accessor.

The returned DetectorDiagnostics exposes intermediate detector outputs — the dense ChESS response map and the Radon heatmap — sourced from this detector’s already-configured DetectorConfig, so a caller holding a configured Detector need not re-supply a config to obtain diagnostic data.

This is the detector-bound half of the diagnostics channel; the free functions in crate::diagnostics serve stateless callers. Both share the same opt-in, looser-stability contract: diagnostic outputs are advisory and may change as the detector internals evolve, independently of the Detector::detect result contract.