FilterBankEvent Class Reference
#include <FilterBankEvent.h>
Inheritance diagram for FilterBankEvent:
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, EventBase::EventTypeID_t tid) | |
| constructor | |
| FilterBankEvent (const FilterBankEvent &fbk) | |
| copy constructor (shallow copy -- the generator shouldn't be going anywhere) | |
| const FilterBankEvent & | operator= (const FilterBankEvent &fbk) |
| assignment operator (shallow copy -- the generator shouldn't be going anywhere) | |
| virtual EventBase * | clone () const |
| allows a copy to be made of an event, supporting polymorphism | |
| FilterBankGenerator * | getSource () 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 | |
| FilterBankGenerator * | src |
| pointer to generator which created this event | |
Constructor & Destructor Documentation
| FilterBankEvent::FilterBankEvent | ( | FilterBankGenerator * | creator, | |
| EventBase::EventGeneratorID_t | gid, | |||
| unsigned int | sid, | |||
| EventBase::EventTypeID_t | tid | |||
| ) | [inline] |
| FilterBankEvent::FilterBankEvent | ( | const FilterBankEvent & | fbk | ) | [inline] |
copy constructor (shallow copy -- the generator shouldn't be going anywhere)
Definition at line 17 of file FilterBankEvent.h.
Member Function Documentation
| virtual EventBase* FilterBankEvent::clone | ( | ) | const [inline, virtual] |
allows a copy to be made of an event, supporting polymorphism
Must be overridden by all subclasses to allow this to happen
I would like to switch this over to the cloneable interface once the compiler gets updated out of the 3.3 branch... see Cloneable::clone() for a discussion of the issue and implementation notes.
Reimplemented from EventBase.
Reimplemented in SegmentedColorFilterBankEvent.
Definition at line 22 of file FilterBankEvent.h.
| unsigned int FilterBankEvent::getFrameNumber | ( | ) | const [inline] |
returns the frame number, see FilterBankGenerator::frameNumber
Definition at line 53 of file FilterBankEvent.h.
Referenced by BallDetectionGenerator::processEvent(), and BallDetectionGenerator::testSendEvent().
| unsigned int FilterBankEvent::getFramesProcessed | ( | ) | const [inline] |
returns the number of frames processed by the generator, see FilterBankGenerator::framesProcessed
Definition at line 55 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 43 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 38 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 50 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 34 of file FilterBankEvent.h.
Referenced by BallDetectionGenerator::processEvent().
| unsigned int FilterBankEvent::getNumLayers | ( | ) | const [inline] |
returns the number of image layers (e.g. different resolutions available)
Definition at line 31 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 45 of file FilterBankEvent.h.
| FilterBankGenerator* FilterBankEvent::getSource | ( | ) | const [inline] |
Gives access to underlying generator.
Definition at line 28 of file FilterBankEvent.h.
Referenced by RawCamBehavior::writeColor(), RegionCamBehavior::writeRegions(), 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 48 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 41 of file FilterBankEvent.h.
Referenced by BallDetectionGenerator::processEvent(), and BallDetectionGenerator::testSendEvent().
| const FilterBankEvent& FilterBankEvent::operator= | ( | const FilterBankEvent & | fbk | ) | [inline] |
assignment operator (shallow copy -- the generator shouldn't be going anywhere)
Definition at line 20 of file FilterBankEvent.h.
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 60 of file FilterBankEvent.h.
Referenced by getFrameNumber(), getFramesProcessed(), getHeight(), getImage(), getIncrement(), getNumChannels(), getNumLayers(), getSkip(), getSource(), getStride(), getWidth(), and operator=().
The documentation for this class was generated from the following file:
