pfs::Channel Class Reference

Channel interface represents a 2D rectangular array with associated tags. More...

#include <pfs.h>

Inheritance diagram for pfs::Channel:

pfs::Array2D

List of all members.

Public Member Functions

int getWidth () const
 Gets width of the channel (in pixels).
virtual int getHeight () const
 Gets height of the channel (in pixels).
virtual const char * getName () const =0
 Gets name of the channel.
virtual TagContainergetTags ()=0
 Returns TagContainer that can be used to access or modify tags associated with this Channel object.
virtual float * getRawData ()=0
 For performance reasons, the channels can be accessed as a table of float values.


Detailed Description

Channel interface represents a 2D rectangular array with associated tags.

Definition at line 182 of file pfs.h.


Member Function Documentation

int pfs::Channel::getWidth (  )  const [inline]

Gets width of the channel (in pixels).

This is a synonym for Array2D::getCols().

Definition at line 188 of file pfs.h.

virtual int pfs::Channel::getHeight (  )  const [inline, virtual]

Gets height of the channel (in pixels).

This is a synonym for Array2D::getRows().

Definition at line 196 of file pfs.h.

virtual float* pfs::Channel::getRawData (  )  [pure virtual]

For performance reasons, the channels can be accessed as a table of float values.

Data is given in row-major order, i.e. it is indexed data[x+y*width]. If performance is not crucial, use Array2D interface instead.

Returns:
a table of floats of the size width*height


The documentation for this class was generated from the following file:
Generated on Tue Nov 25 17:23:48 2008 for Portable Floating-point Streams (pfstools) by  doxygen 1.5.3