PointParticle

class deeptrack.optical.scatterers.PointParticle(**kwargs: Any)

Bases: VolumeScatterer

Generate a diffraction-limited point particle.

A point particle is represented by a single voxel. Subpixel positioning is handled at the optics level.

For fluorescence imaging, a point particle is a zero-dimensional emitter represented on a discrete voxel grid. To preserve the correct emitted measure under discretization, the returned voxel is scaled by the voxel volume.

Parameters

position: tuple[float, float] | tuple[float, float, float] = (32.0, 32.0)

Particle position in 2D or 3D. Third index is optional, and represents the position in the direction normal to the camera plane.

zfloat, optional

The position in the direction normal to the camera plane. Used if position is of length 2.

valuefloat, optional

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(*args, **kwargs)

Return the voxelized point particle.

Methods Documentation

get(*args: Any, **kwargs: Any) → ndarray | Tensor

Return the voxelized point particle.

The point particle is represented by a single voxel. For fluorescence imaging, this voxel is scaled by the voxel volume so that the discrete source has the correct measure under changes in grid resolution.

Parameters

*args: Any

Positional arguments passed to the method. Not used in this implementation.

**kwargs: Any

Keyword arguments passed to the method. Not used in this implementation.

Returns

np.ndarray or torch.Tensor

A (1, 1, 1) array or tensor representing the point particle.