Refiner

class byotrack.api.refiner.Refiner

Bases: ABC, ParametrizedObjectMixin

Base class for tracks refiners

Improve a set of tracks

Each refiner can define a set of parameters (See ParametrizedObjectMixin)

abstract run(video: Sequence[ndarray] | ndarray, tracks: Collection[Track]) → Collection[Track]

Run the refiner on a whole video

Parameters:

  • video (Sequence[np.ndarray] | np.ndarray) – Sequence of T frames (array). Each array is expected to have a shape ([D, ]H, W, C)

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

Returns:

Refined tracks of particles

Return type:

Collection[byotrack.Track]