Configuration

Variable

Default

Tunable

Description

file_name

(no default value)

NO

Name of the detection set file to write.

writer

(no default value)

NO

Block name for algorithm parameters. e.g. writer:type would be used to specify
the algorithm type.

Input Ports

Port name

Data Type

Flags

Description

detected_object_set

kwiver:detected_object_set

_required

Set of detected objects.

image_file_name

kwiver:image_file_name

(none)

Name of an image file. The file name may contain leading path components.

Output Ports

Pipefile Usage

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

Pipefile block

# ================================================================
process <this-proc>
  :: detected_object_output
# Name of the detection set file to write.
  file_name = <value>
# Block name for algorithm parameters. e.g. writer:type would be used to
# specify the algorithm type.
  writer = <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_file_name
         to   <upstream-proc>.image_file_name

The following Output ports will need to be set

# This process will produce the following output ports

Class Description

class detected_object_output_process : public sprokit::process

Writes detected objects to a file.

\process This process writes the detected objecs in the set to a file. The actual renderingwriting is done by the selected detected_object_set_output algorithm implementation.

\iports

\iport{image_file_name} Optional name of an image file to associate with the set of detections.

\iport{detected_object_set} Set ob objects to pass to writer algorithm.

\configs

\config{file_name} Name of the file that the detections are written.

\config{writer} Name of the configuration subblock that selects and configures the writing algorithm

class priv