Refiner

class byotrack.api.refiner.Refiner

Bases: ABC

Base class for tracks refiners.

Improve a set of tracks

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

abstractmethod run(video: Sequence[np.ndarray] | np.ndarray | None, tracks: Collection[byotrack.Track]) → Collection[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]