Skip to main content

Optics

fpm_rs::experiment

Struct Optics

pub struct Optics {
    pub wavelength: f64,
    pub objective_na: f64,
    pub magnification: f64,
    pub camera_pixel_size: f64,
    pub medium_index: f64,
    pub defocus_distance: Option<f64>,
    pub pupil_aberration: Option<PupilAberration>,
}

Expand description

Physical microscope parameters in SI units.

Fields§

§wavelength: f64§objective_na: f64§magnification: f64§camera_pixel_size: f64§medium_index: f64§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§

impl Optics

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

pub fn object_pixel_size(&self) -> f64

pub fn medium_wavenumber(&self) -> f64

Trait Implementations§

impl Clone for Optics

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

impl Debug for Optics

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

Formats the value using the given formatter. Read more

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

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

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Optics

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§

impl Freeze for Optics

impl RefUnwindSafe for Optics

impl Send for Optics

impl Sync for Optics

impl Unpin for Optics

impl UnsafeUnpin for Optics

impl UnwindSafe for Optics

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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,

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

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