YARP
Yet Another Robot Platform
yarp::proto::framegrabber::FrameGrabberOf_Forwarder< ImageType, IfVocab, ImgVocab > Class Template Reference

This classes implement a sender / parser for IFrameGrabberOf interface messages. More...

#include <framegrabber_protocol/yarp/proto/framegrabber/FrameGrabberOf_Forwarder.h>

+ Inheritance diagram for yarp::proto::framegrabber::FrameGrabberOf_Forwarder< ImageType, IfVocab, ImgVocab >:

Public Member Functions

 FrameGrabberOf_Forwarder (yarp::os::Port &port)
 
 ~FrameGrabberOf_Forwarder () override=default
 
int height () const override
 Return the height of each frame. More...
 
int width () const override
 Return the width of each frame. More...
 
bool getImage (ImageType &image) override
 Get an image from the frame grabber. More...
 
bool getImageCrop (cropType_id_t cropType, yarp::sig::VectorOf< std::pair< int, int >> vertices, ImageType &image) override
 Get a crop of the image from the frame grabber. More...
 
- Public Member Functions inherited from yarp::dev::IFrameGrabberImageBase
virtual ~IFrameGrabberImageBase ()
 Destructor. More...
 

Detailed Description

template<typename ImageType, yarp::conf::vocab32_t IfVocab = VOCAB_FRAMEGRABBER_IMAGE, yarp::conf::vocab32_t ImgVocab = VOCAB_RGB_IMAGE>
class yarp::proto::framegrabber::FrameGrabberOf_Forwarder< ImageType, IfVocab, ImgVocab >

This classes implement a sender / parser for IFrameGrabberOf interface messages.

Definition at line 23 of file FrameGrabberOf_Forwarder.h.

Constructor & Destructor Documentation

◆ FrameGrabberOf_Forwarder()

template<typename ImageType , yarp::conf::vocab32_t IfVocab, yarp::conf::vocab32_t ImgVocab>
yarp::proto::framegrabber::FrameGrabberOf_Forwarder< ImageType, IfVocab, ImgVocab >::FrameGrabberOf_Forwarder ( yarp::os::Port port)

Definition at line 21 of file FrameGrabberOf_Forwarder-inl.h.

◆ ~FrameGrabberOf_Forwarder()

template<typename ImageType , yarp::conf::vocab32_t IfVocab = VOCAB_FRAMEGRABBER_IMAGE, yarp::conf::vocab32_t ImgVocab = VOCAB_RGB_IMAGE>
yarp::proto::framegrabber::FrameGrabberOf_Forwarder< ImageType, IfVocab, ImgVocab >::~FrameGrabberOf_Forwarder ( )
overridedefault

Member Function Documentation

◆ getImage()

template<typename ImageType , yarp::conf::vocab32_t IfVocab, yarp::conf::vocab32_t ImgVocab>
bool yarp::proto::framegrabber::FrameGrabberOf_Forwarder< ImageType, IfVocab, ImgVocab >::getImage ( ImageType &  image)
overridevirtual

◆ getImageCrop()

template<typename ImageType , yarp::conf::vocab32_t IfVocab, yarp::conf::vocab32_t ImgVocab>
bool yarp::proto::framegrabber::FrameGrabberOf_Forwarder< ImageType, IfVocab, ImgVocab >::getImageCrop ( cropType_id_t  cropType,
yarp::sig::VectorOf< std::pair< int, int >>  vertices,
ImageType &  image 
)
overridevirtual

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
cropTypeenum specifying how the crop shall be generated
verticesthe input coordinate (u,v) required by the cropType
imagethe image to be filled
Returns
true/false upon success/failure

Reimplemented from yarp::dev::IFrameGrabberOf< ImageType >.

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

Definition at line 138 of file FrameGrabberOf_Forwarder-inl.h.

◆ height()

◆ width()


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