FvRawWriter Class Reference

FvRaw Writer implementation. More...

#include <fvutils/writers/fvraw.h>

Inheritance diagram for FvRawWriter:

Inheritance graph
[legend]

List of all members.


Classes

struct  FvRawHeader
 FvRaw image file header. More...

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.

Detailed Description

FvRaw Writer implementation.

This class allows for writing FvRaw images to a file.

Definition at line 29 of file fvraw.h.

Constructor & Destructor Documentation

FvRawWriter::FvRawWriter (  ) 

Constructor.

Definition at line 44 of file fvraw.cpp.

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

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 61 of file fvraw.cpp.

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

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 83 of file fvraw.cpp.

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

FvRawWriter::~FvRawWriter (  )  [virtual]

Destructor.

Definition at line 100 of file fvraw.cpp.

Member Function Documentation

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

Get write buffer.

Returns:
write buffer

Definition at line 168 of file fvraw.cpp.

void 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 Writer.

Definition at line 114 of file fvraw.cpp.

References FvRawWriter::FvRawHeader::colorspace.

void 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 Writer.

Definition at line 106 of file fvraw.cpp.

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

void FvRawWriter::write (  )  [virtual]

Write to file.

Implements Writer.

Definition at line 122 of file fvraw.cpp.

References FvRawWriter::FvRawHeader::colorspace, Writer::filename, FvRawWriter::FvRawHeader::height, and FvRawWriter::FvRawHeader::width.

Referenced by FireVisionNetworkTool::fuse_inbound_received(), and SEGenerator::linear().

Member Data Documentation

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

File identifier for FvRaw images.

Definition at line 45 of file fvraw.h.

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

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