PointParticle#

class deeptrack.scatterers.PointParticle(**kwargs)#

Generates a point particle

A point particle is approximated by the size of a pixel. For subpixel positioning, the position is interpolated linearly.

Parameters#

positionarray_like of length 2 or 3: The position of the particle. Third index is optional, and represents the position in the direction normal to the camera plane.
zfloat: The position in the direction normal to the camera plane. Used if position is of length 2.
valuefloat: A default value of the characteristic of the particle. Used by optics unless a more direct property is set: (eg. refractive_index for Brightfield and intensity for Fluorescence).

Methods Summary

get(image, **kwargs)

Transform an image [abstract method].

Methods Documentation

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

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.