psf_generator.propagators.cartesian_propagator

The propagator in the case of Cartesian coordinates.

Classes

CartesianPropagator

Intermediate class for propagators with Cartesian parameterization.

Module Contents

class psf_generator.propagators.cartesian_propagator.CartesianPropagator(n_pix_pupil=128, n_pix_psf=128, device='cpu', zernike_coefficients=None, special_phase_mask=None, custom_field=None, wavelength=632, na=1.3, pix_size=10, defocus_step=0, n_defocus=1, sz_correction=True, apod_factor=False, envelope=None, gibson_lanni=False, z_p=1000.0, n_s=1.3, n_g=1.5, n_g0=1.5, t_g=170000.0, t_g0=170000.0, n_i=1.5, n_i0=1.5, t_i0=100000.0)

Bases: psf_generator.propagators.propagator.Propagator, abc.ABC

Intermediate class for propagators with Cartesian parameterization.

Notes

Apart from parameters inherited from the base class, there is one additional sz_correction. This factor appears due to the cartesian parameterization inside the integral to compute, which affects the PSF for high-NA systems. Set it to True to apply the correction factor \(1/s_z\) to the pupil function. Set it to False to ignore the correction factor, to obtain low-NA analytic PSFs such as the Airy disk.

sz_correction

special_phase_mask

k

s_max

zoom_factor

n_pix_pupil

s_x

ds

s_zz

total_fft_range

k_start

k_end

x

correction_factor

defocus_range

defocus_filters

_zernike_aberrations = None

_compute_zernike_aberrations()

Compute Zernike aberrations.

get_pupil()

Get the pupil function with all corrections applied.

update_custom_field(custom_field)

Update custom field without reinitializing propagator.

Parameters

custom_fieldtorch.Tensor or None

Custom field of shape (n_pix_pupil, n_pix_pupil) or (1, 1, n_pix_pupil, n_pix_pupil).

get_correction_factor()

Get the correction factor applied to the pupil (sz_correction, apod_factor, envelope, gibson_lanni).

Returns

torch.Tensor

Correction factor of shape (1, 1, n_pix_pupil, n_pix_pupil).

compute_focus_field()

Compute the electric field at the focal plane.