Skip to main content

Optics

Struct Optics 

Source
pub struct Optics {
    pub wavelength_vacuum_m: f64,
    pub objective_na: f64,
    pub magnification: f64,
    pub camera_pixel_size: f64,
    pub illumination_refractive_index: f64,
    pub objective_medium_refractive_index: f64,
    pub defocus_distance: Option<f64>,
    pub pupil_aberration: Option<PupilAberration>,
}
Expand description

Physical microscope parameters in SI units.

The sample-plane detector pitch must satisfy the coherent-field sampling invariant

camera_pixel_size / magnification < wavelength_vacuum_m / (2 * objective_na).

Equality is rejected because the circular pupil cutoff would lie on the one-sided discrete Nyquist boundary.

§References

§Example

use fpm_rs::experiment::Optics;

let optics = Optics {
    wavelength_vacuum_m: 532e-9,
    objective_na: 0.1,
    magnification: 4.0,
    camera_pixel_size: 6.5e-6,
    illumination_refractive_index: 1.0,
    objective_medium_refractive_index: 1.0,
    defocus_distance: None,
    pupil_aberration: None,
};
optics.validate()?;
assert_eq!(optics.object_pixel_size(), 6.5e-6 / 4.0);

Fields§

§wavelength_vacuum_m: f64

Illumination wavelength in vacuum, in metres.

§objective_na: f64

Objective numerical aperture; must not exceed Self::objective_medium_refractive_index.

§magnification: f64

Lateral image magnification, as a positive dimensionless ratio.

§camera_pixel_size: f64

Physical detector-pixel pitch in metres.

After division by Self::magnification, this must be strictly less than wavelength_vacuum_m / (2 * objective_na).

§illumination_refractive_index: f64

Refractive index between illumination sources and the sample.

§objective_medium_refractive_index: f64

Refractive index in the objective-side medium.

§defocus_distance: Option<f64>

Axial sample displacement from the focal plane in metres.

§pupil_aberration: Option<PupilAberration>

Optional sampled-pupil aberration model.

Coefficients are interpreted by crate::model::Pupil::circular as crate-specific radial-polynomial weights in radians, not as normalized Zernike coefficients.

Implementations§

Source§

impl Optics

Source

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

Validates positive finite physical parameters, coherent-field sampling, objective-medium compatibility, finite optional defocus, and the optional PupilAberration.

Coherent-field sampling requires camera_pixel_size / magnification < wavelength_vacuum_m / (2 * objective_na). Equality is invalid because it places the pupil cutoff on the discrete Nyquist boundary.

Source

pub fn object_pixel_size(&self) -> f64

Returns the sample-plane pixel pitch camera_pixel_size / magnification, in metres.

Source

pub fn illumination_wavenumber(&self) -> f64

Returns 2π n_illumination / wavelength_vacuum, in radians per metre.

Source

pub fn objective_medium_wavenumber(&self) -> f64

Returns the objective-medium angular wavenumber in radians per metre.

Trait Implementations§

Source§

impl Clone for Optics

Source§

fn clone(&self) -> Optics

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 Optics

Source§

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

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

impl<'de> Deserialize<'de> for Optics

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 Serialize for Optics

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

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,