Referência para ultralytics/engine/results.py
Nota
Este ficheiro está disponível em https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/engine/results .py. Se detectares um problema, por favor ajuda a corrigi-lo contribuindo com um Pull Request 🛠️. Obrigado 🙏!
ultralytics.engine.results.BaseTensor
Bases: SimpleClass
Classe base tensor com métodos adicionais para facilitar a manipulação e o manuseamento de dispositivos.
Código fonte em ultralytics/engine/results.py
shape
property
Devolve a forma dos dados tensor.
__getitem__(idx)
__init__(data, orig_shape)
Inicializa o BaseTensor com os dados e a forma original.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
data |
Tensor | ndarray
|
Previsões, tais como bboxes, máscaras e pontos-chave. |
necessário |
orig_shape |
tuple
|
Forma original da imagem. |
necessário |
Código fonte em ultralytics/engine/results.py
__len__()
cpu()
cuda()
numpy()
to(*args, **kwargs)
Devolve uma cópia do tensor com o dispositivo e o dtype especificados.
ultralytics.engine.results.Results
Bases: SimpleClass
Uma classe para armazenar e manipular resultados de inferência.
Atributos:
Nome | Tipo | Descrição |
---|---|---|
orig_img |
ndarray
|
Imagem original como uma matriz numpy. |
orig_shape |
tuple
|
Forma da imagem original no formato (altura, largura). |
boxes |
Boxes
|
Objeto que contém caixas delimitadoras de deteção. |
masks |
Masks
|
Objeto que contém máscaras de deteção. |
probs |
Probs
|
Objeto que contém probabilidades de classe para tarefas de classificação. |
keypoints |
Keypoints
|
Objeto que contém os pontos-chave detectados para cada objeto. |
speed |
dict
|
Dicionário de velocidades de pré-processamento, inferência e pós-processamento (ms/imagem). |
names |
dict
|
Dicionário de nomes de classes. |
path |
str
|
Caminho para o ficheiro de imagem. |
Métodos:
Nome | Descrição |
---|---|
update |
Actualiza os atributos do objeto com novos resultados de deteção. |
cpu |
Devolve uma cópia do objeto Results com todos os tensores na memória da CPU. |
numpy |
Devolve uma cópia do objeto Results com todos os tensores como arrays numpy. |
cuda |
Retorna uma cópia do objeto Results com todos os tensores na memória da GPU. |
to |
Devolve uma cópia do objeto Results com tensores num dispositivo e tipo d especificados. |
new |
Devolve um novo objeto Results com a mesma imagem, caminho e nomes. |
plot |
Traça os resultados da deteção numa imagem de entrada, devolvendo uma imagem anotada. |
show |
Mostra os resultados anotados no ecrã. |
save |
Guarda os resultados anotados num ficheiro. |
verbose |
Devolve uma cadeia de registo para cada tarefa, detalhando as detecções e classificações. |
save_txt |
Guarda os resultados da deteção num ficheiro de texto. |
save_crop |
Guarda as imagens de deteção cortadas. |
tojson |
Converte os resultados da deteção para o formato JSON. |
Código fonte em 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)
Inicializa a classe Results.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
orig_img |
ndarray
|
A imagem original como uma matriz numpy. |
necessário |
path |
str
|
O caminho para o ficheiro de imagem. |
necessário |
names |
dict
|
Um dicionário de nomes de classes. |
necessário |
boxes |
tensor
|
Um tensor 2D de coordenadas da caixa delimitadora para cada deteção. |
None
|
masks |
tensor
|
Um tensor 3D de máscaras de deteção, em que cada máscara é uma imagem binária. |
None
|
probs |
tensor
|
Um 1D tensor de probabilidades de cada classe para a tarefa de classificação. |
None
|
keypoints |
tensor
|
Um tensor 2D de coordenadas de pontos-chave para cada deteção. |
None
|
obb |
tensor
|
Um tensor 2D de coordenadas orientadas da caixa delimitadora para cada deteção. |
None
|
Código fonte em ultralytics/engine/results.py
__len__()
cpu()
cuda()
new()
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)
Plota os resultados da deteção numa imagem RGB de entrada. Aceita uma matriz numpy (cv2) ou uma imagem PIL.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
conf |
bool
|
Se deves representar a pontuação de confiança da deteção. |
True
|
line_width |
float
|
A largura da linha das caixas delimitadoras. Se for Nenhum, é dimensionada para o tamanho da imagem. |
None
|
font_size |
float
|
O tamanho do tipo de letra do texto. Se não tiver nenhum, é redimensionado para o tamanho da imagem. |
None
|
font |
str
|
O tipo de letra a utilizar para o texto. |
'Arial.ttf'
|
pil |
bool
|
Se devolve a imagem como uma imagem PIL. |
False
|
img |
ndarray
|
Plota para outra imagem. Se não, plota para a imagem original. |
None
|
im_gpu |
Tensor
|
Normaliza a imagem na gpu com a forma (1, 3, 640, 640), para uma plotagem mais rápida da máscara. |
None
|
kpt_radius |
int
|
Desenha o raio dos pontos-chave. A predefinição é 5. |
5
|
kpt_line |
bool
|
Se deves desenhar linhas que ligam os pontos-chave. |
True
|
labels |
bool
|
Se deves desenhar a etiqueta das caixas delimitadoras. |
True
|
boxes |
bool
|
Se deves desenhar as caixas delimitadoras. |
True
|
masks |
bool
|
Se queres traçar as máscaras. |
True
|
probs |
bool
|
Se deves traçar a probabilidade de classificação |
True
|
show |
bool
|
Se pretende apresentar diretamente a imagem anotada. |
False
|
save |
bool
|
Se queres guardar a imagem anotada em |
False
|
filename |
str
|
Nome de ficheiro para onde guardar a imagem, se Guardar for Verdadeiro. |
None
|
Devolve:
Tipo | Descrição |
---|---|
ndarray
|
Uma matriz numpy da imagem anotada. |
Exemplo
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
Código fonte em 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)
Guarda a imagem dos resultados anotados.
save_crop(save_dir, file_name=Path('im.jpg'))
Guarda as previsões cortadas em save_dir/cls/file_name.jpg
.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
save_dir |
str | Path
|
Guarda o caminho. |
necessário |
file_name |
str | Path
|
Nome do ficheiro. |
Path('im.jpg')
|
Código fonte em ultralytics/engine/results.py
save_txt(txt_file, save_conf=False)
Guarda as previsões num ficheiro txt.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
txt_file |
str
|
caminho do ficheiro txt. |
necessário |
save_conf |
bool
|
guarda a pontuação de confiança ou não. |
False
|
Código fonte em ultralytics/engine/results.py
show(*args, **kwargs)
summary(normalize=False, decimals=5)
Converte os resultados para um formato resumido.
Código fonte em ultralytics/engine/results.py
to(*args, **kwargs)
Devolve uma cópia do objeto Results com tensores no dispositivo e tipo d especificados.
tojson(normalize=False, decimals=5)
update(boxes=None, masks=None, probs=None, obb=None)
Actualiza os atributos caixas, máscaras e probs do objeto Resultados.
Código fonte em ultralytics/engine/results.py
verbose()
Devolve a cadeia de registo para cada tarefa.
Código fonte em ultralytics/engine/results.py
ultralytics.engine.results.Boxes
Bases: BaseTensor
Gere as caixas de deteção, facilitando o acesso e a manipulação das coordenadas da caixa, das pontuações de confiança, dos identificadores de classe identificadores de classe e IDs de rastreamento opcionais. Suporta vários formatos para coordenadas de caixa, incluindo formas absolutas e e normalizadas.
Atributos:
Nome | Tipo | Descrição |
---|---|---|
data |
Tensor
|
O ficheiro bruto tensor contém as caixas de deteção e os dados associados. |
orig_shape |
tuple
|
O tamanho da imagem original como uma tupla (altura, largura), utilizada para normalização. |
is_track |
bool
|
Indica se os IDs de rastreamento estão incluídos nos dados da caixa. |
Propriedades
xyxy (torch.Tensor | numpy.ndarray): Caixas no formato [x1, y1, x2, y2].
conf (torch.Tensor | numpy.ndarray): Pontua a confiança para cada caixa.
cls (torch.Tensor | numpy.ndarray): Rótulos de classe para cada caixa.
id (torch.Tensor | numpy.ndarray, opcional): IDs de rastreamento para cada caixa, se disponíveis.
xywh (torch.Tensor | numpy.ndarray): Caixas no formato [x, y, largura, altura], calculadas a pedido.
xyxyn (torch.Tensor | numpy.ndarray): Caixas normalizadas [x1, y1, x2, y2], relativas a orig_shape
.
xywhn (torch.Tensor | numpy.ndarray): Caixas [x, y, largura, altura] normalizadas, relativas a orig_shape
.
Métodos:
Nome | Descrição |
---|---|
cpu |
Move as caixas para a memória da CPU. |
numpy |
Converte as caixas para um formato de matriz numpy. |
cuda |
Move as caixas para a memória CUDA (GPU). |
to |
Move as caixas para o dispositivo especificado. |
Código fonte em 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
Devolve os valores de classe das caixas.
conf
property
Devolve os valores de confiança das caixas.
id
property
Devolve as IDs de faixa das caixas (se disponíveis).
xywh
cached
property
Devolve as caixas no formato xywh.
xywhn
cached
property
Devolve as caixas no formato xywh normalizado pelo tamanho da imagem original.
xyxy
property
Devolve as caixas no formato xyxy.
xyxyn
cached
property
Devolve as caixas no formato xyxy normalizado pelo tamanho da imagem original.
__init__(boxes, orig_shape)
Inicializa a classe Caixas.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
boxes |
Tensor | ndarray
|
Uma matriz tensor ou numpy que contém as caixas de deteção, com forma (num_boxes, 6) ou (num_boxes, 7). As duas últimas colunas contêm valores de confiança e de classe. Se presente, a terceira última coluna contém IDs de trajectos. |
necessário |
orig_shape |
tuple
|
Tamanho da imagem original, no formato (altura, largura). |
necessário |
Código fonte em ultralytics/engine/results.py
ultralytics.engine.results.Masks
Bases: BaseTensor
Uma classe para armazenar e manipular máscaras de deteção.
Atributos:
Nome | Tipo | Descrição |
---|---|---|
xy |
list
|
Uma lista de segmentos em coordenadas de píxeis. |
xyn |
list
|
Uma lista de segmentos normalizados. |
Métodos:
Nome | Descrição |
---|---|
cpu |
Devolve as máscaras tensor na memória da CPU. |
numpy |
Devolve as máscaras tensor como uma matriz numpy. |
cuda |
Devolve as máscaras tensor na memória da GPU. |
to |
Devolve as máscaras tensor com o dispositivo e o dtype especificados. |
Código fonte em ultralytics/engine/results.py
xy
cached
property
Devolve segmentos em coordenadas de pixel.
xyn
cached
property
Retorna segmentos normalizados.
__init__(masks, orig_shape)
Inicializa a classe Masks (Máscaras) com as máscaras tensor e a forma da imagem original.
ultralytics.engine.results.Keypoints
Bases: BaseTensor
Uma classe para armazenar e manipular pontos-chave de deteção.
Atributos:
Nome | Tipo | Descrição |
---|---|---|
xy |
Tensor
|
Uma coleção de pontos-chave com coordenadas x, y para cada deteção. |
xyn |
Tensor
|
Uma versão normalizada de xy com coordenadas no intervalo [0, 1]. |
conf |
Tensor
|
Valores de confiança associados aos pontos-chave, se disponíveis; caso contrário, nenhum. |
Métodos:
Nome | Descrição |
---|---|
cpu |
Devolve uma cópia dos pontos-chave tensor na memória da CPU. |
numpy |
Devolve uma cópia dos pontos-chave tensor como uma matriz numpy. |
cuda |
Devolve uma cópia dos pontos-chave tensor na memória da GPU. |
to |
Devolve uma cópia dos pontos-chave tensor com o dispositivo e o dtype especificados. |
Código fonte em ultralytics/engine/results.py
conf
cached
property
Devolve os valores de confiança dos pontos-chave, se disponíveis, caso contrário, nenhum.
xy
cached
property
Devolve as coordenadas x, y dos pontos-chave.
xyn
cached
property
Devolve as coordenadas x, y normalizadas dos pontos-chave.
__init__(keypoints, orig_shape)
Inicializa o objeto Keypoints com os pontos-chave de deteção e o tamanho da imagem original.
Código fonte em ultralytics/engine/results.py
ultralytics.engine.results.Probs
Bases: BaseTensor
Uma classe para armazenar e manipular previsões de classificação.
Atributos:
Nome | Tipo | Descrição |
---|---|---|
top1 |
int
|
Índice da classe 1 superior. |
top5 |
list[int]
|
Índices das 5 primeiras classes. |
top1conf |
Tensor
|
Confiança na classe 1. |
top5conf |
Tensor
|
Confidências das 5 primeiras classes. |
Métodos:
Nome | Descrição |
---|---|
cpu |
Devolve uma cópia do probs tensor na memória da CPU. |
numpy |
Devolve uma cópia do probs tensor como uma matriz numpy. |
cuda |
Devolve uma cópia dos problemas tensor na memória da GPU. |
to |
Devolve uma cópia do probs tensor com o dispositivo e o dtype especificados. |
Código fonte em ultralytics/engine/results.py
top1
cached
property
Devolve o índice do topo 1.
top1conf
cached
property
Devolve a confiança do topo 1.
top5
cached
property
Devolve os índices dos 5 primeiros.
top5conf
cached
property
Devolve as confidências dos 5 primeiros.
__init__(probs, orig_shape=None)
Inicializa a classe Probs com probabilidades de classificação e a forma original opcional da imagem.
ultralytics.engine.results.OBB
Bases: BaseTensor
Uma classe para armazenar e manipular Oriented Bounding Boxes (OBB).
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
boxes |
Tensor | ndarray
|
Uma matriz tensor ou numpy que contém as caixas de deteção, com a forma (num_boxes, 7) ou (num_boxes, 8). As duas últimas colunas contêm valores de confiança e de classe. Se presente, a terceira última coluna contém IDs de trajectos e a quinta coluna a contar da esquerda contém a rotação. |
necessário |
orig_shape |
tuple
|
Tamanho da imagem original, no formato (altura, largura). |
necessário |
Atributos:
Nome | Tipo | Descrição |
---|---|---|
xywhr |
Tensor | ndarray
|
As caixas no formato [x_centro, y_centro, largura, altura, rotação]. |
conf |
Tensor | ndarray
|
Os valores de confiança das casas. |
cls |
Tensor | ndarray
|
Os valores de classe das caixas. |
id |
Tensor | ndarray
|
Os IDs de faixa das caixas (se disponíveis). |
xyxyxyxyn |
Tensor | ndarray
|
As caixas rodadas no formato xyxyxyxy normalizadas pelo tamanho da imagem original. |
xyxyxyxy |
Tensor | ndarray
|
As caixas rodadas no formato xyxyxyxy. |
xyxy |
Tensor | ndarray
|
As caixas horizontais no formato xyxyxyxy. |
data |
Tensor
|
O OBB em bruto tensor (pseudónimo de |
Métodos:
Nome | Descrição |
---|---|
cpu |
Move o objeto para a memória da CPU. |
numpy |
Converte o objeto em um array numpy. |
cuda |
Move o objeto para a memória CUDA. |
to |
Move o objeto para o dispositivo especificado. |
Código fonte em 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
Devolve os valores de classe das caixas.
conf
property
Devolve os valores de confiança das caixas.
id
property
Devolve as IDs de faixa das caixas (se disponíveis).
xywhr
property
Devolve as caixas rodadas no formato xywhr.
xyxy
cached
property
Devolve as caixas horizontais no formato xyxy, (N, 4).
Aceita as caixas torch e numpy.
xyxyxyxy
cached
property
Devolve as caixas no formato xyxyxyxy, (N, 4, 2).
xyxyxyxyn
cached
property
Devolve as caixas no formato xyxyxyxy, (N, 4, 2).
__init__(boxes, orig_shape)
Inicializa a classe Caixas.
Código fonte em ultralytics/engine/results.py
Criado em 2023-11-12, Atualizado em 2024-05-08
Autores: Burhan-Q (1), glenn-jocher (4), Laughing-q (1)