Struct DecodeMetrics 

pub struct DecodeMetrics {
    pub observed_word: u16,
    pub best_id: usize,
    pub best_rotation: u8,
    pub best_dist: u8,
    pub margin: u8,
    pub decode_confidence: f32,
}

Decode quality metrics for a detected marker.

Reports how confidently a 16-sector binary code was matched against the active embedded codebook profile. A best_dist of 0 means an exact match; margin measures how far the second-best codeword is (higher = more confident).

Fields

observed_word: u16

Raw 16-bit word sampled from the code band.

best_id: usize

Best-matching codebook entry index within the active profile.

best_rotation: u8

Cyclic rotation (0–15 sectors) that produced the best match.

best_dist: u8

Hamming distance (bit errors) to the best-matching codeword.

margin: u8

Margin: second_best_dist - best_dist. Higher values indicate a more reliable decode. A margin of 3 or more is typically very confident.

decode_confidence: f32

Combined confidence heuristic in [0, 1].

Equals clamp(1 - dist/6) * clamp(margin / active_min_cyclic_dist). A margin equal to the selected profile’s minimum cyclic Hamming distance yields conf_margin = 1.0, so a perfect decode scores 1.0 regardless of that profile’s density.

Trait Implementations

impl Clone for DecodeMetrics

fn clone(&self) -> DecodeMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecodeMetrics

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DecodeMetrics

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DecodeMetrics

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

where __S: Serializer,

Serialize this value into the given Serde serializer.