MRPT logo

mrpt::vision::CImageGrabber_OpenCV Class Reference

A class for grabing images from a "OpenCV"-compatible camera, or from an AVI video file. More...

#include <mrpt/vision/CImageGrabber_OpenCV.h>

List of all members.

Public Member Functions

 CImageGrabber_OpenCV (int cameraIndex=-1, TCameraType cameraType=CAMERA_CV_AUTODETECT, const TCaptureCVOptions &options=TCaptureCVOptions())
 Constructor for cameras:.
 CImageGrabber_OpenCV (const std::string &AVI_fileName)
 Constructor for AVI files:.
virtual ~CImageGrabber_OpenCV ()
 Destructor.
bool isOpen () const
 Check whether the camera has been open succesfully.
bool getObservation (mrpt::slam::CObservationImage &out_observation)
 Grab an image from the opened camera.

Protected Attributes

bool m_bInitialized
 Set to false if we could not initialize the camera.
void * m_capture
 Internal use:.


Detailed Description

A class for grabing images from a "OpenCV"-compatible camera, or from an AVI video file.

See the constructor for the options when opening the camera.

Unless input from AVI files is required, it is recommended to use the more generic class mrpt::hwdrivers::CCameraSensor.

Note:
This class is only available when compiling MRPT with the flag "MRPT_HAS_OPENCV" defined.

Some code is based on the class CaptureCamera from the Orocos project.

See also:
mrpt::hwdrivers::CCameraSensor, CImageGrabber_dc1394

Definition at line 77 of file CImageGrabber_OpenCV.h.


Constructor & Destructor Documentation

mrpt::vision::CImageGrabber_OpenCV::CImageGrabber_OpenCV ( int  cameraIndex = -1,
TCameraType  cameraType = CAMERA_CV_AUTODETECT,
const TCaptureCVOptions options = TCaptureCVOptions() 
)

Constructor for cameras:.

Parameters:
cameraIndex Set the camera index, or -1 if it does not matter and you select AUTODETECT as cameraType.
cameraType Can be any value of TCameraType, or CAMERA_CV_AUTODETECT if there is only one camera.
options Capture options, defined in mrpt::vision::TCaptureCVOptions. If not provided, all the default options will be used.

mrpt::vision::CImageGrabber_OpenCV::CImageGrabber_OpenCV ( const std::string &  AVI_fileName  ) 

Constructor for AVI files:.

virtual mrpt::vision::CImageGrabber_OpenCV::~CImageGrabber_OpenCV (  )  [virtual]

Destructor.


Member Function Documentation

bool mrpt::vision::CImageGrabber_OpenCV::getObservation ( mrpt::slam::CObservationImage out_observation  ) 

Grab an image from the opened camera.

Parameters:
out_observation The object to be filled with sensed data.
Returns:
false on any error, true if all go fine.

bool mrpt::vision::CImageGrabber_OpenCV::isOpen (  )  const [inline]

Check whether the camera has been open succesfully.

Definition at line 109 of file CImageGrabber_OpenCV.h.


Member Data Documentation

Set to false if we could not initialize the camera.

Definition at line 82 of file CImageGrabber_OpenCV.h.

Internal use:.

Definition at line 86 of file CImageGrabber_OpenCV.h.




Page generated by Doxygen 1.5.7.1 for MRPT 0.6.5 SVN: at Mon Feb 23 13:35:09 EST 2009