RL_SequenceReader Class Reference

Input Stream class for reading Roadlab Sequence. More...

#include <RL_SequenceReader.hpp>

List of all members.

Public Member Functions
	RL_SequenceReader ()
	Default constructor for RL_SequenceReader. Initiates new RL_GPSData and RL_CANData.
	RL_SequenceReader (char *filename)
	Constructor for RL_SequenceReader with the file name. Initiates new RL_GPSData and RL_CANData, then opens a sequence file.
virtual	~RL_SequenceReader ()
	Deconstructor.
bool	SetFile (char *filename)
	SetFile: opens new file. If there were a file already open. The function will assume the sequence was recorded with the same configuration as priviously opened sequences.
bool	ReadFrame ()
	ReadFrame: read single frame from input stream and store on data.
IplImage *	GrabFrame (int i)
	GrabFrame: Returns last image frame read.
unsigned int	GrabSerials (int i)
	GrabSerials: Returns the serial number for the image frame with given index. This function is required in order to load correct calibration parameters.
unsigned int	GetNumberOfFrames ()
	GetNumberOfFrames: Returns the number of cameras used to record the sequence.
int	GetFrameWidth ()
	GetFrameWidth: Returns the width of each image frame.
int	GetFrameHeight ()
	GetFrameHeight: Returns the height of each image frame.
int	GetNumberOfChannels ()
	GetNumberOfChannels: Returns number of channels in recorded image frame.
void	GetCANStruct (CANStruct *canInfo, int index)
RL_GPSData *	GetGPSData ()
	GetGPSData: Returns last GPS data.

---

Detailed Description

Input Stream class for reading Roadlab Sequence.

---

Member Function Documentation

int RL_SequenceReader::GetFrameHeight

(

)

GetFrameHeight: Returns the height of each image frame.

Returns:

int - The height of the image frame

int RL_SequenceReader::GetFrameWidth

(

)

GetFrameWidth: Returns the width of each image frame.

Returns:

int - The width of the image frame

RL_GPSData * RL_SequenceReader::GetGPSData

(

)

GetGPSData: Returns last GPS data.

Returns:

RL_GPSData* - The last GPS data read

int RL_SequenceReader::GetNumberOfChannels

(

)

GetNumberOfChannels: Returns number of channels in recorded image frame.

Returns:

int - 1 for grayscale and 3 for RGB image

unsigned int RL_SequenceReader::GetNumberOfFrames

(

)

GetNumberOfFrames: Returns the number of cameras used to record the sequence.

Returns:

unsigned int - number of cameras used to record the sequence

IplImage * RL_SequenceReader::GrabFrame

(

int

i )

GrabFrame: Returns last image frame read.

Parameters:

int	i - image frame index

Returns:

IplImage* - returns NULL in case of error

unsigned int RL_SequenceReader::GrabSerials

(

int

i )

GrabSerials: Returns the serial number for the image frame with given index. This function is required in order to load correct calibration parameters.

Parameters:

int	i - image frame index

Returns:

unsigned int - a serial number of the camera

bool RL_SequenceReader::ReadFrame

(

)

ReadFrame: read single frame from input stream and store on data.

Returns:

bool - true if read input stream succesfully false if read input stream fails

bool RL_SequenceReader::SetFile

(

char *

filename )

SetFile: opens new file. If there were a file already open. The function will assume the sequence was recorded with the same configuration as priviously opened sequences.

Parameters:

char	*filename - File name

Returns:

bool - true if open the input stream succesfully false if open the input stream fails

---

The documentation for this class was generated from the following files:

• RL_Reader/src/RL_SequenceReader.hpp
• RL_Reader/src/RL_SequenceReader.cpp