ocetrac.Tracker.track

Tracker.track()

Label and track image features.

Parameters

daxarray.DataArray

The data to label.

maskxarray.DataArray

The mask of points to ignore. Must be binary where 1 = true point and 0 = background to be ignored.

radiusint

The size of the structuring element used in morphological opening and closing. Radius specified by the number of grid units.

Structuring elements are defined such that cells are included if their distance from the origin in index space is strictly less than the radius. For example, a radius of 1 means that the structuring element includes just an individual pixel (such that applying the morhological closing and opening just returns the original binary array), while a radius of 2 would additionally include the eight cells cells adjacent to the origin. As the radius increases, the shape of the structure element asymptotes to a circle centered on the origin.

min_size_quartilefloat

The quantile used to define the threshold of the smallest area object retained in tracking. Value should be between 0 and 1. A value of exactly 0 means objects of any size are retained while a value of 1 retains just the single largest event. Higher values of min_size_quartile result in improved performance because less events are stored in memory and need to be compared.

timedimstr

The name of the time dimension

xdimstr

The name of the x dimension

ydimstr

The name of the y dimension

positivebool

True if da values are expected to be positive, false if they are negative. Default argument is True

Returns

labelsxarray.DataArray

Integer labels of the connected regions.