Fawkes API  Fawkes Development Version
firevision::SeqWriter Class Reference

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

#include <>>

Public Member Functions

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

Detailed Description

Writes a sequence of images to disk.

Author
Daniel Beck

Definition at line 36 of file seq_writer.h.

Constructor & Destructor Documentation

◆ SeqWriter()

firevision::SeqWriter::SeqWriter ( Writer writer)

Constructor.

Parameters
writerthe actual image writer

Definition at line 50 of file seq_writer.cpp.

◆ ~SeqWriter()

firevision::SeqWriter::~SeqWriter ( )

Destructor.

Definition at line 65 of file seq_writer.cpp.

Member Function Documentation

◆ set_colorspace()

void firevision::SeqWriter::set_colorspace ( colorspace_t  cspace)

Set the colorspace of the image.

Parameters
cspacethe colospace

Definition at line 107 of file seq_writer.cpp.

Referenced by FvRetrieverThread::init().

◆ set_dimensions()

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

Set the image dimensions.

Parameters
widththe width of the image
heightthe height of the image

Definition at line 99 of file seq_writer.cpp.

Referenced by FvRetrieverThread::init().

◆ set_filename()

void firevision::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
filenamethe (base-) filename

Definition at line 89 of file seq_writer.cpp.

◆ set_path()

void firevision::SeqWriter::set_path ( const char *  img_path)

Set the path to where the images are stored.

Parameters
img_paththe image path

Definition at line 77 of file seq_writer.cpp.

Referenced by FvRetrieverThread::init().

◆ write()

void firevision::SeqWriter::write ( unsigned char *  buffer)

Write a single image to disk.

A running number is added to the filename

Parameters
bufferthe image buffer that is written to disk

Definition at line 116 of file seq_writer.cpp.

Referenced by FvRetrieverThread::loop().


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