firevision::CompressedImageWriter Class Reference

Writer for arbitrarily compressed images. More...

#include <fvutils/writers/compressed.h>

Inheritance diagram for firevision::CompressedImageWriter:

[legend]
List of all members.

Public Member Functions

 CompressedImageWriter (ImageCompressor *ic=NULL)
 Constructor.
virtual ~CompressedImageWriter ()
 Destructor.
virtual void set_filename (const char *filename)
 Set filename.
virtual void set_dimensions (unsigned int width, unsigned int height)
 Set dimensions of image in pixels.
virtual void set_buffer (colorspace_t cspace, unsigned char *buffer)
 Set image buffer.
virtual void write ()
 Write to file.
virtual void set_image_compressor (ImageCompressor *ic)
 Set image compressor.

Detailed Description

Writer for arbitrarily compressed images.

This class uses any image compressor to write compressed images to a file.

Author:
Tim Niemueller

Definition at line 37 of file compressed.h.


Constructor & Destructor Documentation

firevision::CompressedImageWriter::CompressedImageWriter ( ImageCompressor ic = NULL  ) 

Constructor.

Parameters:
ic ImageCompressor to use for image compression

Definition at line 52 of file compressed.cpp.

References firevision::Writer::buffer, firevision::CS_UNKNOWN, firevision::Writer::cspace, firevision::Writer::filename, firevision::Writer::height, and firevision::Writer::width.

firevision::CompressedImageWriter::~CompressedImageWriter (  )  [virtual]

Destructor.

Definition at line 64 of file compressed.cpp.

References firevision::Writer::filename.


Member Function Documentation

void firevision::CompressedImageWriter::set_buffer ( colorspace_t  cspace,
unsigned char *  buffer 
) [virtual]

Set image buffer.

Parameters:
cspace color space of image
buffer buffer of image

Reimplemented from firevision::Writer.

Definition at line 94 of file compressed.cpp.

References firevision::ImageCompressor::set_image_buffer().

void firevision::CompressedImageWriter::set_dimensions ( unsigned int  width,
unsigned int  height 
) [virtual]

Set dimensions of image in pixels.

Parameters:
width width of image in pixels
height height of image in pixels.

Reimplemented from firevision::Writer.

Definition at line 83 of file compressed.cpp.

References firevision::ImageCompressor::set_image_dimensions().

void firevision::CompressedImageWriter::set_filename ( const char *  filename  )  [virtual]

Set filename.

Parameters:
filename name of file to write to. This can either be the complete filename (including) extension or the basename only in which case the extension is added.

Reimplemented from firevision::Writer.

Definition at line 71 of file compressed.cpp.

References firevision::ImageCompressor::set_filename().

void firevision::CompressedImageWriter::set_image_compressor ( ImageCompressor ic  )  [virtual]

Set image compressor.

Use this method to change the used image compressor at runtime.

Parameters:
ic new image compressor.

Definition at line 136 of file compressed.cpp.

References firevision::Writer::buffer, firevision::Writer::cspace, firevision::Writer::filename, firevision::Writer::height, firevision::ImageCompressor::set_filename(), firevision::ImageCompressor::set_image_buffer(), firevision::ImageCompressor::set_image_dimensions(), and firevision::Writer::width.

void firevision::CompressedImageWriter::write (  )  [virtual]

Write to file.

Implements firevision::Writer.

Definition at line 105 of file compressed.cpp.

References firevision::ImageCompressor::COMP_DEST_FILE, firevision::ImageCompressor::COMP_DEST_MEM, firevision::ImageCompressor::compress(), firevision::ImageCompressor::compressed_size(), firevision::Writer::filename, firevision::ImageCompressor::recommended_compressed_buffer_size(), firevision::ImageCompressor::set_compression_destination(), firevision::ImageCompressor::set_destination_buffer(), and firevision::ImageCompressor::supports_compression_destination().


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:31:44 2011 for Fawkes API by  doxygen 1.4.7