Reference for ultralytics/trackers/track.py
Note
This file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/track.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
ultralytics.trackers.track.on_predict_start
on_predict_start(predictor: object, persist: bool = False) -> None
Initialize trackers for object tracking during prediction.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
predictor
|
object
|
The predictor object to initialize trackers for. |
required |
persist
|
bool
|
Whether to persist the trackers if they already exist. |
False
|
Raises:
Type | Description |
---|---|
AssertionError
|
If the tracker_type is not 'bytetrack' or 'botsort'. |
ValueError
|
If the task is 'classify' as classification doesn't support tracking. |
Examples:
Initialize trackers for a predictor object:
>>> predictor = SomePredictorClass()
>>> on_predict_start(predictor, persist=True)
Source code in ultralytics/trackers/track.py
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 |
|
ultralytics.trackers.track.on_predict_postprocess_end
on_predict_postprocess_end(predictor: object, persist: bool = False) -> None
Postprocess detected boxes and update with object tracking.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
predictor
|
object
|
The predictor object containing the predictions. |
required |
persist
|
bool
|
Whether to persist the trackers if they already exist. |
False
|
Examples:
Postprocess predictions and update with tracking
>>> predictor = YourPredictorClass()
>>> on_predict_postprocess_end(predictor, persist=True)
Source code in ultralytics/trackers/track.py
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 |
|
ultralytics.trackers.track.register_tracker
register_tracker(model: object, persist: bool) -> None
Register tracking callbacks to the model for object tracking during prediction.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
object
|
The model object to register tracking callbacks for. |
required |
persist
|
bool
|
Whether to persist the trackers if they already exist. |
required |
Examples:
Register tracking callbacks to a YOLO model
>>> model = YOLOModel()
>>> register_tracker(model, persist=True)
Source code in ultralytics/trackers/track.py
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
|