Skip to content

Background Color Visualization

Class: BackgroundColorVisualizationBlockV1

Source: inference.core.workflows.core_steps.visualizations.background_color.v1.BackgroundColorVisualizationBlockV1

The BackgroundColorVisualization block draws all areas outside of detected regions in an image with a specified color.

Type identifier

Use the following identifier in step "type" field: roboflow_core/background_color_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 str Color of the background..
opacity float Transparency of the Mask overlay..

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 Background Color Visualization in version v1.

Input and Output Bindings

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

Bindings
Example JSON definition of step Background Color Visualization in version v1
{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/background_color_visualization@v1",
    "image": "$inputs.image",
    "copy_image": true,
    "predictions": "$steps.object_detection_model.predictions",
    "color": "WHITE",
    "opacity": 0.5
}