Référence pour ultralytics/engine/results.py
Note
Ce fichier est disponible à l'adresse https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/engine/results .py. Si tu repères un problème, aide à le corriger en contribuant à une Pull Request 🛠️. Merci 🙏 !
ultralytics.engine.results.BaseTensor
Bases : SimpleClass
Classe de base tensor avec des méthodes supplémentaires pour faciliter la manipulation et la prise en charge des appareils.
Code source dans ultralytics/engine/results.py
shape
property
Retourne la forme des données tensor.
__getitem__(idx)
__init__(data, orig_shape)
Initialise le BaseTensor avec les données et la forme originale.
Paramètres :
Nom | Type | Description | Défaut |
---|---|---|---|
data |
Tensor | ndarray
|
Les prédictions, telles que les bbox, les masques et les points clés. |
requis |
orig_shape |
tuple
|
Forme originale de l'image. |
requis |
Code source dans ultralytics/engine/results.py
__len__()
cpu()
cuda()
numpy()
to(*args, **kwargs)
Renvoie une copie de tensor avec le périphérique et le type spécifiés.
ultralytics.engine.results.Results
Bases : SimpleClass
Une classe pour stocker et manipuler les résultats de l'inférence.
Attributs :
Nom | Type | Description |
---|---|---|
orig_img |
ndarray
|
Image originale sous forme de tableau numpy. |
orig_shape |
tuple
|
Forme de l'image originale au format (hauteur, largeur). |
boxes |
Boxes
|
Objet contenant des boîtes de délimitation de détection. |
masks |
Masks
|
Objet contenant des masques de détection. |
probs |
Probs
|
Objet contenant les probabilités de classe pour les tâches de classification. |
keypoints |
Keypoints
|
Objet contenant les points clés détectés pour chaque objet. |
speed |
dict
|
Dictionnaire des vitesses de prétraitement, d'inférence et de post-traitement (ms/image). |
names |
dict
|
Dictionnaire des noms de classes. |
path |
str
|
Chemin d'accès au fichier image. |
Méthodes :
Nom | Description |
---|---|
update |
Met à jour les attributs de l'objet avec les nouveaux résultats de la détection. |
cpu |
Renvoie une copie de l'objet Résultats avec tous les tenseurs sur la mémoire de l'unité centrale. |
numpy |
Renvoie une copie de l'objet Résultats avec tous les tenseurs sous forme de tableaux numpy. |
cuda |
Renvoie une copie de l'objet Résultats avec tous les tenseurs sur la mémoire du GPU. |
to |
Renvoie une copie de l'objet Résultats avec les tenseurs sur un périphérique et un type spécifiés. |
new |
Renvoie un nouvel objet Résultats avec la même image, le même chemin et les mêmes noms. |
plot |
Reporte les résultats de la détection sur une image d'entrée et renvoie une image annotée. |
show |
Affiche les résultats annotés à l'écran. |
save |
Enregistre les résultats annotés dans un fichier. |
verbose |
Renvoie une chaîne de journal pour chaque tâche, détaillant les détections et les classifications. |
save_txt |
Enregistre les résultats de la détection dans un fichier texte. |
save_crop |
Sauvegarde les images de détection recadrées. |
tojson |
Convertit les résultats de la détection au format JSON. |
Code source dans ultralytics/engine/results.py
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 316 317 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 |
|
__getitem__(idx)
__init__(orig_img, path, names, boxes=None, masks=None, probs=None, keypoints=None, obb=None)
Initialise la classe Résultats.
Paramètres :
Nom | Type | Description | Défaut |
---|---|---|---|
orig_img |
ndarray
|
L'image originale sous forme de tableau numérique. |
requis |
path |
str
|
Le chemin d'accès au fichier image. |
requis |
names |
dict
|
Un dictionnaire de noms de classes. |
requis |
boxes |
tensor
|
Une tensor 2D des coordonnées de la boîte de délimitation pour chaque détection. |
None
|
masks |
tensor
|
Un site Web 3D tensor de masques de détection, où chaque masque est une image binaire. |
None
|
probs |
tensor
|
Un site 1D tensor des probabilités de chaque classe pour la tâche de classification. |
None
|
keypoints |
tensor
|
Une tensor 2D des coordonnées des points clés pour chaque détection. |
None
|
obb |
tensor
|
Une tensor 2D des coordonnées de la boîte de délimitation orientée pour chaque détection. |
None
|
Code source dans ultralytics/engine/results.py
__len__()
cpu()
cuda()
new()
Renvoie un nouvel objet Résultats avec la même image, le même chemin et les mêmes noms.
numpy()
plot(conf=True, line_width=None, font_size=None, font='Arial.ttf', pil=False, img=None, im_gpu=None, kpt_radius=5, kpt_line=True, labels=True, boxes=True, masks=True, probs=True, show=False, save=False, filename=None)
Trace les résultats de la détection sur une image RVB d'entrée. Accepte un tableau numpy (cv2) ou une image PIL.
Paramètres :
Nom | Type | Description | Défaut |
---|---|---|---|
conf |
bool
|
Indique s'il faut tracer le score de confiance de la détection. |
True
|
line_width |
float
|
La largeur de ligne des boîtes de délimitation. Si elle est nulle, elle est adaptée à la taille de l'image. |
None
|
font_size |
float
|
La taille de la police du texte. Si elle est nulle, elle est adaptée à la taille de l'image. |
None
|
font |
str
|
La police à utiliser pour le texte. |
'Arial.ttf'
|
pil |
bool
|
Indique si l'image doit être renvoyée en tant qu'image PIL. |
False
|
img |
ndarray
|
Trace une autre image. Si ce n'est pas le cas, trace l'image originale. |
None
|
im_gpu |
Tensor
|
Image normalisée dans gpu avec la forme (1, 3, 640, 640), pour un tracé plus rapide du masque. |
None
|
kpt_radius |
int
|
Rayon des points clés dessinés. La valeur par défaut est 5. |
5
|
kpt_line |
bool
|
S'il faut tracer des lignes reliant les points clés. |
True
|
labels |
bool
|
Indique s'il faut tracer l'étiquette des boîtes de délimitation. |
True
|
boxes |
bool
|
Indique s'il faut tracer les boîtes de délimitation. |
True
|
masks |
bool
|
S'il faut tracer les masques. |
True
|
probs |
bool
|
Si tu veux tracer la probabilité de la classification |
True
|
show |
bool
|
Permet d'afficher directement l'image annotée. |
False
|
save |
bool
|
Si tu veux enregistrer l'image annotée dans |
False
|
filename |
str
|
Nom de fichier pour enregistrer l'image si l'option Save est True. |
None
|
Retourne :
Type | Description |
---|---|
ndarray
|
Un tableau numpy de l'image annotée. |
Exemple
from PIL import Image
from ultralytics import YOLO
model = YOLO('yolov8n.pt')
results = model('bus.jpg') # results list
for r in results:
im_array = r.plot() # plot a BGR numpy array of predictions
im = Image.fromarray(im_array[..., ::-1]) # RGB PIL image
im.show() # show image
im.save('results.jpg') # save image
Code source dans ultralytics/engine/results.py
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 |
|
save(filename=None, *args, **kwargs)
Sauvegarde l'image des résultats annotés.
save_crop(save_dir, file_name=Path('im.jpg'))
Sauvegarde les prévisions recadrées dans save_dir/cls/file_name.jpg
.
Paramètres :
Nom | Type | Description | Défaut |
---|---|---|---|
save_dir |
str | Path
|
Sauvegarde le chemin d'accès. |
requis |
file_name |
str | Path
|
Nom du fichier. |
Path('im.jpg')
|
Code source dans ultralytics/engine/results.py
save_txt(txt_file, save_conf=False)
Enregistre les prédictions dans un fichier txt.
Paramètres :
Nom | Type | Description | Défaut |
---|---|---|---|
txt_file |
str
|
chemin du fichier txt. |
requis |
save_conf |
bool
|
Sauvegarde ou non le score de confiance. |
False
|
Code source dans ultralytics/engine/results.py
show(*args, **kwargs)
summary(normalize=False, decimals=5)
Convertis les résultats en un format résumé.
Code source dans ultralytics/engine/results.py
to(*args, **kwargs)
Renvoie une copie de l'objet Résultats avec les tenseurs sur le périphérique et le type spécifiés.
tojson(normalize=False, decimals=5)
update(boxes=None, masks=None, probs=None, obb=None)
Mets à jour les attributs boxes, masks et probs de l'objet Results.
Code source dans ultralytics/engine/results.py
verbose()
Renvoie la chaîne du journal pour chaque tâche.
Code source dans ultralytics/engine/results.py
ultralytics.engine.results.Boxes
Bases : BaseTensor
Gère les boîtes de détection en facilitant l'accès et la manipulation des coordonnées des boîtes, des scores de confiance, des identificateurs de classe et des identificateurs de suivi optionnels. et des identifiants de suivi optionnels. Prend en charge plusieurs formats pour les coordonnées des boîtes, y compris les formes absolues et normalisées. formes normalisées.
Attributs :
Nom | Type | Description |
---|---|---|
data |
Tensor
|
Le site tensor brut contenant les boîtes de détection et leurs données associées. |
orig_shape |
tuple
|
La taille de l'image originale sous forme de tuple (hauteur, largeur), utilisée pour la normalisation. |
is_track |
bool
|
Indique si les identifiants de suivi sont inclus dans les données de la boîte. |
Propriétés
xyxy (torch.Tensor | numpy.ndarray) : Boîtes au format [x1, y1, x2, y2].
conf (torch.Tensor | numpy.ndarray) : Scores de confiance pour chaque boîte.
cls (torch.Tensor | numpy.ndarray) : Étiquettes de classe pour chaque boîte.
id (torch.Tensor | numpy.ndarray, optionnel) : Identifiants de suivi pour chaque boîte, s'ils sont disponibles.
xywh (torch.Tensor | numpy.ndarray) : Boîtes au format [x, y, largeur, hauteur], calculées à la demande.
xyxyn (torch.Tensor | numpy.ndarray) : Boîtes normalisées [x1, y1, x2, y2], par rapport à orig_shape
.
xywhn (torch.Tensor | numpy.ndarray) : Boîtes [x, y, largeur, hauteur] normalisées, par rapport à orig_shape
.
Méthodes :
Nom | Description |
---|---|
cpu |
Déplace les boîtes dans la mémoire de l'unité centrale. |
numpy |
Convertit les cases en un format de tableau numpy. |
cuda |
Déplace les boîtes vers la mémoire CUDA (GPU). |
to |
Déplace les boîtes vers le périphérique spécifié. |
Code source dans ultralytics/engine/results.py
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 |
|
cls
property
Renvoie les valeurs de classe des boîtes.
conf
property
Renvoie les valeurs de confiance des boîtes.
id
property
Renvoie les identifiants de piste des boîtes (si disponibles).
xywh
cached
property
Renvoie les boîtes au format xywh.
xywhn
cached
property
Renvoie les boîtes au format xywh normalisé par la taille de l'image originale.
xyxy
property
Renvoie les cases au format xyxy.
xyxyn
cached
property
Renvoie les cases au format xyxy normalisé par la taille de l'image originale.
__init__(boxes, orig_shape)
Initialise la classe Boxes.
Paramètres :
Nom | Type | Description | Défaut |
---|---|---|---|
boxes |
Tensor | ndarray
|
Un tableau tensor ou numpy contenant les boîtes de détection, avec la forme (num_boxes, 6 ou (num_boxes, 7). forme (num_boxes, 6) ou (num_boxes, 7). Les deux dernières colonnes contiennent les valeurs de confiance et de classe. Si elle est présente, la troisième dernière colonne contient les identifiants des pistes. |
requis |
orig_shape |
tuple
|
Taille de l'image originale, au format (hauteur, largeur). |
requis |
Code source dans ultralytics/engine/results.py
ultralytics.engine.results.Masks
Bases : BaseTensor
Une classe pour stocker et manipuler les masques de détection.
Attributs :
Nom | Type | Description |
---|---|---|
xy |
list
|
Une liste de segments en coordonnées de pixels. |
xyn |
list
|
Une liste de segments normalisés. |
Méthodes :
Nom | Description |
---|---|
cpu |
Renvoie les masques tensor sur la mémoire de l'unité centrale. |
numpy |
Renvoie les masques tensor sous la forme d'un tableau numpy. |
cuda |
Renvoie les masques tensor sur la mémoire du GPU. |
to |
Renvoie les masques tensor avec le périphérique et le type spécifiés. |
Code source dans ultralytics/engine/results.py
xy
cached
property
Retourne les segments en coordonnées de pixels.
xyn
cached
property
Retourne les segments normalisés.
__init__(masks, orig_shape)
Initialise la classe Masques avec les masques donnés tensor et la forme de l'image originale.
ultralytics.engine.results.Keypoints
Bases : BaseTensor
Une classe pour stocker et manipuler les points clés de détection.
Attributs :
Nom | Type | Description |
---|---|---|
xy |
Tensor
|
Une collection de points clés contenant les coordonnées x, y de chaque détection. |
xyn |
Tensor
|
Une version normalisée de xy dont les coordonnées se situent dans l'intervalle [0, 1]. |
conf |
Tensor
|
Valeurs de confiance associées aux points clés si elles sont disponibles, sinon Aucune. |
Méthodes :
Nom | Description |
---|---|
cpu |
Renvoie une copie des points clés tensor sur la mémoire de l'unité centrale. |
numpy |
Renvoie une copie des points clés tensor sous la forme d'un tableau numpy. |
cuda |
Renvoie une copie des points clés tensor sur la mémoire du GPU. |
to |
Renvoie une copie des keypoints tensor avec le périphérique et le type spécifiés. |
Code source dans ultralytics/engine/results.py
conf
cached
property
Renvoie les valeurs de confiance des points clés si elles sont disponibles, sinon aucune.
xy
cached
property
Renvoie les coordonnées x, y des points clés.
xyn
cached
property
Renvoie les coordonnées normalisées x, y des points clés.
__init__(keypoints, orig_shape)
Initialise l'objet Points clés avec les points clés de détection et la taille de l'image originale.
Code source dans ultralytics/engine/results.py
ultralytics.engine.results.Probs
Bases : BaseTensor
Une classe pour stocker et manipuler les prédictions de classification.
Attributs :
Nom | Type | Description |
---|---|---|
top1 |
int
|
Indice de la classe supérieure 1. |
top5 |
list[int]
|
Indices des 5 premières classes. |
top1conf |
Tensor
|
Confiance de la classe des 1ers. |
top5conf |
Tensor
|
Confidences des 5 premières classes. |
Méthodes :
Nom | Description |
---|---|
cpu |
Renvoie une copie de probs tensor sur la mémoire de l'unité centrale. |
numpy |
Renvoie une copie de probs tensor sous la forme d'un tableau numpy. |
cuda |
Renvoie une copie de probs tensor sur la mémoire du GPU. |
to |
Renvoie une copie de probs tensor avec le périphérique et le type spécifiés. |
Code source dans ultralytics/engine/results.py
top1
cached
property
Renvoie l'index du top 1.
top1conf
cached
property
Retourne la confiance du top 1.
top5
cached
property
Renvoie les indices des 5 premiers.
top5conf
cached
property
Retourne les confidences des 5 premiers.
__init__(probs, orig_shape=None)
Initialise la classe Probs avec les probabilités de classification et la forme originale facultative de l'image.
ultralytics.engine.results.OBB
Bases : BaseTensor
Une classe pour stocker et manipuler les boîtes de délimitation orientées (OBB).
Paramètres :
Nom | Type | Description | Défaut |
---|---|---|---|
boxes |
Tensor | ndarray
|
Un tableau tensor ou numpy contenant les boîtes de détection, de forme (num_boxes, 7) ou (num_boxes, 8). Les deux dernières colonnes contiennent les valeurs de confiance et de classe. Si elle est présente, l'avant-dernière colonne contient les identifiants des pistes, et la cinquième colonne à partir de la gauche contient la rotation. |
requis |
orig_shape |
tuple
|
Taille de l'image originale, au format (hauteur, largeur). |
requis |
Attributs :
Nom | Type | Description |
---|---|---|
xywhr |
Tensor | ndarray
|
Les cases au format [x_center, y_center, width, height, rotation]. |
conf |
Tensor | ndarray
|
Les valeurs de confiance des boîtes. |
cls |
Tensor | ndarray
|
Les valeurs de classe des boîtes. |
id |
Tensor | ndarray
|
Les identifiants de piste des boîtes (s'ils sont disponibles). |
xyxyxyxyn |
Tensor | ndarray
|
Les boîtes tournées au format xyxyxyxy normalisé par la taille de l'image d'origine. |
xyxyxyxy |
Tensor | ndarray
|
Les boîtes tournées au format xyxyxyxyxy. |
xyxy |
Tensor | ndarray
|
Les cases horizontales au format xyxyxyxyxy. |
data |
Tensor
|
L'OBB brut tensor (alias pour |
Méthodes :
Nom | Description |
---|---|
cpu |
Déplace l'objet dans la mémoire de l'unité centrale. |
numpy |
Convertit l'objet en un tableau numpy. |
cuda |
Déplace l'objet dans la mémoire CUDA. |
to |
Déplace l'objet vers l'appareil spécifié. |
Code source dans ultralytics/engine/results.py
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 |
|
cls
property
Renvoie les valeurs de classe des boîtes.
conf
property
Renvoie les valeurs de confiance des boîtes.
id
property
Renvoie les identifiants de piste des boîtes (si disponibles).
xywhr
property
Renvoie les boîtes tournées au format xywhr.
xyxy
cached
property
Renvoie les cases horizontales au format xyxy, (N, 4).
Accepte les boîtes torch et numpy.
xyxyxyxy
cached
property
Renvoie les cases au format xyxyxyxy, (N, 4, 2).
xyxyxyxyn
cached
property
Renvoie les cases au format xyxyxyxy, (N, 4, 2).
__init__(boxes, orig_shape)
Initialise la classe Boxes.
Code source dans ultralytics/engine/results.py
Créé le 2023-11-12, Mis à jour le 2024-05-08
Auteurs : Burhan-Q (1), glenn-jocher (4), Laughing-q (1)