Control interface for frame grabber devices. More...

#include <yarp/dev/FrameGrabberInterfaces.h>

Inheritance diagram for yarp::dev::IFrameGrabberControls:

Public Member Functions
virtual	~IFrameGrabberControls ()
	Destructor. More...

virtual bool	setBrightness (double v)
	Set the brightness. More...

virtual bool	setExposure (double v)
	Set the exposure. More...

virtual bool	setSharpness (double v)
	Set the sharpness. More...

virtual bool	setWhiteBalance (double blue, double red)
	Set the white balance for the frame grabber. More...

virtual bool	setHue (double v)
	Set the hue. More...

virtual bool	setSaturation (double v)
	Set the saturation. More...

virtual bool	setGamma (double v)
	Set the gamma. More...

virtual bool	setShutter (double v)
	Set the shutter parameter. More...

virtual bool	setGain (double v)
	Set the gain. More...

virtual bool	setIris (double v)
	Set the iris. More...

virtual double	getBrightness ()
	Read the brightness parameter. More...

virtual double	getExposure ()
	Read the exposure parameter. More...

virtual double	getSharpness ()
	Read the sharpness parameter. More...

virtual bool	getWhiteBalance (double &blue, double &red)
	Read the white balance parameters. More...

virtual double	getHue ()
	Read the hue parameter. More...

virtual double	getSaturation ()
	Read the saturation parameter. More...

virtual double	getGamma ()
	Read the gamma parameter. More...

virtual double	getShutter ()
	Read the shutter parameter. More...

virtual double	getGain ()
	Read the gain parameter. More...

virtual double	getIris ()
	Read the iris parameter. More...

cameraFeature_id_t	featureVOCABEnum (int vocab)

int	featureEnum2Vocab (cameraFeature_id_t _enum)

std::string	busType2String (BusType type)

FeatureMode	toFeatureMode (bool _auto)

virtual bool	getCameraDescription (CameraDescriptor *camera)=0
	Get a basic description of the camera hw. More...

virtual bool	hasFeature (int feature, bool *hasFeature)=0
	Check if camera has the requested feature (saturation, brightness ... More...

virtual bool	setFeature (int feature, double value)=0
	Set the requested feature to a value (saturation, brightness ... More...

virtual bool	getFeature (int feature, double *value)=0
	Get the current value for the requested feature. More...

virtual bool	setFeature (int feature, double value1, double value2)=0
	Set the requested feature to a value using 2 params (like white balance) More...

virtual bool	getFeature (int feature, double value1, double value2)=0
	Get the current value for the requested feature. More...

virtual bool	hasOnOff (int feature, bool *HasOnOff)=0
	Check if the camera has the ability to turn on/off the requested feature. More...

virtual bool	setActive (int feature, bool onoff)=0
	Set the requested feature on or off. More...

virtual bool	getActive (int feature, bool *isActive)=0
	Get the current status of the feature, on or off. More...

virtual bool	hasAuto (int feature, bool *hasAuto)=0
	Check if the requested feature has the 'auto' mode. More...

virtual bool	hasManual (int feature, bool *hasManual)=0
	Check if the requested feature has the 'manual' mode. More...

virtual bool	hasOnePush (int feature, bool *hasOnePush)=0
	Check if the requested feature has the 'onePush' mode. More...

virtual bool	setMode (int feature, FeatureMode mode)=0
	Set the requested mode for the feature. More...

virtual bool	getMode (int feature, FeatureMode *mode)=0
	Get the current mode for the feature. More...

virtual bool	setOnePush (int feature)=0
	Set the requested feature to a value (saturation, brightness ... More...

Detailed Description

Control interface for frame grabber devices.

Definition at line 364 of file FrameGrabberInterfaces.h.

Constructor & Destructor Documentation

◆ ~IFrameGrabberControls()

virtual yarp::dev::IFrameGrabberControls::~IFrameGrabberControls ( )

inlinevirtual

Destructor.

Definition at line 370 of file FrameGrabberInterfaces.h.

Member Function Documentation

◆ busType2String()

std::string yarp::dev::IFrameGrabberControls::busType2String ( BusType type )

inline

Definition at line 568 of file FrameGrabberInterfaces.h.

◆ featureEnum2Vocab()

int yarp::dev::IFrameGrabberControls::featureEnum2Vocab ( cameraFeature_id_t _enum )

inline

Definition at line 539 of file FrameGrabberInterfaces.h.

◆ featureVOCABEnum()

cameraFeature_id_t yarp::dev::IFrameGrabberControls::featureVOCABEnum ( int vocab )

inline

Definition at line 510 of file FrameGrabberInterfaces.h.

◆ getActive()

virtual bool yarp::dev::IFrameGrabberControls::getActive	(	int	feature,
		bool *	isActive
	)

pure virtual

Get the current status of the feature, on or off.

Parameters

feature	the identifier of the feature to check
isActive	flag true if the feature is active, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, USBCameraDriver, FakeFrameGrabber, depthCameraDriver, and V4L_camera.

◆ getBrightness()

virtual double yarp::dev::IFrameGrabberControls::getBrightness ( )

inlinevirtual

Read the brightness parameter.

Returns: the current brightness value.

Reimplemented in RemoteFrameGrabber.

Definition at line 451 of file FrameGrabberInterfaces.h.

◆ getCameraDescription()

virtual bool yarp::dev::IFrameGrabberControls::getCameraDescription ( CameraDescriptor * camera )

pure virtual

Get a basic description of the camera hw.

This is mainly used to determine the HW bus type in order to choose the corresponding interface for advanced controls.

Parameters

device returns an identifier for the bus

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ getExposure()

virtual double yarp::dev::IFrameGrabberControls::getExposure ( )

inlinevirtual

Read the exposure parameter.

Returns: the current exposure value.

Reimplemented in RemoteFrameGrabber.

Definition at line 457 of file FrameGrabberInterfaces.h.

◆ getFeature() [1/2]

virtual bool yarp::dev::IFrameGrabberControls::getFeature	(	int	feature,
		double *	value
	)

pure virtual

Get the current value for the requested feature.

Parameters

feature	the identifier of the feature to read
value	pointer to current value of the feature, from 0 to 1 expressed as a percentage

Returns: returns true on success, false on failure.

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ getFeature() [2/2]

virtual bool yarp::dev::IFrameGrabberControls::getFeature	(	int	feature,
		double *	value1,
		double *	value2
	)

pure virtual

Get the current value for the requested feature.

Parameters

feature	the identifier of the feaature to read
value1	returns the current value of the feature, from 0 to 1 expressed as a percentage
value2	returns the current value of the feature, from 0 to 1 expressed as a percentage

Returns: returns true on success, false on failure.

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ getGain()

virtual double yarp::dev::IFrameGrabberControls::getGain ( )

inlinevirtual

Read the gain parameter.

Returns: the current gain value.

Reimplemented in RemoteFrameGrabber.

Definition at line 501 of file FrameGrabberInterfaces.h.

◆ getGamma()

virtual double yarp::dev::IFrameGrabberControls::getGamma ( )

inlinevirtual

Read the gamma parameter.

Returns: the current gamma value.

Reimplemented in RemoteFrameGrabber.

Definition at line 489 of file FrameGrabberInterfaces.h.

◆ getHue()

virtual double yarp::dev::IFrameGrabberControls::getHue ( )

inlinevirtual

Read the hue parameter.

Returns: the current hue value.

Reimplemented in RemoteFrameGrabber.

Definition at line 477 of file FrameGrabberInterfaces.h.

◆ getIris()

virtual double yarp::dev::IFrameGrabberControls::getIris ( )

inlinevirtual

Read the iris parameter.

Returns: the current iris value.

Reimplemented in RemoteFrameGrabber.

Definition at line 507 of file FrameGrabberInterfaces.h.

◆ getMode()

virtual bool yarp::dev::IFrameGrabberControls::getMode	(	int	feature,
		FeatureMode *	mode
	)

pure virtual

Get the current mode for the feature.

Parameters

feature	the identifier of the feature to change
hasAuto	flag true if the feature is has 'auto' mode, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ getSaturation()

virtual double yarp::dev::IFrameGrabberControls::getSaturation ( )

inlinevirtual

Read the saturation parameter.

Returns: the current saturation value.

Reimplemented in RemoteFrameGrabber.

Definition at line 483 of file FrameGrabberInterfaces.h.

◆ getSharpness()

virtual double yarp::dev::IFrameGrabberControls::getSharpness ( )

inlinevirtual

Read the sharpness parameter.

Returns: the current sharpness value.

Reimplemented in RemoteFrameGrabber.

Definition at line 463 of file FrameGrabberInterfaces.h.

◆ getShutter()

virtual double yarp::dev::IFrameGrabberControls::getShutter ( )

inlinevirtual

Read the shutter parameter.

Returns: the current shutter value.

Reimplemented in RemoteFrameGrabber.

Definition at line 495 of file FrameGrabberInterfaces.h.

◆ getWhiteBalance()

virtual bool yarp::dev::IFrameGrabberControls::getWhiteBalance	(	double &	blue,
		double &	red
	)

inlinevirtual

Read the white balance parameters.

Parameters

blue	reference to return value for the red parameter.
red	reference to return value for the green parameter.

Returns: true/false.

Reimplemented in RemoteFrameGrabber.

Definition at line 471 of file FrameGrabberInterfaces.h.

◆ hasAuto()

virtual bool yarp::dev::IFrameGrabberControls::hasAuto	(	int	feature,
		bool *	hasAuto
	)

pure virtual

Check if the requested feature has the 'auto' mode.

Parameters

feature	the identifier of the feature to check
hasAuto	flag true if the feature is has 'auto' mode, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, USBCameraDriver, FakeFrameGrabber, depthCameraDriver, and V4L_camera.

◆ hasFeature()

virtual bool yarp::dev::IFrameGrabberControls::hasFeature	(	int	feature,
		bool *	hasFeature
	)

pure virtual

Check if camera has the requested feature (saturation, brightness ...

)

Parameters

feature	the identifier of the feature to check
hasFeature	flag value: true if the feature is present, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ hasManual()

virtual bool yarp::dev::IFrameGrabberControls::hasManual	(	int	feature,
		bool *	hasManual
	)

pure virtual

Check if the requested feature has the 'manual' mode.

Parameters

feature	the identifier of the feature to check
hasAuto	flag true if the feature is has 'manual' mode, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, USBCameraDriver, FakeFrameGrabber, depthCameraDriver, and V4L_camera.

◆ hasOnePush()

virtual bool yarp::dev::IFrameGrabberControls::hasOnePush	(	int	feature,
		bool *	hasOnePush
	)

pure virtual

Check if the requested feature has the 'onePush' mode.

Parameters

feature	the identifier of the feature to check
hasAuto	flag true if the feature is has 'onePush' mode, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, USBCameraDriver, FakeFrameGrabber, depthCameraDriver, and V4L_camera.

◆ hasOnOff()

virtual bool yarp::dev::IFrameGrabberControls::hasOnOff	(	int	feature,
		bool *	HasOnOff
	)

pure virtual

Check if the camera has the ability to turn on/off the requested feature.

Parameters

feature	the identifier of the feature to change
hasOnOff	flag true if this feature can be turned on/off, false otherwise.

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, USBCameraDriver, FakeFrameGrabber, depthCameraDriver, and V4L_camera.

◆ setActive()

virtual bool yarp::dev::IFrameGrabberControls::setActive	(	int	feature,
		bool	onoff
	)

pure virtual

Set the requested feature on or off.

Parameters

feature	the identifier of the feature to change
onoff	true to activate, off to deactivate the feature

Returns: returns true on success, false on failure.

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ setBrightness()

virtual bool yarp::dev::IFrameGrabberControls::setBrightness ( double v )

inlinevirtual

Set the brightness.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 379 of file FrameGrabberInterfaces.h.

◆ setExposure()

virtual bool yarp::dev::IFrameGrabberControls::setExposure ( double v )

inlinevirtual

Set the exposure.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 386 of file FrameGrabberInterfaces.h.

◆ setFeature() [1/2]

virtual bool yarp::dev::IFrameGrabberControls::setFeature	(	int	feature,
		double	value
	)

pure virtual

Set the requested feature to a value (saturation, brightness ...

)

Parameters

feature	the identifier of the feature to change
value	new value of the feature, range from 0 to 1 expressed as a percentage

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ setFeature() [2/2]

virtual bool yarp::dev::IFrameGrabberControls::setFeature	(	int	feature,
		double	value1,
		double	value2
	)

pure virtual

Set the requested feature to a value using 2 params (like white balance)

Parameters

feature	the identifier of the feature to change
value1	first param, from 0 to 1 expressed as a percentage
value2	second param, from 0 to 1 expressed as a percentage

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ setGain()

virtual bool yarp::dev::IFrameGrabberControls::setGain ( double v )

inlinevirtual

Set the gain.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 436 of file FrameGrabberInterfaces.h.

◆ setGamma()

virtual bool yarp::dev::IFrameGrabberControls::setGamma ( double v )

inlinevirtual

Set the gamma.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 422 of file FrameGrabberInterfaces.h.

◆ setHue()

virtual bool yarp::dev::IFrameGrabberControls::setHue ( double v )

inlinevirtual

Set the hue.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 408 of file FrameGrabberInterfaces.h.

◆ setIris()

virtual bool yarp::dev::IFrameGrabberControls::setIris ( double v )

inlinevirtual

Set the iris.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 443 of file FrameGrabberInterfaces.h.

◆ setMode()

virtual bool yarp::dev::IFrameGrabberControls::setMode	(	int	feature,
		FeatureMode	mode
	)

pure virtual

Set the requested mode for the feature.

Parameters

feature	the identifier of the feature to change
auto_onoff	true to activate 'auto' mode, false to activate 'manual' mode

Returns: returns true on success, false on failure.

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ setOnePush()

virtual bool yarp::dev::IFrameGrabberControls::setOnePush ( int feature )

pure virtual

Set the requested feature to a value (saturation, brightness ...

)

Parameters

feature	the identifier of the feature to change
value	new value of the feature, from 0 to 1 as a percentage of param range

Returns: returns true on success, false on failure.

Implemented in yarp::dev::FrameGrabberControls_Sender, V4L_camera, USBCameraDriver, FakeFrameGrabber, and depthCameraDriver.

◆ setSaturation()

virtual bool yarp::dev::IFrameGrabberControls::setSaturation ( double v )

inlinevirtual

Set the saturation.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 415 of file FrameGrabberInterfaces.h.

◆ setSharpness()

virtual bool yarp::dev::IFrameGrabberControls::setSharpness ( double v )

inlinevirtual

Set the sharpness.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 393 of file FrameGrabberInterfaces.h.

◆ setShutter()

virtual bool yarp::dev::IFrameGrabberControls::setShutter ( double v )

inlinevirtual

Set the shutter parameter.

Parameters

v	new value for parameter.

Returns: true on success.

Reimplemented in RemoteFrameGrabber.

Definition at line 429 of file FrameGrabberInterfaces.h.

◆ setWhiteBalance()

virtual bool yarp::dev::IFrameGrabberControls::setWhiteBalance	(	double	blue,
		double	red
	)

inlinevirtual

Set the white balance for the frame grabber.

Parameters

blue	component gain.
red	component gain.

Returns: true/false if successful or not.

Reimplemented in RemoteFrameGrabber.

Definition at line 401 of file FrameGrabberInterfaces.h.

◆ toFeatureMode()

FeatureMode yarp::dev::IFrameGrabberControls::toFeatureMode ( bool _auto )

inline

Definition at line 585 of file FrameGrabberInterfaces.h.

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

src/libYARP_dev/src/yarp/dev/FrameGrabberInterfaces.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IFrameGrabberControls()

Member Function Documentation

◆ busType2String()

◆ featureEnum2Vocab()

◆ featureVOCABEnum()

◆ getActive()

◆ getBrightness()

◆ getCameraDescription()

◆ getExposure()

◆ getFeature() [1/2]

◆ getFeature() [2/2]

◆ getGain()

◆ getGamma()

◆ getHue()

◆ getIris()

◆ getMode()

◆ getSaturation()

◆ getSharpness()

◆ getShutter()

◆ getWhiteBalance()

◆ hasAuto()

◆ hasFeature()

◆ hasManual()

◆ hasOnePush()

◆ hasOnOff()

◆ setActive()

◆ setBrightness()

◆ setExposure()

◆ setFeature() [1/2]

◆ setFeature() [2/2]

◆ setGain()

◆ setGamma()

◆ setHue()

◆ setIris()

◆ setMode()

◆ setOnePush()

◆ setSaturation()

◆ setSharpness()

◆ setShutter()

◆ setWhiteBalance()

◆ toFeatureMode()