Struct BoardLayout 

pub struct BoardLayout {
    pub name: String,
    pub pitch_mm: f32,
    pub rows: usize,
    pub long_row_cols: usize,
    pub marker_outer_radius_mm: f32,
    pub marker_inner_radius_mm: f32,
    pub markers: Vec<BoardMarker>,
    /* private fields */
}

Runtime board layout used by the detector.

Describes the physical hex-lattice arrangement of ring markers: their positions in millimeters, ring radii, and lattice parameters. Load from a JSON file conforming to ringgrid.target.v3 schema, or use the built-in default via BoardLayout::default().

Example

use ringgrid::BoardLayout;
use std::path::Path;

let board = BoardLayout::from_json_file(Path::new("target.json")).unwrap();
println!("{} markers, pitch={} mm", board.n_markers(), board.pitch_mm);

Fields

name: String

pitch_mm: f32

rows: usize

long_row_cols: usize

marker_outer_radius_mm: f32

marker_inner_radius_mm: f32

markers: Vec<BoardMarker>

Implementations

impl BoardLayout

pub fn build_index(&mut self)

Build the internal ID->index lookup table. Must be called after manual marker modifications.

pub fn xy_mm(&self, id: usize) -> Option<[f32; 2]>

Look up board coordinates (x, y) in mm for a given marker ID.

pub fn n_markers(&self) -> usize

Total number of markers on the board.

pub fn marker_outer_radius_mm(&self) -> f32

Marker outer radius in board units (mm).

pub fn marker_inner_radius_mm(&self) -> f32

Marker inner radius in board units (mm).

pub fn marker_ids(&self) -> impl Iterator<Item = usize> + '_

Iterator over all marker IDs present on the board.

pub fn max_marker_id(&self) -> usize

Maximum marker ID present on the board.

pub fn marker_bounds_mm(&self) -> Option<([f32; 2], [f32; 2])>

Axis-aligned marker bounds in board mm.

Returns (min_xy, max_xy) over marker centers.

pub fn marker_span_mm(&self) -> Option<[f32; 2]>

Axis-aligned marker span in board mm ([width, height]).

pub fn from_json_file(path: &Path) -> Result<Self, Box<dyn Error>>

Load a board layout from a JSON file.

Trait Implementations

impl Clone for BoardLayout

fn clone(&self) -> BoardLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoardLayout

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

Formats the value using the given formatter.

impl Default for BoardLayout

fn default() -> Self

Returns the “default value” for a type.