Skip to content

Bounding Box Visualization

Class: BoundingBoxVisualizationBlockV1

Source: inference.core.workflows.core_steps.visualizations.bounding_box.v1.BoundingBoxVisualizationBlockV1

The BoundingBoxVisualization block draws a box around detected objects in an image using Supervision's sv.RoundBoxAnnotator.

Type identifier

Use the following identifier in step "type" field: roboflow_core/bounding_box_visualization@v1to add the block as as step in your workflow.

Properties

Name Type Description Refs
name str Enter a unique identifier for this step..
copy_image bool Enable this option to create a copy of the input image for visualization, preserving the original. Use this when stacking multiple visualizations..
color_palette str Select a color palette for the visualised elements..
palette_size int Specify the number of colors in the palette. This applies when using custom or Matplotlib palettes..
custom_colors List[str] Define a list of custom colors for bounding boxes in HEX format..
color_axis str Choose how bounding box colors are assigned..
thickness int Set the thickness of the bounding box edges..
roundness float Define the roundness of the bounding box corners..

The Refs column marks possibility to parametrise the property with dynamic values available in workflow runtime. See Bindings for more info.

Available Connections

Compatible Blocks

Check what blocks you can connect to Bounding Box Visualization in version v1.

Input and Output Bindings

The available connections depend on its binding kinds. Check what binding kinds Bounding Box Visualization in version v1 has.

Bindings
  • input

    • image (image): Select the input image to visualize on..
    • copy_image (boolean): Enable this option to create a copy of the input image for visualization, preserving the original. Use this when stacking multiple visualizations..
    • predictions (Union[instance_segmentation_prediction, keypoint_detection_prediction, object_detection_prediction]): Predictions.
    • color_palette (string): Select a color palette for the visualised elements..
    • palette_size (integer): Specify the number of colors in the palette. This applies when using custom or Matplotlib palettes..
    • custom_colors (list_of_values): Define a list of custom colors for bounding boxes in HEX format..
    • color_axis (string): Choose how bounding box colors are assigned..
    • thickness (integer): Set the thickness of the bounding box edges..
    • roundness (float_zero_to_one): Define the roundness of the bounding box corners..
  • output

    • image (image): Image in workflows.
Example JSON definition of step Bounding Box Visualization in version v1
{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/bounding_box_visualization@v1",
    "image": "$inputs.image",
    "copy_image": true,
    "predictions": "$steps.object_detection_model.predictions",
    "color_palette": "DEFAULT",
    "palette_size": 10,
    "custom_colors": [
        "#FF0000",
        "#00FF00",
        "#0000FF"
    ],
    "color_axis": "CLASS",
    "thickness": 2,
    "roundness": 0.0
}