frameGrabber_nwc_yarp: The client of a frameGrabber_nws_yarp. More...

#include <networkWrappers/frameGrabber_nwc_yarp/FrameGrabber_nwc_yarp.h>

Inheritance diagram for FrameGrabber_nwc_yarp:

Public Member Functions
	FrameGrabber_nwc_yarp ()

	FrameGrabber_nwc_yarp (const FrameGrabber_nwc_yarp &)=delete

	FrameGrabber_nwc_yarp (FrameGrabber_nwc_yarp &&)=delete

FrameGrabber_nwc_yarp &	operator= (const FrameGrabber_nwc_yarp &)=delete

FrameGrabber_nwc_yarp &	operator= (FrameGrabber_nwc_yarp &&)=delete

	~FrameGrabber_nwc_yarp () override=default

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.

yarp::dev::ReturnValue	getCameraDescription (yarp::dev::CameraDescriptor &camera) override
	Get a basic description of the camera hw.

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	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	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	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	hasOnePush (yarp::dev::cameraFeature_id_t feature, bool &hasOnePush) override
	Check if the requested feature has the 'onePush' 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	setOnePush (yarp::dev::cameraFeature_id_t feature) override
	Set the requested feature to a value (saturation, brightness ... )

yarp::dev::ReturnValue	getVideoModeMaskDC1394 (unsigned int &val) override

yarp::dev::ReturnValue	getVideoModeDC1394 (unsigned int &val) override

yarp::dev::ReturnValue	setVideoModeDC1394 (int video_mode) override

yarp::dev::ReturnValue	getFPSMaskDC1394 (unsigned int &val) override

yarp::dev::ReturnValue	getFPSDC1394 (unsigned int &val) override

yarp::dev::ReturnValue	setFPSDC1394 (int fps) override

yarp::dev::ReturnValue	getISOSpeedDC1394 (unsigned int &val) override

yarp::dev::ReturnValue	setISOSpeedDC1394 (int speed) override

yarp::dev::ReturnValue	getColorCodingMaskDC1394 (unsigned int video_mode, unsigned int &val) override

yarp::dev::ReturnValue	getColorCodingDC1394 (unsigned int &val) override

yarp::dev::ReturnValue	setColorCodingDC1394 (int coding) override

yarp::dev::ReturnValue	getFormat7MaxWindowDC1394 (unsigned int &xdim, unsigned int &ydim, unsigned int &xstep, unsigned int &ystep, unsigned int &xoffstep, unsigned int &yoffstep) override

yarp::dev::ReturnValue	getFormat7WindowDC1394 (unsigned int &xdim, unsigned int &ydim, int &x0, int &y0) override

yarp::dev::ReturnValue	setFormat7WindowDC1394 (unsigned int xdim, unsigned int ydim, int x0, int y0) override

yarp::dev::ReturnValue	setOperationModeDC1394 (bool b1394b) override

yarp::dev::ReturnValue	getOperationModeDC1394 (bool &b1394b) override

yarp::dev::ReturnValue	setTransmissionDC1394 (bool bTxON) override

yarp::dev::ReturnValue	getTransmissionDC1394 (bool &bTxON) override

yarp::dev::ReturnValue	setBroadcastDC1394 (bool onoff) override

yarp::dev::ReturnValue	setDefaultsDC1394 () override

yarp::dev::ReturnValue	setResetDC1394 () override

yarp::dev::ReturnValue	setPowerDC1394 (bool onoff) override

yarp::dev::ReturnValue	setCaptureDC1394 (bool bON) override

yarp::dev::ReturnValue	getBytesPerPacketDC1394 (unsigned int &bpp) override

yarp::dev::ReturnValue	setBytesPerPacketDC1394 (unsigned int bpp) override

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

bool	close () override
	Close the DeviceDriver.

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

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 FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelRgb > >
	FrameGrabberOf_ForwarderWithStream (FrameGrabberMsgs *thriftClient)

	~FrameGrabberOf_ForwarderWithStream () override=default

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

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

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

yarp::dev::ReturnValue	getImageCrop (yarp::dev::cropType_id_t cropType, std::vector< yarp::dev::vertex_t > vertices, yarp::sig::ImageOf< yarp::sig::PixelRgb > &image) override
	Get a crop of the image from the frame grabber.

void	setStreamReceiver (StreamReceiver *m_streamReceiver)

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

Public Member Functions inherited from FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelMono > >
	FrameGrabberOf_ForwarderWithStream (FrameGrabberMsgs *thriftClient)

	~FrameGrabberOf_ForwarderWithStream () override=default

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

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

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

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

void	setStreamReceiver (StreamReceiver *m_streamReceiver)

Public Member Functions inherited from FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelFloat > >
	FrameGrabberOf_ForwarderWithStream (FrameGrabberMsgs *thriftClient)

	~FrameGrabberOf_ForwarderWithStream () override=default

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

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

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

yarp::dev::ReturnValue	getImageCrop (yarp::dev::cropType_id_t cropType, std::vector< yarp::dev::vertex_t > vertices, yarp::sig::ImageOf< yarp::sig::PixelFloat > &image) override
	Get a crop of the image from the frame grabber.

void	setStreamReceiver (StreamReceiver *m_streamReceiver)

Public Member Functions inherited from FrameGrabberOf_ForwarderWithStream< yarp::sig::FlexImage >
	FrameGrabberOf_ForwarderWithStream (FrameGrabberMsgs *thriftClient)

	~FrameGrabberOf_ForwarderWithStream () override=default

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

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

yarp::dev::ReturnValue	getImage (yarp::sig::FlexImage &image) override
	Get an image from the frame grabber.

yarp::dev::ReturnValue	getImageCrop (yarp::dev::cropType_id_t cropType, std::vector< yarp::dev::vertex_t > vertices, yarp::sig::FlexImage &image) override
	Get a crop of the image from the frame grabber.

void	setStreamReceiver (StreamReceiver *m_streamReceiver)

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::IFrameGrabberControlsDC1394
virtual	~IFrameGrabberControlsDC1394 ()

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

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

Public Member Functions inherited from FrameGrabber_nwc_yarp_ParamsParser
	FrameGrabber_nwc_yarp_ParamsParser ()

	~FrameGrabber_nwc_yarp_ParamsParser () override=default

bool	parseParams (const yarp::os::Searchable &config) override
	Parse the DeviceDriver parameters.

std::string	getDeviceClassName () const override
	Get the name of the DeviceDriver class.

std::string	getDeviceName () const override
	Get the name of the device (i.e.

std::string	getDocumentationOfDeviceParams () const override
	Get the documentation of the DeviceDriver's parameters.

std::vector< std::string >	getListOfParams () const override
	Return a list of all params used by the device.

bool	getParamValue (const std::string &paramName, std::string &paramValue) const override
	Return the value (represented as a string) of the requested parameter.

std::string	getConfiguration () const override
	Return the configuration of the device.

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

Additional Inherited Members
Public Attributes inherited from FrameGrabber_nwc_yarp_ParamsParser
const std::string	m_device_classname = {"FrameGrabber_nwc_yarp"}

const std::string	m_device_name = {"frameGrabber_nwc_yarp"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

std::string	m_provided_configuration

const std::string	m_local_defaultValue = {""}

const std::string	m_remote_defaultValue = {""}

const std::string	m_carrier_defaultValue = {"fast_tcp"}

const std::string	m_no_stream_defaultValue = {"false"}

std::string	m_local = {}

std::string	m_remote = {}

std::string	m_carrier = {"fast_tcp"}

bool	m_no_stream = {false}

Detailed Description

frameGrabber_nwc_yarp: The client of a frameGrabber_nws_yarp.

frameGrabber_nwc_yarp

Parameters required by this device are shown in class: FrameGrabber_nwc_yarp_ParamsParser

Definition at line 63 of file FrameGrabber_nwc_yarp.h.

Constructor & Destructor Documentation

◆ FrameGrabber_nwc_yarp() [1/3]

FrameGrabber_nwc_yarp::FrameGrabber_nwc_yarp ( )

Definition at line 175 of file FrameGrabber_nwc_yarp.cpp.

◆ FrameGrabber_nwc_yarp() [2/3]

FrameGrabber_nwc_yarp::FrameGrabber_nwc_yarp ( const FrameGrabber_nwc_yarp & )

delete

◆ FrameGrabber_nwc_yarp() [3/3]

FrameGrabber_nwc_yarp::FrameGrabber_nwc_yarp ( FrameGrabber_nwc_yarp && )

delete

◆ ~FrameGrabber_nwc_yarp()

FrameGrabber_nwc_yarp::~FrameGrabber_nwc_yarp ( )

overridedefault

Member Function Documentation

◆ close()

bool FrameGrabber_nwc_yarp::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 230 of file FrameGrabber_nwc_yarp.cpp.

◆ getActive()

ReturnValue FrameGrabber_nwc_yarp::getActive	(	yarp::dev::cameraFeature_id_t	feature,
		bool &	isActive
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 394 of file FrameGrabber_nwc_yarp.cpp.

◆ getBytesPerPacketDC1394()

ReturnValue FrameGrabber_nwc_yarp::getBytesPerPacketDC1394 ( unsigned int & bpp )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 636 of file FrameGrabber_nwc_yarp.cpp.

◆ getCameraDescription()

ReturnValue FrameGrabber_nwc_yarp::getCameraDescription ( yarp::dev::CameraDescriptor & camera )

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 331 of file FrameGrabber_nwc_yarp.cpp.

◆ getColorCodingDC1394()

ReturnValue FrameGrabber_nwc_yarp::getColorCodingDC1394 ( unsigned int & val )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 520 of file FrameGrabber_nwc_yarp.cpp.

◆ getColorCodingMaskDC1394()

ReturnValue FrameGrabber_nwc_yarp::getColorCodingMaskDC1394	(	unsigned int	video_mode,
		unsigned int &	val
	)

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 512 of file FrameGrabber_nwc_yarp.cpp.

◆ getFeature() [1/2]

ReturnValue FrameGrabber_nwc_yarp::getFeature	(	yarp::dev::cameraFeature_id_t	feature,
		double &	value
	)

overridevirtual

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.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 355 of file FrameGrabber_nwc_yarp.cpp.

◆ getFeature() [2/2]

ReturnValue FrameGrabber_nwc_yarp::getFeature	(	yarp::dev::cameraFeature_id_t	feature,
		double &	value1,
		double &	value2
	)

overridevirtual

Get the current value for the requested feature.

Parameters

feature	the identifier of the feature 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.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 370 of file FrameGrabber_nwc_yarp.cpp.

◆ getFormat7MaxWindowDC1394()

ReturnValue FrameGrabber_nwc_yarp::getFormat7MaxWindowDC1394	(	unsigned int &	xdim,
		unsigned int &	ydim,
		unsigned int &	xstep,
		unsigned int &	ystep,
		unsigned int &	xoffstep,
		unsigned int &	yoffstep
	)

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 535 of file FrameGrabber_nwc_yarp.cpp.

◆ getFormat7WindowDC1394()

ReturnValue FrameGrabber_nwc_yarp::getFormat7WindowDC1394	(	unsigned int &	xdim,
		unsigned int &	ydim,
		int &	x0,
		int &	y0
	)

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 553 of file FrameGrabber_nwc_yarp.cpp.

◆ getFPSDC1394()

ReturnValue FrameGrabber_nwc_yarp::getFPSDC1394 ( unsigned int & val )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 482 of file FrameGrabber_nwc_yarp.cpp.

◆ getFPSMaskDC1394()

ReturnValue FrameGrabber_nwc_yarp::getFPSMaskDC1394 ( unsigned int & val )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 474 of file FrameGrabber_nwc_yarp.cpp.

◆ getISOSpeedDC1394()

ReturnValue FrameGrabber_nwc_yarp::getISOSpeedDC1394 ( unsigned int & val )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 497 of file FrameGrabber_nwc_yarp.cpp.

◆ getLastInputStamp()

yarp::os::Stamp FrameGrabber_nwc_yarp::getLastInputStamp ( )

overridevirtual

Return the time stamp relative to the last acquisition.

Implements yarp::dev::IPreciselyTimed.

Definition at line 241 of file FrameGrabber_nwc_yarp.cpp.

◆ getMode()

ReturnValue FrameGrabber_nwc_yarp::getMode	(	yarp::dev::cameraFeature_id_t	feature,
		yarp::dev::FeatureMode &	mode
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 433 of file FrameGrabber_nwc_yarp.cpp.

◆ getOperationModeDC1394()

ReturnValue FrameGrabber_nwc_yarp::getOperationModeDC1394 ( bool & b1394b )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 578 of file FrameGrabber_nwc_yarp.cpp.

◆ getRgbFOV()

ReturnValue FrameGrabber_nwc_yarp::getRgbFOV	(	double &	horizontalFov,
		double &	verticalFov
	)

overridevirtual

Get the field of view (FOV) of the rgb camera.

Parameters

horizontalFov	will return the value of the horizontal fov in degrees
verticalFov	will return the value of the vertical fov in degrees

Returns: true on success

Implements yarp::dev::IRgbVisualParams.

Definition at line 288 of file FrameGrabber_nwc_yarp.cpp.

◆ getRgbHeight()

int FrameGrabber_nwc_yarp::getRgbHeight ( )

overridevirtual

Return the height of each frame.

Returns: rgb image height

Implements yarp::dev::IRgbVisualParams.

Definition at line 250 of file FrameGrabber_nwc_yarp.cpp.

◆ getRgbIntrinsicParam()

ReturnValue FrameGrabber_nwc_yarp::getRgbIntrinsicParam ( yarp::os::Property & intrinsic )

overridevirtual

Get the intrinsic parameters of the rgb camera.

Parameters

intrinsic return a Property containing intrinsic parameters of the optical model of the camera.

Returns: true if success

The yarp::os::Property describing the intrinsic parameters is expected to be in the form:

Parameter name	SubParameter	Type	Units	Default Value	Required	Description	Notes
physFocalLength	-	double	m	-	Yes	Physical focal length of the lens in meters
focalLengthX	-	double	pixel	-	Yes	Horizontal component of the focal length as a multiple of pixel width
focalLengthY	-	double	pixel	-	Yes	Vertical component of the focal length as a multiple of pixel height
principalPointX	-	double	pixel	-	Yes	X coordinate of the principal point
principalPointY	-	double	pixel	-	Yes	Y coordinate of the principal point
rectificationMatrix	-	4x4 double matrix	-	-	Yes	Matrix that describes the lens' distortion
distortionModel	-	string	-	-	Yes	Reference to group of parameters describing the distortion model of the camera, example 'cameraDistortionModelGroup'	This is another group's name to be searched for in the config file
cameraDistortionModelGroup
	name	string	-	-	Yes	Name of the distortion model, see notes	right now only 'plumb_bob' is supported
	k1	double	-	-	Yes	Radial distortion coefficient of the lens
	k2	double	-	-	Yes	Radial distortion coefficient of the lens
	k3	double	-	-	Yes	Radial distortion coefficient of the lens
	t1	double	-	-	Yes	Tangential distortion of the lens
	t2	double	-	-	Yes	Tangential distortion of the lens

Implements yarp::dev::IRgbVisualParams.

Definition at line 305 of file FrameGrabber_nwc_yarp.cpp.

◆ getRgbMirroring()

ReturnValue FrameGrabber_nwc_yarp::getRgbMirroring ( bool & mirror )

overridevirtual

Get the mirroring setting of the sensor.

Parameters

mirror true if image is mirrored, false otherwise

Returns: true if success

Implements yarp::dev::IRgbVisualParams.

Definition at line 313 of file FrameGrabber_nwc_yarp.cpp.

◆ getRgbResolution()

ReturnValue FrameGrabber_nwc_yarp::getRgbResolution	(	int &	width,
		int &	height
	)

overridevirtual

Get the resolution of the rgb image from the camera.

Parameters

width	image width
height	image height

Returns: true on success

Implements yarp::dev::IRgbVisualParams.

Definition at line 272 of file FrameGrabber_nwc_yarp.cpp.

◆ getRgbSupportedConfigurations()

ReturnValue FrameGrabber_nwc_yarp::getRgbSupportedConfigurations ( std::vector< yarp::dev::CameraConfig > & configurations )

overridevirtual

Get the possible configurations of the camera.

Parameters

configurations list of camera supported configurations as CameraConfig type

Returns: true on success

Implements yarp::dev::IRgbVisualParams.

Definition at line 264 of file FrameGrabber_nwc_yarp.cpp.

◆ getRgbWidth()

int FrameGrabber_nwc_yarp::getRgbWidth ( )

overridevirtual

Return the width of each frame.

Returns: rgb image width

Implements yarp::dev::IRgbVisualParams.

Definition at line 257 of file FrameGrabber_nwc_yarp.cpp.

◆ getTransmissionDC1394()

ReturnValue FrameGrabber_nwc_yarp::getTransmissionDC1394 ( bool & bTxON )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 593 of file FrameGrabber_nwc_yarp.cpp.

◆ getVideoModeDC1394()

ReturnValue FrameGrabber_nwc_yarp::getVideoModeDC1394 ( unsigned int & val )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 459 of file FrameGrabber_nwc_yarp.cpp.

◆ getVideoModeMaskDC1394()

ReturnValue FrameGrabber_nwc_yarp::getVideoModeMaskDC1394 ( unsigned int & val )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 451 of file FrameGrabber_nwc_yarp.cpp.

◆ hasAuto()

ReturnValue FrameGrabber_nwc_yarp::hasAuto	(	yarp::dev::cameraFeature_id_t	feature,
		bool &	hasAuto
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 402 of file FrameGrabber_nwc_yarp.cpp.

◆ hasFeature()

ReturnValue FrameGrabber_nwc_yarp::hasFeature	(	yarp::dev::cameraFeature_id_t	,
		bool &	hasFeature
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 340 of file FrameGrabber_nwc_yarp.cpp.

◆ hasManual()

ReturnValue FrameGrabber_nwc_yarp::hasManual	(	yarp::dev::cameraFeature_id_t	feature,
		bool &	hasManual
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 410 of file FrameGrabber_nwc_yarp.cpp.

◆ hasOnePush()

ReturnValue FrameGrabber_nwc_yarp::hasOnePush	(	yarp::dev::cameraFeature_id_t	feature,
		bool &	hasOnePush
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 418 of file FrameGrabber_nwc_yarp.cpp.

◆ hasOnOff()

ReturnValue FrameGrabber_nwc_yarp::hasOnOff	(	yarp::dev::cameraFeature_id_t	feature,
		bool &	HasOnOff
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 379 of file FrameGrabber_nwc_yarp.cpp.

◆ open()

bool FrameGrabber_nwc_yarp::open ( yarp::os::Searchable & config )

overridevirtual

Open the DeviceDriver.

Parameters

config is a list of parameters for the device. Which parameters are effective for your device can vary. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).

Returns: true/false upon success/failure

attach the message server

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 184 of file FrameGrabber_nwc_yarp.cpp.

◆ operator=() [1/2]

FrameGrabber_nwc_yarp & FrameGrabber_nwc_yarp::operator= ( const FrameGrabber_nwc_yarp & )

delete

◆ operator=() [2/2]

FrameGrabber_nwc_yarp & FrameGrabber_nwc_yarp::operator= ( FrameGrabber_nwc_yarp && )

delete

◆ setActive()

ReturnValue FrameGrabber_nwc_yarp::setActive	(	yarp::dev::cameraFeature_id_t	feature,
		bool	onoff
	)

overridevirtual

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.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 387 of file FrameGrabber_nwc_yarp.cpp.

◆ setBroadcastDC1394()

ReturnValue FrameGrabber_nwc_yarp::setBroadcastDC1394 ( bool onoff )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 601 of file FrameGrabber_nwc_yarp.cpp.

◆ setBytesPerPacketDC1394()

ReturnValue FrameGrabber_nwc_yarp::setBytesPerPacketDC1394 ( unsigned int bpp )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 644 of file FrameGrabber_nwc_yarp.cpp.

◆ setCaptureDC1394()

ReturnValue FrameGrabber_nwc_yarp::setCaptureDC1394 ( bool bON )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 629 of file FrameGrabber_nwc_yarp.cpp.

◆ setColorCodingDC1394()

ReturnValue FrameGrabber_nwc_yarp::setColorCodingDC1394 ( int coding )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 528 of file FrameGrabber_nwc_yarp.cpp.

◆ setDefaultsDC1394()

ReturnValue FrameGrabber_nwc_yarp::setDefaultsDC1394 ( )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 608 of file FrameGrabber_nwc_yarp.cpp.

◆ setFeature() [1/2]

ReturnValue FrameGrabber_nwc_yarp::setFeature	(	yarp::dev::cameraFeature_id_t	feature,
		double	value
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 348 of file FrameGrabber_nwc_yarp.cpp.

◆ setFeature() [2/2]

ReturnValue FrameGrabber_nwc_yarp::setFeature	(	yarp::dev::cameraFeature_id_t	feature,
		double	value1,
		double	value2
	)

overridevirtual

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)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 363 of file FrameGrabber_nwc_yarp.cpp.

◆ setFormat7WindowDC1394()

ReturnValue FrameGrabber_nwc_yarp::setFormat7WindowDC1394	(	unsigned int	xdim,
		unsigned int	ydim,
		int	x0,
		int	y0
	)

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 564 of file FrameGrabber_nwc_yarp.cpp.

◆ setFPSDC1394()

ReturnValue FrameGrabber_nwc_yarp::setFPSDC1394 ( int fps )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 490 of file FrameGrabber_nwc_yarp.cpp.

◆ setISOSpeedDC1394()

ReturnValue FrameGrabber_nwc_yarp::setISOSpeedDC1394 ( int speed )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 505 of file FrameGrabber_nwc_yarp.cpp.

◆ setMode()

ReturnValue FrameGrabber_nwc_yarp::setMode	(	yarp::dev::cameraFeature_id_t	feature,
		yarp::dev::FeatureMode	mode
	)

overridevirtual

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.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 426 of file FrameGrabber_nwc_yarp.cpp.

◆ setOnePush()

ReturnValue FrameGrabber_nwc_yarp::setOnePush ( yarp::dev::cameraFeature_id_t feature )

overridevirtual

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.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 441 of file FrameGrabber_nwc_yarp.cpp.

◆ setOperationModeDC1394()

ReturnValue FrameGrabber_nwc_yarp::setOperationModeDC1394 ( bool b1394b )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 571 of file FrameGrabber_nwc_yarp.cpp.

◆ setPowerDC1394()

ReturnValue FrameGrabber_nwc_yarp::setPowerDC1394 ( bool onoff )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 622 of file FrameGrabber_nwc_yarp.cpp.

◆ setResetDC1394()

ReturnValue FrameGrabber_nwc_yarp::setResetDC1394 ( )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 615 of file FrameGrabber_nwc_yarp.cpp.

◆ setRgbFOV()

ReturnValue FrameGrabber_nwc_yarp::setRgbFOV	(	double	horizontalFov,
		double	verticalFov
	)

overridevirtual

Set the field of view (FOV) of the rgb camera.

Parameters

horizontalFov	will set the value of the horizontal fov in degrees
verticalFov	will set the value of the vertical fov in degrees

Returns: true on success

Implements yarp::dev::IRgbVisualParams.

Definition at line 298 of file FrameGrabber_nwc_yarp.cpp.

◆ setRgbMirroring()

ReturnValue FrameGrabber_nwc_yarp::setRgbMirroring ( bool mirror )

overridevirtual

Set the mirroring setting of the sensor.

Parameters

mirror true if image should be mirrored, false otherwise

Returns: true if success

Implements yarp::dev::IRgbVisualParams.

Definition at line 321 of file FrameGrabber_nwc_yarp.cpp.

◆ setRgbResolution()

ReturnValue FrameGrabber_nwc_yarp::setRgbResolution	(	int	width,
		int	height
	)

overridevirtual

Set the resolution of the rgb image from the camera.

Parameters

width	image width
height	image height

Returns: true on success

Implements yarp::dev::IRgbVisualParams.

Definition at line 281 of file FrameGrabber_nwc_yarp.cpp.

◆ setTransmissionDC1394()

ReturnValue FrameGrabber_nwc_yarp::setTransmissionDC1394 ( bool bTxON )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 586 of file FrameGrabber_nwc_yarp.cpp.

◆ setVideoModeDC1394()

ReturnValue FrameGrabber_nwc_yarp::setVideoModeDC1394 ( int video_mode )

overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 467 of file FrameGrabber_nwc_yarp.cpp.

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

src/devices/networkWrappers/frameGrabber_nwc_yarp/FrameGrabber_nwc_yarp.h
src/devices/networkWrappers/frameGrabber_nwc_yarp/FrameGrabber_nwc_yarp.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

frameGrabber_nwc_yarp

Constructor & Destructor Documentation

◆ FrameGrabber_nwc_yarp() [1/3]

◆ FrameGrabber_nwc_yarp() [2/3]

◆ FrameGrabber_nwc_yarp() [3/3]

◆ ~FrameGrabber_nwc_yarp()

Member Function Documentation

◆ close()

◆ getActive()

◆ getBytesPerPacketDC1394()

◆ getCameraDescription()

◆ getColorCodingDC1394()

◆ getColorCodingMaskDC1394()

◆ getFeature() [1/2]

◆ getFeature() [2/2]

◆ getFormat7MaxWindowDC1394()

◆ getFormat7WindowDC1394()

◆ getFPSDC1394()

◆ getFPSMaskDC1394()

◆ getISOSpeedDC1394()

◆ getLastInputStamp()

◆ getMode()

◆ getOperationModeDC1394()

◆ getRgbFOV()

◆ getRgbHeight()

◆ getRgbIntrinsicParam()

◆ getRgbMirroring()

◆ getRgbResolution()

◆ getRgbSupportedConfigurations()

◆ getRgbWidth()

◆ getTransmissionDC1394()

◆ getVideoModeDC1394()

◆ getVideoModeMaskDC1394()

◆ hasAuto()

◆ hasFeature()

◆ hasManual()

◆ hasOnePush()

◆ hasOnOff()

◆ open()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setActive()

◆ setBroadcastDC1394()

◆ setBytesPerPacketDC1394()

◆ setCaptureDC1394()

◆ setColorCodingDC1394()

◆ setDefaultsDC1394()

◆ setFeature() [1/2]

◆ setFeature() [2/2]

◆ setFormat7WindowDC1394()

◆ setFPSDC1394()

◆ setISOSpeedDC1394()

◆ setMode()

◆ setOnePush()

◆ setOperationModeDC1394()

◆ setPowerDC1394()

◆ setResetDC1394()

◆ setRgbFOV()

◆ setRgbMirroring()

◆ setRgbResolution()

◆ setTransmissionDC1394()

◆ setVideoModeDC1394()