Skip to main content

Fpie

Struct Fpie 

Source
pub struct Fpie {
    pub iterations: usize,
    pub object_step: f64,
    pub stability: f64,
    pub batch_size: usize,
    pub epsilon: f64,
    pub loss_type: LossType,
}
Expand description

Regularized ptychographic iterative-engine reconstruction adapted to FPM.

§Method

Fpie performs the same detector-amplitude projection as super::AlternatingProjection, but preconditions each object correction with the rPIE denominator (1 - stability) * |pupil|^2 + stability * max(|pupil|^2). This blends local inverse-pupil weighting with a global power bound, reducing unstable updates where the pupil transfer is weak. The corrected low-resolution spectrum is inserted into the corresponding overlapping patch of the high-resolution object spectrum.

This crate adapts the rPIE update, originally formulated for scanned ptychography, to image-plane Fourier ptychography.

§Reference

A. Maiden, D. Johnson, and P. Li, “Further improvements to the ptychographical iterative engine,” Optica 4(7), 736–745 (2017), doi:10.1364/OPTICA.4.000736.

Fields§

§iterations: usize

Number of complete passes through the acquisition schedule.

§object_step: f64

Relaxation factor applied to each object-spectrum correction.

§stability: f64

Blend between local pupil power (0) and maximum pupil power (1) in the rPIE denominator.

§batch_size: usize

Number of measured frames supplied to each reconstruction step.

§epsilon: f64

Positive numerical floor added to the rPIE denominator.

§loss_type: LossType

Loss used for diagnostics; the projection itself always enforces the measured amplitude.

Implementations§

Source§

impl Fpie

Source

pub fn iterations(self, iterations: usize) -> Self

Source

pub fn object_step(self, step: f64) -> Self

Source

pub fn stability(self, stability: f64) -> Self

Trait Implementations§

Source§

impl Clone for Fpie

Source§

fn clone(&self) -> Fpie

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 Fpie

Source§

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

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

impl Default for Fpie

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl ReconstructionAlgorithm for Fpie

Auto Trait Implementations§

§

impl Freeze for Fpie

§

impl RefUnwindSafe for Fpie

§

impl Send for Fpie

§

impl Sync for Fpie

§

impl Unpin for Fpie

§

impl UnsafeUnpin for Fpie

§

impl UnwindSafe for Fpie

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

§

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