Skip to main content

CodedDiffraction

Struct CodedDiffraction 

Source
pub struct CodedDiffraction {
    pub n: usize,
    pub n_masks: usize,
    /* private fields */
}
Expand description

A coded-diffraction forward operator: L random complex masks of length n.

Fields§

§n: usize

Signal length n.

§n_masks: usize

Number of coded patterns L.

Implementations§

Source§

impl CodedDiffraction

Source

pub fn new( n: usize, n_masks: usize, kind: MaskKind, rng: &mut LcgRng, ) -> CsResult<Self>

Construct n_masks random masks of length n.

§Errors

CsError::InvalidParameter for n == 0 or n_masks == 0.

Source

pub fn n_measurements(&self) -> usize

Total number of real measurements m = L · n.

Source

pub fn forward(&self, x: &[f64]) -> CsResult<Vec<f64>>

Phaseless forward measurement y = |A_l x|² stacked over all masks.

x is interleaved complex (length 2n). Output is real, length m = L·n, laid out mask-major: y[l·n + k] = |(A_l x)_k|².

§Errors

CsError::DimensionMismatch if x.len() != 2n.

Source

pub fn wirtinger_flow( &self, y: &[f64], cfg: &WirtingerConfig, rng: &mut LcgRng, ) -> CsResult<Vec<f64>>

Recover x (up to a global phase) from phaseless measurements y by Wirtinger Flow.

  • y — measurements from forward, length m = L·n.
  • cfg — algorithm configuration.
  • rng — RNG for the spectral-initialisation power iteration.

Returns the recovered interleaved-complex signal (length 2n).

§Errors

Trait Implementations§

Source§

impl Clone for CodedDiffraction

Source§

fn clone(&self) -> CodedDiffraction

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 CodedDiffraction

Source§

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

Formats the value using the given formatter. 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> 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> 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.