diff --git a/docs/README.md b/docs/README.md index c74d6570..7538967d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -141,6 +141,39 @@ Function that draws a list of detections on a frame. - `draw_labels (optional)`: If `True` the detection's label will be drawn along with the detected points. - `label_size (optional)`: Size of the label being drawn along with the detected points. +## draw_boxes + +Function that draws a list of detections as boxes on a frame. This function uses the first 2 points of your [`Detection`](#detection) instances to draw a box with those points as its corners. + +##### Arguments: + +- `frame`: The OpenCV frame to draw on. +- `detections`: List of [`Detection`](#detection)s to be drawn. +- `line_color (optional)`: [`Color`](#color) of the boxes representing the detections. +- `line_width (optional)`: Width of the lines constituting the sides of the boxes representing the detections. +- `random_color (optional)`: If `True` each detection will be colored with a random color. +- `color_by_label (optional)`: If `True` detections will be colored by label. +- `draw_labels (optional)`: If `True` the detection's label will be drawn along with the detected boxes. +- `label_size (optional)`: Size of the label being drawn along with the detected boxes. + +## draw_tracked_boxes + +Function that draws a list of tracked objects on a frame. This function uses the first 2 points of your [`TrackedObject`](#trackedobject) instances to draw a box with those points as its corners. + +##### Arguments: + +- `frame`: The OpenCV frame to draw on. +- `objects`: List of [`TrackedObject`](#trackedobject)s to be drawn. +- `border_colors (optional)`: [`Color`](#color) of the boxes representing the tracked objects. +- `border_width (optional)`: Width of the lines constituting the sides of the boxes representing the tracked objects. +- `id_size (optional)`: Size of the id number being drawn on each tracked object. The id wont get drawn if `id_size` is set to 0. +- `id_thickness (optional)`: Thickness of the id number being drawn on each tracked object. +- `draw_box (optional)`: Boolean determining if the function should draw the boxes estimated by the tracked objects. If set to `True` the boxes get drawn, if set to `False` only the id numbers get drawn. Defaults to `True`. +- `color_by_label (optional)`: If `True` objects will be colored by label. +- `draw_labels (optional)`: If `True` the objects's label will be drawn along with the tracked boxes. +- `label_size (optional)`: Size of the label being drawn along with the tracked boxes. +- `label_width (optional)`: Thickness of the label being drawn along with the tracked boxes. + ## Paths Class that draws the paths taken by a set of points of interest defined from the coordinates of each tracker estimation.