Configuration

Variable

Default

Tunable

Description

draw_algo

(no default value)

NO

Name of drawing algorithm config block.

Input Ports

Port name

Data Type

Flags

Description

detected_object_set

kwiver:detected_object_set

_required

Set of detected objects.

image

kwiver:image

_required

Single frame image.

Output Ports

Port name

Data Type

Flags

Description

image

kwiver:image

(none)

Single frame image.

Pipefile Usage

The following sections describe the blocks needed to use this process in a pipe file.

Pipefile block

# ================================================================
process <this-proc>
  :: draw_detected_object_set
# Name of drawing algorithm config block.
  draw_algo = <value>
# ================================================================

Process connections

The following Input ports will need to be set

# This process will consume the following input ports
connect from <this-proc>.detected_object_set
         to   <upstream-proc>.detected_object_set
connect from <this-proc>.image
         to   <upstream-proc>.image

The following Output ports will need to be set

# This process will produce the following output ports
connect from <this-proc>.image
         to   <downstream-proc>.image

Class Description

class draw_detected_object_set_process : public sprokit::process

Draw detected objects on reference imagery.

\process This process draws the bounding box outlines of the detections in the supplied set on the supplied reference imagery. The actual rendering is done by the selected draw_detected_object_set algorithm implementation.

\iports

\iport{detected_object_set} Set of detected objects to render on reference image.

\iport{image} Reference image for rendering.

\oports

\oport{image} A copy of the input image with bounding boxes rendered.

\configs

\config{draw_algo} Name of the configuration subblock that selects and configures the drawing algorithm.

class priv