firevision::CameraControlColor Class Reference

Camera color control interface. More...

#include <cams/control/color.h>

Inheritance diagram for firevision::CameraControlColor:

[legend]
List of all members.

Public Member Functions

virtual ~CameraControlColor ()
 Empty virtual destructor.
virtual bool auto_gain ()=0
 Return whether auto gain is enabled.
virtual void set_auto_gain (bool enabled)=0
 Enable/disable auto gain.
virtual bool auto_white_balance ()=0
 Return whether auto white balance is enabled.
virtual void set_auto_white_balance (bool enabled)=0
 Enable/disable auto white balance.
virtual bool auto_exposure ()=0
 Return whether auto exposure is enabled.
virtual void set_auto_exposure (bool enabled)=0
 Enable/disable auto exposure.
virtual void set_auto_all (bool enabled)
 Enable/disable all automatic settings.
virtual int red_balance ()=0
 Get current red balance.
virtual void set_red_balance (int red_balance)=0
 Set red balance.
virtual int blue_balance ()=0
 Get current blue balance.
virtual void set_blue_balance (int blue_balance)=0
 Set blue balance.
virtual int u_balance ()=0
 Get current u balance.
virtual void set_u_balance (int u_balance)=0
 Set u balance.
virtual int v_balance ()=0
 Get current v balance.
virtual void set_v_balance (int v_balance)=0
 Set v balance.
virtual unsigned int brightness ()=0
 Get current brightness.
virtual void set_brightness (unsigned int brightness)=0
 Set new brightness.
virtual unsigned int contrast ()=0
 Get current contrast.
virtual void set_contrast (unsigned int contrast)=0
 Set new contrast.
virtual unsigned int saturation ()=0
 Get current saturation.
virtual void set_saturation (unsigned int saturation)=0
 Set new saturation.
virtual int hue ()=0
 Get current hue.
virtual void set_hue (int hue)=0
 Set new hue.
virtual unsigned int exposure ()=0
 Get current exposure.
virtual void set_exposure (unsigned int exposure)=0
 Set new exposure.
virtual unsigned int gain ()=0
 Get current gain.
virtual void set_gain (unsigned int gain)=0
 Set new gain.

Detailed Description

Camera color control interface.

Some cameras feature adjustable color controls like white balance, brightness etc. In general methods might throw an NotImplementedException if a particular method if not available.

This interface shall be implemented by such cameras.

Author:
Tobias Kellner

Tim Niemueller

Definition at line 35 of file color.h.


Constructor & Destructor Documentation

firevision::CameraControlColor::~CameraControlColor (  )  [virtual]

Empty virtual destructor.

Definition at line 155 of file color.cpp.


Member Function Documentation

bool firevision::CameraControlColor::auto_exposure (  )  [pure virtual]

Return whether auto exposure is enabled.

Returns:
true if auto exposure is enabled

Implemented in firevision::DummyCameraControl, firevision::NaoCamera, and firevision::V4L2Camera.

bool firevision::CameraControlColor::auto_gain (  )  [pure virtual]

Return whether auto gain is enabled.

Returns:
true if auto gain is enabled

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

bool firevision::CameraControlColor::auto_white_balance (  )  [pure virtual]

Return whether auto white balance is enabled.

Returns:
true if auto white balance is enabled

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

int firevision::CameraControlColor::blue_balance (  )  [pure virtual]

Get current blue balance.

Returns:
current blue balance value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

unsigned int firevision::CameraControlColor::brightness (  )  [pure virtual]

Get current brightness.

Returns:
current brightness value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

unsigned int firevision::CameraControlColor::contrast (  )  [pure virtual]

Get current contrast.

Returns:
current contrast value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

unsigned int firevision::CameraControlColor::exposure (  )  [pure virtual]

Get current exposure.

Returns:
current exposure value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

unsigned int firevision::CameraControlColor::gain (  )  [pure virtual]

Get current gain.

Returns:
current gain value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

int firevision::CameraControlColor::hue (  )  [pure virtual]

Get current hue.

Returns:
current hue value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

int firevision::CameraControlColor::red_balance (  )  [pure virtual]

Get current red balance.

Returns:
current red balance value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

unsigned int firevision::CameraControlColor::saturation (  )  [pure virtual]

Get current saturation.

Returns:
current saturation value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_auto_all ( bool  enabled  )  [virtual]

Enable/disable all automatic settings.

Most of the time, you'll want to disable all of them.

Parameters:
enabled whether the automatic settings should be enabled or disabled

Definition at line 165 of file color.cpp.

References set_auto_exposure(), set_auto_gain(), and set_auto_white_balance().

void firevision::CameraControlColor::set_auto_exposure ( bool  enabled  )  [pure virtual]

Enable/disable auto exposure.

Parameters:
enabled whether auto exposure should be enabled

Implemented in firevision::DummyCameraControl, firevision::NaoCamera, and firevision::V4L2Camera.

Referenced by set_auto_all().

void firevision::CameraControlColor::set_auto_gain ( bool  enabled  )  [pure virtual]

Enable/disable auto gain.

Parameters:
enabled whether auto gain should be enabled

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

Referenced by set_auto_all().

void firevision::CameraControlColor::set_auto_white_balance ( bool  enabled  )  [pure virtual]

Enable/disable auto white balance.

Parameters:
enabled whether auto white balance should be enabled

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

Referenced by set_auto_all().

void firevision::CameraControlColor::set_blue_balance ( int  blue_balance  )  [pure virtual]

Set blue balance.

Parameters:
blue_balance new blue balance

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_brightness ( unsigned int  brightness  )  [pure virtual]

Set new brightness.

Parameters:
brightness new brightness

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_contrast ( unsigned int  contrast  )  [pure virtual]

Set new contrast.

Parameters:
contrast new contrast

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_exposure ( unsigned int  exposure  )  [pure virtual]

Set new exposure.

Parameters:
exposure new exposure

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_gain ( unsigned int  gain  )  [pure virtual]

Set new gain.

Parameters:
gain new gain

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_hue ( int  hue  )  [pure virtual]

Set new hue.

Parameters:
hue new hue

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

int firevision::CameraControlColor::set_red_balance ( int  red_balance  )  [pure virtual]

Set red balance.

Parameters:
red_balance new red balance

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_saturation ( unsigned int  saturation  )  [pure virtual]

Set new saturation.

Parameters:
saturation new saturation

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_u_balance ( int  u_balance  )  [pure virtual]

Set u balance.

Parameters:
u_balance new u balance

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

void firevision::CameraControlColor::set_v_balance ( int  v_balance  )  [pure virtual]

Set v balance.

Parameters:
v_balance new v balance

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

int firevision::CameraControlColor::u_balance (  )  [pure virtual]

Get current u balance.

Returns:
current u balance value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.

int firevision::CameraControlColor::v_balance (  )  [pure virtual]

Get current v balance.

Returns:
current v balance value

Implemented in firevision::DummyCameraControl, and firevision::V4L2Camera.


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:31:42 2011 for Fawkes API by  doxygen 1.4.7