aberrations

Features that aberrate and modify pupil functions

Classes

Aberration

Base abstract class

GaussianApodization

Introduces pupil apodization.

Zernike

Introduces a Zernike phase aberration.

Piston

Zernike polynomial with n=0, m=0.

VerticalTilt

Zernike polynomial with n=1, m=-1.

HorizontalTilt

Zernike polynomial with n=1, m=1.

ObliqueAstigmatism

Zernike polynomial with n=2, m=-2.

Defocus

Zernike polynomial with n=2, m=0.

Astigmatism

Zernike polynomial with n=2, m=2.

ObliqueTrefoil

Zernike polynomial with n=3, m=-3.

VerticalComa

Zernike polynomial with n=3, m=-1.

HorizontalComa

Zernike polynomial with n=3, m=1.

Trefoil

Zernike polynomial with n=3, m=3.

SphericalAberration

Zernike polynomial with n=4, m=0.

Module classes

Aberration

class deeptrack.aberrations.Aberration(*args: dict, **kwargs)

Base abstract class.

Ensures that the method .get() receives rho and theta as optional arguments, describing the polar coordinates of each pixel in the image scaled so that rho is 1 at the edge of the pupil.

Astigmatism

class deeptrack.aberrations.Astigmatism(*args, coefficient=1, **kwargs)

Zernike polynomial with n=2, m=2.

Parameters

coefficient (float) – The coefficient of the polynomial

Defocus

class deeptrack.aberrations.Defocus(*args, coefficient=1, **kwargs)

Zernike polynomial with n=2, m=0.

Parameters

coefficient (float) – The coefficient of the polynomial

GaussianApodization

class deeptrack.aberrations.GaussianApodization(sigma, **kwargs)

Introduces pupil apodization.

Decreases the amplitude of the pupil at high frequencies according to a Gaussian distribution.

Parameters

sigma (float) – The standard deviation of the apodization. The edge of the pupil is at one deviation from the center.

get(pupil, sigma, rho, **kwargs)

Method for altering an image Abstract method that define how the feature transforms the input. The current value of all properties will be passed as keyword arguments.

Parameters
  • image (Image or List[Image]) – The Image or list of images to transform

  • **kwargs – The current value of all properties in properties as well as any global arguments.

Returns

The transformed image or list of images

Return type

Image or List[Image]

HorizontalComa

class deeptrack.aberrations.HorizontalComa(*args, coefficient=1, **kwargs)

Zernike polynomial with n=3, m=1.

Parameters

coefficient (float) – The coefficient of the polynomial

HorizontalTilt

class deeptrack.aberrations.HorizontalTilt(*args, coefficient=1, **kwargs)

Zernike polynomial with n=1, m=1.

Parameters

coefficient (float) – The coefficient of the polynomial

ObliqueAstigmatism

class deeptrack.aberrations.ObliqueAstigmatism(*args, coefficient=1, **kwargs)

Zernike polynomial with n=2, m=-2.

Parameters

coefficient (float) – The coefficient of the polynomial

ObliqueTrefoil

class deeptrack.aberrations.ObliqueTrefoil(*args, coefficient=1, **kwargs)

Zernike polynomial with n=3, m=-3.

Parameters

coefficient (float) – The coefficient of the polynomial

Piston

class deeptrack.aberrations.Piston(*args, coefficient=1, **kwargs)

Zernike polynomial with n=0, m=0.

Parameters

coefficient (float) – The coefficient of the polynomial

SphericalAberration

class deeptrack.aberrations.SphericalAberration(*args, coefficient=1, **kwargs)

Zernike polynomial with n=4, m=0.

Parameters

coefficient (float) – The coefficient of the polynomial

Trefoil

class deeptrack.aberrations.Trefoil(*args, coefficient=1, **kwargs)

Zernike polynomial with n=3, m=3.

Parameters

coefficient (float) – The coefficient of the polynomial

VerticalComa

class deeptrack.aberrations.VerticalComa(*args, coefficient=1, **kwargs)

Zernike polynomial with n=3, m=-1.

Parameters

coefficient (float) – The coefficient of the polynomial

VerticalTilt

class deeptrack.aberrations.VerticalTilt(*args, coefficient=1, **kwargs)

Zernike polynomial with n=1, m=-1.

Parameters

coefficient (float) – The coefficient of the polynomial

Zernike

class deeptrack.aberrations.Zernike(n, m, coefficient=1, **kwargs)

Introduces a Zernike phase aberration.

Calculates the Zernike polynomial deined by the numbers n and m at each pixel in the pupil, multiplies it by coefficient, and adds the result to the phase of the pupil.

If n, m and coefficient are lists of equal lengths, sum the Zernike polynomials corresponding to each set of values in these lists before adding them to the phase.

Parameters
  • m (n,) – The zernike polynomial numbers.

  • coefficient (float or list of floats) – The coefficient of the polynomial

get(pupil, rho, theta, n, m, coefficient, **kwargs)

Method for altering an image Abstract method that define how the feature transforms the input. The current value of all properties will be passed as keyword arguments.

Parameters
  • image (Image or List[Image]) – The Image or list of images to transform

  • **kwargs – The current value of all properties in properties as well as any global arguments.

Returns

The transformed image or list of images

Return type

Image or List[Image]