RawCameraGenerator Class Reference

Generates FilterBankEvents containing raw camera images directly from the system (doesn't make a copy). More...

#include <RawCameraGenerator.h>

Inheritance diagram for RawCameraGenerator:

[legend]

Detailed Description

Generates FilterBankEvents containing raw camera images directly from the system (doesn't make a copy).

Definition at line 15 of file RawCameraGenerator.h.

List of all members.

Public Types
enum	channel_id_t { CHAN_Y, CHAN_U, CHAN_V, CHAN_Y_DY, CHAN_Y_DX, CHAN_Y_DXDY, NUM_CHANNELS }
	holds id values for specifying image channel/bands More...
Public Member Functions
	RawCameraGenerator (unsigned int numRawLayers, unsigned int numCalcLayers, unsigned int mysid, EventBase::EventGeneratorID_t gid, unsigned int sid)
	constructor, numRawLayers is the number of real layers passed from the system, numCalcLayers is the total number of layers to make available
virtual	~RawCameraGenerator ()
	destructor
virtual void	doStart ()
	need to override EventGeneratorBase's lazy listening -- as a root stage, need to remember each frame, just in case it might be used
virtual void	doEvent ()
	called with system's image info
virtual void	freeCaches ()
	the memory for all layers except the double layer was allocated by system, so we just set them to NULL before calling FilterBankGenerator::freeCaches() so it won't try to delete them
virtual unsigned int	getBinSize () const
virtual unsigned int	loadBuffer (const char buf[], unsigned int len, const char *filename=NULL)
virtual unsigned int	saveBuffer (char buf[], unsigned int len) const
virtual unsigned int	saveFileStream (FILE *f) const
	overrridden to allow saving direct to file without an extra buffer copy
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 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 the width, height, skip and stride values
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
void	upsampleImage (channel_id_t chan)
	Creates a double resolution version of a channel, doesn't do any smoothing.
void	reconstructImage ()
	Creates a double resolution Y-channel from the Y and Y gradient channels.
Static Protected Member Functions
static unsigned int	mapChannelID (channel_id_t chan)
	returns the value to pass to OPENR functions corresponding to the desired channel_id_t.
static unsigned char	clipRange (int val)
	helper functions for reconstructImage() - see documentation for that function
Protected Attributes
unsigned int	numRealLayers
	the number of "real" layers being sent from the system
unsigned char **	layers
	points to the image data supplied by the system, one per layer (all channels are interleaved by row)
const OFbkImageInfo **	imageInfos
	image info provided by the system
Private Member Functions
	RawCameraGenerator (const RawCameraGenerator &fbk)
	don't call
const RawCameraGenerator &	operator= (const RawCameraGenerator &fbk)
	don't call

Member Enumeration Documentation

enum RawCameraGenerator::channel_id_t

holds id values for specifying image channel/bands

Enumerator:

CHAN_Y	Y (intensity) channel.
CHAN_U	Cb (approx. blue,green,yellow) channel.
CHAN_V	Cr (approx. pink,red,yellow) channel.
CHAN_Y_DY	vertical derivative of Y channel (aka LH)
CHAN_Y_DX	horizontal derivative of Y channel (aka HL)
CHAN_Y_DXDY	vert. & horiz. derivatives of Y channel (aka HH)
NUM_CHANNELS	number of channels per resolution layer

Definition at line 43 of file RawCameraGenerator.h.

Constructor & Destructor Documentation

RawCameraGenerator::RawCameraGenerator	(	unsigned int	numRawLayers,
		unsigned int	numCalcLayers,
		unsigned int	mysid,
		EventBase::EventGeneratorID_t	gid,
		unsigned int	sid
	)

constructor, numRawLayers is the number of real layers passed from the system, numCalcLayers is the total number of layers to make available

The extra calculated layers are simply created by giving larger increments, they reference the same data (no computational cost, marginal memory costs... it's just nice to have more layers in the image pyramid.

However you'll have to write your code to use the getIncrement() value properly if you want it to work. Otherwise, you could write a de-interlace generator which will do the resampling.

The top most layer (largest index) is a double-scale image. For the Y-channel, it is reconstructed from the 4 Y channels. For the other channels, it just does a fast scaling (but these operations do cost, so use the top layer conservatively.

See also:: FilterBankGenerator for information on serialization format

Definition at line 17 of file RawCameraGenerator.cc.

RawCameraGenerator::~RawCameraGenerator ( ) [virtual]

destructor

Definition at line 32 of file RawCameraGenerator.cc.

RawCameraGenerator::RawCameraGenerator ( const RawCameraGenerator & fbk ) [private]

don't call

Member Function Documentation

void RawCameraGenerator::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 293 of file RawCameraGenerator.cc.

static unsigned char RawCameraGenerator::clipRange ( int val ) [static, protected]

helper functions for reconstructImage() - see documentation for that function

Definition at line 100 of file RawCameraGenerator.h.

Referenced by reconstructImage().

unsigned char * RawCameraGenerator::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 282 of file RawCameraGenerator.cc.

Referenced by loadBuffer().

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

deletes the arrays

Reimplemented from FilterBankGenerator.

Definition at line 348 of file RawCameraGenerator.cc.

Referenced by ~RawCameraGenerator().

void RawCameraGenerator::doEvent ( ) [virtual]

called with system's image info

The const casts in this function are regretable but necessary since the OPEN-R OFbkImage constructor requires mutable arguments, even though it shouldn't be modifying the data

Reimplemented from FilterBankGenerator.

Definition at line 41 of file RawCameraGenerator.cc.

virtual void RawCameraGenerator::doStart ( ) [virtual]

need to override EventGeneratorBase's lazy listening -- as a root stage, need to remember each frame, just in case it might be used

Reimplemented from EventGeneratorBase.

Definition at line 54 of file RawCameraGenerator.h.

void RawCameraGenerator::freeCaches ( ) [virtual]

the memory for all layers except the double layer was allocated by system, so we just set them to NULL before calling FilterBankGenerator::freeCaches() so it won't try to delete them

Reimplemented from FilterBankGenerator.

Definition at line 252 of file RawCameraGenerator.cc.

Referenced by doEvent(), setDimensions(), and ~RawCameraGenerator().

unsigned int RawCameraGenerator::getBinSize ( ) const [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 99 of file RawCameraGenerator.cc.

Referenced by saveFileStream().

static std::string RawCameraGenerator::getClassDescription ( ) [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 40 of file RawCameraGenerator.h.

unsigned int RawCameraGenerator::loadBuffer	(	const char	buf[],
		unsigned int	len,
		const char *	filename = `NULL`
	)			`[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 106 of file RawCameraGenerator.cc.

unsigned int RawCameraGenerator::mapChannelID ( channel_id_t chan ) [static, protected]

returns the value to pass to OPENR functions corresponding to the desired channel_id_t.

Definition at line 356 of file RawCameraGenerator.cc.

Referenced by calcImage().

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

don't call

void RawCameraGenerator::reconstructImage ( ) [protected]

Creates a double resolution Y-channel from the Y and Y gradient channels.

This function is lifted from Sony's ImageObserver sample code. Here's Sony's original license for the file (ImageObserver.cc) that contained this function:

  Copyright 2002,2003 Sony Corporation

  Permission to use, copy, modify, and redistribute this software for
  non-commercial use is hereby granted.

  This software is provided "as is" without warranty of any kind,
  either expressed or implied, including but not limited to the
  implied warranties of fitness for a particular purpose.

Definition at line 416 of file RawCameraGenerator.cc.

Referenced by calcImage().

unsigned int RawCameraGenerator::saveBuffer	(	char	buf[],
		unsigned int	len
	)			const `[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 130 of file RawCameraGenerator.cc.

Referenced by saveFileStream().

unsigned int RawCameraGenerator::saveFileStream ( FILE * f ) const [virtual]

overrridden to allow saving direct to file without an extra buffer copy

Reimplemented from LoadSave.

Definition at line 170 of file RawCameraGenerator.cc.

void RawCameraGenerator::setDimensions ( ) [protected, virtual]

resets the width, height, skip and stride values

Reimplemented from FilterBankGenerator.

Definition at line 238 of file RawCameraGenerator.cc.

Referenced by doEvent().

void RawCameraGenerator::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 267 of file RawCameraGenerator.cc.

Referenced by RawCameraGenerator().

void RawCameraGenerator::upsampleImage ( channel_id_t chan ) [protected]

Creates a double resolution version of a channel, doesn't do any smoothing.

Definition at line 376 of file RawCameraGenerator.cc.

Referenced by calcImage().