yarp::dev::IFrameGrabberOf< ImageType > Class Template Reference

Read a YARP-format image (of a specific type) from a device. More...

#include <yarp/dev/IFrameGrabberImage.h>

Inheritance diagram for yarp::dev::IFrameGrabberOf< ImageType >:

Public Member Functions
virtual yarp::dev::ReturnValue	getImage (ImageType &image)=0
	Get an image from the frame grabber.
virtual yarp::dev::ReturnValue	getImageCrop (yarp::dev::cropType_id_t cropType, std::vector< vertex_t > vertices, ImageType &image)
	Get a crop of the image from the frame grabber.
Public Member Functions inherited from yarp::dev::IFrameGrabberImageBase
virtual	~IFrameGrabberImageBase ()
	Destructor.
virtual int	height () const =0
	Return the height of each frame.
virtual int	width () const =0
	Return the width of each frame.

Detailed Description

template<typename ImageType>
class yarp::dev::IFrameGrabberOf< ImageType >

Read a YARP-format image (of a specific type) from a device.

Definition at line 80 of file IFrameGrabberImage.h.

Member Function Documentation

getImage()

template<typename ImageType >

virtual yarp::dev::ReturnValue yarp::dev::IFrameGrabberOf< ImageType >::getImage ( ImageType &  image )

pure virtual

Get an image from the frame grabber.

Parameters

image

the image to be filled

Returns

true/false upon success/failure

Implemented in FrameGrabberCropperOf< ImageType >, FrameGrabberOf_ForwarderWithStream< ImageType >, FrameGrabberOf_ForwarderWithStream< yarp::sig::FlexImage >, FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, realsense2Driver, FakeFrameGrabber, FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelMono > >, USBCameraDriverRgb, USBCameraDriverRaw, V4L_camera, argusCameraDriver, pylonCameraDriver, UltraPythonDriver, FakeBot, FakeFrameGrabber, FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >, FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelRgb > >, OpenCVGrabber, USBCameraDriverRgb, and V4L_camera.

getImageCrop()

template<typename ImageType >

yarp::dev::ReturnValue yarp::dev::IFrameGrabberOf< ImageType >::getImageCrop ( yarp::dev::cropType_id_t  cropType, std::vector< vertex_t >  vertices, ImageType &  image  )

virtual

Get a crop of the image from the frame grabber.

Note: this is not configuring the camera sensor to acquire a crop of the image, nor to generate a cropped version of the streaming. Instead, the full image is acquired and then a crop is created from it. If the hardware supports it, it is possible to override this method and request a hardware crop.

Parameters

cropType	enum specifying how the crop shall be generated
vertices	the input coordinate (u,v) required by the cropType
image	the image to be filled

Returns

true/false upon success/failure

Reimplemented in FrameGrabberOf_ForwarderWithStream< ImageType >, FrameGrabberOf_ForwarderWithStream< yarp::sig::FlexImage >, FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelMono > >, FakeFrameGrabber, and FrameGrabberOf_ForwarderWithStream< yarp::sig::ImageOf< yarp::sig::PixelRgb > >.

Definition at line 18 of file IFrameGrabberImage-inl.h.

---

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

• src/libYARP_dev/src/yarp/dev/IFrameGrabberImage.h
• src/libYARP_dev/src/yarp/dev/IFrameGrabberImage-inl.h