vpFrameGrabber Class Reference

#include <visp3/core/vpFrameGrabber.h>

Inheritance diagram for vpFrameGrabber:

Public Member Functions
	vpFrameGrabber ()
virtual	~vpFrameGrabber ()
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
Inherited functionalities from vpFramegrabber
unsigned int	getHeight () const
unsigned int	getWidth () const

Public Attributes
bool	init

Protected Attributes
unsigned int	height
unsigned int	width

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>

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
}

Author

Eric Marchand (Eric..nosp@m.Marc.nosp@m.hand@.nosp@m.iris.nosp@m.a.fr), Irisa / Inria Rennes

Definition at line 101 of file vpFrameGrabber.h.

Constructor & Destructor Documentation

vpFrameGrabber()

vpFrameGrabber::vpFrameGrabber ( )

inline

Definition at line 120 of file vpFrameGrabber.h.

~vpFrameGrabber()

virtual vpFrameGrabber::~vpFrameGrabber ( )

inlinevirtual

Definition at line 121 of file vpFrameGrabber.h.

Member Function Documentation

acquire() [1/2]

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

pure virtual

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

acquire() [2/2]

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

pure virtual

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

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 vp1394TwoGrabber, vpV4l2Grabber, vpVideoReader, vp1394CMUGrabber, vpFlyCaptureGrabber, vpDiskGrabber, vpPylonGrabber, vpDirectShowGrabber, vpPylonGrabberGigE, and vpPylonGrabberUsb.

getHeight()

unsigned int vpFrameGrabber::getHeight ( ) const

inline

Return the number of rows in the image.

Examples:

AROgre.cpp, AROgreBasic.cpp, and testPylonGrabber.cpp.

Definition at line 114 of file vpFrameGrabber.h.

getWidth()

unsigned int vpFrameGrabber::getWidth ( ) const

inline

Return the number of columns in the image.

Examples:

AROgre.cpp, AROgreBasic.cpp, and testPylonGrabber.cpp.

Definition at line 116 of file vpFrameGrabber.h.

open() [1/2]

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

pure virtual

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

Referenced by vpVideoReader::getFrameStep(), vpDiskGrabber::getImageName(), vp1394CMUGrabber::getVideoColorCoding(), and vpFlyCaptureGrabber::isCaptureStarted().

open() [2/2]

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

pure virtual

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

Member Data Documentation

height

unsigned int vpFrameGrabber::height

protected

Number of rows in the image.

Definition at line 107 of file vpFrameGrabber.h.

Referenced by vpPylonGrabberGigE::acquire(), vpPylonGrabberUsb::acquire(), vpDiskGrabber::acquire(), vpFlyCaptureGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vpV4l2Grabber::close(), vp1394TwoGrabber::dequeue(), vpVideoReader::getFrame(), vp1394TwoGrabber::getHeight(), vpDiskGrabber::open(), vpV4l2Grabber::open(), vp1394CMUGrabber::open(), vp1394CMUGrabber::selectCamera(), vpVideoReader::setFileName(), vp1394TwoGrabber::setFormat7ROI(), vp1394CMUGrabber::setVideoMode(), vp1394TwoGrabber::setVideoMode(), vp1394CMUGrabber::vp1394CMUGrabber(), and vp1394TwoGrabber::vp1394TwoGrabber().

init

bool vpFrameGrabber::init

Set to true if the frame grabber has been initialized.

Definition at line 104 of file vpFrameGrabber.h.

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

width

unsigned int vpFrameGrabber::width

protected

Number of columns in the image.

Definition at line 108 of file vpFrameGrabber.h.

Referenced by vpPylonGrabberGigE::acquire(), vpPylonGrabberUsb::acquire(), vpDiskGrabber::acquire(), vpFlyCaptureGrabber::acquire(), vpV4l2Grabber::acquire(), vp1394TwoGrabber::acquire(), vpV4l2Grabber::close(), vp1394TwoGrabber::dequeue(), vpVideoReader::getFrame(), vp1394TwoGrabber::getWidth(), vpDiskGrabber::open(), vpV4l2Grabber::open(), vp1394CMUGrabber::open(), vp1394CMUGrabber::selectCamera(), vpVideoReader::setFileName(), vp1394TwoGrabber::setFormat7ROI(), vp1394CMUGrabber::setVideoMode(), vp1394TwoGrabber::setVideoMode(), vp1394CMUGrabber::vp1394CMUGrabber(), and vp1394TwoGrabber::vp1394TwoGrabber().