YARP
Yet Another Robot Platform
Public Member Functions | List of all members
FrameGrabberOf_ForwarderWithStream< ImageType, IfVocab, ImgVocab > Class Template Reference

#include <RemoteFrameGrabber/FrameGrabber_nwc_yarp.h>

+ Inheritance diagram for FrameGrabberOf_ForwarderWithStream< ImageType, IfVocab, ImgVocab >:

Public Member Functions

 FrameGrabberOf_ForwarderWithStream (yarp::os::Port &rpcPort)
 
 ~FrameGrabberOf_ForwarderWithStream () 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...
 
void setStreamReceiver (StreamReceiver *m_streamReceiver)
 
- Public Member Functions inherited from yarp::proto::framegrabber::FrameGrabberOf_Forwarder< ImageType, VOCAB_FRAMEGRABBER_IMAGE, VOCAB_RGB_IMAGE >
 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 FrameGrabberOf_ForwarderWithStream< ImageType, IfVocab, ImgVocab >

Definition at line 52 of file FrameGrabber_nwc_yarp.h.

Constructor & Destructor Documentation

◆ FrameGrabberOf_ForwarderWithStream()

template<typename ImageType , yarp::conf::vocab32_t IfVocab, yarp::conf::vocab32_t ImgVocab>
FrameGrabberOf_ForwarderWithStream< ImageType, IfVocab, ImgVocab >::FrameGrabberOf_ForwarderWithStream ( yarp::os::Port &  rpcPort)

Definition at line 107 of file FrameGrabber_nwc_yarp.cpp.

◆ ~FrameGrabberOf_ForwarderWithStream()

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

Member Function Documentation

◆ getImage()

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

Get an image from the frame grabber.

Parameters
imagethe image to be filled
Returns
true/false upon success/failure

Implements yarp::dev::IFrameGrabberOf< ImageType >.

Definition at line 141 of file FrameGrabber_nwc_yarp.cpp.

◆ getImageCrop()

template<typename ImageType , yarp::conf::vocab32_t IfVocab, yarp::conf::vocab32_t ImgVocab>
bool FrameGrabberOf_ForwarderWithStream< 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 >.

Definition at line 154 of file FrameGrabber_nwc_yarp.cpp.

◆ height()

template<typename ImageType , yarp::conf::vocab32_t IfVocab, yarp::conf::vocab32_t ImgVocab>
int FrameGrabberOf_ForwarderWithStream< ImageType, IfVocab, ImgVocab >::height ( ) const
overridevirtual

Return the height of each frame.

Returns
image height

Implements yarp::dev::IFrameGrabberImageBase.

Definition at line 115 of file FrameGrabber_nwc_yarp.cpp.

◆ setStreamReceiver()

template<typename ImageType , yarp::conf::vocab32_t IfVocab, yarp::conf::vocab32_t ImgVocab>
void FrameGrabberOf_ForwarderWithStream< ImageType, IfVocab, ImgVocab >::setStreamReceiver ( StreamReceiver *  m_streamReceiver)

Definition at line 172 of file FrameGrabber_nwc_yarp.cpp.

◆ width()

template<typename ImageType , yarp::conf::vocab32_t IfVocab, yarp::conf::vocab32_t ImgVocab>
int FrameGrabberOf_ForwarderWithStream< ImageType, IfVocab, ImgVocab >::width ( ) const
overridevirtual

Return the width of each frame.

Returns
image width

Implements yarp::dev::IFrameGrabberImageBase.

Definition at line 128 of file FrameGrabber_nwc_yarp.cpp.

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