Struct DetectConfig 

pub struct DetectConfig {

    pub marker_scale: MarkerScalePrior,
    pub outer_estimation: OuterEstimationConfig,
    pub proposal: ProposalConfig,
    pub seed_proposals: SeedProposalParams,
    pub edge_sample: EdgeSampleConfig,
    pub decode: DecodeConfig,
    pub marker_spec: MarkerSpec,
    pub inner_fit: InnerFitConfig,
    pub outer_fit: OuterFitConfig,
    pub circle_refinement: CircleRefinementMethod,
    pub projective_center: ProjectiveCenterParams,
    pub completion: CompletionParams,
    pub max_aspect_ratio: f64,
    pub dedup_radius: f64,
    pub use_global_filter: bool,
    pub ransac_homography: RansacHomographyConfig,
    pub board: BoardLayout,
    pub self_undistort: SelfUndistortConfig,
    pub id_correction: IdCorrectionConfig,
    pub inner_as_outer_recovery: InnerAsOuterRecoveryConfig,
    pub h_reproj_confidence_alpha: f32,
    pub proposal_downscale: ProposalDownscale,
    /* private fields */
}

Top-level detection configuration.

Contains all parameters that control the detection pipeline. Use one of the recommended constructors rather than constructing directly:

• DetectConfig::from_target — default scale prior
• DetectConfig::from_target_and_scale_prior — explicit scale range
• DetectConfig::from_target_and_marker_diameter — fixed diameter hint

These constructors auto-derive scale-dependent parameters (proposal radii, edge search windows, validation bounds) from the board geometry and marker scale prior. Individual fields can be tuned after construction.

Fields

marker_scale: MarkerScalePrior

Marker diameter prior (range) in working-frame pixels.

outer_estimation: OuterEstimationConfig

Outer edge estimation configuration (anchored on marker_scale).

proposal: ProposalConfig

Proposal generation configuration.

seed_proposals: SeedProposalParams

Seed-injection controls for multi-pass proposal generation.

edge_sample: EdgeSampleConfig

Radial edge sampling configuration.

decode: DecodeConfig

Marker decode configuration.

marker_spec: MarkerSpec

Marker geometry specification and estimator controls.

inner_fit: InnerFitConfig

Robust inner ellipse fitting controls shared across pipeline stages.

outer_fit: OuterFitConfig

Robust outer ellipse fitting controls shared across pipeline stages.

circle_refinement: CircleRefinementMethod

Post-fit circle refinement method selector.

projective_center: ProjectiveCenterParams

Projective-center recovery controls.

completion: CompletionParams

Homography-guided completion controls.

max_aspect_ratio: f64

Maximum aspect ratio (a/b) for a valid ellipse.

dedup_radius: f64

NMS dedup radius for final markers (pixels).

use_global_filter: bool

Enable global homography filtering (requires board spec).

ransac_homography: RansacHomographyConfig

RANSAC homography configuration.

board: BoardLayout

Board layout: marker positions and geometry.

self_undistort: SelfUndistortConfig

Self-undistort estimation controls.

id_correction: IdCorrectionConfig

Structural ID verification and correction using hex neighborhood consensus.

inner_as_outer_recovery: InnerAsOuterRecoveryConfig

Automatic recovery for markers where the inner edge was incorrectly fitted as the outer ellipse.

h_reproj_confidence_alpha: f32

Soft confidence penalty alpha for H-reprojection error.

After the final homography is estimated, each marker’s confidence is multiplied by 1 / (1 + alpha * h_reproj_err_px). Markers with small reprojection errors are unaffected; geometrically inconsistent markers (e.g. 5 px error) are penalised by roughly 1 / (1 + 0.2 * 5) = 0.5.

Set to 0.0 to disable the penalty. Default: 0.2.

proposal_downscale: ProposalDownscale

Optional image downscaling before proposal generation.

When markers are large, running proposals on a smaller image is much faster while proposal coordinates are approximate anyway (downstream stages refine at full resolution). Default: Off.

Implementations

impl DetectConfig

pub fn from_target_and_scale_prior( board: BoardLayout, marker_scale: MarkerScalePrior, ) -> Self

Build a configuration with scale-dependent parameters derived from a marker diameter range and a runtime target layout.

This is the recommended constructor for library users. After calling it, individual fields can be overridden as needed.

pub fn from_target(board: BoardLayout) -> Self

Build a configuration from target layout and default marker scale prior.

pub fn from_target_and_marker_diameter( board: BoardLayout, diameter_px: f32, ) -> Self

Build a configuration from target layout and a fixed marker diameter hint.

pub fn set_marker_scale_prior(&mut self, marker_scale: MarkerScalePrior)

Update marker scale prior and re-derive all scale-coupled parameters.

pub fn set_marker_diameter_hint_px(&mut self, diameter_px: f32)

Update marker scale prior from a fixed marker diameter hint.

Trait Implementations

impl Clone for DetectConfig

fn clone(&self) -> DetectConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DetectConfig

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

Formats the value using the given formatter.

impl Default for DetectConfig

fn default() -> Self

Returns the “default value” for a type.