vpFrameGrabber Class Reference

#include <vpFrameGrabber.h>

Inheritance diagram for vpFrameGrabber:

Public Attributes
bool	init

Inherited functionalities from vpFramegrabber
unsigned int	height
unsigned int	width
unsigned int	getHeight () const
unsigned int	getWidth () const
	vpFrameGrabber ()
	vpFrameGrabber (const vpFrameGrabber &)=default
virtual	~vpFrameGrabber ()=default
virtual void	open (vpImage< unsigned char > &I)=0
virtual void	open (vpImage< vpRGBa > &I)=0
virtual void	acquire (vpImage< unsigned char > &I)=0
virtual void	acquire (vpImage< vpRGBa > &I)=0
virtual void	close ()=0
vpFrameGrabber &	operator= (const vpFrameGrabber &)=default

Detailed Description

Base class for all video devices. It is designed to provide a front end to video sources.

This class should provide a virtual function that allows the acquisition of an image.

The example below shows how to use this class.

#include <visp3/core/vpConfig.h>
#include <visp3/core/vpImage.h>
#include <visp3/io/vpImageIo.h>
#include <visp3/sensor/vp1394TwoGrabber.h>
#include <visp3/sensor/vpV4l2Grabber.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
#if defined(VISP_HAVE_V4L2) || defined(VISP_HAVE_DC1394)
  vpImage<unsigned char> I;
  vpFrameGrabber *g; // Generic framegrabber
 
#if defined( VISP_HAVE_DC1394 )
  vp1394TwoGrabber *g_1394_2 = new vp1394TwoGrabber;
  // specific settings for firewire grabber based on libdc1394-2.x version
  g_1394_2->setVideoMode(vp1394TwoGrabber::vpVIDEO_MODE_320x240_YUV422);
  g_1394_2->setFramerate(vp1394TwoGrabber::vpFRAMERATE_30);
  g = g_1394_2;
#elif defined( VISP_HAVE_V4L2 )
  vpV4l2Grabber *g_v4l2 = new vpV4l2Grabber;
  // specific settings for Video For Linux Two grabber
  g_v4l2->setInput(2);    // Input 2 on the board
  g_v4l2->setFramerate(vpV4l2Grabber::framerate_50fps); // 50 fps
  g_v4l2->setWidth(384);  // Acquired images are 768 width
  g_v4l2->setHeight(288); // Acquired images are 576 height
  g_v4l2->setNBuffers(3); // 3 ring buffers to ensure real-time acquisition
  g = g_v4l2;
#endif
 
  g->open(I);                           // Open the framegrabber
  g->acquire(I);                        // Acquire an image
  vpImageIo::write(I, "image.pgm");  // Write image on the disk
#endif
}

Definition at line 99 of file vpFrameGrabber.h.

Constructor & Destructor Documentation

vpFrameGrabber() [1/2]

vpFrameGrabber::vpFrameGrabber ( )

inline

Definition at line 114 of file vpFrameGrabber.h.

References height, init, and width.

Referenced by operator=(), vpDiskGrabber::vpDiskGrabber(), vpFrameGrabber(), vpVideoReader::vpVideoReader(), vpVideoReader::vpVideoReader(), and ~vpFrameGrabber().

vpFrameGrabber() [2/2]

vpFrameGrabber::vpFrameGrabber ( const vpFrameGrabber & )

default

References vpFrameGrabber().

~vpFrameGrabber()

virtual vpFrameGrabber::~vpFrameGrabber ( )

virtualdefault

References vpFrameGrabber().

Member Function Documentation

acquire() [1/2]

virtual void vpFrameGrabber::acquire ( vpImage< unsigned char > & I )

pure virtual

Implemented in vp1394CMUGrabber, vp1394TwoGrabber, vpDirectShowGrabber, vpDiskGrabber, vpFlyCaptureGrabber, vpPylonGrabber, vpPylonGrabberGigE, vpPylonGrabberUsb, vpV4l2Grabber, and vpVideoReader.

acquire() [2/2]

virtual void vpFrameGrabber::acquire ( vpImage< vpRGBa > & I )

pure virtual

Implemented in vp1394CMUGrabber, vp1394TwoGrabber, vpDirectShowGrabber, vpDiskGrabber, vpFlyCaptureGrabber, vpPylonGrabber, vpPylonGrabberGigE, vpPylonGrabberUsb, vpV4l2Grabber, and vpVideoReader.

close()

virtual void vpFrameGrabber::close ( )

pure virtual

This virtual function is used to de-allocate the memory used by a specific frame grabber

Implemented in vp1394CMUGrabber, vp1394TwoGrabber, vpDirectShowGrabber, vpDiskGrabber, vpFlyCaptureGrabber, vpPylonGrabber, vpPylonGrabberGigE, vpPylonGrabberUsb, vpV4l2Grabber, and vpVideoReader.

getHeight()

BEGIN_VISP_NAMESPACE unsigned int vpFrameGrabber::getHeight

(

)

const

Return the number of rows in the image.

Examples

AROgre.cpp, AROgreBasic.cpp, testPylonGrabber.cpp, and tutorial-rbt-sequence.cpp.

Definition at line 38 of file vpFrameGrabber.cpp.

References height.

getWidth()

unsigned int vpFrameGrabber::getWidth

(

)

const

Return the number of columns in the image.

Examples

AROgre.cpp, AROgreBasic.cpp, testPylonGrabber.cpp, and tutorial-rbt-sequence.cpp.

Definition at line 43 of file vpFrameGrabber.cpp.

References width.

open() [1/2]

virtual void vpFrameGrabber::open ( vpImage< unsigned char > & I )

pure virtual

Implemented in vp1394CMUGrabber, vp1394TwoGrabber, vpDirectShowGrabber, vpDiskGrabber, vpFlyCaptureGrabber, vpPylonGrabber, vpPylonGrabberGigE, vpPylonGrabberUsb, vpV4l2Grabber, and vpVideoReader.

open() [2/2]

virtual void vpFrameGrabber::open ( vpImage< vpRGBa > & I )

pure virtual

Implemented in vp1394CMUGrabber, vp1394TwoGrabber, vpDirectShowGrabber, vpDiskGrabber, vpFlyCaptureGrabber, vpPylonGrabber, vpPylonGrabberGigE, vpPylonGrabberUsb, vpV4l2Grabber, and vpVideoReader.

operator=()

vpFrameGrabber & vpFrameGrabber::operator= ( const vpFrameGrabber & )

default

References vpFrameGrabber().

Member Data Documentation

height

unsigned int vpFrameGrabber::height

protected

Number of rows in the image.

Definition at line 139 of file vpFrameGrabber.h.

Referenced by vp1394TwoGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpFlyCaptureGrabber::acquire(), vpFlyCaptureGrabber::acquire(), vpPylonGrabberGigE::acquire(), vpPylonGrabberGigE::acquire(), vpPylonGrabberUsb::acquire(), vpPylonGrabberUsb::acquire(), vpV4l2Grabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::dequeue(), vp1394TwoGrabber::dequeue(), vpDirectShowGrabber::getFormat(), vpVideoReader::getFrame(), vpVideoReader::getFrame(), vp1394TwoGrabber::getHeight(), vp1394TwoGrabber::getHeight(), getHeight(), vp1394CMUGrabber::open(), vp1394CMUGrabber::open(), vpDiskGrabber::open(), vpDiskGrabber::open(), vpDiskGrabber::open(), vpV4l2Grabber::open(), vpV4l2Grabber::open(), vpDirectShowGrabber::setFormat(), vp1394TwoGrabber::setFormat7ROI(), vpV4l2Grabber::setHeight(), vpDirectShowGrabber::setImageSize(), vp1394CMUGrabber::setVideoMode(), vp1394TwoGrabber::setVideoMode(), vp1394CMUGrabber::vp1394CMUGrabber(), vp1394TwoGrabber::vp1394TwoGrabber(), and vpFrameGrabber().

init

bool vpFrameGrabber::init

Set to true if the frame grabber has been initialized.

Definition at line 102 of file vpFrameGrabber.h.

Referenced by vpV4l2Grabber::acquire(), vpV4l2Grabber::acquire(), vp1394CMUGrabber::close(), vp1394TwoGrabber::close(), vpFlyCaptureGrabber::connect(), vpPylonGrabberGigE::connect(), vpPylonGrabberUsb::connect(), vpFlyCaptureGrabber::disconnect(), vpPylonGrabberGigE::disconnect(), vpPylonGrabberUsb::disconnect(), vpDiskGrabber::open(), vpDiskGrabber::open(), vpDiskGrabber::open(), vpV4l2Grabber::open(), vpV4l2Grabber::open(), vp1394TwoGrabber::resetBus(), vpFlyCaptureGrabber::startCapture(), vpPylonGrabberGigE::startCapture(), vpPylonGrabberUsb::startCapture(), vpFlyCaptureGrabber::stopCapture(), vpPylonGrabberGigE::stopCapture(), vpPylonGrabberUsb::stopCapture(), vp1394CMUGrabber::vp1394CMUGrabber(), vp1394TwoGrabber::vp1394TwoGrabber(), vpDiskGrabber::vpDiskGrabber(), vpDiskGrabber::vpDiskGrabber(), vpDiskGrabber::vpDiskGrabber(), vpFrameGrabber(), vpV4l2Grabber::vpV4l2Grabber(), vpV4l2Grabber::vpV4l2Grabber(), vpV4l2Grabber::vpV4l2Grabber(), vpV4l2Grabber::vpV4l2Grabber(), and vpV4l2Grabber::vpV4l2Grabber().

width

unsigned int vpFrameGrabber::width

protected

Number of columns in the image.

Definition at line 140 of file vpFrameGrabber.h.

Referenced by vp1394TwoGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpDiskGrabber::acquire(), vpFlyCaptureGrabber::acquire(), vpFlyCaptureGrabber::acquire(), vpPylonGrabberGigE::acquire(), vpPylonGrabberGigE::acquire(), vpPylonGrabberUsb::acquire(), vpPylonGrabberUsb::acquire(), vpV4l2Grabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::dequeue(), vp1394TwoGrabber::dequeue(), vpDirectShowGrabber::getFormat(), vpVideoReader::getFrame(), vpVideoReader::getFrame(), vp1394TwoGrabber::getWidth(), vp1394TwoGrabber::getWidth(), getWidth(), vp1394CMUGrabber::open(), vp1394CMUGrabber::open(), vpDiskGrabber::open(), vpDiskGrabber::open(), vpDiskGrabber::open(), vpV4l2Grabber::open(), vpV4l2Grabber::open(), vpDirectShowGrabber::setFormat(), vp1394TwoGrabber::setFormat7ROI(), vpDirectShowGrabber::setImageSize(), vp1394CMUGrabber::setVideoMode(), vp1394TwoGrabber::setVideoMode(), vpV4l2Grabber::setWidth(), vp1394CMUGrabber::vp1394CMUGrabber(), vp1394TwoGrabber::vp1394TwoGrabber(), and vpFrameGrabber().