Struct ChessConfig 

#[non_exhaustive]
pub struct ChessConfig {

    pub detector_mode: DetectorMode,
    pub descriptor_mode: DescriptorMode,
    pub threshold_mode: ThresholdMode,
    pub threshold_value: f32,
    pub nms_radius: u32,
    pub min_cluster_size: u32,
    pub refiner: RefinerConfig,
    pub pyramid_levels: u8,
    pub pyramid_min_size: usize,
    pub refinement_radius: u32,
    pub merge_radius: f32,
    pub upscale: UpscaleConfig,
    pub radon_detector: RadonDetectorParams,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

detector_mode: DetectorMode

descriptor_mode: DescriptorMode

threshold_mode: ThresholdMode

threshold_value: f32

nms_radius: u32

min_cluster_size: u32

refiner: RefinerConfig

pyramid_levels: u8

pyramid_min_size: usize

refinement_radius: u32

merge_radius: f32

upscale: UpscaleConfig

Optional pre-pipeline integer upscaling. Disabled by default.

radon_detector: RadonDetectorParams

Parameters for the whole-image Radon detector. Only consulted when detector_mode is DetectorMode::Radon; otherwise left at its default.

Implementations

impl ChessConfig

pub fn single_scale() -> Self

Single-scale preset (one pyramid level). Recommended for images where the cell size comfortably exceeds the ChESS ring support (~12 px diameter) and no multiscale coverage is needed.

pub fn multiscale() -> Self

Three-level coarse-to-fine pyramid preset. Recommended for images ≥ 1 MP or whenever cell sizes vary significantly across the frame. The pyramid stops at pyramid_min_size = 128 pixels on the short edge.

pub fn radon() -> Self

Preset for the whole-image Radon detector. Single-scale by construction (pyramidal Radon is deferred — the SAT-based detector is already fast enough at base resolution for typical calibration frames). Uses the Gaussian peak-fit inherited from RadonDetectorParams; corners are subpixel-refined by the detector’s own peak-fit, so refiner is effectively a pass-through.

pub fn to_chess_params(&self) -> ChessParams

Translate this config into the low-level ChessParams consumed by chess-corners-core. This is called internally by the detection pipeline; callers that need direct access to core primitives can use the returned value with chess_corners_core::detect functions.

pub fn to_coarse_to_fine_params(&self) -> CoarseToFineParams

Translate this config into the CoarseToFineParams that drive the multiscale pipeline. Pyramid levels, minimum pyramid size, refinement radius, and merge radius are all copied from this struct.

Trait Implementations

impl Clone for ChessConfig

fn clone(&self) -> ChessConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChessConfig

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

Formats the value using the given formatter.

impl Default for ChessConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChessConfig

where ChessConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChessConfig

fn eq(&self, other: &ChessConfig) -> 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 Serialize for ChessConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChessConfig