iLab Neuromorphic Robotics Toolkit  0.1
nrt::ImageFilesSource Class Reference

#include <ImageFilesSource.H>


A SeekableImageSourceType for opening sequences of images.

This ImageSourceType is used to read a sequence of image files as a continuous stream. The files are selected by setting the 'images' parameter, using a syntax like /path/to/my/images#.jpg. Image files are decoded using the nrt::readImage() method, and available Image readers can be found in nrt/ImageProc/IO/ImageSource/ImageReaders

Definition at line 50 of file ImageFilesSource.H.

Inheritance diagram for nrt::ImageFilesSource:
nrt::SeekableImageSourceType

List of all members.

Public Member Functions

GenericImage const in ()
 Read the next image in the stream.
bool const seek (size_t const frameNumber)
 Seek to the requested frame number.
bool const ok () const
 Return whether or not the next call to in() will return a valid GenericImage.
FrameRange const frameRange () const
 Get the FrameRange of this source.
size_t const nextFrameNumber () const
 Get the current frame number.

Static Public Member Functions

static std::string const id ()
 Get the name associated with our --in type.
static std::string const description ()
 Get a description to show for --help.

Member Function Documentation

bool const nrt::ImageFilesSource::seek ( size_t const  frameNumber) [virtual]

Seek to the requested frame number.

Returns:
Whether or not the seek was successful

Implements nrt::SeekableImageSourceType.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines