Skip to content

Commit 8e25a48

Browse files
committed
Fix README.md
Fix README to better reflect how images are edited (copy of image returned) to draw boxes and labels
1 parent ea2a413 commit 8e25a48

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ The bounding box points are expected in the format: `(xmin, ymin, xmax, ymax)`
2828

2929
| **image** | **function** |
3030
|:----------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------:|
31-
| ![bbox with label on top](images/bbox_top.jpg "Bouding box with label on top") | bbv.draw_rectangle(img, bbox)<br>bbv.add_label(img, label, bbox, top=True) |
32-
| ![bbox with T label](images/bbox_T.jpg "Bouding box with label inside") | bbv.draw_rectangle(img, bbox)<br>bbv.add_T_label(img, label, bbox) |
33-
| ![label with flag](images/flag.jpg "Label that looks like a flag, pole originates from inside the object") | bbv.draw_flag_with_label(img, label, bbox) |
34-
| ![bbox with label inside](images/bbox_inside.jpg "Bouding box with label inside") | bbv.draw_rectangle(img, bbox)<br>bbv.add_label(img, label, bbox, top=False) |
35-
| ![label with opaque overlay](images/overlay.jpg "Opaque bounding box with label inside the box") | bbv.draw_rectangle(image, bbox, is_opaque=True)<br>bbv.add_label(img, label, bbox, draw_bg=False, top=False) |
36-
| ![multiple bbox](images/bbox_multiple.jpg "Multiple bounding boxes") | bbv.draw_multiple_rectangles(img, bboxes)<br>bbv.add_multiple_labels(img, labels, bboxes) |
37-
| ![multiple flags](images/bbox_multiple_flags.jpg "Multiple flags") | bbv.draw_multiple_flags_with_labels(img, labels, bboxes) |
38-
| ![multiple T bbox](images/bbox_multiple_T.jpg "Multiple bounding boxes with T labels") | bbv.draw_multiple_rectangles(img, bboxes)<br>bbv.add_multiple_T_labels(img, labels, bboxes) |
31+
| ![bbox with label on top](images/bbox_top.jpg "Bouding box with label on top") | img = bbv.draw_rectangle(img, bbox)<br>img = bbv.add_label(img, label, bbox, top=True) |
32+
| ![bbox with T label](images/bbox_T.jpg "Bouding box with label inside") | img = bbv.draw_rectangle(img, bbox)<br>img = bbv.add_T_label(img, label, bbox) |
33+
| ![label with flag](images/flag.jpg "Label that looks like a flag, pole originates from inside the object") | img = bbv.draw_flag_with_label(img, label, bbox) |
34+
| ![bbox with label inside](images/bbox_inside.jpg "Bouding box with label inside") | img = bbv.draw_rectangle(img, bbox)<br>img = bbv.add_label(img, label, bbox, top=False) |
35+
| ![label with opaque overlay](images/overlay.jpg "Opaque bounding box with label inside the box") | img = bbv.draw_rectangle(image, bbox, is_opaque=True)<br>img = bbv.add_label(img, label, bbox, draw_bg=False, top=False) |
36+
| ![multiple bbox](images/bbox_multiple.jpg "Multiple bounding boxes") | img = bbv.draw_multiple_rectangles(img, bboxes)<br>img = bbv.add_multiple_labels(img, labels, bboxes) |
37+
| ![multiple flags](images/bbox_multiple_flags.jpg "Multiple flags") | img = bbv.draw_multiple_flags_with_labels(img, labels, bboxes) |
38+
| ![multiple T bbox](images/bbox_multiple_T.jpg "Multiple bounding boxes with T labels") | img = bbv.draw_multiple_rectangles(img, bboxes)<br>img = bbv.add_multiple_T_labels(img, labels, bboxes) |
3939

4040
## There are *optional* functions that can draw multiple bounding boxes and/or write multiple labels on the same image, but it is advisable to use the above functions in a loop in order to have full control over your visualizations.
4141

0 commit comments

Comments
 (0)