Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

RegionGenerator Class Reference

#include <RegionGenerator.h>

Inheritance diagram for RegionGenerator:

List of all members.


Detailed Description

Connects regions of CMVision format runs in RLEGenerator.

Uses the CMVision library for main processing.

getImage() will return an array of RegionGenerator::region_stats - one entry per color. This will give you some statistics on colors present, as well as the head of a linked list through regions of each color in the image.

Uses fields in the RLEGenerator's runs to store region information. This means we don't have to make an extra copy of the data, but unfortunately also means these two stages are tightly coupled...

Similarly, this also accesses the color information of the runs, so the events received must be a SegmentedColorFilterBankEvents so that it can interpret the color information. Some statistical information will then be stored in the color struct to report the min region area, max region area, and number of regions.

Definition at line 30 of file RegionGenerator.h.


Public Types

typedef CMVision::region region
 using the CMVision library's region information
typedef CMVision::color_class_state region_stats
 using the CMVision library's color struct to store the region info

Public Member Functions

 RegionGenerator (unsigned int mysid, RLEGenerator *rleg, EventBase::EventTypeID_t tid)
 constructor
virtual ~RegionGenerator ()
 destructor
virtual void freeCaches ()
 deletes storage of cached images and marks it invalid
virtual void processEvent (const EventBase &event)
 see class notes above for what data this can handle
virtual unsigned int getBinSize () const
 Calculates space needed to save - if you can't precisely add up the size, just make sure to 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 in memory.

Static Public Member Functions

static std::string getClassDescription ()
 Gives a short description of what this class of behaviors does... you should override this (but don't have to).

Protected Types

typedef
SegmentedColorFilterBankEvent::color_class_state 
color_class_state
 use the same color info as SegmentedColorFilterBankEvent (since that's what's supplying the color info)

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 unsigned char * createImageCache (unsigned int layer, unsigned int chan) const
 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 chan)
 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

unsigned int srcNumColors
 number of colors available (from src->src, which should be SegmentedColorGenerator...)
const color_class_statesrcColors
 colors information (from src->src, which should be SegmentedColorGenerator...)
region *** regions
 data storage for region information

Static Protected Attributes

static const unsigned int MAX_REGIONS = 176*144/16
 maximum number of regions, value is from historical Vision sources

Private Member Functions

 RegionGenerator (const RegionGenerator &fbk)
 don't call
const RegionGeneratoroperator= (const RegionGenerator &fbk)
 don't call

Member Typedef Documentation

using the CMVision library's region information

Definition at line 32 of file RegionGenerator.h.

using the CMVision library's color struct to store the region info

Definition at line 33 of file RegionGenerator.h.

use the same color info as SegmentedColorFilterBankEvent (since that's what's supplying the color info)

Definition at line 56 of file RegionGenerator.h.


Constructor & Destructor Documentation

RegionGenerator::RegionGenerator ( unsigned int  mysid,
RLEGenerator rleg,
EventBase::EventTypeID_t  tid 
)

constructor

Definition at line 11 of file RegionGenerator.cc.

virtual RegionGenerator::~RegionGenerator (  )  [inline, virtual]

destructor

Definition at line 39 of file RegionGenerator.h.

RegionGenerator::RegionGenerator ( const RegionGenerator fbk  )  [private]

don't call


Member Function Documentation

static std::string RegionGenerator::getClassDescription (  )  [inline, static]

Gives a short description of what this class of behaviors does... you should override this (but don't have to).

If you do override this, also consider overriding getDescription() to return it

Reimplemented from BehaviorBase.

Definition at line 44 of file RegionGenerator.h.

void RegionGenerator::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 from FilterBankGenerator.

Definition at line 27 of file RegionGenerator.cc.

Referenced by loadBuffer(), processEvent(), and ~RegionGenerator().

void RegionGenerator::processEvent ( const EventBase event  )  [virtual]

see class notes above for what data this can handle

Reimplemented from FilterBankGenerator.

Definition at line 37 of file RegionGenerator.cc.

unsigned int RegionGenerator::getBinSize (  )  const [virtual]

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

getBinSize is used for reserving buffers during serialization, but does not necessarily determine the actual size of what is written -- the return value of saveBuffer() specifies that after the data actually has been written. If getBinSize overestimates, the extra memory allocation is only temporary, no extra filler bytes are actually stored.

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

Reimplemented from FilterBankGenerator.

Definition at line 64 of file RegionGenerator.cc.

unsigned int RegionGenerator::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...

Reimplemented from FilterBankGenerator.

Definition at line 87 of file RegionGenerator.cc.

unsigned int RegionGenerator::saveBuffer ( char  buf[],
unsigned int  len 
) const [virtual]

Save to a given buffer in memory.

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

Reimplemented from FilterBankGenerator.

Definition at line 140 of file RegionGenerator.cc.

Referenced by RegionCamBehavior::writeRegions().

void RegionGenerator::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 from FilterBankGenerator.

Definition at line 182 of file RegionGenerator.cc.

Referenced by RegionGenerator().

unsigned char * RegionGenerator::createImageCache ( unsigned int  layer,
unsigned int  channel 
) const [protected, 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

Implements FilterBankGenerator.

Definition at line 195 of file RegionGenerator.cc.

Referenced by loadBuffer().

void RegionGenerator::calcImage ( unsigned int  layer,
unsigned int  channel 
) [protected, 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

Implements FilterBankGenerator.

Definition at line 210 of file RegionGenerator.cc.

void RegionGenerator::destruct (  )  [protected, virtual]

deletes the arrays

Reimplemented from FilterBankGenerator.

Definition at line 231 of file RegionGenerator.cc.

Referenced by ~RegionGenerator().

const RegionGenerator& RegionGenerator::operator= ( const RegionGenerator fbk  )  [private]

don't call


Member Data Documentation

const unsigned int RegionGenerator::MAX_REGIONS = 176*144/16 [static, protected]

maximum number of regions, value is from historical Vision sources

Definition at line 57 of file RegionGenerator.h.

Referenced by calcImage(), createImageCache(), getBinSize(), and loadBuffer().

unsigned int RegionGenerator::srcNumColors [protected]

number of colors available (from src->src, which should be SegmentedColorGenerator...)

Definition at line 64 of file RegionGenerator.h.

Referenced by calcImage(), createImageCache(), getBinSize(), loadBuffer(), processEvent(), RegionGenerator(), and saveBuffer().

colors information (from src->src, which should be SegmentedColorGenerator...)

Definition at line 65 of file RegionGenerator.h.

Referenced by createImageCache(), processEvent(), and RegionGenerator().

data storage for region information

Definition at line 66 of file RegionGenerator.h.

Referenced by calcImage(), createImageCache(), destruct(), freeCaches(), loadBuffer(), and setNumImages().


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:38 2007 by Doxygen 1.5.4