Rescale

class deeptrack.holography.Rescale(rescale=1, **kwargs)

Bases: Feature

Rescales an optical field by subtracting the real part of the field before multiplication.

Parameters

rescalefloat

index of z-propagator matrix

Methods Summary

get(image, rescale, **kwargs)

Transform an image [abstract method].

Methods Documentation

get(image, rescale, **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.