Struct Pupil 

pub struct Pupil { /* private fields */ }

Owned sampled complex pupil and same-shaped binary aperture support.

Arrays are shaped (height, width) on the low-resolution Fourier grid and stored in standard row-major order. Values encode amplitude and phase transfer; support entries are exactly zero or one.

Implementations

impl Pupil

pub fn new(values: Array2<Complex64>, support: Array2<u8>) -> Result<Self>

Stores owned pupil arrays without copying their elements.

Both inputs must have identical, non-zero shapes and C-contiguous standard row-major layout. Nonstandard inputs are rejected rather than copied. Support entries must be exactly zero or one.

pub fn circular( shape: (usize, usize), sampling: &Sampling, optics: &Optics, ) -> Result<Self>

Builds a sampled circular pupil from microscope optics.

Samples outside sqrt(kx^2 + ky^2) <= 2 pi NA / lambda are set to zero. Inside the support, optional defocus contributes the paraxial phase -z * (kx^2 + ky^2) / (2 k0), where k0 = 2 pi n / lambda.

If crate::experiment::PupilAberration is present, this method adds crate-specific phase terms astigmatism * rho^2 * cos(2 theta), coma * (3 rho^3 - 2 rho) * cos(theta), and spherical * (6 rho^4 - 6 rho^2 + 1), with amplitude exp(-edge_apodization * rho^2). These coefficients are direct radian weights, not normalized Zernike coefficients.

pub fn shape(&self) -> (usize, usize)

Returns the pupil array shape as (height, width).

pub fn values(&self) -> ArrayView2<'_, Complex64>

Borrows the pupil values without allocating or copying.

pub fn values_mut(&mut self) -> ArrayViewMut2<'_, Complex64>

Mutably borrows pupil elements without permitting structural mutation.

pub fn support(&self) -> ArrayView2<'_, u8>

Borrows the binary pupil support without allocating or copying.

pub fn replace_values(&mut self, values: Array2<Complex64>) -> Result<()>

Replaces owned complex values without changing support.

values must be finite, standard row-major, and have Self::shape.

pub fn apply_support(&mut self)

Sets every complex pupil value outside the binary aperture to zero in place.

Trait Implementations

impl Clone for Pupil

fn clone(&self) -> Pupil

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pupil

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pupil

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Pupil

fn eq(&self, other: &Pupil) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Pupil

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Pupil