firevision::FvRawWriter Class Reference

FvRaw Writer implementation. More...

#include <fvutils/writers/fvraw.h>

Inheritance diagram for firevision::FvRawWriter:

[legend]
List of all members.

Public Member Functions

 FvRawWriter ()
 Constructor.
 FvRawWriter (const char *filename, unsigned int width, unsigned int height)
 Constructor.
 FvRawWriter (const char *filename, unsigned int width, unsigned int height, colorspace_t colorspace, unsigned char *buffer)
 Constructor.
virtual ~FvRawWriter ()
 Destructor.
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 unsigned char * get_write_buffer ()
 Get write buffer.

Static Public Attributes

static const unsigned int FILE_IDENTIFIER = 0x17559358
 File identifier for FvRaw images.

Classes

struct  FvRawHeader
 FvRaw image file header. More...

Detailed Description

FvRaw Writer implementation.

This class allows for writing FvRaw images to a file.

Author:
Tim Niemueller

Definition at line 34 of file fvraw.h.


Constructor & Destructor Documentation

firevision::FvRawWriter::FvRawWriter (  ) 

Constructor.

Definition at line 50 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::colorspace, firevision::CS_UNKNOWN, firevision::FvRawWriter::FvRawHeader::file_id, FILE_IDENTIFIER, firevision::FvRawWriter::FvRawHeader::height, and firevision::FvRawWriter::FvRawHeader::width.

firevision::FvRawWriter::FvRawWriter ( const char *  filename,
unsigned int  width,
unsigned int  height 
)

Constructor.

Parameters:
filename file name to write to
width width of image
height height of image

Definition at line 67 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::colorspace, firevision::CS_UNKNOWN, firevision::FvRawWriter::FvRawHeader::file_id, FILE_IDENTIFIER, firevision::FvRawWriter::FvRawHeader::height, firevision::Writer::set_filename(), and firevision::FvRawWriter::FvRawHeader::width.

firevision::FvRawWriter::FvRawWriter ( const char *  filename,
unsigned int  width,
unsigned int  height,
colorspace_t  colorspace,
unsigned char *  buffer 
)

Constructor.

Parameters:
filename file name to write to
width width of image
height height of image
colorspace colorspace
buffer buffer

Definition at line 89 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::colorspace, firevision::FvRawWriter::FvRawHeader::file_id, FILE_IDENTIFIER, firevision::FvRawWriter::FvRawHeader::height, firevision::Writer::set_filename(), and firevision::FvRawWriter::FvRawHeader::width.

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

Destructor.

Definition at line 106 of file fvraw.cpp.


Member Function Documentation

unsigned char * firevision::FvRawWriter::get_write_buffer (  )  [virtual]

Get write buffer.

Returns:
write buffer

Definition at line 174 of file fvraw.cpp.

void firevision::FvRawWriter::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 120 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::colorspace.

void firevision::FvRawWriter::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 112 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::height, and firevision::FvRawWriter::FvRawHeader::width.

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

Write to file.

Implements firevision::Writer.

Definition at line 128 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::colorspace, firevision::colorspace_buffer_size(), firevision::CS_UNKNOWN, firevision::Writer::filename, firevision::FvRawWriter::FvRawHeader::height, and firevision::FvRawWriter::FvRawHeader::width.

Referenced by firevision::SEGenerator::linear().


Member Data Documentation

const unsigned int firevision::FvRawWriter::FILE_IDENTIFIER = 0x17559358 [static]

File identifier for FvRaw images.

Definition at line 50 of file fvraw.h.

Referenced by firevision::FvRawReader::FvRawReader(), FvRawWriter(), and firevision::FvRawReader::is_FvRaw().


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