Skip to main content

RotatingLedArc

fpm_rs::experiment

Struct RotatingLedArc 

Source 
pub struct RotatingLedArc {
    pub led_thetas: Vec<f64>,
    pub rotation_angles: Vec<f64>,
    pub radius: f64,
    pub axis_origin_offset: (f64, f64, f64),
    pub axis_tilt_radians: (f64, f64),
    pub led_angular_corrections: Option<Vec<(f64, f64)>>,
    pub led_radial_offsets: Option<Vec<f64>>,
    pub rotation_zero_radians: f64,
    pub rotation_scale: f64,
    pub rotation_backlash_radians: f64,
}
Expand description

A quarter-circle LED arc rotated about an axis nominally collinear with the optical axis.

Every LED is compiled at every commanded rotation angle. Sources are ordered rotation-major and then by led_thetas. The nominal arm lies in the x-z plane, with LED polar positions measured from positive z.

Fields§

§led_thetas: Vec<f64>

Nominal LED polar positions along the quarter-circle arm, in radians.

§rotation_angles: Vec<f64>

Commanded arm azimuths in physical movement order, in radians.

§radius: f64

Positive nominal arc radius in metres.

§axis_origin_offset: (f64, f64, f64)

Point on the rotation axis relative to the sample, in metres.

§axis_tilt_radians: (f64, f64)

Rotation-axis tilt (rx, ry) away from the optical axis, in radians.

§led_angular_corrections: Option<Vec<(f64, f64)>>

Per-LED (delta_theta, delta_phi) mounting corrections.

§led_radial_offsets: Option<Vec<f64>>

Per-LED radial corrections to the nominal arm radius, in metres.

§rotation_zero_radians: f64

Additive rotation-encoder zero offset in radians.

§rotation_scale: f64

Positive dimensionless rotation-encoder scale.

§rotation_backlash_radians: f64

Total separation between increasing and decreasing rotation branches.

Implementations§

Source§

impl RotatingLedArc

Source

pub fn new(led_thetas: Vec<f64>, rotation_angles: Vec<f64>, radius: f64) -> Self

Creates an arc from LED polar angles and movement-order rotations in radians, with a positive radius in metres.

Source

pub fn axis_origin_offset(self, offset: (f64, f64, f64)) -> Self

Sets a point on the rotation axis (x, y, z) relative to the sample, in metres.

Source

pub fn axis_tilt_deg(self, x: f64, y: f64) -> Self

Sets extrinsic x and y tilts of the rotation axis in degrees.

Source

pub fn led_angular_corrections(self, corrections: Vec<(f64, f64)>) -> Self

Sets per-LED (delta_theta, delta_phi) mounting corrections in radians.

Source

pub fn led_radial_offsets(self, offsets: Vec<f64>) -> Self

Sets per-LED radial corrections in metres.

Source

pub fn rotation_encoder_zero_deg(self, degrees: f64) -> Self

Sets the additive rotation-encoder zero offset in degrees.

Source

pub fn rotation_encoder_scale(self, scale: f64) -> Self

Sets the positive dimensionless rotation-encoder scale.

Source

pub fn rotation_backlash_deg(self, degrees: f64) -> Self

Sets total separation between increasing and decreasing rotation branches in degrees.

Source

pub fn source_count(&self) -> usize

Returns the rotation-major physical source count.

Source

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

Validates angular domains, positive radius and scale, finite pose and encoder calibration, per-LED correction lengths, optional wavelength, and gains.

Source

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

Resolves rotation-major physical positions and transverse vectors.

Trait Implementations§

Source§

impl Clone for RotatingLedArc

Source§

fn clone(&self) -> RotatingLedArc

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RotatingLedArc

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RotatingLedArc

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<RotatingLedArc> for SourceGeometry

Source§

fn from(value: RotatingLedArc) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for RotatingLedArc

Source§

fn eq(&self, other: &RotatingLedArc) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for RotatingLedArc

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RotatingLedArc

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Key for T
where T: Clone,

§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
§

fn size(&self) -> usize

The size of the key in bytes.
§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,