Cleaner

class byotrack.implementation.refiner.cleaner.Cleaner(min_length: int, max_dist: float)

Bases: Refiner

Cleaner refiner.

Split tracklet when the distance between two consecutive points is greater than max_dist. And delete tracks that are shorter than min_length.

Warning

It will not split when the position of the track is NaN.

Warning

merge_id is only set on the last split track, which may be deleted (if too short).

min_length

Minimum length of tracks kept

Type:

int

max_dist

Maximum distance between two consecutive points in a track

Type:

float

run(video, tracks: Collection[byotrack.Track]) → list[byotrack.Track]

Run the refiner on a whole video.

Parameters:

• video (Sequence[np.ndarray] | np.ndarray | None) – Optional sequence of T frames (array). Each array is expected to have a shape ([D, ]H, W, C). Some refiners may not require any video. In that case, you may provide explicitly None.

• tracks (Collection[byotrack.Track]) – Tracks of particles

Returns:

Refined tracks of particles

Return type:

Collection[byotrack.Track]

static clean_tracks(tracks: Collection[byotrack.Track], min_length: int, max_dist: float) → list[byotrack.Track]

Clean tracks.

Split tracklet when the distance between two consecutive points is greater than max_dist. And delete tracks that are shorter than min_length.

Warning

It will not split when the position of the track is NaN.

Warning

parent_id is only set on the first split track, which may be deleted (if too short). merge_id is only set on the last split track, which may be deleted (if too short).

XXX: Stop duplicating identifiers.

Parameters:

• tracks (Collection[Track]) – Tracks to clean

• min_length (int) – Minimum length of tracks kept

• max_dist (float) – Maximum distance between two consecutive points in a track If max_dist <= 0, splitting is not done

Returns:

Cleaned tracks

Return type:

list[Track]