Sphere

class deeptrack.scatterers.Sphere(radius: float | Callable[[...], float] = 1e-06, **kwargs)

Bases: Scatterer

Generates a spherical scatterer

Parameters

radius: float

Radius of the sphere in meters.

position: ArrayLike[float, float (, float)]

The position of the particle. Third index is optional, and represents the position in the direction normal to the camera plane.

z: float

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

value: float

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).

upsample: int

Upsamples the calculations of the pixel occupancy fraction.

Methods Summary

get(image, radius, voxel_size, **kwargs)

Abstract method to initialize the sphere scatterer

Methods Documentation

get(image: Image, radius: float | Callable[[...], float], voxel_size: float | Callable[[...], float], **kwargs) → Tuple[float, ...] | List[float] | ndarray

Abstract method to initialize the sphere scatterer