Clip

class deeptrack.math.Clip(min: float | Callable[[...], float] = -inf, max: float | Callable[[...], float] = inf, **kwargs)

Bases: Feature

Clip the input within a minimum and a maximum value.

Parameters

min: float

Clip the input to be larger than this value.

max: float

Clip the input to be smaller than this value.

Methods Summary

get(image[, min, max])

Transform an image [abstract method].

Methods Documentation

get(image, min=None, max=None, **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: np.ndarray or list of np.ndarray or Image or list of Images

The image or list of images to transform.

**kwargs: dict of str to Any

The current value of all properties in properties, as well as any global arguments passed to the feature.

Returns

Image or list of Images

The transformed image or list of images.

Raises

NotImplementedError

Raised if this method is not overridden by subclasses.