Homepage Demos Overview Downloads Tutorials Reference
Credits

FilterBankEvent Class Reference

#include <FilterBankEvent.h>

Inheritance diagram for FilterBankEvent:

Inheritance graph
[legend]
List of all members.

Detailed Description

This event gives access to a set of image channels at different resolutions, see FilterBankGenerator.

Definition at line 9 of file FilterBankEvent.h.

Public Member Functions

 FilterBankEvent (FilterBankGenerator *creator, EventBase::EventGeneratorID_t gid, unsigned int sid)
 constructor
FilterBankGeneratorgetSource () const
 Gives access to underlying generator.
unsigned int getNumLayers () const
 returns the number of image layers (e.g. different resolutions available)
unsigned int getNumChannels () const
 returns the number of channels per image (e.g. Y, U, or V components)
unsigned char * getImage (unsigned int layer, unsigned int channel) const
 returns pointer to the beginning of the image data for the specified layer and channel
unsigned int getWidth (unsigned int layer) const
 returns width of the image in a given layer
unsigned int getHeight (unsigned int layer) const
 returns height of the image in a given layer
unsigned int getSkip (unsigned int layer) const
 returns the bytes to skip from the one-past-end of a row to get the beginning of the next
unsigned int getStride (unsigned int layer) const
 returns the bytes to skip from the beginning of one row to get the beginning of the next
unsigned int getIncrement (unsigned int layer) const
 returns the increment to use to go from one sample to the next
unsigned int getFrameNumber () const
 returns the frame number, see FilterBankGenerator::frameNumber
unsigned int getFramesProcessed () const
 returns the number of frames processed by the generator, see FilterBankGenerator::framesProcessed

Protected Attributes

FilterBankGeneratorsrc
 pointer to generator which created this event

Private Member Functions

 FilterBankEvent (const FilterBankEvent &fbk)
 don't call
const FilterBankEventoperator= (const FilterBankEvent &fbk)
 don't call


Constructor & Destructor Documentation

FilterBankEvent::FilterBankEvent FilterBankGenerator creator,
EventBase::EventGeneratorID_t  gid,
unsigned int  sid
[inline]
 

constructor

Definition at line 12 of file FilterBankEvent.h.

FilterBankEvent::FilterBankEvent const FilterBankEvent fbk  )  [private]
 

don't call


Member Function Documentation

unsigned int FilterBankEvent::getFrameNumber  )  const [inline]
 

returns the frame number, see FilterBankGenerator::frameNumber

Definition at line 42 of file FilterBankEvent.h.

unsigned int FilterBankEvent::getFramesProcessed  )  const [inline]
 

returns the number of frames processed by the generator, see FilterBankGenerator::framesProcessed

Definition at line 44 of file FilterBankEvent.h.

unsigned int FilterBankEvent::getHeight unsigned int  layer  )  const [inline]
 

returns height of the image in a given layer

Definition at line 32 of file FilterBankEvent.h.

Referenced by BallDetectionGenerator::processEvent(), and BallDetectionGenerator::testSendEvent().

unsigned char* FilterBankEvent::getImage unsigned int  layer,
unsigned int  channel
const [inline]
 

returns pointer to the beginning of the image data for the specified layer and channel

this will cause the data to be calculated and cached if it's not already available

Definition at line 27 of file FilterBankEvent.h.

Referenced by BallDetectionGenerator::processEvent().

unsigned int FilterBankEvent::getIncrement unsigned int  layer  )  const [inline]
 

returns the increment to use to go from one sample to the next

Definition at line 39 of file FilterBankEvent.h.

unsigned int FilterBankEvent::getNumChannels  )  const [inline]
 

returns the number of channels per image (e.g. Y, U, or V components)

Definition at line 23 of file FilterBankEvent.h.

unsigned int FilterBankEvent::getNumLayers  )  const [inline]
 

returns the number of image layers (e.g. different resolutions available)

Definition at line 20 of file FilterBankEvent.h.

Referenced by BallDetectionGenerator::processEvent(), and BallDetectionGenerator::testSendEvent().

unsigned int FilterBankEvent::getSkip unsigned int  layer  )  const [inline]
 

returns the bytes to skip from the one-past-end of a row to get the beginning of the next

Definition at line 34 of file FilterBankEvent.h.

FilterBankGenerator* FilterBankEvent::getSource  )  const [inline]
 

Gives access to underlying generator.

Definition at line 17 of file FilterBankEvent.h.

Referenced by FilterBankGenerator::processEvent(), RawCamBehavior::writeColor(), SegCamBehavior::writeRLE(), SegCamBehavior::writeSeg(), and RawCamBehavior::writeSingleChannel().

unsigned int FilterBankEvent::getStride unsigned int  layer  )  const [inline]
 

returns the bytes to skip from the beginning of one row to get the beginning of the next

This is just for convenience; the stride is just the skip plus the width, but it's precomputed for you for speed and clarity

Definition at line 37 of file FilterBankEvent.h.

unsigned int FilterBankEvent::getWidth unsigned int  layer  )  const [inline]
 

returns width of the image in a given layer

Definition at line 30 of file FilterBankEvent.h.

Referenced by BallDetectionGenerator::processEvent(), and BallDetectionGenerator::testSendEvent().

const FilterBankEvent& FilterBankEvent::operator= const FilterBankEvent fbk  )  [private]
 

don't call


Member Data Documentation

FilterBankGenerator* FilterBankEvent::src [protected]
 

pointer to generator which created this event

the generator holds all the actual image data to be more memory efficient

Definition at line 49 of file FilterBankEvent.h.

Referenced by FilterBankEvent(), getFrameNumber(), getFramesProcessed(), getHeight(), getImage(), getIncrement(), getNumChannels(), getNumLayers(), getSkip(), getStride(), and getWidth().


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

Tekkotsu v2.2.1
Generated Tue Nov 23 16:37:46 2004 by Doxygen 1.3.9.1