Struct PlanarLedArray 

pub struct PlanarLedArray { /* private fields */ }

Regular planar LED grid with row-major physical source indexing.

shape is (rows, columns), pitch_m is (pitch_x, pitch_y), and reference_index is the fractional (column, row) lattice coordinate at the pose origin. Source index is row * columns + column. Per-source local Cartesian corrections are applied before the global ArrayPose.

Implementations

impl PlanarLedArray

pub fn new( shape: (usize, usize), pitch_m: (f64, f64), reference_index: (f64, f64), pose: ArrayPose, ) -> Self

Creates a planar array from its canonical physical fields.

pub fn with_position_offsets_m(self, offsets: Vec<[f64; 3]>) -> Self

Sets array-local per-source Cartesian corrections in metres.

An empty vector means all-zero corrections; otherwise its length must equal Self::source_count.

pub fn with_pitch_m(self, pitch_m: (f64, f64)) -> Self

Replaces the physical (pitch_x, pitch_y) lattice spacing in metres.

pub fn with_reference_index(self, reference_index: (f64, f64)) -> Self

Replaces the fractional (column, row) lattice coordinate at the pose origin.

pub fn with_pose(self, pose: ArrayPose) -> Self

Replaces the active-extrinsic-XYZ rigid pose of the array.

pub const fn shape(&self) -> (usize, usize)

Returns array shape as (rows, columns).

pub const fn pitch_m(&self) -> (f64, f64)

Returns pitch as (pitch_x, pitch_y) in metres.

pub const fn reference_index(&self) -> (f64, f64)

Returns the fractional reference lattice coordinate (column, row).

pub const fn pose(&self) -> &ArrayPose

Borrows the array-local to sample-coordinate rigid pose.

pub fn position_offsets_m(&self) -> &[[f64; 3]]

Borrows canonical local position offsets in metres.

pub fn source_count(&self) -> usize

Returns rows * columns, or zero if an impossible platform overflow occurs.

pub fn source_index(&self, row: usize, column: usize) -> Result<usize>

Converts (row, column) to its row-major source index.

pub fn source_row_column(&self, index: usize) -> Result<(usize, usize)>

Converts a row-major source index to (row, column).

pub fn validate(&self) -> Result<()>

Validates dimensions, pitches, reference coordinate, pose, and offsets.

pub fn resolve(&self, optics: &Optics) -> Result<ResolvedSources>

Resolves physical positions, directions, and transverse propagation vectors.

Trait Implementations

impl Clone for PlanarLedArray

fn clone(&self) -> PlanarLedArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanarLedArray

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlanarLedArray

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PlanarLedArray> for SourceGeometry

fn from(value: PlanarLedArray) -> Self

Converts to this type from the input type.

impl PartialEq for PlanarLedArray

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PlanarLedArray