image_file_reader

Configuration

Variable

Default

Tunable

Description

error_mode

fail

NO

How to handle file not found errors. Options are ‘abort’ and ‘skip’. Specifying
‘fail’ will cause an exception to be thrown. The ‘pass’ option will only log a
warning and wait for the next file name.

image_reader

(no default value)

NO

Algorithm configuration subblock.

path

(no default value)

NO

Path to search for image file. The format is the same as the standard path
specification, a set of directories separated by a colon (‘:’)

Input Ports

Port name

Data Type

Flags

Description

image_file_name

kwiver:image_file_name

_required

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

Output Ports

Port name

Data Type

Flags

Description

image

kwiver:image

(none)

Single frame image.

image_file_name

kwiver:image_file_name

(none)

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

timestamp

kwiver:timestamp

(none)

Timestamp for input image.

Pipefile Usage

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

Pipefile block

# ================================================================
process <this-proc>
  :: image_file_reader
# How to handle file not found errors. Options are 'abort' and 'skip'.
# Specifying 'fail' will cause an exception to be thrown. The 'pass' option
# will only log a warning and wait for the next file name.
  error_mode = fail
# Algorithm configuration subblock.
  image_reader = <value>
# Path to search for image file. The format is the same as the standard path
# specification, a set of directories separated by a colon (':')
  path = <value>
# ================================================================

Process connections

The following Input ports will need to be set

# This process will consume the following input ports
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
connect from <this-proc>.image
         to   <downstream-proc>.image
connect from <this-proc>.image_file_name
         to   <downstream-proc>.image_file_name
connect from <this-proc>.timestamp
         to   <downstream-proc>.timestamp

Class Description

class image_file_reader_process : public sprokit::process

Reads a series of images.

\oports \oport{image}

\oport{frame} \oport{time}

\configs

\config{error_mode} (string) \config{path} (string) \config{frame_time} (double) \config{image_reader} (string)

class priv