SeqWriter Class Reference

Writes a sequence of images to disk. More...

#include <fvutils/writers/seq_writer.h>

List of all members.


Public Member Functions

 SeqWriter (Writer *writer)
 Constructor.
 ~SeqWriter ()
 Destructor.
void set_path (const char *img_path)
 Set the path to where the images are stored.
void set_filename (const char *filename)
 Set a (base-) filename.
void set_dimensions (unsigned int width, unsigned int height)
 Set the image dimensions.
void set_colorspace (colorspace_t cspace)
 Set the colorspace of the image.
void write (unsigned char *buffer)
 Write a single image to disk.

Detailed Description

Writes a sequence of images to disk.

Author:
Daniel Beck

Definition at line 31 of file seq_writer.h.

Constructor & Destructor Documentation

SeqWriter::SeqWriter ( Writer *  writer  ) 

Constructor.

Parameters:
writer the actual image writer

Definition at line 45 of file seq_writer.cpp.

SeqWriter::~SeqWriter (  ) 

Destructor.

Definition at line 60 of file seq_writer.cpp.

Member Function Documentation

void SeqWriter::set_colorspace ( colorspace_t  cspace  ) 

Set the colorspace of the image.

Parameters:
cspace the colospace

Definition at line 102 of file seq_writer.cpp.

Referenced by FvRetrieverThread::init().

void SeqWriter::set_dimensions ( unsigned int  width,
unsigned int  height 
)

Set the image dimensions.

Parameters:
width the width of the image
height the height of the image

Definition at line 94 of file seq_writer.cpp.

References Writer::set_dimensions().

Referenced by FvRetrieverThread::init().

void SeqWriter::set_filename ( const char *  filename  ) 

Set a (base-) filename.

If a filename is set the name of the files will look like this: filename_index.ext .

Parameters:
filename the (base-) filename

Definition at line 84 of file seq_writer.cpp.

void SeqWriter::set_path ( const char *  img_path  ) 

Set the path to where the images are stored.

Parameters:
img_path the image path

Definition at line 72 of file seq_writer.cpp.

Referenced by FvRetrieverThread::init().

void SeqWriter::write ( unsigned char *  buffer  ) 

Write a single image to disk.

A running number is added to the filename

Parameters:
buffer the image buffer that is written to disk

Definition at line 111 of file seq_writer.cpp.

References Writer::set_buffer(), Writer::set_filename(), and Writer::write().

Referenced by FvRetrieverThread::loop().

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