FrameGrabberCropper: An image frame grabber device which can also crop the frame. More...

#include <frameGrabberCropper/FrameGrabberCropper.h>

Inheritance diagram for FrameGrabberCropper:

Public Member Functions
	FrameGrabberCropper ()=default

	FrameGrabberCropper (const FrameGrabberCropper &)=delete

	FrameGrabberCropper (FrameGrabberCropper &&)=delete

FrameGrabberCropper &	operator= (const FrameGrabberCropper &)=delete

FrameGrabberCropper &	operator= (FrameGrabberCropper &&)=delete

	~FrameGrabberCropper () override

bool	close () override
	Close the DeviceDriver.

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

bool	attach (yarp::dev::PolyDriver *poly) override
	Attach to another object.

bool	detach () override
	Detach the object (you must have first called attach).

bool	attachAll (const yarp::dev::PolyDriverList &device2attach) override
	Attach to a list of objects.

bool	detachAll () override
	Detach the object (you must have first called attach).

bool	getCameraDescription (CameraDescriptor *camera) override
	Get a basic description of the camera hw.

bool	hasFeature (int feature, bool *hasFeature) override
	Check if camera has the requested feature (saturation, brightness ... )

bool	setFeature (int feature, double value) override
	Set the requested feature to a value (saturation, brightness ... )

bool	getFeature (int feature, double *value) override
	Get the current value for the requested feature.

bool	setFeature (int feature, double value1, double value2) override
	Set the requested feature to a value using 2 params (like white balance)

bool	getFeature (int feature, double value1, double value2) override
	Get the current value for the requested feature.

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

bool	setActive (int feature, bool onoff) override
	Set the requested feature on or off.

bool	getActive (int feature, bool *isActive) override
	Get the current status of the feature, on or off.

bool	hasAuto (int feature, bool *hasAuto) override
	Check if the requested feature has the 'auto' mode.

bool	hasManual (int feature, bool *hasManual) override
	Check if the requested feature has the 'manual' mode.

bool	hasOnePush (int feature, bool *hasOnePush) override
	Check if the requested feature has the 'onePush' mode.

bool	setMode (int feature, FeatureMode mode) override
	Set the requested mode for the feature.

bool	getMode (int feature, FeatureMode *mode) override
	Get the current mode for the feature.

bool	setOnePush (int feature) override
	Set the requested feature to a value (saturation, brightness ... )

unsigned int	getVideoModeMaskDC1394 () override

unsigned int	getVideoModeDC1394 () override

bool	setVideoModeDC1394 (int video_mode) override

unsigned int	getFPSMaskDC1394 () override

unsigned int	getFPSDC1394 () override

bool	setFPSDC1394 (int fps) override

unsigned int	getISOSpeedDC1394 () override

bool	setISOSpeedDC1394 (int speed) override

unsigned int	getColorCodingMaskDC1394 (unsigned int video_mode) override

unsigned int	getColorCodingDC1394 () override

bool	setColorCodingDC1394 (int coding) override

bool	getFormat7MaxWindowDC1394 (unsigned int &xdim, unsigned int &ydim, unsigned int &xstep, unsigned int &ystep, unsigned int &xoffstep, unsigned int &yoffstep) override

bool	getFormat7WindowDC1394 (unsigned int &xdim, unsigned int &ydim, int &x0, int &y0) override

bool	setFormat7WindowDC1394 (unsigned int xdim, unsigned int ydim, int x0, int y0) override

bool	setOperationModeDC1394 (bool b1394b) override

bool	getOperationModeDC1394 () override

bool	setTransmissionDC1394 (bool bTxON) override

bool	getTransmissionDC1394 () override

bool	setBroadcastDC1394 (bool onoff) override

bool	setDefaultsDC1394 () override

bool	setResetDC1394 () override

bool	setPowerDC1394 (bool onoff) override

bool	setCaptureDC1394 (bool bON) override

unsigned int	getBytesPerPacketDC1394 () override

bool	setBytesPerPacketDC1394 (unsigned int bpp) override

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

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

bool	setRgbResolution (int width, int height) override
	Set the resolution of the rgb image from the camera.

bool	getRgbFOV (double &horizontalFov, double &verticalFov) override
	Get the field of view (FOV) of the rgb camera.

bool	setRgbFOV (double horizontalFov, double verticalFov) override
	Set the field of view (FOV) of the rgb camera.

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

bool	getRgbMirroring (bool &mirror) override
	Get the mirroring setting of the sensor.

bool	setRgbMirroring (bool mirror) override
	Set the mirroring setting of the sensor.

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 yarp::dev::IWrapper
virtual	~IWrapper ()
	Destructor.

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

Public Member Functions inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >
	~FrameGrabberCropperOf () override=default

bool	getImage (yarp::sig::ImageOf< yarp::sig::PixelRgb > &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 yarp::dev::IFrameGrabberOf< ImageType >
virtual bool	getImageCrop (cropType_id_t cropType, yarp::sig::VectorOf< std::pair< int, int > > vertices, ImageType &image)
	Get a crop of the image from the frame grabber.

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

Public Member Functions inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelMono > >
	~FrameGrabberCropperOf () override=default

bool	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 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 ()

virtual bool	getRgbSupportedConfigurations (yarp::sig::VectorOf< yarp::dev::CameraConfig > &configurations)
	Get the possible configurations of the camera.

virtual bool	getRgbResolution (int &width, int &height)
	Get the resolution of the rgb image from the camera.

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

Public Member Functions inherited from FrameGrabberCropper_ParamsParser
	FrameGrabberCropper_ParamsParser ()

	~FrameGrabberCropper_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.

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

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

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

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_x1_defaultValue = {"0"}

const std::string	m_y1_defaultValue = {"0"}

const std::string	m_x2_defaultValue = {"100"}

const std::string	m_y2_defaultValue = {"100"}

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

int	m_x1 = {0}

int	m_y1 = {0}

int	m_x2 = {100}

int	m_y2 = {100}

bool	m_forwardRgbVisualParams = {false}

Protected Attributes inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >
yarp::dev::IFrameGrabberOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > > *	iFrameGrabberOf

yarp::sig::VectorOf< std::pair< int, int > >	vertices

Protected Attributes inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelMono > >
yarp::dev::IFrameGrabberOf< yarp::sig::ImageOf< yarp::sig::PixelMono > > *	iFrameGrabberOf

yarp::sig::VectorOf< std::pair< int, int > >	vertices

Static Protected Attributes inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >
static constexpr cropType_id_t	cropType

Static Protected Attributes inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelMono > >
static constexpr cropType_id_t	cropType

Detailed Description

FrameGrabberCropper: An image frame grabber device which can also crop the frame.

In must be attached to another grabber.

Parameters required by this device are shown in class: FrameGrabberCropper_ParamsParser

Definition at line 66 of file FrameGrabberCropper.h.

Constructor & Destructor Documentation

◆ FrameGrabberCropper() [1/3]

FrameGrabberCropper::FrameGrabberCropper ( )

default

◆ FrameGrabberCropper() [2/3]

FrameGrabberCropper::FrameGrabberCropper ( const FrameGrabberCropper & )

delete

◆ FrameGrabberCropper() [3/3]

FrameGrabberCropper::FrameGrabberCropper ( FrameGrabberCropper && )

delete

◆ ~FrameGrabberCropper()

FrameGrabberCropper::~FrameGrabberCropper ( )

override

Definition at line 15 of file FrameGrabberCropper.cpp.

Member Function Documentation

◆ attach()

bool FrameGrabberCropper::attach ( yarp::dev::PolyDriver * driver )

overridevirtual

Attach to another object.

Parameters

driver the polydriver that you want to attach to.

Returns: true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 37 of file FrameGrabberCropper.cpp.

◆ attachAll()

bool FrameGrabberCropper::attachAll ( const yarp::dev::PolyDriverList & drivers )

overridevirtual

Attach to a list of objects.

Parameters

drivers the polydriver list that you want to attach to.

Returns: true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 70 of file FrameGrabberCropper.cpp.

◆ close()

bool FrameGrabberCropper::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 32 of file FrameGrabberCropper.cpp.

◆ detach()

bool FrameGrabberCropper::detach ( )

overridevirtual

Detach the object (you must have first called attach).

Returns: true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 59 of file FrameGrabberCropper.cpp.

◆ detachAll()

bool FrameGrabberCropper::detachAll ( )

overridevirtual

Detach the object (you must have first called attach).

Returns: true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 80 of file FrameGrabberCropper.cpp.

◆ getActive()

bool FrameGrabberCropper::getActive	(	int	feature,
		bool *	isActive
	)

inlineoverridevirtual

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 168 of file FrameGrabberCropper.h.

◆ getBytesPerPacketDC1394()

unsigned int FrameGrabberCropper::getBytesPerPacketDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 418 of file FrameGrabberCropper.h.

◆ getCameraDescription()

bool FrameGrabberCropper::getCameraDescription ( CameraDescriptor * camera )

inlineoverridevirtual

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 105 of file FrameGrabberCropper.h.

◆ getColorCodingDC1394()

unsigned int FrameGrabberCropper::getColorCodingDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 301 of file FrameGrabberCropper.h.

◆ getColorCodingMaskDC1394()

unsigned int FrameGrabberCropper::getColorCodingMaskDC1394 ( unsigned int video_mode )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 293 of file FrameGrabberCropper.h.

◆ getFeature() [1/2]

bool FrameGrabberCropper::getFeature	(	int	feature,
		double *	value
	)

inlineoverridevirtual

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 128 of file FrameGrabberCropper.h.

◆ getFeature() [2/2]

bool FrameGrabberCropper::getFeature	(	int	feature,
		double *	value1,
		double *	value2
	)

inlineoverridevirtual

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.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 144 of file FrameGrabberCropper.h.

◆ getFormat7MaxWindowDC1394()

bool FrameGrabberCropper::getFormat7MaxWindowDC1394	(	unsigned int &	xdim,
		unsigned int &	ydim,
		unsigned int &	xstep,
		unsigned int &	ystep,
		unsigned int &	xoffstep,
		unsigned int &	yoffstep
	)

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 317 of file FrameGrabberCropper.h.

◆ getFormat7WindowDC1394()

bool FrameGrabberCropper::getFormat7WindowDC1394	(	unsigned int &	xdim,
		unsigned int &	ydim,
		int &	x0,
		int &	y0
	)

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 330 of file FrameGrabberCropper.h.

◆ getFPSDC1394()

unsigned int FrameGrabberCropper::getFPSDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 258 of file FrameGrabberCropper.h.

◆ getFPSMaskDC1394()

unsigned int FrameGrabberCropper::getFPSMaskDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 250 of file FrameGrabberCropper.h.

◆ getISOSpeedDC1394()

unsigned int FrameGrabberCropper::getISOSpeedDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 276 of file FrameGrabberCropper.h.

◆ getLastInputStamp()

yarp::os::Stamp FrameGrabberCropper::getLastInputStamp ( )

inlineoverridevirtual

Return the time stamp relative to the last acquisition.

Implements yarp::dev::IPreciselyTimed.

Definition at line 501 of file FrameGrabberCropper.h.

◆ getMode()

bool FrameGrabberCropper::getMode	(	int	feature,
		FeatureMode *	mode
	)

inlineoverridevirtual

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 208 of file FrameGrabberCropper.h.

◆ getOperationModeDC1394()

bool FrameGrabberCropper::getOperationModeDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 354 of file FrameGrabberCropper.h.

◆ getRgbFOV()

bool FrameGrabberCropper::getRgbFOV	(	double &	horizontalFov,
		double &	verticalFov
	)

inlineoverridevirtual

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 454 of file FrameGrabberCropper.h.

◆ getRgbHeight()

int FrameGrabberCropper::getRgbHeight ( )

inlineoverridevirtual

Return the height of each frame.

Returns: rgb image height

Implements yarp::dev::IRgbVisualParams.

Definition at line 436 of file FrameGrabberCropper.h.

◆ getRgbIntrinsicParam()

bool FrameGrabberCropper::getRgbIntrinsicParam ( yarp::os::Property & intrinsic )

inlineoverridevirtual

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 472 of file FrameGrabberCropper.h.

◆ getRgbMirroring()

bool FrameGrabberCropper::getRgbMirroring ( bool & mirror )

inlineoverridevirtual

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 481 of file FrameGrabberCropper.h.

◆ getRgbWidth()

int FrameGrabberCropper::getRgbWidth ( )

inlineoverridevirtual

Return the width of each frame.

Returns: rgb image width

Implements yarp::dev::IRgbVisualParams.

Definition at line 441 of file FrameGrabberCropper.h.

◆ getTransmissionDC1394()

bool FrameGrabberCropper::getTransmissionDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 370 of file FrameGrabberCropper.h.

◆ getVideoModeDC1394()

unsigned int FrameGrabberCropper::getVideoModeDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 234 of file FrameGrabberCropper.h.

◆ getVideoModeMaskDC1394()

unsigned int FrameGrabberCropper::getVideoModeMaskDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 226 of file FrameGrabberCropper.h.

◆ hasAuto()

bool FrameGrabberCropper::hasAuto	(	int	feature,
		bool *	hasAuto
	)

inlineoverridevirtual

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 176 of file FrameGrabberCropper.h.

◆ hasFeature()

bool FrameGrabberCropper::hasFeature	(	int	feature,
		bool *	hasFeature
	)

inlineoverridevirtual

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 113 of file FrameGrabberCropper.h.

◆ hasManual()

bool FrameGrabberCropper::hasManual	(	int	feature,
		bool *	hasManual
	)

inlineoverridevirtual

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 184 of file FrameGrabberCropper.h.

◆ hasOnePush()

bool FrameGrabberCropper::hasOnePush	(	int	feature,
		bool *	hasOnePush
	)

inlineoverridevirtual

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 192 of file FrameGrabberCropper.h.

◆ hasOnOff()

bool FrameGrabberCropper::hasOnOff	(	int	feature,
		bool *	HasOnOff
	)

inlineoverridevirtual

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 152 of file FrameGrabberCropper.h.

◆ open()

bool FrameGrabberCropper::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. See device invocation examples. 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

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 21 of file FrameGrabberCropper.cpp.

◆ operator=() [1/2]

FrameGrabberCropper & FrameGrabberCropper::operator= ( const FrameGrabberCropper & )

delete

◆ operator=() [2/2]

FrameGrabberCropper & FrameGrabberCropper::operator= ( FrameGrabberCropper && )

delete

◆ setActive()

bool FrameGrabberCropper::setActive	(	int	feature,
		bool	onoff
	)

inlineoverridevirtual

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 160 of file FrameGrabberCropper.h.

◆ setBroadcastDC1394()

bool FrameGrabberCropper::setBroadcastDC1394 ( bool onoff )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 378 of file FrameGrabberCropper.h.

◆ setBytesPerPacketDC1394()

bool FrameGrabberCropper::setBytesPerPacketDC1394 ( unsigned int bpp )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 426 of file FrameGrabberCropper.h.

◆ setCaptureDC1394()

bool FrameGrabberCropper::setCaptureDC1394 ( bool bON )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 410 of file FrameGrabberCropper.h.

◆ setColorCodingDC1394()

bool FrameGrabberCropper::setColorCodingDC1394 ( int coding )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 309 of file FrameGrabberCropper.h.

◆ setDefaultsDC1394()

bool FrameGrabberCropper::setDefaultsDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 386 of file FrameGrabberCropper.h.

◆ setFeature() [1/2]

bool FrameGrabberCropper::setFeature	(	int	feature,
		double	value
	)

inlineoverridevirtual

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 121 of file FrameGrabberCropper.h.

◆ setFeature() [2/2]

bool FrameGrabberCropper::setFeature	(	int	feature,
		double	value1,
		double	value2
	)

inlineoverridevirtual

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 136 of file FrameGrabberCropper.h.

◆ setFormat7WindowDC1394()

bool FrameGrabberCropper::setFormat7WindowDC1394	(	unsigned int	xdim,
		unsigned int	ydim,
		int	x0,
		int	y0
	)

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 338 of file FrameGrabberCropper.h.

◆ setFPSDC1394()

bool FrameGrabberCropper::setFPSDC1394 ( int fps )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 267 of file FrameGrabberCropper.h.

◆ setISOSpeedDC1394()

bool FrameGrabberCropper::setISOSpeedDC1394 ( int speed )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 284 of file FrameGrabberCropper.h.

◆ setMode()

bool FrameGrabberCropper::setMode	(	int	feature,
		FeatureMode	mode
	)

inlineoverridevirtual

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 200 of file FrameGrabberCropper.h.

◆ setOnePush()

bool FrameGrabberCropper::setOnePush ( int feature )

inlineoverridevirtual

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 216 of file FrameGrabberCropper.h.

◆ setOperationModeDC1394()

bool FrameGrabberCropper::setOperationModeDC1394 ( bool b1394b )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 346 of file FrameGrabberCropper.h.

◆ setPowerDC1394()

bool FrameGrabberCropper::setPowerDC1394 ( bool onoff )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 402 of file FrameGrabberCropper.h.

◆ setResetDC1394()

bool FrameGrabberCropper::setResetDC1394 ( )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 394 of file FrameGrabberCropper.h.

◆ setRgbFOV()

bool FrameGrabberCropper::setRgbFOV	(	double	horizontalFov,
		double	verticalFov
	)

inlineoverridevirtual

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 464 of file FrameGrabberCropper.h.

◆ setRgbMirroring()

bool FrameGrabberCropper::setRgbMirroring ( bool mirror )

inlineoverridevirtual

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 491 of file FrameGrabberCropper.h.

◆ setRgbResolution()

bool FrameGrabberCropper::setRgbResolution	(	int	width,
		int	height
	)

inlineoverridevirtual

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 446 of file FrameGrabberCropper.h.

◆ setTransmissionDC1394()

bool FrameGrabberCropper::setTransmissionDC1394 ( bool bTxON )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 362 of file FrameGrabberCropper.h.

◆ setVideoModeDC1394()

bool FrameGrabberCropper::setVideoModeDC1394 ( int video_mode )

inlineoverridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 242 of file FrameGrabberCropper.h.

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

src/devices/frameGrabberCropper/FrameGrabberCropper.h
src/devices/frameGrabberCropper/FrameGrabberCropper.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FrameGrabberCropper() [1/3]

◆ FrameGrabberCropper() [2/3]

◆ FrameGrabberCropper() [3/3]

◆ ~FrameGrabberCropper()

Member Function Documentation

◆ attach()

◆ attachAll()

◆ close()

◆ detach()

◆ detachAll()

◆ getActive()

◆ getBytesPerPacketDC1394()

◆ getCameraDescription()

◆ getColorCodingDC1394()

◆ getColorCodingMaskDC1394()

◆ getFeature() [1/2]

◆ getFeature() [2/2]

◆ getFormat7MaxWindowDC1394()

◆ getFormat7WindowDC1394()

◆ getFPSDC1394()

◆ getFPSMaskDC1394()

◆ getISOSpeedDC1394()

◆ getLastInputStamp()

◆ getMode()

◆ getOperationModeDC1394()

◆ getRgbFOV()

◆ getRgbHeight()

◆ getRgbIntrinsicParam()

◆ getRgbMirroring()

◆ 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()