usbCameraRaw: Documentation to be added More...

#include <usbCamera/common/USBcamera.h>

Inheritance diagram for USBCameraDriverRaw:

Public Member Functions
	USBCameraDriverRaw ()

	~USBCameraDriverRaw () override

yarp::dev::ReturnValue	getImage (yarp::sig::ImageOf< yarp::sig::PixelMono > &image) override
	Get an image from the frame grabber.

int	height () const override
	Return the height of each frame.

int	width () const override
	Return the width of each frame.

Public Member Functions inherited from USBCameraDriver
	USBCameraDriver ()
	Constructor.

	~USBCameraDriver () override
	Destructor.

bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

int	height () const

int	width () const

yarp::os::Stamp	getLastInputStamp () override
	Return the time stamp relative to the last acquisition.

yarp::dev::ReturnValue	getCameraDescription (yarp::dev::CameraDescriptor &camera) override
	Implementation of IFrameGrabberControls2 interface.

yarp::dev::ReturnValue	hasFeature (yarp::dev::cameraFeature_id_t feature, bool &hasFeature) override
	Check if camera has the requested feature (saturation, brightness ... )

yarp::dev::ReturnValue	setFeature (yarp::dev::cameraFeature_id_t feature, double value) override
	Set the requested feature to a value (saturation, brightness ... )

yarp::dev::ReturnValue	getFeature (yarp::dev::cameraFeature_id_t feature, double &value) override
	Get the current value for the requested feature.

yarp::dev::ReturnValue	setFeature (yarp::dev::cameraFeature_id_t feature, double value1, double value2) override
	Set the requested feature to a value using 2 params (like white balance)

yarp::dev::ReturnValue	getFeature (yarp::dev::cameraFeature_id_t feature, double &value1, double &value2) override
	Get the current value for the requested feature.

yarp::dev::ReturnValue	setActive (yarp::dev::cameraFeature_id_t feature, bool onoff) override
	Set the requested feature on or off.

yarp::dev::ReturnValue	getActive (yarp::dev::cameraFeature_id_t feature, bool &isActive) override
	Get the current status of the feature, on or off.

yarp::dev::ReturnValue	hasOnOff (yarp::dev::cameraFeature_id_t feature, bool &HasOnOff) override
	Check if the camera has the ability to turn on/off the requested feature.

yarp::dev::ReturnValue	hasAuto (yarp::dev::cameraFeature_id_t feature, bool &hasAuto) override
	Check if the requested feature has the 'auto' mode.

yarp::dev::ReturnValue	hasManual (yarp::dev::cameraFeature_id_t feature, bool &hasManual) override
	Check if the requested feature has the 'manual' mode.

yarp::dev::ReturnValue	setMode (yarp::dev::cameraFeature_id_t feature, yarp::dev::FeatureMode mode) override
	Set the requested mode for the feature.

yarp::dev::ReturnValue	getMode (yarp::dev::cameraFeature_id_t feature, yarp::dev::FeatureMode &mode) override
	Get the current mode for the feature.

yarp::dev::ReturnValue	hasOnePush (yarp::dev::cameraFeature_id_t feature, bool &hasOnePush) override
	Check if the requested feature has the 'onePush' mode.

yarp::dev::ReturnValue	setOnePush (yarp::dev::cameraFeature_id_t feature) override
	Set the requested feature to a value (saturation, brightness ... )

int	getRgbHeight () override
	Return the height of each frame.

int	getRgbWidth () override
	Return the width of each frame.

yarp::dev::ReturnValue	getRgbSupportedConfigurations (std::vector< yarp::dev::CameraConfig > &configurations) override
	Get the possible configurations of the camera.

yarp::dev::ReturnValue	getRgbResolution (int &width, int &height) override
	Get the resolution of the rgb image from the camera.

yarp::dev::ReturnValue	setRgbResolution (int width, int height) override
	Set the resolution of the rgb image from the camera.

yarp::dev::ReturnValue	getRgbFOV (double &horizontalFov, double &verticalFov) override
	Get the field of view (FOV) of the rgb camera.

yarp::dev::ReturnValue	setRgbFOV (double horizontalFov, double verticalFov) override
	Set the field of view (FOV) of the rgb camera.

yarp::dev::ReturnValue	getRgbIntrinsicParam (yarp::os::Property &intrinsic) override
	Get the intrinsic parameters of the rgb camera.

yarp::dev::ReturnValue	getRgbMirroring (bool &mirror) override
	Get the mirroring setting of the sensor.

yarp::dev::ReturnValue	setRgbMirroring (bool mirror) override
	Set the mirroring setting of the sensor.

Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()

	DeviceDriver (const DeviceDriver &other)=delete

	DeviceDriver (DeviceDriver &&other) noexcept=delete

DeviceDriver &	operator= (const DeviceDriver &other)=delete

DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete

virtual	~DeviceDriver ()

virtual std::string	id () const
	Return the id assigned to the PolyDriver.

virtual void	setId (const std::string &id)
	Set the id for this device.

template<class T >
bool	view (T *&x)
	Get an interface to the device driver.

virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.

Public Member Functions inherited from yarp::dev::IPreciselyTimed
virtual	~IPreciselyTimed ()

Public Member Functions inherited from yarp::dev::IFrameGrabberControls
virtual	~IFrameGrabberControls ()
	Destructor.

std::string	busType2String (BusType type)

FeatureMode	toFeatureMode (bool _auto)

Public Member Functions inherited from yarp::dev::IRgbVisualParams
virtual	~IRgbVisualParams ()

Public Member Functions inherited from yarp::dev::IFrameGrabberOf< yarp::sig::ImageOf< yarp::sig::PixelMono > >
virtual yarp::dev::ReturnValue	getImageCrop (yarp::dev::cropType_id_t cropType, std::vector< vertex_t > vertices, yarp::sig::ImageOf< yarp::sig::PixelMono > &image)
	Get a crop of the image from the frame grabber.

Public Member Functions inherited from yarp::dev::IFrameGrabberImageBase
virtual	~IFrameGrabberImageBase ()
	Destructor.

Additional Inherited Members
Protected Attributes inherited from USBCameraDriver
yarp::dev::IPreciselyTimed *	deviceTimed

yarp::dev::IFrameGrabberImage *	frameGrabberImage

yarp::dev::IFrameGrabberImageRaw *	frameGrabberImageRaw

yarp::dev::DeviceDriver *	os_device

yarp::dev::IFrameGrabberControls *	deviceControls

yarp::dev::IRgbVisualParams *	deviceRgbVisualParam

size_t	_width

size_t	_height

int	pixelType

Detailed Description

usbCameraRaw: Documentation to be added

Definition at line 127 of file USBcamera.h.

Constructor & Destructor Documentation

◆ USBCameraDriverRaw()

USBCameraDriverRaw::USBCameraDriverRaw ( )

Definition at line 250 of file USBcamera.cpp.

◆ ~USBCameraDriverRaw()

USBCameraDriverRaw::~USBCameraDriverRaw ( )

override

Definition at line 257 of file USBcamera.cpp.

Member Function Documentation

◆ getImage()

yarp::dev::ReturnValue USBCameraDriverRaw::getImage ( yarp::sig::ImageOf< yarp::sig::PixelMono > & image )

overridevirtual

Get an image from the frame grabber.

Parameters

image the image to be filled

Returns: true/false upon success/failure

Implements yarp::dev::IFrameGrabberOf< yarp::sig::ImageOf< yarp::sig::PixelMono > >.

Definition at line 262 of file USBcamera.cpp.

◆ height()

int USBCameraDriverRaw::height ( ) const

overridevirtual

Return the height of each frame.

Returns: image height

Implements yarp::dev::IFrameGrabberImageBase.

Definition at line 272 of file USBcamera.cpp.

◆ width()

int USBCameraDriverRaw::width ( ) const

overridevirtual

Return the width of each frame.

Returns: image width

Implements yarp::dev::IFrameGrabberImageBase.

Definition at line 267 of file USBcamera.cpp.

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

src/devices/usbCamera/common/USBcamera.h
src/devices/usbCamera/common/USBcamera.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ USBCameraDriverRaw()

◆ ~USBCameraDriverRaw()

Member Function Documentation

◆ getImage()

◆ height()

◆ width()