Fawkes API  Fawkes Development Version
firevision::PNMReader Class Reference

PNM file reader. More...

#include <>>

Inheritance diagram for firevision::PNMReader:

Public Member Functions

 PNMReader (const char *filename)
 Constructor. More...
 
virtual ~PNMReader ()
 Destructor. More...
 
virtual void set_buffer (unsigned char *yuv422planar_buffer)
 Set buffer that the read image should be written to. More...
 
virtual colorspace_t colorspace ()
 Get colorspace from the just read image. More...
 
virtual unsigned int pixel_width ()
 Get width of read image in pixels. More...
 
virtual unsigned int pixel_height ()
 Get height of read image in pixels. More...
 
virtual void read ()
 Read data from file. More...
 
- Public Member Functions inherited from firevision::Reader
virtual ~Reader ()
 Virtual empty destructor. More...
 

Detailed Description

PNM file reader.

Author
Daniel Beck

Definition at line 36 of file pnm.h.

Constructor & Destructor Documentation

◆ PNMReader()

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

Constructor.

Parameters
filenamename of the PNM file

Definition at line 49 of file pnm.cpp.

◆ ~PNMReader()

firevision::PNMReader::~PNMReader ( )
virtual

Destructor.

Definition at line 130 of file pnm.cpp.

Member Function Documentation

◆ colorspace()

colorspace_t firevision::PNMReader::colorspace ( )
virtual

Get colorspace from the just read image.

Returns
colorspace

Implements firevision::Reader.

Definition at line 144 of file pnm.cpp.

Referenced by firevision::MirrorCalibTool::load_mask().

◆ pixel_height()

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

Get height of read image in pixels.

Returns
height of image

Implements firevision::Reader.

Definition at line 156 of file pnm.cpp.

Referenced by firevision::MirrorCalibTool::load_mask().

◆ pixel_width()

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

Get width of read image in pixels.

Returns
width of image

Implements firevision::Reader.

Definition at line 150 of file pnm.cpp.

Referenced by firevision::MirrorCalibTool::load_mask().

◆ read()

void firevision::PNMReader::read ( )
virtual

Read data from file.

Implements firevision::Reader.

Definition at line 162 of file pnm.cpp.

Referenced by firevision::MirrorCalibTool::load_mask().

◆ set_buffer()

void firevision::PNMReader::set_buffer ( unsigned char *  yuv422planar_buffer)
virtual

Set buffer that the read image should be written to.

Parameters
yuv422planar_bufferbuffer 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 138 of file pnm.cpp.

Referenced by firevision::MirrorCalibTool::load_mask().


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