LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::toUCam::parameters Class Reference

frameGrabber parameters class More...

#include <ltiToUCam.h>

Inheritance diagram for lti::toUCam::parameters:
Inheritance graph
[legend]
Collaboration diagram for lti::toUCam::parameters:
Collaboration graph
[legend]

List of all members.

Public Types

enum  eCompressionType {
  None = 0, Low = 1, Medium = 2, High = 3,
  Invalid = 4
}
enum  eWhiteBalanceType {
  InvalidWB = -1, Indoor = 0, Outdoor = 1, Fluorescent = 2,
  Manual = 3, Auto = 4
}

Public Member Functions

 parameters (const bool valid=true)
 parameters (const parameters &other)
parameterscopy (const parameters &other)
virtual functor::parametersclone () const
virtual const char * getTypeName () const
virtual bool write (ioHandler &handler, const bool complete=true) const
virtual bool read (ioHandler &handler, const bool complete=true)

Public Attributes

point size
float brightness
float hue
float saturation
float contrast
float gamma
int frameRate
bool snapshotMode
eCompressionType compression
bool agc
float gain
bool autoShutter
float shutterSpeed
eWhiteBalanceType whiteBalance
float redGain
float blueGain
int led
std::string device

Detailed Description

frameGrabber parameters class


Member Enumeration Documentation

the image compression rate

Enumerator:
None 

no compression will be used

Low 

low compression

Medium 

middle compression rate

High 

high compression

Invalid 

flag to denote invalid value

white balance mode

Enumerator:
InvalidWB 

Invalid value.

Indoor 

Indoor lighting.

Outdoor 

Outdoor lighting.

Fluorescent 

Fluorescent lighting.

Manual 

Manual mode.

You need this mode to adjust the blue and red gains

Auto 

Automatic White Balance.


Constructor & Destructor Documentation

lti::toUCam::parameters::parameters ( const bool  valid = true  ) 

constructor to generate an invalid set of parameters (all values out of range).

if valid is false, the parameter set will be invalid, otherwise a default set will be generated.

lti::toUCam::parameters::parameters ( const parameters other  )  [inline]

copy constructor

Reimplemented from lti::frameGrabber::parameters.

References copy().


Member Function Documentation

virtual functor::parameters* lti::toUCam::parameters::clone (  )  const [virtual]

returns a pointer to a clone of the parameters.

Reimplemented from lti::frameGrabber::parameters.

parameters& lti::toUCam::parameters::copy ( const parameters other  ) 

copy member

Reimplemented from lti::frameGrabber::parameters.

Referenced by parameters().

virtual const char* lti::toUCam::parameters::getTypeName (  )  const [virtual]

returns the type name

Reimplemented from lti::frameGrabber::parameters.

virtual bool lti::toUCam::parameters::read ( ioHandler handler,
const bool  complete = true 
) [virtual]

write the parameters in the given ioHandler

Parameters:
handler the ioHandler to be used
complete if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.
Returns:
true if write was successful

Reimplemented from lti::frameGrabber::parameters.

virtual bool lti::toUCam::parameters::write ( ioHandler handler,
const bool  complete = true 
) const [virtual]

write the parameters in the given ioHandler

Parameters:
handler the ioHandler to be used
complete if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.
Returns:
true if write was successful

Reimplemented from lti::frameGrabber::parameters.


Member Data Documentation

automatic gain control

Default value: false

automatic shutter speed

Default value: false

Blue gain.

Valid values between 0.0 and 1.0

To see the effect of this gain factor you need to set the white balance mode into "Manual".

Default value: 0.5

image brightness (valid values between 0.0 and 1.0)

Default value: 0.5

Set compression preference.

The Philips webcams use losy compression techniques to get the images across the (narrow) USB bus. With this parameter you can specify if you like no compression, low, medium or high compression. Higher compression means less bandwidth is used, but it could introduce artefacts in the image.

Default value: Medium

image contrast (valid values between 0.0 and 1.0)

Default value: 0.5

This string denotes the name of the device used.

For Linux it could be for example /dev/video or /dev/video0. There is a special constructor that allows you to give this value directly.

Default value: for Linux: /dev/video for Windows: not implemented yet.

frame rate This value shoud be between 0 and 60.

If 0 is given, the last frame rate will be used again. Not all combination of frameRate and size are allowed. For more details see parameters::size;

Default value:

gain valid values between 0.0 and 1.0

Default value: 0.75

gamma correction (valid values between 0.0 and 1.0)

Default value: 0.5

image hue (valid values between 0.0 and 1.0) This value doesn't seem to be used by the ToUCams, but it belongs to the V4L standard.

..

Default value: 0.5

LED.

Specify a value of zero or negative for an "off LED" and a value of exactly 1 for a LED always on.

Otherwise, the led "on" time will be computed as "led%65536" and the led "off" time as "led/65536". Both times will have a resolution of 100ms and accept a maximum value of 25000.

Default value: 1 (led on).

Red gain.

To see the effect of this gain factor you need to set the white balance mode into "Manual".

Valid values between 0.0 and 1.0

Default value: 0.5

image color saturation (valid values between 0.0 and 1.0)

Default value: 0.5

shutter speed.

Only used if autoShutter is false. The value has no time units. It just means a long exposure time (1.0) or a very short exposure time (0.0).

Default value: 0.75

the image size

The following values are accepted by the camera: 128x96, 160x120, 176x144, 320x240, 352x288 and 640x480.

Default value: 320x240

Following is an excerpt of the original driver pages:

Resolution chart

Below is a table that shows the possible resolutions and framerates for the webcams. On the left, all possible physical resolutions are listed; at the top, the various framerates for the cameras.

If a cell is blank, it means the combination of resolution and framerate is not directly supported by the webcam. If an unsupported image size is requested by a program, the first smaller image size is selected and padded with a black or gray border.

A green cell means the combination is supported uncompressed; a red cell indicates that combination is only available with the decompressor module, pwcx.
Size PCA 645/646 & VC010   PCVC 675/680/690   PCVC 730/740
3.75 5 7.5 10 12 15 20 24 5 10 15 20 25 30 5 10 15 20 25 30
sQCIF
128x96
                                       
QSIF
160x120
                                       
QCIF
176x144
                                       
SIF
320x240
                                       
CIF
352x288
                                       
VGA
640x480
                                       

(Yes, VGA resolutions are limited to 15 fps: there isn't enough bandwidth available on the USB bus to squeeze through more, even with compression).

The Philips driver now supports any image size between the minimum and maximum size. For image sizes that are not an 'integral' image size directly supported by the camera, the image is now padded with a gray or black border, depending on the palette.

Note: the driver only pads the image; it selects a format that is smaller or equal to the requested size; it does not crop an image that is only a bit larger than the requested current image.

snapshot mode Default value:

white balance

Default value: Outdoor


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

Generated on Sat Apr 10 15:28:07 2010 for LTI-Lib by Doxygen 1.6.1