Ellipsoid

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

Bases: Scatterer

Generates an ellipsoidal scatterer

Parameters

radiusfloat or array_like[float (, float, float)]

Radius of the ellipsoid in meters. If only one value, assume spherical.

rotationfloat

Rotation of the ellipsoid in about the x, y and z axis.

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

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

upsampleint

Upsamples the calculations of the pixel occupancy fraction.

transposebool

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(image, radius, rotation, voxel_size, ...)

Transform an image [abstract method].

Methods Documentation

get(image, radius, rotation, voxel_size, transpose, **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‘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.

Returns

‘Image’ or List[‘Image’]

The transformed image or list of images.

Raises

NotImplementedError

Must be overridden by subclasses.