Skip to content

Reference Path Visualization

Class: ReferencePathVisualizationBlockV1

Source: inference.core.workflows.core_steps.visualizations.reference_path.v1.ReferencePathVisualizationBlockV1

The Reference Path Visualization block draws reference path in the image. To be used in combination with Path deviation block - to display the reference path.

Type identifier

Use the following identifier in step "type" field: roboflow_core/reference_path_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..
reference_path List[Any] Reference path in a format [(x1, y1), (x2, y2), (x3, y3), ...].
color str Color of the zone..
thickness int Thickness of the lines in pixels..

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 Reference Path Visualization in version v1.

Input and Output Bindings

The available connections depend on its binding kinds. Check what binding kinds Reference Path 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..
    • reference_path (list_of_values): Reference path in a format [(x1, y1), (x2, y2), (x3, y3), ...].
    • color (string): Color of the zone..
    • thickness (integer): Thickness of the lines in pixels..
  • output

    • image (image): Image in workflows.
Example JSON definition of step Reference Path Visualization in version v1
{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/reference_path_visualization@v1",
    "image": "$inputs.image",
    "copy_image": true,
    "reference_path": "$inputs.expected_path",
    "color": "WHITE",
    "thickness": 2
}