Struct LabelledGrid 

#[non_exhaustive]
pub struct LabelledGrid {
    pub lattice: LatticeKind,
    pub entries: Vec<GridEntry>,
    pub bbox: Option<(Coord, Coord)>,
    pub dimensions: Option<GridDimensions>,
}

A labelled grid component.

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.

lattice: LatticeKind

Lattice family of this grid.

entries: Vec<GridEntry>

Labelled feature entries.

bbox: Option<(Coord, Coord)>

Inclusive coordinate bounding box, if the grid is non-empty.

dimensions: Option<GridDimensions>

Optional known dimensions supplied by the caller.

Implementations

impl LabelledGrid

pub fn new( lattice: LatticeKind, entries: Vec<GridEntry>, dimensions: Option<GridDimensions>, ) -> Self

Construct a labelled grid.

pub fn find(&self, source_index: usize) -> Option<&GridEntry>

Linear-scan lookup of the labelled entry with the given source index.

pub fn normalize(&mut self)

Normalize the labelled grid in place to the canonical output frame.

Three steps, in order:

1. Rebase the coordinate bounding-box minimum to (0, 0), so every coord is non-negative (the hard non-negative-label invariant for overlay / calibration consumers).
2. Canonicalize orientation so the first lattice axis (u) points roughly +x (right) and the second (v) roughly +y (down) in image pixels. The grid finder assigns (u, v) from its internal axis-slot convention, which has no relation to image orientation; without this step (0, 0) can land anywhere on the detected grid. The decision is driven by GridEntry::image_position (averaged step vectors over all adjacent labelled pairs); positions are never modified, only labels are permuted / sign-flipped. When this step transposes the two axes, any caller-supplied dimensions have their width/height swapped too, so they stay aligned with the new axes.
3. Sort entries by (v, u) for a stable output order, and recompute bbox.

This is the single source of truth for grid-result normalization: target detectors call it instead of re-implementing rebase / canonicalize / sort at their output stage. It operates only on the labelled grid, so any LatticeFit computed against the pre-normalization labels is no longer valid afterwards — normalize before fitting, or refit.

Trait Implementations

impl Clone for LabelledGrid

fn clone(&self) -> LabelledGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LabelledGrid

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

Formats the value using the given formatter.

impl PartialEq for LabelledGrid

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