YARP
Yet Another Robot Platform
FrameGrabberCropperOf< ImageType > Class Template Reference

#include <frameGrabberCropper/frameGrabberCropper.h>

+ Inheritance diagram for FrameGrabberCropperOf< ImageType >:

Public Member Functions

 ~FrameGrabberCropperOf () override=default
 
bool getImage (ImageType &image) override
 Get an image from the frame grabber. More...
 
int height () const override
 Return the height of each frame. More...
 
int width () const override
 Return the width of each frame. More...
 
- 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. More...
 
- Public Member Functions inherited from yarp::dev::IFrameGrabberImageBase
virtual ~IFrameGrabberImageBase ()
 Destructor. More...
 

Protected Attributes

yarp::dev::IFrameGrabberOf< ImageType > * iFrameGrabberOf {nullptr}
 
yarp::sig::VectorOf< std::pair< int, int > > vertices
 

Static Protected Attributes

static constexpr cropType_id_t cropType {YARP_CROP_RECT}
 

Detailed Description

template<typename ImageType>
class FrameGrabberCropperOf< ImageType >

Definition at line 21 of file frameGrabberCropper.h.

Constructor & Destructor Documentation

◆ ~FrameGrabberCropperOf()

template<typename ImageType >
FrameGrabberCropperOf< ImageType >::~FrameGrabberCropperOf ( )
overridedefault

Member Function Documentation

◆ getImage()

template<typename ImageType >
bool FrameGrabberCropperOf< ImageType >::getImage ( ImageType &  image)
inlineoverridevirtual

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 32 of file frameGrabberCropper.h.

◆ height()

template<typename ImageType >
int FrameGrabberCropperOf< ImageType >::height ( ) const
inlineoverridevirtual

Return the height of each frame.

Returns
image height

Implements yarp::dev::IFrameGrabberImageBase.

Definition at line 40 of file frameGrabberCropper.h.

◆ width()

template<typename ImageType >
int FrameGrabberCropperOf< ImageType >::width ( ) const
inlineoverridevirtual

Return the width of each frame.

Returns
image width

Implements yarp::dev::IFrameGrabberImageBase.

Definition at line 48 of file frameGrabberCropper.h.

Member Data Documentation

◆ cropType

template<typename ImageType >
constexpr cropType_id_t FrameGrabberCropperOf< ImageType >::cropType {YARP_CROP_RECT}
staticconstexprprotected

Definition at line 26 of file frameGrabberCropper.h.

◆ iFrameGrabberOf

template<typename ImageType >
yarp::dev::IFrameGrabberOf<ImageType>* FrameGrabberCropperOf< ImageType >::iFrameGrabberOf {nullptr}
protected

Definition at line 25 of file frameGrabberCropper.h.

◆ vertices

template<typename ImageType >
yarp::sig::VectorOf<std::pair<int, int> > FrameGrabberCropperOf< ImageType >::vertices
protected

Definition at line 27 of file frameGrabberCropper.h.


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