Homepage Demos Overview Downloads Tutorials Reference
Credits

FilterBankGenerator Class Reference

#include <FilterBankGenerator.h>

Inheritance diagram for FilterBankGenerator:

Inheritance graph
[legend]
List of all members.

Detailed Description

Abstract base class for generators of FilterBankEvent's.

This is needed to provide an interface for the FilterBankEvent to call back when the actual image data is requested from it. This facilitates lazy calculation of image data... no sense in processing layers or channels which aren't actually going to be used...

Also this way we save on allocating/deallocating large memory blocks on each event... the buffers allocated here can be reused frame to frame.

Larger layer indicies generally indicate higher resolution images in a scaling pyramid, but you are free to store your own data however you wish.

Serialization Format

First, be sure to get a good overview of the LoadSave style. Most serialization is handled using this interface.

When, for instance, RawCameraGenerator::SaveBuffer() is called, it first calls it's super class, FilterBankGenerator::SaveBuffer(), which will write out the general image information, common to all subclasses of FilterBankGenerator. (i'll cover the specifics in a second) Once that's done, the RawCameraGenerator adds it's own bit of header and then saves the image data itself.

Note that only a single channel is being saved at this point. So for instance, all the Y information. No interleaving is going on. (unless you're saving from InterleavedYUVGenerator of course, which treats the 3 interleaved channels as a single image) Otherwise,only one image (selected with selectSaveImage()) of the bank will loaded or saved at a time.

So, anyway. The first header will be the same for all FilterBankGenerator subclasses. In the specification below, I'm going to use one field per line (the new lines are not literal, it's a binary stream). Each field is of the form '<type:name> (notes)'

FilterBankGenerator Header: (from FilterBankGenerator::SaveBuffer())

  • <string: "FbkImage"> (remember a 'string' is len+str+0; so this is the literal "\010\0\0\0FbkImage\0"; also remember "\010" is octal for 8)
  • <unsigned int: width>
  • <unsigned int: height>
  • <unsigned int: image layer>
  • <unsigned int: image channel> (so notice you can tell which channel it is after it's been saved)

Generator Specific Header (selected examples follow, or similarly, any of the other generators)

  • RawCameraGenerator: (from RawCameraGenerator::SaveBuffer())
    • <string: "RawImage">
    • <char[width*height]: image data> (note, just once channel being stored)
  • InterleavedYUVGenerator: (from InterleavedYUVGenerator::SaveBuffer())
    • <string: "InterleavedYUVImage">
    • <char[width*height*3]: image data> (in YVU order, technically YCbCr)
  • SegmentedColorGenerator: (from SegmentedColorGenerator::SaveBuffer())
    • <string: "SegColorImage">
    • <char[width*height]: image data> (one byte per sample)
    • <unsigned int: num_cols> (number of different colors available)
    • for each of num_col:
      • <char: red> red color to use for display of this index
      • <char: green> green color to use for display of this index
      • <char: blue> blue color to use for display of this index
  • RLEGenerator: (from RLEGenerator::SaveBuffer())
    • <string: "RLEImage"> (remember a 'string' is len+str+0; so this is the literal "\010\0\0\0RLEImage\0"; also remember "\010" is octal for 8)
    • <unsigned int: num_runs> (how many runs will follow)
    • for each of num_runs:
      • <char: color> (index value of color of run)
      • <short: x> (x position of start of run ("unknown" runs are skipped - assume index 0 for pixels which are jumped))
      • <short: width> (length of run, will not exceed remaining width of image)
    • notice there's no color information from RLE - it's not (shouldn't be) assuming anything about the data being compressed)

However, while we're on the topic, I'll mention that although this is the same image format used for streaming to VisionGUI, there's a few more fields added by RawCamBehavior or SegCamBehavior at the beginning of each packet. See those classes for more information on the wireless protocol. That should tell you everything you need to know to interpret the vision stream as well.

Adding New FilterBankGenerator Subclasses

If you're doing fancy memory stuff, you probably want to override the freeCaches() and destruct() functions so that the default implementation won't try to free something it shouldn't. Don't forget to call them from your own destructor though, otherwise your versions won't get called before the default implementation's does.

If you want to be able to transmit or save your images, you will need to override the LoadSave functions (listed below) to provide your own code for interpreting the image data itself, and then create or modify a behavior to open a socket and transmit the information. (you could do that from within the generator itself if you like)

You will probably also want to add a few extra functions to allow users to set compression/data format parameters.

See also:
RawCameraGenerator, SegmentedColorGenerator for the basic image access

RLEGenerator, RegionGenerator for some relatively simple examples of vision stages if you want to make some of your own.

Definition at line 112 of file FilterBankGenerator.h.

Public Member Functions

 FilterBankGenerator ()
 constructor

 FilterBankGenerator (const std::string &name, EventBase::EventGeneratorID_t srcgid, unsigned int srcsid, EventBase::EventGeneratorID_t mgid, unsigned int msid)
 constructor

virtual ~FilterBankGenerator ()
 destructor

virtual const FilterBankGeneratorgetSourceGenerator () const
 returns the generator this is receiving its events from (or the last one anyway)

virtual unsigned int getNumLayers () const
 returns the number of image layers (e.g. different resolutions available)

virtual unsigned int getNumChannels () const
 returns the number of channels per image (e.g. Y, U, or V components)

virtual 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 (in samples) of the image in a given layer

unsigned int getHeight (unsigned int layer) const
 returns height (in samples) 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 (in bytes) to use to go from one sample to the next

unsigned int getFrameNumber () const
 returns the frame number of the current frame, see frameNumber

unsigned int getFramesProcessed () const
 returns the number of frames processed, see framesProcessed

virtual void freeCaches ()
 deletes storage of cached images and marks it invalid

virtual void invalidateCaches ()
 marks all of the cached images as invalid (but doesn't free their memory)

virtual void processEvent (const EventBase &event)
 default implementation does a few common housekeeping chores for you - probably should just take a look at its code

LoadSave interface
virtual unsigned int getBinSize () const
 calculates space needed to save - if you can't precisely add up the size, overestimate and things will still work.

virtual unsigned int LoadBuffer (const char buf[], unsigned int len)
virtual unsigned int SaveBuffer (char buf[], unsigned int len) const
 Save to a given buffer.

virtual void selectSaveImage (unsigned int layer, unsigned int channel)
 not actually part of the LoadSave interface, but allows you to select which image of the bank will be saved

virtual unsigned int getSelectedSaveLayer () const
 returns layer to be saved, or layer of last image loaded

virtual unsigned int getSelectedSaveChannel () const
 returns channel to be saved, or channel of last image loaded


Protected Member Functions

virtual void setNumImages (unsigned int nLayers, unsigned int nChannels)
 resizes the filter bank information storage area, you should override this to do your setup and call it from your constructor

virtual void setDimensions ()
 resets width and height parameters to that of the src

virtual unsigned char * createImageCache (unsigned int layer, unsigned int channel) const=0
 create new image data storage area for the cache - this called by getImage() only when the corresponding entry in images is NULL

virtual void calcImage (unsigned int layer, unsigned int channel) const=0
 should calculate new image data, called by getImage() only when imageValids indicates the image being requested is dirty (and only after getImage() has already called createImageCache())

virtual void destruct ()
 deletes the arrays


Protected Attributes

const FilterBankGeneratorsrc
 the generator of the last FilterBankEvent received

unsigned int numLayers
 current number of layers available

unsigned int numChannels
 current number of channels available

unsigned int * widths
 an array of size numLayers, width (in samples) in pixels of each layer

unsigned int * heights
 an array of size numLayers, height (in samples) in pixels of each layer

unsigned int * skips
 an array of size numLayers, skip (in bytes) from row end to next row begin

unsigned int * strides
 an array of size numLayers, stride (in bytes) from a given column in one row to the same column in the next row

unsigned int * increments
 an array of size numLayers, increment (in bytes) to use to get from one sample to the next

unsigned char *** images
 an array [numLayers][numChannels], stores pointer to cached image data

bool ** imageValids
 an array [numLayers][numChannels], entry is true if cached data is still valid

unsigned int selectedSaveLayer
 layer to be manipulated with the LoadSave functions

unsigned int selectedSaveChannel
 channel to be manipulated with the LoadSave functions

unsigned int frameNumber
 the current frame number - subclasses will need to set to the source's frameNumber when they receive a new frame (probably from processEvent())

unsigned int framesProcessed
 subclasses should increment this any time they make a new filter bank available


Private Member Functions

 FilterBankGenerator (const FilterBankGenerator &fbk)
 don't call

const FilterBankGeneratoroperator= (const FilterBankGenerator &fbk)
 don't call


Constructor & Destructor Documentation

FilterBankGenerator::FilterBankGenerator  )  [inline]
 

constructor

Definition at line 115 of file FilterBankGenerator.h.

FilterBankGenerator::FilterBankGenerator const std::string &  name,
EventBase::EventGeneratorID_t  srcgid,
unsigned int  srcsid,
EventBase::EventGeneratorID_t  mgid,
unsigned int  msid
[inline]
 

constructor

Definition at line 120 of file FilterBankGenerator.h.

virtual FilterBankGenerator::~FilterBankGenerator  )  [inline, virtual]
 

destructor

Your own subclasses should also have destructors which call freeCaches() and destruct(). Otherwise, if you override these functions to delete any custom memory you allocate, those implementations won't be called by this destructor... a destructor ignores virtual functions, only calls at its own class level.
So it really doesn't matter if you aren't allocating any extra memory other than what's in the image cache, but it's still good form just in case you add stuff later so you won't forget and leak memory everywhere

Definition at line 135 of file FilterBankGenerator.h.

FilterBankGenerator::FilterBankGenerator const FilterBankGenerator fbk  )  [private]
 

don't call


Member Function Documentation

virtual void FilterBankGenerator::calcImage unsigned int  layer,
unsigned int  channel
const [protected, pure virtual]
 

should calculate new image data, called by getImage() only when imageValids indicates the image being requested is dirty (and only after getImage() has already called createImageCache())

This is where you'll want to put your user-specific code for calculating the image data

Implemented in CDTGenerator, InterleavedYUVGenerator, JPEGGenerator, RawCameraGenerator, RegionGenerator, RLEGenerator, and SegmentedColorGenerator.

Referenced by getImage().

virtual unsigned char* FilterBankGenerator::createImageCache unsigned int  layer,
unsigned int  channel
const [protected, pure virtual]
 

create new image data storage area for the cache - this called by getImage() only when the corresponding entry in images is NULL

You should return the pointer you want stored in images to be returned by any calls to getFirstRow. Interpretation of the data it points to is dependant on the the generator which creates it

Implemented in CDTGenerator, InterleavedYUVGenerator, JPEGGenerator, RawCameraGenerator, RegionGenerator, RLEGenerator, and SegmentedColorGenerator.

Referenced by getImage().

void FilterBankGenerator::destruct  )  [protected, virtual]
 

deletes the arrays

Reimplemented in CDTGenerator, JPEGGenerator, RawCameraGenerator, RegionGenerator, and RLEGenerator.

Definition at line 132 of file FilterBankGenerator.cc.

Referenced by RLEGenerator::destruct(), RegionGenerator::destruct(), RawCameraGenerator::destruct(), JPEGGenerator::destruct(), CDTGenerator::destruct(), setNumImages(), ~FilterBankGenerator(), InterleavedYUVGenerator::~InterleavedYUVGenerator(), and SegmentedColorGenerator::~SegmentedColorGenerator().

void FilterBankGenerator::freeCaches  )  [virtual]
 

deletes storage of cached images and marks it invalid

you should override this if the images cache pointer isn't actually an array of bytes... Don't forget to call it in your subclass's destructor or your version won't get called...

Reimplemented in CDTGenerator, RawCameraGenerator, and RegionGenerator.

Definition at line 18 of file FilterBankGenerator.cc.

Referenced by RegionGenerator::freeCaches(), RawCameraGenerator::freeCaches(), CDTGenerator::freeCaches(), setNumImages(), ~FilterBankGenerator(), InterleavedYUVGenerator::~InterleavedYUVGenerator(), JPEGGenerator::~JPEGGenerator(), RLEGenerator::~RLEGenerator(), and SegmentedColorGenerator::~SegmentedColorGenerator().

unsigned int FilterBankGenerator::getBinSize  )  const [virtual]
 

calculates space needed to save - if you can't precisely add up the size, overestimate and things will still work.

Returns:
number of bytes read/written, 0 if error (or empty)

Implements LoadSave.

Reimplemented in CDTGenerator, InterleavedYUVGenerator, JPEGGenerator, RawCameraGenerator, RegionGenerator, RLEGenerator, and SegmentedColorGenerator.

Definition at line 48 of file FilterBankGenerator.cc.

Referenced by SegmentedColorGenerator::getBinSize(), RLEGenerator::getBinSize(), RegionGenerator::getBinSize(), RawCameraGenerator::getBinSize(), JPEGGenerator::getBinSize(), InterleavedYUVGenerator::getBinSize(), CDTGenerator::getBinSize(), and RawCameraGenerator::SaveFileStream().

unsigned int FilterBankGenerator::getFrameNumber  )  const [inline]
 

returns the frame number of the current frame, see frameNumber

Definition at line 170 of file FilterBankGenerator.h.

Referenced by FilterBankEvent::getFrameNumber(), SegCamBehavior::openPacket(), RawCamBehavior::openPacket(), and processEvent().

unsigned int FilterBankGenerator::getFramesProcessed  )  const [inline]
 

returns the number of frames processed, see framesProcessed

Definition at line 173 of file FilterBankGenerator.h.

Referenced by FilterBankEvent::getFramesProcessed().

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

returns height (in samples) of the image in a given layer

Definition at line 157 of file FilterBankGenerator.h.

Referenced by RLEGenerator::calcExpMaxRuns(), SegmentedColorGenerator::calcImage(), RLEGenerator::calcImage(), RawCameraGenerator::calcImage(), InterleavedYUVGenerator::calcImage(), FilterBankEvent::getHeight(), SegCamBehavior::openPacket(), RawCamBehavior::openPacket(), RawCameraGenerator::processEvent(), processEvent(), CDTGenerator::processEvent(), and setDimensions().

unsigned char * FilterBankGenerator::getImage unsigned int  layer,
unsigned int  channel
const [virtual]
 

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 6 of file FilterBankGenerator.cc.

Referenced by SegmentedColorGenerator::calcImage(), RLEGenerator::calcImage(), RegionGenerator::calcImage(), JPEGGenerator::calcImage(), InterleavedYUVGenerator::calcImage(), FilterBankEvent::getImage(), RLEGenerator::getNumRuns(), RLEGenerator::getRun(), RLEGenerator::getRuns(), JPEGGenerator::LoadBuffer(), CameraBehavior::processEvent(), RawCameraGenerator::reconstructImage(), SegmentedColorGenerator::SaveBuffer(), RLEGenerator::SaveBuffer(), RegionGenerator::SaveBuffer(), RawCameraGenerator::SaveBuffer(), JPEGGenerator::SaveBuffer(), InterleavedYUVGenerator::SaveBuffer(), CDTGenerator::SaveBuffer(), RawCameraGenerator::SaveFileStream(), and RawCameraGenerator::upsampleImage().

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

returns the increment (in bytes) to use to go from one sample to the next

Definition at line 167 of file FilterBankGenerator.h.

Referenced by InterleavedYUVGenerator::calcImage(), FilterBankEvent::getIncrement(), RawCameraGenerator::SaveBuffer(), CDTGenerator::SaveBuffer(), and RawCameraGenerator::SaveFileStream().

virtual unsigned int FilterBankGenerator::getNumChannels  )  const [inline, virtual]
 

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

Definition at line 147 of file FilterBankGenerator.h.

Referenced by FilterBankEvent::getNumChannels(), and processEvent().

virtual unsigned int FilterBankGenerator::getNumLayers  )  const [inline, virtual]
 

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

Definition at line 144 of file FilterBankGenerator.h.

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

virtual unsigned int FilterBankGenerator::getSelectedSaveChannel  )  const [inline, virtual]
 

returns channel to be saved, or channel of last image loaded

Definition at line 207 of file FilterBankGenerator.h.

virtual unsigned int FilterBankGenerator::getSelectedSaveLayer  )  const [inline, virtual]
 

returns layer to be saved, or layer of last image loaded

Definition at line 206 of file FilterBankGenerator.h.

unsigned int FilterBankGenerator::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 160 of file FilterBankGenerator.h.

Referenced by InterleavedYUVGenerator::calcImage(), FilterBankEvent::getSkip(), RawCameraGenerator::reconstructImage(), RawCameraGenerator::SaveBuffer(), CDTGenerator::SaveBuffer(), RawCameraGenerator::SaveFileStream(), and RawCameraGenerator::upsampleImage().

virtual const FilterBankGenerator* FilterBankGenerator::getSourceGenerator  )  const [inline, virtual]
 

returns the generator this is receiving its events from (or the last one anyway)

Definition at line 141 of file FilterBankGenerator.h.

Referenced by SegCamBehavior::writeRLE().

unsigned int FilterBankGenerator::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 164 of file FilterBankGenerator.h.

Referenced by SegmentedColorGenerator::calcImage(), RawCameraGenerator::calcImage(), JPEGGenerator::calcImage(), FilterBankEvent::getStride(), RawCameraGenerator::SaveBuffer(), and RawCameraGenerator::SaveFileStream().

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

returns width (in samples) of the image in a given layer

Definition at line 154 of file FilterBankGenerator.h.

Referenced by RLEGenerator::calcExpMaxRuns(), SegmentedColorGenerator::calcImage(), RLEGenerator::calcImage(), InterleavedYUVGenerator::calcImage(), FilterBankEvent::getWidth(), RLEGenerator::LoadBuffer(), SegCamBehavior::openPacket(), RawCamBehavior::openPacket(), RawCameraGenerator::processEvent(), processEvent(), CDTGenerator::processEvent(), RawCameraGenerator::reconstructImage(), and setDimensions().

void FilterBankGenerator::invalidateCaches  )  [virtual]
 

marks all of the cached images as invalid (but doesn't free their memory)

You probably want to call this right before you send the FilterBankEvent

Definition at line 28 of file FilterBankGenerator.cc.

Referenced by freeCaches(), RawCameraGenerator::processEvent(), processEvent(), CDTGenerator::processEvent(), and JPEGGenerator::setQuality().

unsigned int FilterBankGenerator::LoadBuffer const char  buf[],
unsigned int  len
[virtual]
 

The LoadBuffer() functions of the included subclasses aren't tested, so don't assume they'll work without a little debugging...

Implements LoadSave.

Reimplemented in CDTGenerator, InterleavedYUVGenerator, JPEGGenerator, RawCameraGenerator, RegionGenerator, RLEGenerator, and SegmentedColorGenerator.

Definition at line 59 of file FilterBankGenerator.cc.

Referenced by SegmentedColorGenerator::LoadBuffer(), RLEGenerator::LoadBuffer(), RegionGenerator::LoadBuffer(), RawCameraGenerator::LoadBuffer(), JPEGGenerator::LoadBuffer(), and InterleavedYUVGenerator::LoadBuffer().

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

don't call

void FilterBankGenerator::processEvent const EventBase event  )  [virtual]
 

default implementation does a few common housekeeping chores for you - probably should just take a look at its code

It doesn't throw any events for you - that's probably the main reason you'd still want to override it
Also, if your class has a set number of layers or channels - for instance, always 1 channel like InterleavedYUVGenerator, you should override setNumImages() to enforce that constraint by throwing away the appropriate argument and passing the your own value to the superclass implementation.

Reimplemented from BehaviorBase.

Reimplemented in CDTGenerator, InterleavedYUVGenerator, JPEGGenerator, RawCameraGenerator, RegionGenerator, RLEGenerator, and SegmentedColorGenerator.

Definition at line 35 of file FilterBankGenerator.cc.

Referenced by SegmentedColorGenerator::processEvent(), RLEGenerator::processEvent(), RegionGenerator::processEvent(), JPEGGenerator::processEvent(), and InterleavedYUVGenerator::processEvent().

unsigned int FilterBankGenerator::SaveBuffer char  buf[],
unsigned int  len
const [virtual]
 

Save to a given buffer.

Parameters:
buf pointer to the memory where you should begin writing
len length of buf available. (this isn't all yours, constrain yourself to what you returned in getBinSize() )
Returns:
the number of bytes actually used

Implements LoadSave.

Reimplemented in CDTGenerator, InterleavedYUVGenerator, JPEGGenerator, RawCameraGenerator, RegionGenerator, RLEGenerator, and SegmentedColorGenerator.

Definition at line 75 of file FilterBankGenerator.cc.

Referenced by SegmentedColorGenerator::SaveBuffer(), RLEGenerator::SaveBuffer(), RegionGenerator::SaveBuffer(), RawCameraGenerator::SaveBuffer(), JPEGGenerator::SaveBuffer(), InterleavedYUVGenerator::SaveBuffer(), CDTGenerator::SaveBuffer(), RawCameraGenerator::SaveFileStream(), RawCamBehavior::writeColor(), SegCamBehavior::writeSeg(), and RawCamBehavior::writeSingleChannel().

virtual void FilterBankGenerator::selectSaveImage unsigned int  layer,
unsigned int  channel
[inline, virtual]
 

not actually part of the LoadSave interface, but allows you to select which image of the bank will be saved

when loading, the saved image's layer and channel will reset this

Definition at line 204 of file FilterBankGenerator.h.

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

void FilterBankGenerator::setDimensions  )  [protected, virtual]
 

resets width and height parameters to that of the src

You'll probably want to override this to also set #skip and #stride

Reimplemented in CDTGenerator, InterleavedYUVGenerator, RawCameraGenerator, RLEGenerator, and SegmentedColorGenerator.

Definition at line 122 of file FilterBankGenerator.cc.

Referenced by processEvent(), SegmentedColorGenerator::setDimensions(), RLEGenerator::setDimensions(), and InterleavedYUVGenerator::setDimensions().

void FilterBankGenerator::setNumImages unsigned int  nLayers,
unsigned int  nChannels
[protected, virtual]
 

resizes the filter bank information storage area, you should override this to do your setup and call it from your constructor

In general, it isn't expected that FilterBankGenerator's should necessarily be dynamically resizeable (although it would be nice), which is why this isn't public. If yours is, just add some pubic accessor functions which call this. In general, the included subclasses should be able to handle being resized, but there's no reason to do so since the system won't be changing its available resolutions at run time.

The default implementation is a no-op if(numLayers==nLayers && numChannels==nChannels)

Reimplemented in CDTGenerator, InterleavedYUVGenerator, JPEGGenerator, RawCameraGenerator, RegionGenerator, RLEGenerator, and SegmentedColorGenerator.

Definition at line 92 of file FilterBankGenerator.cc.

Referenced by processEvent(), SegmentedColorGenerator::setNumImages(), RLEGenerator::setNumImages(), RegionGenerator::setNumImages(), RawCameraGenerator::setNumImages(), JPEGGenerator::setNumImages(), InterleavedYUVGenerator::setNumImages(), and CDTGenerator::setNumImages().


Member Data Documentation

unsigned int FilterBankGenerator::frameNumber [protected]
 

the current frame number - subclasses will need to set to the source's frameNumber when they receive a new frame (probably from processEvent())

The idea is to use this as a unique serial number for each frame. That way you can know if the current image in different generators is actually the same camera image before you try to compare or combine them.

You could also figure out the number of dropped frames by subtracting framesProcessed from this value. Give some leeway however, because it takes the first 40-70 frames just to boot up, so there's no way they can be processed.

Definition at line 272 of file FilterBankGenerator.h.

Referenced by FilterBankGenerator(), getFrameNumber(), and processEvent().

unsigned int FilterBankGenerator::framesProcessed [protected]
 

subclasses should increment this any time they make a new filter bank available

this is automatically incremented if you use the FilterBankGenerator::processEvent()

Definition at line 276 of file FilterBankGenerator.h.

Referenced by FilterBankGenerator(), getFramesProcessed(), and processEvent().

unsigned int* FilterBankGenerator::heights [protected]
 

an array of size numLayers, height (in samples) in pixels of each layer

Definition at line 250 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), getBinSize(), getHeight(), LoadBuffer(), processEvent(), SaveBuffer(), setDimensions(), and setNumImages().

unsigned char*** FilterBankGenerator::images [mutable, protected]
 

an array [numLayers][numChannels], stores pointer to cached image data

Definition at line 255 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), freeCaches(), getImage(), and setNumImages().

bool** FilterBankGenerator::imageValids [mutable, protected]
 

an array [numLayers][numChannels], entry is true if cached data is still valid

Definition at line 256 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), getImage(), invalidateCaches(), and setNumImages().

unsigned int* FilterBankGenerator::increments [protected]
 

an array of size numLayers, increment (in bytes) to use to get from one sample to the next

Definition at line 253 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), getIncrement(), and setNumImages().

unsigned int FilterBankGenerator::numChannels [protected]
 

current number of channels available

Definition at line 247 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), freeCaches(), getNumChannels(), invalidateCaches(), and setNumImages().

unsigned int FilterBankGenerator::numLayers [protected]
 

current number of layers available

Definition at line 246 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), freeCaches(), getNumLayers(), invalidateCaches(), processEvent(), setDimensions(), and setNumImages().

unsigned int FilterBankGenerator::selectedSaveChannel [protected]
 

channel to be manipulated with the LoadSave functions

Definition at line 259 of file FilterBankGenerator.h.

Referenced by FilterBankGenerator(), getBinSize(), getSelectedSaveChannel(), LoadBuffer(), SaveBuffer(), and selectSaveImage().

unsigned int FilterBankGenerator::selectedSaveLayer [protected]
 

layer to be manipulated with the LoadSave functions

Definition at line 258 of file FilterBankGenerator.h.

Referenced by FilterBankGenerator(), getBinSize(), getSelectedSaveLayer(), LoadBuffer(), SaveBuffer(), and selectSaveImage().

unsigned int* FilterBankGenerator::skips [protected]
 

an array of size numLayers, skip (in bytes) from row end to next row begin

Definition at line 251 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), getSkip(), and setNumImages().

const FilterBankGenerator* FilterBankGenerator::src [protected]
 

the generator of the last FilterBankEvent received

Definition at line 244 of file FilterBankGenerator.h.

Referenced by FilterBankGenerator(), getSourceGenerator(), processEvent(), and setDimensions().

unsigned int* FilterBankGenerator::strides [protected]
 

an array of size numLayers, stride (in bytes) from a given column in one row to the same column in the next row

Definition at line 252 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), getStride(), and setNumImages().

unsigned int* FilterBankGenerator::widths [protected]
 

an array of size numLayers, width (in samples) in pixels of each layer

Definition at line 249 of file FilterBankGenerator.h.

Referenced by destruct(), FilterBankGenerator(), getBinSize(), getWidth(), LoadBuffer(), processEvent(), SaveBuffer(), setDimensions(), and setNumImages().


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

Tekkotsu v2.1
Generated Tue Mar 16 23:22:10 2004 by Doxygen 1.3.5