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 marker_ring_width_mm: f32,
    /* private fields */
}

Runtime board layout used by the detector.

Describes the physical hex-lattice arrangement of ring markers: their positions in millimeters, ring radii, ring width, and lattice parameters. Load from a JSON file conforming to ringgrid.target.v4 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

marker_ring_width_mm: f32

Implementations

impl BoardLayout

pub fn new( pitch_mm: f32, rows: usize, long_row_cols: usize, marker_outer_radius_mm: f32, marker_inner_radius_mm: f32, marker_ring_width_mm: f32, ) -> Result<Self, BoardLayoutValidationError>

Construct a board layout from direct geometry arguments.

Uses a deterministic geometry-derived name so the layout can round-trip through the canonical ringgrid.target.v4 JSON schema without requiring the caller to supply a name up front.

pub fn with_name<S: Into<String>>( name: S, pitch_mm: f32, rows: usize, long_row_cols: usize, marker_outer_radius_mm: f32, marker_inner_radius_mm: f32, marker_ring_width_mm: f32, ) -> Result<Self, BoardLayoutValidationError>

Construct a named board layout from direct geometry arguments.

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 marker(&self, id: usize) -> Option<&BoardMarker>

Look up a marker by ID.

pub fn markers(&self) -> &[BoardMarker]

Borrow all markers as a read-only slice.

pub fn marker_by_index(&self, index: usize) -> Option<&BoardMarker>

Look up a marker by storage index.

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_ring_width_mm(&self) -> f32

Marker ring width 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, BoardLayoutLoadError>

Load a board layout from a JSON file.

pub fn from_json_str(data: &str) -> Result<Self, BoardLayoutLoadError>

Load a board layout from a JSON string.

pub fn to_json_string(&self) -> String

Serialize the layout as canonical ringgrid.target.v4 JSON.

pub fn write_json_file(&self, path: &Path) -> Result<(), Error>

Write the canonical ringgrid.target.v4 JSON representation to disk.

impl BoardLayout

pub fn render_target_svg( &self, options: &SvgTargetOptions, ) -> Result<String, TargetGenerationError>

Render a printable SVG target.

Input marker centers stay in normalized board millimeters with marker id=0 anchored at [0, 0]. The returned SVG translates those markers into a square page in millimeters with top-left origin and +y increasing downward.

pub fn write_target_svg( &self, path: &Path, options: &SvgTargetOptions, ) -> Result<(), TargetGenerationError>

Write a printable SVG target to disk.

pub fn render_target_png( &self, options: &PngTargetOptions, ) -> Result<GrayImage, TargetGenerationError>

Render a printable PNG target.

The raster uses integer pixel centers, matching the existing Python target generator’s sampling convention.

pub fn write_target_png( &self, path: &Path, options: &PngTargetOptions, ) -> Result<(), TargetGenerationError>

Write a printable PNG target to disk.

This always writes PNG bytes and embeds the requested dpi as PNG physical pixel dimensions (pHYs) so the output preserves print scale.

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.