firevision::FvRawReader Class Reference

FvRaw image reader implementation. More...

#include <fvutils/readers/fvraw.h>

Inheritance diagram for firevision::FvRawReader:

[legend]
List of all members.

Public Member Functions

 FvRawReader (const char *filename)
 Constructor.
virtual ~FvRawReader ()
 Destructor.
virtual void set_buffer (unsigned char *yuv422planar_buffer)
 Set buffer that the read image should be written to.
virtual colorspace_t colorspace ()
 Get colorspace from the just read image.
virtual unsigned int pixel_width ()
 Get width of read image in pixels.
virtual unsigned int pixel_height ()
 Get height of read image in pixels.
virtual void read ()
 Read data from file.

Static Public Member Functions

static bool is_FvRaw (const char *filename)
 Check if given file contains FvRaw image.

Detailed Description

FvRaw image reader implementation.

Author:
Tim Niemueller

Definition at line 37 of file fvraw.h.


Constructor & Destructor Documentation

firevision::FvRawReader::FvRawReader ( const char *  filename  ) 

Constructor.

Parameters:
filename filename to read from.

Definition at line 47 of file fvraw.cpp.

References firevision::colorspace_buffer_size(), and firevision::FvRawWriter::FILE_IDENTIFIER.

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

Destructor.

Definition at line 73 of file fvraw.cpp.


Member Function Documentation

colorspace_t firevision::FvRawReader::colorspace (  )  [virtual]

Get colorspace from the just read image.

Returns:
colorspace

Implements firevision::Reader.

Definition at line 88 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::colorspace, and firevision::CS_UNKNOWN.

bool firevision::FvRawReader::is_FvRaw ( const char *  filename  )  [static]

Check if given file contains FvRaw image.

Parameters:
filename file to check
Returns:
true if file contains FvRaw image, false otherwise

Definition at line 141 of file fvraw.cpp.

References firevision::FvRawWriter::FILE_IDENTIFIER.

unsigned int firevision::FvRawReader::pixel_height (  )  [virtual]

Get height of read image in pixels.

Returns:
height of image

Implements firevision::Reader.

Definition at line 110 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::height.

unsigned int firevision::FvRawReader::pixel_width (  )  [virtual]

Get width of read image in pixels.

Returns:
width of image

Implements firevision::Reader.

Definition at line 99 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::width.

void firevision::FvRawReader::read (  )  [virtual]

Read data from file.

Implements firevision::Reader.

Definition at line 121 of file fvraw.cpp.

void firevision::FvRawReader::set_buffer ( unsigned char *  yuv422planar_buffer  )  [virtual]

Set buffer that the read image should be written to.

Parameters:
yuv422planar_buffer buffer to write image to. The reader must ensure that it does the proper conversion (if needed) to YUV 422 planar format.

Implements firevision::Reader.

Definition at line 81 of file fvraw.cpp.


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