Tracking¶
Track module for detection tracking functionality.
This module provides tracking utilities and classes for object detection.
ReClass ¶
ReClass(
num_frames: int = 25,
threshold: float = 0.75,
model: str = "rtdetr",
weights: str = "x",
device: str = "auto",
default_class: int = 0,
match_class: list | None = None,
)
ReClass is responsible for re-classifying object tracks in video frames using detection results.
Attributes:
| Name | Type | Description |
|---|---|---|
detector |
Detector
|
The detection model used for re-classification. |
num_frames |
int
|
Number of frames to consider for re-classification. |
threshold |
float
|
Threshold for matching detections to tracks. |
default_class |
int
|
Default class to assign if no match is found. |
match_class |
list
|
List of classes to match during re-classification. |
Methods:
| Name | Description |
|---|---|
match_mmv |
Matches a track to detections and computes the average score. |
re_classify |
tracks: pd.DataFrame, input_video: str, track_ids: list = None, out_file: str = None, verbose: bool = True |
) -> pd.DataFrame |
Re-classifies tracks and returns a DataFrame with results. |
Re-classify tracks based on detection results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
num_frames
|
int
|
Number of frames to consider for re-classification, default 25 |
25
|
threshold
|
float
|
Threshold for matching, default 0.75 |
0.75
|
model
|
str
|
Detection model to use, default 'rtdetr' |
'rtdetr'
|
weights
|
str
|
Weights for the detection model, default 'x' |
'x'
|
device
|
str
|
Device to use for detection, default 'auto' |
'auto'
|
default_class
|
int
|
Default class to assign if no match found, default 0 (pedestrian) |
0
|
match_class
|
list
|
List of classes to match, default [1, 36] (bicycle, skateboard/scooter) |
None
|
Source code in src/dnt/track/re_class.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | |
match_mmv ¶
match_mmv(
track: DataFrame, dets: DataFrame
) -> tuple[bool, float]
Match track bboxes to detection bboxes and compute average overlap score.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
track
|
DataFrame
|
DataFrame containing track data with columns [x, y, w, h, frame]. |
required |
dets
|
DataFrame
|
DataFrame containing detection data with columns [x, y, w, h, frame, class]. |
required |
Returns:
| Type | Description |
|---|---|
tuple[bool, float]
|
A tuple (hit, avg_score) where: - hit : bool True if average overlap score meets threshold, False otherwise. - avg_score : float Average Intersection over Box (IoB) score across all matched detections. |
Notes
Only frames present in both track and detection datasets are considered. The matching uses IoB metric from the engine.iob module.
Source code in src/dnt/track/re_class.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | |
re_classify ¶
re_classify(
tracks: DataFrame,
input_video: str,
track_ids: list | None = None,
out_file: str | None = None,
verbose: bool = True,
) -> pd.DataFrame
Re-classify tracks using detection matching against reference image frame samples.
For each track, extracts the top N largest frames (by area), runs detection on those frames, and matches detections against the track bboxes using IoB metric. Assigns the highest-scoring match class if confidence exceeds self.threshold.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tracks
|
DataFrame
|
Input tracks DataFrame with required columns: track, x, y, w, h, frame. Additional columns are preserved in output. |
required |
input_video
|
str
|
Path to source video file from which to extract frame samples. |
required |
track_ids
|
list | None
|
List of track IDs to re-classify. If None (default), all tracks in the input are re-classified. |
None
|
out_file
|
str | None
|
Path to save re-classified results as CSV. If None (default), results are not saved to file. |
None
|
verbose
|
bool
|
If True (default), display progress bar during re-classification. |
True
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
Output DataFrame with columns [track, cls, avg_score] where: - track : int Track ID from input tracks. - cls : int Re-classified class ID. Set to default_class if no match found. - avg_score : float Maximum IoB score among matched detections, rounded to 2 decimals. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If input tracks DataFrame is empty. |
FileNotFoundError
|
If input_video does not exist. |
Notes
The method considers only the top N frames (self.num_frames) by bounding box area for computational efficiency. It matches detections from match_class list against track bboxes and selects the class with highest average score.
Examples:
>>> import pandas as pd
>>> from .re_class import ReClass
>>> tracks = pd.DataFrame({
... 'frame': [0, 1, 2],
... 'track': [1, 1, 1],
... 'x': [100, 102, 104],
... 'y': [50, 52, 54],
... 'w': [50, 50, 50],
... 'h': [100, 100, 100],
... })
>>> rc = ReClass(num_frames=2, threshold=0.75, match_class=[1, 36])
>>> result = rc.re_classify(tracks, 'video.mp4')
>>> print(result) # DataFrame with [track, cls, avg_score]
Source code in src/dnt/track/re_class.py
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | |
BoostTrackConfig
dataclass
¶
BoostTrackConfig(
model: MOTModels = MOTModels.BOOSTTRACK,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
reid_weights: ReIDWeights
| str
| None = ReIDWeights.OSNET_X1_0_MSMT17,
det_thresh: float = 0.3,
max_age: int = 30,
min_hits: int = 3,
iou_threshold: float = 0.3,
asso_func: str = "iou",
)
Bases: MOTBaseConfig
BoostTrack-specific parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
reid_weights |
ReIDWeights | str | None
|
Optional ReID weights path (default: |
det_thresh |
float
|
Detection confidence threshold (default: |
max_age |
int
|
Maximum age of unmatched tracks (default: |
min_hits |
int
|
Minimum hits before track confirmation (default: |
iou_threshold |
float
|
IoU threshold for association (default: |
asso_func |
str
|
Association function name (default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
BoTSORTConfig
dataclass
¶
BoTSORTConfig(
model: MOTModels = MOTModels.BOTSORT,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
reid_weights: ReIDWeights
| str
| None = ReIDWeights.OSNET_X1_0_MSMT17,
track_high_thresh: float = 0.5,
track_low_thresh: float = 0.1,
new_track_thresh: float = 0.6,
match_thresh: float = 0.8,
track_buffer: int = 30,
with_reid: bool = True,
proximity_thresh: float = 0.5,
appearance_thresh: float = 0.25,
)
Bases: MOTBaseConfig
BoTSORT-specific parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
reid_weights |
ReIDWeights | str | None
|
Optional ReID weights path (default: |
track_high_thresh |
float
|
High score threshold for first association (default: |
track_low_thresh |
float
|
Lower score threshold for second association (default: |
new_track_thresh |
float
|
Threshold to initialize new tracks (default: |
match_thresh |
float
|
Matching threshold for association (default: |
track_buffer |
int
|
Number of frames to keep lost tracks (default: |
with_reid |
bool
|
Whether to enable ReID-assisted association (default: |
proximity_thresh |
float
|
Proximity threshold for ReID matching (default: |
appearance_thresh |
float
|
Appearance similarity threshold for ReID matching (default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
ByteTrackConfig
dataclass
¶
ByteTrackConfig(
model: MOTModels = MOTModels.BYTE_TRACK,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
track_thresh: float = 0.5,
match_thresh: float = 0.8,
track_buffer: int = 30,
frame_rate: int = 30,
)
Bases: MOTBaseConfig
ByteTrack-specific parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
track_thresh |
float
|
Detection confidence threshold (default: |
match_thresh |
float
|
Threshold for matching detections to tracks (default: |
track_buffer |
int
|
Number of frames to keep lost tracks (default: |
frame_rate |
int
|
Source video frame rate used by the tracker (default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
DeepOCSORTConfig
dataclass
¶
DeepOCSORTConfig(
model: MOTModels = MOTModels.DEEPOCSORT,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
reid_weights: ReIDWeights
| str
| None = ReIDWeights.OSNET_X1_0_MSMT17,
det_thresh: float = 0.3,
max_age: int = 30,
min_hits: int = 3,
iou_threshold: float = 0.3,
asso_func: str = "iou",
delta_t: int = 3,
inertia: float = 0.2,
)
Bases: MOTBaseConfig
DeepOCSORT-specific parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
reid_weights |
ReIDWeights | str | None
|
Optional ReID weights path (default: |
det_thresh |
float
|
Detection confidence threshold (default: |
max_age |
int
|
Maximum age of unmatched tracks (default: |
min_hits |
int
|
Minimum hits before track confirmation (default: |
iou_threshold |
float
|
IoU threshold for association (default: |
asso_func |
str
|
Association function name (default: |
delta_t |
int
|
Time gap used by motion compensation (default: |
inertia |
float
|
Motion inertia weight (default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
HybridSORTConfig
dataclass
¶
HybridSORTConfig(
model: MOTModels = MOTModels.HYBRIDSORT,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
reid_weights: ReIDWeights
| str
| None = ReIDWeights.OSNET_X1_0_MSMT17,
det_thresh: float = 0.3,
max_age: int = 30,
min_hits: int = 3,
iou_threshold: float = 0.3,
asso_func: str = "iou",
)
Bases: MOTBaseConfig
HybridSORT-specific parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
reid_weights |
ReIDWeights | str | None
|
Optional ReID weights path (default: |
det_thresh |
float
|
Detection confidence threshold (default: |
max_age |
int
|
Maximum age of unmatched tracks (default: |
min_hits |
int
|
Minimum hits before track confirmation (default: |
iou_threshold |
float
|
IoU threshold for association (default: |
asso_func |
str
|
Association function name (default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
MOTBaseConfig
dataclass
¶
MOTBaseConfig(
model: MOTModels = MOTModels.BOTSORT,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
)
Common configuration fields for BoxMOT tracker creation.
Attributes:
| Name | Type | Description |
|---|---|---|
model |
MOTModels
|
BoxMOT tracker backend for this parameter bundle
(default: |
per_class |
bool
|
Whether to run tracking independently per class (default: |
extra_kwargs |
dict[str, Any]
|
Additional kwargs merged into tracker construction arguments
(default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
MOTModels ¶
Bases: StrEnum
Supported tracker backends exposed by BoxMOT.
Attributes:
| Name | Type | Description |
|---|---|---|
BOTSORT |
str
|
BoT-SORT tracker name used by BoxMOT. Good default when you want motion + appearance matching. |
BOOSTTRACK |
str
|
BoostTrack tracker name used by BoxMOT. Usually improves association under difficult motion/crowding. |
BYTE_TRACK |
str
|
ByteTrack tracker name used by BoxMOT. Faster and simpler; does not require ReID weights. |
OCSORT |
str
|
OCSORT tracker name used by BoxMOT. Motion-centric tracker; useful when appearance features are unreliable. |
STRONGSORT |
str
|
StrongSORT tracker name used by BoxMOT. Appearance-heavy tracker; typically more robust to long occlusions. |
DEEPOCSORT |
str
|
DeepOCSORT tracker name used by BoxMOT. OCSORT variant enhanced with appearance features. |
HYBRIDSORT |
str
|
HybridSORT tracker name used by BoxMOT. Hybrid strategy between motion and appearance matching. |
SFSORT |
str
|
SFSort tracker name used by BoxMOT. Lightweight motion-centric tracking for real-time pipelines. |
OCSORTConfig
dataclass
¶
OCSORTConfig(
model: MOTModels = MOTModels.OCSORT,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
det_thresh: float = 0.3,
max_age: int = 30,
min_hits: int = 3,
iou_threshold: float = 0.3,
asso_func: str = "iou",
delta_t: int = 3,
inertia: float = 0.2,
)
Bases: MOTBaseConfig
OCSORT-specific parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
det_thresh |
float
|
Detection confidence threshold (default: |
max_age |
int
|
Maximum age of unmatched tracks (default: |
min_hits |
int
|
Minimum hits before track confirmation (default: |
iou_threshold |
float
|
IoU threshold for association (default: |
asso_func |
str
|
Association function name (default: |
delta_t |
int
|
Time gap used by motion compensation (default: |
inertia |
float
|
Motion inertia weight (default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
ReIDWeights ¶
Bases: StrEnum
Built-in BoxMOT ReID weight file names.
Use these enum values for reid_weights in tracker parameter dataclasses.
SFSORTConfig
dataclass
¶
SFSORTConfig(
model: MOTModels = MOTModels.SFSORT,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
det_thresh: float = 0.3,
max_age: int = 30,
min_hits: int = 3,
iou_threshold: float = 0.3,
asso_func: str = "iou",
)
Bases: MOTBaseConfig
SFSORT-specific parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
det_thresh |
float
|
Detection confidence threshold (default: |
max_age |
int
|
Maximum age of unmatched tracks (default: |
min_hits |
int
|
Minimum hits before track confirmation (default: |
iou_threshold |
float
|
IoU threshold for association (default: |
asso_func |
str
|
Association function name (default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
StrongSORTConfig
dataclass
¶
StrongSORTConfig(
model: MOTModels = MOTModels.STRONGSORT,
per_class: bool = False,
extra_kwargs: dict[str, Any] = dict(),
reid_weights: ReIDWeights
| str
| None = ReIDWeights.OSNET_X1_0_MSMT17,
max_dist: float = 0.2,
max_iou_dist: float = 0.7,
max_age: int = 70,
n_init: int = 3,
nn_budget: int = 100,
ema_alpha: float = 0.9,
mc_lambda: float = 0.995,
)
Bases: MOTBaseConfig
StrongSORT-specific parameters.
Attributes:
| Name | Type | Description |
|---|---|---|
reid_weights |
ReIDWeights | str | None
|
Optional ReID weights path (default: |
max_dist |
float
|
Maximum cosine distance for appearance matching (default: |
max_iou_dist |
float
|
Maximum IoU distance for geometric matching (default: |
max_age |
int
|
Maximum age of unmatched tracks (default: |
n_init |
int
|
Minimum hits before track confirmation (default: |
nn_budget |
int
|
Maximum size of appearance feature gallery (default: |
ema_alpha |
float
|
EMA factor for appearance embeddings (default: |
mc_lambda |
float
|
Motion compensation blending factor (default: |
to_kwargs ¶
to_kwargs() -> dict[str, Any]
Convert dataclass fields to keyword arguments for BoxMOT tracker creation.
Source code in src/dnt/track/tracker.py
189 190 191 192 193 194 195 | |
to_dict ¶
to_dict() -> dict[str, Any]
Return dataclass values as a serializable dictionary.
Source code in src/dnt/track/tracker.py
197 198 199 | |
from_dict
classmethod
¶
from_dict(data: dict[str, Any]) -> MOTBaseConfig
Build a parameter object from a dictionary.
Unknown keys are stored in extra_kwargs.
Source code in src/dnt/track/tracker.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
export_yaml ¶
export_yaml(yaml_file: str) -> None
Export parameters to a YAML file.
Source code in src/dnt/track/tracker.py
232 233 234 235 236 237 | |
import_yaml
classmethod
¶
import_yaml(yaml_file: str) -> MOTBaseConfig
Import parameters from a YAML file.
Source code in src/dnt/track/tracker.py
239 240 241 242 243 244 245 246 247 | |
Tracker ¶
Tracker(
config: BoxMOTModelParams | None = None,
config_yaml: str | None = None,
device: str = "auto",
half: bool = False,
output_score_cls: bool = True,
boxmot_verbose: bool = False,
)
Unified interface for BoxMOT tracking and track post-processing.
This class runs BoxMOT tracking given a detection file and source video. It also provides post-processing utilities to infill missing frames, split tracks by large gaps, and drop short tracks.
Attributes:
| Name | Type | Description |
|---|---|---|
TRACK_FIELDS |
list[str]
|
Standard output columns for tracking and post-processing utilities (default: class constant). |
device |
str
|
Device string used by deep trackers (default: |
half |
bool
|
Whether half precision is enabled for deep trackers (default: |
boxmot_model |
MOTModels
|
Selected BoxMOT tracker backend (default: |
boxmot_config |
BoxMOTModelConfig
|
Configuration dataclass instance for BoxMOT tracker creation (default: model-specific defaults). |
boxmot_verbose |
bool
|
If False, suppress BoxMOT INFO/SUCCESS logging output. |
output_score_cls |
bool
|
Whether to include tracker |
REID_WEIGHTS_DIR |
Path
|
Directory where relative ReID weights are resolved and stored. |
DEFAULT_REID_WEIGHT |
str
|
Fallback ReID weight file name used when a model expects ReID and no weight is explicitly set. |
Initialize the tracker.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
BoxMOTModelConfig
|
Configuration bundle for BoxMOT tracker creation. Tracker backend
is selected from |
None
|
config_yaml
|
str
|
YAML file containing model-aware config. When provided,
values loaded from YAML override |
None
|
device
|
str
|
Device string used by deep trackers (default: |
'auto'
|
half
|
bool
|
Whether half precision is enabled for deep trackers (default: |
False
|
output_score_cls
|
bool
|
If True, output tracker confidence and class values in |
True
|
boxmot_verbose
|
bool
|
If False, suppress BoxMOT INFO/SUCCESS logging output. |
False
|
Source code in src/dnt/track/tracker.py
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 | |
track ¶
track(
det_file: str,
out_file: str,
video_file: str | None = None,
show: bool = False,
video_index: int | None = None,
video_tot: int | None = None,
message: str | None = None,
) -> pd.DataFrame
Run tracking on a single detection file using BoxMOT.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
det_file
|
str
|
Path to detection file in DNT detection format (frame, -, x, y, width, height, confidence, class_id). |
required |
out_file
|
str
|
Path to write tracking results. If empty string, results are not saved. |
required |
video_file
|
str
|
Path to source video file. Required for BoxMOT tracker. |
None
|
show
|
bool
|
If True (default: False), display live tracking preview with bounding boxes and track IDs. Press 's' to toggle preview, 'ESC' to hide, 'q' to stop tracking early. |
False
|
video_index
|
int
|
Index of current video in batch (for progress bar display). |
None
|
video_tot
|
int
|
Total number of videos in batch (for complete progress context). |
None
|
message
|
str | None
|
Optional progress text shown in the progress bar. If None, the video stem is used (default: None). |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
Tracking results with columns: frame, track, x, y, w, h, score, cls, r3, r4 Each row represents one detected object per frame. |
Raises:
| Type | Description |
|---|---|
FileNotFoundError
|
If det_file or video_file does not exist. |
ValueError
|
If video_file is None. |
Notes
The tracker processes detections frame-by-frame, maintaining track IDs across frames. Detection coordinates are converted from (x1, y1, x2, y2) to (x, y, width, height) format for BoxMOT.
Track IDs are persistent across frame sequences and reused if tracks are lost and then re-acquired within track_buffer frames.
Source code in src/dnt/track/tracker.py
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 | |
track_batch ¶
track_batch(
det_files: list[str] | None = None,
video_files: list[str] | None = None,
output_path: str | None = None,
is_overwrite: bool = False,
is_report: bool = True,
message: str | None = None,
) -> list[str]
Run tracking on multiple detection files sequentially.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
det_files
|
list[str] | None
|
List of detection file paths. Each file should contain frame-level detections in CSV format. If None (default), returns empty list. |
None
|
video_files
|
list[str] | None
|
List of corresponding source video file paths for each detection file. Length should match det_files. Required for BoxMOT tracking. |
None
|
output_path
|
str | None
|
Directory to save tracking results. Track files are named based on input filename with '_track.txt' suffix. If None (default), tracking still runs but results are not persisted. |
None
|
is_overwrite
|
bool
|
If False (default), skip tracking for videos with existing output files. |
False
|
is_report
|
bool
|
If True (default), include skipped files in returned list. |
True
|
message
|
str | None
|
Optional progress text shown in each tracking progress bar. If None (default), each video's stem is used. |
None
|
Returns:
| Type | Description |
|---|---|
list[str]
|
List of output track file paths. Includes both newly created and existing files (if is_report=True). Empty list if det_files is None. |
Notes
Processing is sequential (not parallel). Each detection file is tracked in order with progress display showing "Tracking X of Y".
Files matching between det_files and video_files by index position. If video_files is shorter than det_files, missing videos are left None and those detections are skipped.
Source code in src/dnt/track/tracker.py
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 | |
export_config_to_yaml
staticmethod
¶
export_config_to_yaml(
yaml_file: str, config: BoxMOTModelParams
) -> None
Export model-aware BoxMOT config to a YAML file.
Source code in src/dnt/track/tracker.py
994 995 996 997 998 999 1000 1001 1002 1003 | |
import_config_from_yaml
staticmethod
¶
import_config_from_yaml(
yaml_file: str,
) -> BoxMOTModelParams
Import model-aware BoxMOT config from a YAML file.
Source code in src/dnt/track/tracker.py
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 | |
export_params_to_yaml
staticmethod
¶
export_params_to_yaml(
yaml_file: str, params: BoxMOTModelParams
) -> None
Export model-aware BoxMOT params to a YAML file (backward-compatible wrapper).
Source code in src/dnt/track/tracker.py
1019 1020 1021 1022 1023 1024 1025 | |
import_params_from_yaml
staticmethod
¶
import_params_from_yaml(
yaml_file: str,
) -> BoxMOTModelParams
Import model-aware BoxMOT params from a YAML file (backward-compatible wrapper).
Source code in src/dnt/track/tracker.py
1027 1028 1029 1030 | |
export_current_config_to_yaml ¶
export_current_config_to_yaml(yaml_file: str) -> None
Export this tracker's active model and config to YAML.
Source code in src/dnt/track/tracker.py
1032 1033 1034 1035 1036 1037 | |
export_current_params_to_yaml ¶
export_current_params_to_yaml(yaml_file: str) -> None
Export this tracker's active model and config to YAML (backward-compatible wrapper).
Source code in src/dnt/track/tracker.py
1039 1040 1041 | |
interpolate_tracks_rts ¶
interpolate_tracks_rts(
tracks: DataFrame | None = None,
track_file: str | None = None,
output_file: str | None = None,
col_names: list[str] | None = None,
fill_gaps_only: bool = True,
smooth_existing: bool = False,
process_var: float = 10.0,
meas_var_pos: float = 25.0,
meas_var_size: float = 16.0,
min_track_len: int = 2,
max_gap: int = 30,
add_interp_flag: bool = True,
interp_col: str = "interp",
verbose: bool = True,
video_index: int | None = None,
video_tot: int | None = None,
) -> pd.DataFrame
Interpolate trajectory gaps in each track chain using RTS smoothing.
Applies a constant-velocity Kalman filter per track on bounding box center and size states, then runs Rauch-Tung-Striebel (RTS) smoothing from FilterPy to produce smooth, continuous trajectories. Missing frames are interpolated with velocity estimates.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tracks
|
DataFrame
|
Input track data with columns at minimum: frame, track, x, y, w, h.
May also contain cls, score, and other columns which are preserved.
If None, |
None
|
track_file
|
str
|
CSV file path to read tracks from when |
None
|
output_file
|
str
|
CSV file path to write the interpolated results. |
None
|
col_names
|
list[str]
|
Column names to apply when input columns are positional integers. Default is ["frame","track","x","y","w","h","score","cls","r3","r4"]. |
None
|
fill_gaps_only
|
bool
|
If True (default), only interpolate frames without observations. If False, also smooth observed frames. |
True
|
smooth_existing
|
bool
|
If True, apply smoothed state to observed frames. Only used when fill_gaps_only is True. Default is False. |
False
|
process_var
|
float
|
Process noise variance for Kalman filter. Controls model uncertainty. Default is 10.0. |
10.0
|
meas_var_pos
|
float
|
Measurement noise variance for position (cx, cy). Default is 25.0. |
25.0
|
meas_var_size
|
float
|
Measurement noise variance for size (w, h). Default is 16.0. |
16.0
|
min_track_len
|
int
|
Minimum track length to apply interpolation. Tracks shorter than this are returned as-is. Default is 2. |
2
|
max_gap
|
int
|
Maximum number of consecutive missing frames allowed to interpolate within a track chain. Gaps larger than this value are not filled. Default is 30. |
30
|
add_interp_flag
|
bool
|
If True (default), add column with interpolation flags (0=observed, 1=interpolated). |
True
|
interp_col
|
str
|
Name of the interpolation flag column. Default is "interp". |
'interp'
|
verbose
|
bool
|
If True, show tqdm progress bar over tracks. Default is True. |
True
|
video_index
|
int
|
Current video index for progress description. Default is None. |
None
|
video_tot
|
int
|
Total videos for progress description. Default is None. |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
Output tracks with interpolated frames. Columns include all input columns plus interp_col if add_interp_flag is True. Frame indices are continuous within each track after interpolation. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If tracks has fewer than 6 columns (when columns are not named). |
Notes
The Kalman filter uses an 8-state constant-velocity model: [cx, vx, cy, vy, w, vw, h, vh] where (cx, cy) is bounding box center, (w, h) is size, and (vx, vy, vw, vh) are their velocities.
Input coordinates assume [x, y, w, h] format where x, y is top-left corner. These are converted to center coordinates for Kalman processing.
Frame gaps within tracks are filled by interpolation. If a track has missing frames between observations, the filter predicts values for those frames based on velocity estimates from nearby observations.
Examples:
>>> import pandas as pd
>>> import numpy as np
>>> # Create sample track with gaps
>>> tracks = pd.DataFrame({
... 'frame': [0, 1, 5, 6],
... 'track': [1, 1, 1, 1],
... 'x': [10.0, 12.0, 20.0, 22.0],
... 'y': [20.0, 22.0, 30.0, 32.0],
... 'w': [100.0, 100.0, 100.0, 100.0],
... 'h': [50.0, 50.0, 50.0, 50.0],
... })
>>> result = interpolate_tracks_rts(tracks, fill_gaps_only=True)
>>> print(result[['frame', 'track', 'interp']]) # Shows interpolated frames
Source code in src/dnt/track/post_process.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 | |
link_tracklets ¶
link_tracklets(
tracks: DataFrame | None = None,
track_file: str | None = None,
output_file: str | None = None,
col_names: list[str] | None = None,
max_gap: int = 20,
vel_frames: int = 5,
size_ratio_max: float = 2.0,
dist_mult: float = 2.5,
iou_min: float = 0.05,
w_d: float = 1.0,
w_iou: float = 1.0,
w_s: float = 0.3,
verbose: bool = True,
video_index: int | None = None,
video_tot: int | None = None,
) -> pd.DataFrame
Reconnect broken tracklets using global optimal 1-to-1 matching.
Links tracklets (short track segments) by computing a cost matrix based on spatial proximity, appearance similarity (IoU), and size consistency. Uses linear sum assignment (Hungarian algorithm) to find optimal matches, then merges tracklets via union-find to handle transitive connections.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tracks
|
DataFrame | None
|
Input track data with columns: frame, track, x, y, w, h, and optionally
score, cls, interp, r4. If None (default), |
None
|
track_file
|
str | None
|
CSV file path to read tracks from when |
None
|
output_file
|
str | None
|
CSV file path to write linked results. If None (default), results are not saved to file. |
None
|
col_names
|
list[str] | None
|
Column names to apply when input has positional integer columns. Default: ["frame","track","x","y","w","h","score","cls","interp","r4"]. |
None
|
max_gap
|
int
|
Maximum frame gap between tracklet end and start to attempt linking. Default is 20. |
20
|
vel_frames
|
int
|
Number of recent frames to use for velocity estimation (polynomial fit). Default is 5. |
5
|
size_ratio_max
|
float
|
Maximum allowed width/height ratio between tracklet end and start. Default is 2.0. Values outside [1/ratio_max, ratio_max] are rejected. |
2.0
|
dist_mult
|
float
|
Distance threshold multiplier: distance_threshold = dist_mult * sqrt(area). Default is 2.5. Larger values allow more spatial flexibility. |
2.5
|
iou_min
|
float
|
Minimum Intersection over Union (IoU) between predicted and actual start box. Default is 0.05. Range [0.0, 1.0]. |
0.05
|
w_d
|
float
|
Weight for normalized distance cost in weighted sum. Default is 1.0. |
1.0
|
w_iou
|
float
|
Weight for (1 - IoU) cost in weighted sum. Default is 1.0. |
1.0
|
w_s
|
float
|
Weight for size inconsistency cost (log ratio) in weighted sum. Default is 0.3 (smaller weight for size). |
0.3
|
verbose
|
bool
|
If True (default), display tqdm progress bar over tracklets. |
True
|
video_index
|
int | None
|
Current video index for progress description. Default is None. |
None
|
video_tot
|
int | None
|
Total number of videos for progress description. Default is None. |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
Output tracks with linked IDs. Same columns as input. Track IDs are remapped so that all frames belonging to a logical track share the same ID. Frame and track are sorted in output. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If tracks has fewer than 6 columns and no named columns provided. |
FileNotFoundError
|
If track_file path does not exist. |
Notes
Algorithm Overview:
- Extract descriptor for each track: endpoints, velocity, bounding boxes, class
- Build cost matrix using spatial (distance, IoU), appearance (class), and size (width/height ratio) metrics with weighted combination
- Solve linear sum assignment problem (Hungarian algorithm) to find optimal 1-to-1 tracklet pairings with minimum total cost
- Use Union-Find (Disjoint Set Union) to handle transitive merges: if tracklet A links to B and B links to C, they all get merged to same group
- Remap all track IDs according to merged components
Cost Function Details:
- Velocity is estimated using polynomial fit (1st order) on recent observed frames
- Predicted next tracklet start = end_position + velocity * temporal_gap
- Distance is normalized by sqrt(bounding_box_area) for scale invariance
- Only considers tracklets from same class (if class info available)
- Skips linking if temporal gap, size ratio, or distance threshold exceeded
Input Requirements:
- Requires "frame", "track", "x", "y", "w", "h" columns minimum
- If "interp" column exists, uses only rows with interp==0 for velocity estimation
- If "cls" column exists, only links tracklets with same class
Examples:
>>> import pandas as pd
>>> # Create sample tracklets
>>> tracks = pd.DataFrame({
... 'frame': [0, 1, 10, 11, 20, 21],
... 'track': [1, 1, 2, 2, 3, 3],
... 'x': [10, 12, 25, 27, 40, 42],
... 'y': [20, 22, 35, 37, 50, 52],
... 'w': [50, 50, 50, 50, 50, 50],
... 'h': [100, 100, 100, 100, 100, 100],
... 'cls': [1, 1, 1, 1, 1, 1],
... })
>>> linked = link_tracklets(tracks, max_gap=15, verbose=False)
>>> # Track IDs may now be remapped: e.g., [1, 1, 1, 1, 1, 1]
>>> print(linked['track'].unique()) # All in same track if linked
Source code in src/dnt/track/post_process.py
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 | |