Configuration

Variable	Default	Tunable	Description
footer	bottom	NO	Footer text for image display. Displayed centered at bottom of image.
gsd	3.14159	NO	Meters per pixel scaling.
header	top	NO	Header text for image display.

Input Ports

Port name	Data Type	Flags	Description
image	kwiver:image	_required	Single frame image.
timestamp	kwiver:timestamp	(none)	Timestamp for input 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>
  :: template
# Footer text for image display. Displayed centered at bottom of image.
  footer = bottom
# Meters per pixel scaling.
  gsd = 3.14159
# Header text for image display.
  header = top
# ================================================================

Process connections

The following Input ports will need to be set

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

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 template_process : public sprokit::process

brief description

Process template.

\process Full description of process.

\iports

\iport{timestamp} time stamp for incoming images.

\iport{image} Input image to be processed.

\oports

\oport{image} Resulting image

\configs

\config{header} Header text. (string)

\config{footer} Footer text (string)

class priv