Struct DecodeConfig 

pub struct DecodeConfig {
    pub codebook_profile: CodebookProfile,
    pub code_band_ratio: f32,
    pub samples_per_sector: usize,
    pub n_radial_rings: usize,
    pub max_decode_dist: u8,
    pub min_decode_confidence: f32,
    pub min_decode_margin: u8,
    pub min_decode_contrast: f32,
    pub threshold_max_iters: usize,
    pub threshold_convergence_eps: f32,
}

Configuration for sector decoding.

Fields

codebook_profile: CodebookProfile

Embedded codebook profile to match against.

Default: CodebookProfile::Base, which preserves the shipped stable IDs 0..892. extended is explicit opt-in and expands the codebook at the cost of a weaker minimum cyclic Hamming distance.

code_band_ratio: f32

Ratio of code band center radius to outer ellipse semi-major axis. The code band is sampled at code_band_ratio * (a, b) in the ellipse coordinate frame. Default: DecodeConfig::DEFAULT_CODE_BAND_RATIO.

samples_per_sector: usize

Number of angular samples per sector. Default: DecodeConfig::DEFAULT_SAMPLES_PER_SECTOR.

n_radial_rings: usize

Number of radial rings to sample within the code band. Default: DecodeConfig::DEFAULT_N_RADIAL_RINGS.

max_decode_dist: u8

Maximum Hamming distance for a valid decode. Default: DecodeConfig::DEFAULT_MAX_DECODE_DIST.

min_decode_confidence: f32

Minimum confidence for a valid decode. Default: DecodeConfig::DEFAULT_MIN_DECODE_CONFIDENCE.

min_decode_margin: u8

Minimum Hamming margin (second_best_dist - best_dist) for a valid decode.

A margin of 0 means the two closest codewords are equidistant from the observed word — genuinely ambiguous. Default rejects ties (margin = 0). For setups without homography validation (e.g. no camera intrinsics), setting this to the selected profile’s minimum cyclic Hamming distance accepts only matches that are unambiguous within that profile’s distance guarantee. For the shipped baseline profile this value is 2.

Default: DecodeConfig::DEFAULT_MIN_DECODE_MARGIN.

min_decode_contrast: f32

Minimum accepted sector-intensity contrast (max - min) before decode. Default: DecodeConfig::DEFAULT_MIN_DECODE_CONTRAST.

threshold_max_iters: usize

Maximum iterations for iterative 2-means threshold refinement. Default: DecodeConfig::DEFAULT_THRESHOLD_MAX_ITERS.

threshold_convergence_eps: f32

Convergence epsilon for iterative 2-means threshold refinement. Stop when |new_threshold - old_threshold| <= eps. Default: DecodeConfig::DEFAULT_THRESHOLD_CONVERGENCE_EPS.

Implementations

impl DecodeConfig

pub const DEFAULT_CODE_BAND_RATIO: f32 = 0.76

Default radial location of the code band as a fraction of outer radius.

pub const DEFAULT_SAMPLES_PER_SECTOR: usize = 5

Default number of angular intensity samples per bit sector.

pub const DEFAULT_N_RADIAL_RINGS: usize = 3

Default number of concentric rings used for radial sampling.

pub const DEFAULT_MAX_DECODE_DIST: u8 = 3

Default maximum Hamming distance accepted by decode.

pub const DEFAULT_MIN_DECODE_CONFIDENCE: f32 = 0.3

Minimum decode confidence with the corrected formula clamp(1-dist/6) * clamp(margin/profile.min_cyclic_dist). A perfect decode (dist=0, margin≥2) scores 1.0; this threshold accepts matches down to dist=2 with margin≥1 on the shipped baseline profile.

pub const DEFAULT_MIN_DECODE_MARGIN: u8 = 1

Minimum Hamming margin required for a valid decode.

A margin of 0 means two codewords are equidistant from the observed word (genuinely ambiguous). Setting this to 1 (default) rejects such ties.

pub const DEFAULT_MIN_DECODE_CONTRAST: f32 = 0.03

Default minimum sector-intensity contrast (max - min) before decode.

pub const DEFAULT_THRESHOLD_MAX_ITERS: usize = 10

Default iteration cap for iterative 2-means threshold refinement.

pub const DEFAULT_THRESHOLD_CONVERGENCE_EPS: f32 = 1e-4

Default convergence epsilon for iterative 2-means threshold refinement.

Trait Implementations

impl Clone for DecodeConfig

fn clone(&self) -> DecodeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodeConfig

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

Formats the value using the given formatter.

impl Default for DecodeConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DecodeConfig

where DecodeConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DecodeConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.