Struct DetectorConfig 

pub struct DetectorConfig {

    pub threshold_tile_size: usize,
    pub threshold_min_range: u8,
    pub enable_bilateral: bool,
    pub bilateral_sigma_space: f32,
    pub bilateral_sigma_color: f32,
    pub enable_sharpening: bool,
    pub enable_adaptive_window: bool,
    pub threshold_min_radius: usize,
    pub threshold_max_radius: usize,
    pub adaptive_threshold_constant: i16,
    pub adaptive_threshold_gradient_threshold: u8,
    pub quad_min_area: u32,
    pub quad_max_aspect_ratio: f32,
    pub quad_min_fill_ratio: f32,
    pub quad_max_fill_ratio: f32,
    pub quad_min_edge_length: f64,
    pub quad_min_edge_score: f64,
    pub subpixel_refinement_sigma: f64,
    pub segmentation_margin: i16,
    pub segmentation_connectivity: SegmentationConnectivity,
    pub upscale_factor: usize,
    pub decimation: usize,
    pub nthreads: usize,
    pub decoder_min_contrast: f64,
    pub refinement_mode: CornerRefinementMode,
    pub decode_mode: DecodeMode,
    pub max_hamming_error: u32,
    pub huber_delta_px: f64,
    pub tikhonov_alpha_max: f64,
    pub sigma_n_sq: f64,
    pub structure_tensor_radius: u8,
}

Pipeline-level configuration for the detector.

These settings affect the fundamental behavior of the detection pipeline and are immutable after the Detector is constructed. Use the builder pattern for ergonomic construction.

Fields

threshold_tile_size: usize

Tile size for adaptive thresholding (default: 4). Larger tiles are faster but less adaptive to local contrast.

threshold_min_range: u8

Minimum intensity range in a tile to be considered valid (default: 10). Tiles with lower range are treated as uniform (no edges).

enable_bilateral: bool

Enable bilateral pre-filtering for edge-preserving noise reduction (default: true).

bilateral_sigma_space: f32

Bilateral spatial sigma for spatial smoothing (default: 3.0).

bilateral_sigma_color: f32

Bilateral color sigma for edge preservation (default: 30.0). Higher values = more smoothing across edges.

enable_sharpening: bool

Enable Laplacian sharpening to enhance edges for small tags (default: true).

enable_adaptive_window: bool

Enable adaptive threshold window sizing based on gradient (default: true).

threshold_min_radius: usize

Minimum threshold window radius for high-gradient regions (default: 2 = 5x5).

threshold_max_radius: usize

Maximum threshold window radius for low-gradient regions (default: 7 = 15x15).

adaptive_threshold_constant: i16

Constant subtracted from local mean in adaptive thresholding (default: 3).

adaptive_threshold_gradient_threshold: u8

Gradient magnitude threshold above which the minimum window radius is used (default: 40).

quad_min_area: u32

Minimum quad area in pixels (default: 16).

quad_max_aspect_ratio: f32

Maximum aspect ratio of bounding box (default: 3.0).

quad_min_fill_ratio: f32

Minimum fill ratio (pixel count / bbox area) (default: 0.3).

quad_max_fill_ratio: f32

Maximum fill ratio (default: 0.95).

quad_min_edge_length: f64

Minimum edge length in pixels (default: 4.0).

quad_min_edge_score: f64

Minimum edge alignment score (0.0 to 1.0)

subpixel_refinement_sigma: f64

PSF blur factor for subpixel refinement (e.g., 0.6)

segmentation_margin: i16

Minimum deviation from threshold for a pixel to be connected in threshold-model CCL (default: 2).

segmentation_connectivity: SegmentationConnectivity

Segmentation connectivity (4-way or 8-way).

upscale_factor: usize

Factor to upscale the image before detection (1 = no upscaling). Increasing this to 2 allows detecting smaller tags (e.g., < 15px) at the cost of processing speed (O(N^2)). Nearest-neighbor interpolation is used.

decimation: usize

Decimation factor for preprocessing (1 = no decimation).

nthreads: usize

Number of threads for parallel processing (0 = auto).

decoder_min_contrast: f64

Minimum contrast range for Otsu-based bit classification (default: 20.0). For checkerboard patterns with densely packed tags, lower values (e.g., 10.0) can improve recall on small/blurry tags.

refinement_mode: CornerRefinementMode

Strategy for refining corner positions (default: Edge).

decode_mode: DecodeMode

Decoding mode (Hard vs Soft).

max_hamming_error: u32

Maximum number of Hamming errors allowed for tag decoding (default: 2). Higher values increase recall but also increase false positive rate in noise.

huber_delta_px: f64

Huber delta for LM reprojection (pixels) in Fast mode. Residuals beyond this threshold are down-weighted linearly. 1.5 px is a standard robust threshold for sub-pixel corner detectors.

tikhonov_alpha_max: f64

Maximum Tikhonov regularisation alpha (px^2) for ill-conditioned corners in Accurate mode. Controls the gain-scheduled regularisation of the Structure Tensor information matrix on foreshortened tags.

sigma_n_sq: f64

Pixel noise variance (sigma_n^2) assumed for the Structure Tensor covariance model in Accurate mode. Typical webcams: ~4.0.

structure_tensor_radius: u8

Radius (in pixels) of the window used for Structure Tensor computation in Accurate mode. A radius of 2 yields a 5x5 window. Smaller values (1) are better for small tags; larger (3-4) for noisy images.

Implementations

impl DetectorConfig

pub fn builder() -> DetectorConfigBuilder

Create a new builder for DetectorConfig.

pub fn validate(&self) -> Result<(), ConfigError>

Validate the configuration, returning an error if any parameter is out of range.

Errors

Returns [ConfigError] if any parameter violates its constraints.

pub fn production_default() -> Self

High-fidelity configuration used for production accuracy evaluations.

This matches the default settings used in the Python CLI and Regression suite:

• Corner Refinement: Erf
• Pre-processing: Sharpening Enabled
• Tile Size: 8

pub fn fast_default() -> Self

Low-latency configuration for high-speed tracking.

Disables heavy pre-processing and uses lighter corner refinement.

Trait Implementations

impl Clone for DetectorConfig

fn clone(&self) -> DetectorConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DetectorConfig

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

Formats the value using the given formatter.

impl Default for DetectorConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for DetectorConfig

fn eq(&self, other: &DetectorConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DetectorConfig

impl StructuralPartialEq for DetectorConfig