Ellipse

class deeptrack.scatterers.Ellipse(radius: float | Callable[[...], float] = 1e-06, rotation: float | Callable[[...], float] = 0, transpose: bool | Callable[[...], bool] = False, **kwargs)

Bases: Scatterer

Generates an elliptical disk scatterer

Parameters

radius: float or array_like [float (, float)]

Radius of the ellipse in meters. If only one value, assume circular.

rotation: float

Orientation angle of the ellipse in the camera plane in radians.

position: array_like[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.

transpose: bool

If True, the ellipse is transposed as to align the first axis of the radius with the first axis of the created volume. This is applied before rotation.

Methods Summary

get(*ignore, radius, rotation, voxel_size, ...)

Abstract method to initialize the ellipse scatterer

Methods Documentation

get(*ignore, radius: Tuple[float, ...] | List[float] | ndarray | float, rotation: float | Callable[[...], float], voxel_size: float | Callable[[...], float], transpose: bool | Callable[[...], bool], **kwargs) → Tuple[float, ...] | List[float] | ndarray

Abstract method to initialize the ellipse scatterer