firevision::PNMReader Class Reference

PNM file reader. More...

#include <fvutils/readers/pnm.h>

Inheritance diagram for firevision::PNMReader:

[legend]
List of all members.

Public Member Functions

 PNMReader (const char *filename)
 Constructor.
virtual ~PNMReader ()
 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.

Detailed Description

PNM file reader.

Author:
Daniel Beck

Definition at line 36 of file pnm.h.


Constructor & Destructor Documentation

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

Constructor.

Parameters:
filename name of the PNM file

Definition at line 49 of file pnm.cpp.

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

Destructor.

Definition at line 130 of file pnm.cpp.


Member Function Documentation

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

Get colorspace from the just read image.

Returns:
colorspace

Implements firevision::Reader.

Definition at line 143 of file pnm.cpp.

References firevision::YUV422_PLANAR.

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

Get height of read image in pixels.

Returns:
height of image

Implements firevision::Reader.

Definition at line 155 of file pnm.cpp.

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

Get width of read image in pixels.

Returns:
width of image

Implements firevision::Reader.

Definition at line 149 of file pnm.cpp.

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

Read data from file.

Implements firevision::Reader.

Definition at line 161 of file pnm.cpp.

References firevision::convert(), firevision::RGB, and firevision::YUV422_PLANAR.

void firevision::PNMReader::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 137 of file pnm.cpp.


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