IlluminationGradient

class deeptrack.optics.IlluminationGradient(gradient: Tuple[float, ...] | List[float] | ndarray | Callable[[...], Tuple[float, ...] | List[float] | ndarray] = (0, 0), constant: float | Callable[[...], float] = 0, vmin: float | Callable[[...], float] = 0, vmax: float | Callable[[...], float] = inf, **kwargs)

Bases: Feature

Adds a gradient in the illumination

Parameters

gradientarray_like[float, float]

Gradient of the plane to add to the amplitude of the field in pixels.

constantfloat

Constant value to add to the amplitude of the field.

vminfloat

clips the amplitude of the field to be at least this value

vmaxfloat

clips the amplitude of the field to be at most this value

Methods Summary

get(image, gradient, constant, vmin, vmax, ...)

Transform an image [abstract method].

Methods Documentation

get(image, gradient, constant, vmin, vmax, **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.