Struct Sampling

Source

pub struct Sampling {
    pub low_res_pixel_size: f64,
    pub high_res_pixel_size: f64,
    pub dkx: f64,
    pub dky: f64,
    pub wavelength: Option<f64>,
    pub synthetic_na: Option<f64>,
    pub coordinate_convention: CoordinateConvention,
}

Expand description

Physical sampling metadata for low- and high-resolution grids.

Fields§

§low_res_pixel_size: f64

Sample-plane low-resolution pixel pitch in metres.

§high_res_pixel_size: f64

Sample-plane high-resolution reconstruction pixel pitch in metres.

§dkx: f64

Fourier angular-frequency spacing along columns (x), in radians per metre.

§dky: f64

Fourier angular-frequency spacing along rows (y), in radians per metre.

§wavelength: Option<f64>

Optional vacuum illumination wavelength in metres.

§synthetic_na: Option<f64>

Optional dimensionless synthetic numerical aperture.

§coordinate_convention: CoordinateConvention

Convention used to store zero frequency and map positive wave vectors.

Implementations§

Source §

impl Sampling

Source

pub fn new( low_res_pixel_size: f64, high_res_pixel_size: f64, dkx: f64, dky: f64, ) -> Result<Self>

Creates centered-positive-k sampling from positive finite SI spacings.

Source

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

Checks positive finite pixel/frequency spacings and positive finite optional wavelength and synthetic numerical aperture.

Trait Implementations§

Source §

impl Clone for Sampling

Source §

fn clone(&self) -> Sampling

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 Sampling

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for Sampling

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 Sampling

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§

§

impl UnwindSafe for Sampling

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 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

§