Background

class deeptrack.noises.Background(offset: float | Callable[[...], float], **kwargs)

Bases: Noise

Adds a constant value to an image

Parameters

offsetfloat

The value to add to the image

Methods Summary

get(image, offset, **kwargs)

Transform an image [abstract method].

Methods Documentation

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