GaussianApodization

class deeptrack.aberrations.GaussianApodization(sigma: float | Callable[[...], float] = 1, offset: Tuple[int, int] | Callable[[...], Tuple[int, int]] = (0, 0), **kwargs)

Bases: Aberration

Introduces pupil apodization.

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

Parameters

sigmafloat

The standard deviation of the apodization. The edge of the pupil is at one deviation from the center.

offset(float, float)

Offsets the center of the gaussian.

Examples

>>> particle = dt.PointParticle(z = 1 * dt.units.micrometer)
>>> aberrated_optics = dt.Fluorescence(aberration=dt.GaussianApodization(sigma=0.1))
>>> pipeline = aberrated_optics(particle)
>>> pipeline.plot()
>>> plt.show()

Methods Summary

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

Transform an image [abstract method].

Methods Documentation

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

Transform an image [abstract method].

Abstract method that defines 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.

**kwargsDict[str, Any]

The current value of all properties in properties as well as any global arguments.

Returns

‘Image’ or List[‘Image’]

The transformed image or list of images.

Raises

NotImplementedError

Must be overridden by subclasses.