OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Public Member Functions | List of all members
osvr::vbtracker::ImageSource Class Referenceabstract

#include </home/jenkins/root/workspace/OSVR-Core-Docs/plugins/unifiedvideoinertialtracker/ImageSources/ImageSource.h>

Inheritance diagram for osvr::vbtracker::ImageSource:
osvr::vbtracker::DirectShowImageSource osvr::vbtracker::DirectShowImageSource osvr::vbtracker::DK2WrappedImageSource osvr::vbtracker::DK2WrappedImageSource osvr::vbtracker::FakeImageSource osvr::vbtracker::FakeImageSource osvr::vbtracker::OpenCVImageSource osvr::vbtracker::OpenCVImageSource

Public Member Functions

virtual ~ImageSource ()
 Destructor.
 
virtual bool ok () const =0
 
virtual bool grab ()=0
 
virtual void retrieve (cv::Mat &color, cv::Mat &gray, osvr::util::time::TimeValue &timestamp)
 Call after grab() to get the actual image data.
 
void retrieve (cv::Mat &color, cv::Mat &gray)
 
virtual cv::Size resolution () const =0
 Get resolution of the images from this source.
 
virtual void retrieveColor (cv::Mat &color, osvr::util::time::TimeValue &timestamp)=0
 
void retrieveColor (cv::Mat &color)
 
virtual ~ImageSource ()
 Destructor.
 
virtual bool ok () const =0
 
virtual bool grab ()=0
 
virtual void retrieve (cv::Mat &color, cv::Mat &gray)
 Call after grab() to get the actual image data.
 
virtual cv::Size resolution () const =0
 Get resolution of the images from this source.
 
virtual void retrieveColor (cv::Mat &color)=0
 

Detailed Description

Uniform interface for the various normal to strange image sources for the tracking algorithm.

Definition at line 42 of file ImageSource.h.

Member Function Documentation

virtual bool osvr::vbtracker::ImageSource::ok ( ) const
pure virtual
Returns
true if the camera/image source is OK

Implemented in osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::OpenCVImageSource, osvr::vbtracker::DK2WrappedImageSource, osvr::vbtracker::FakeImageSource, osvr::vbtracker::OpenCVImageSource, osvr::vbtracker::DK2WrappedImageSource, and osvr::vbtracker::FakeImageSource.

virtual bool osvr::vbtracker::ImageSource::grab ( )
pure virtual

Trigger camera capture. May not necessarily include retrieval. Blocks until an image is available. or failure occurs.

Timestamp after this call returns.

Returns
false if the camera failed.

Implemented in osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::OpenCVImageSource, osvr::vbtracker::DK2WrappedImageSource, osvr::vbtracker::FakeImageSource, osvr::vbtracker::OpenCVImageSource, osvr::vbtracker::DK2WrappedImageSource, and osvr::vbtracker::FakeImageSource.

void osvr::vbtracker::ImageSource::retrieve ( cv::Mat &  color,
cv::Mat &  gray 
)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. discards timestamp.

Definition at line 64 of file ImageSource.h.

virtual void osvr::vbtracker::ImageSource::retrieveColor ( cv::Mat &  color,
osvr::util::time::TimeValue &  timestamp 
)
pure virtual

For those devices that naturally read a non-corrupt color image, overriding just this method will let the default implementation of retrieve() do the RGB to Gray for you.

Implemented in osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::DK2WrappedImageSource, osvr::vbtracker::OpenCVImageSource, and osvr::vbtracker::FakeImageSource.

void osvr::vbtracker::ImageSource::retrieveColor ( cv::Mat &  color)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. discards timestamp.

Definition at line 79 of file ImageSource.h.

virtual bool osvr::vbtracker::ImageSource::ok ( ) const
pure virtual
Returns
true if the camera/image source is OK

Implemented in osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::OpenCVImageSource, osvr::vbtracker::DK2WrappedImageSource, osvr::vbtracker::FakeImageSource, osvr::vbtracker::OpenCVImageSource, osvr::vbtracker::DK2WrappedImageSource, and osvr::vbtracker::FakeImageSource.

virtual bool osvr::vbtracker::ImageSource::grab ( )
pure virtual

Trigger camera capture. May not necessarily include retrieval. Blocks until an image is available. or failure occurs.

Timestamp after this call returns.

Returns
false if the camera failed.

Implemented in osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::OpenCVImageSource, osvr::vbtracker::DK2WrappedImageSource, osvr::vbtracker::FakeImageSource, osvr::vbtracker::OpenCVImageSource, osvr::vbtracker::DK2WrappedImageSource, and osvr::vbtracker::FakeImageSource.

virtual void osvr::vbtracker::ImageSource::retrieveColor ( cv::Mat &  color)
pure virtual

For those devices that naturally read a non-corrupt color image, overriding just this method will let the default implementation of retrieve() do the RGB to Gray for you.

Implemented in osvr::vbtracker::DirectShowImageSource, osvr::vbtracker::DK2WrappedImageSource, osvr::vbtracker::OpenCVImageSource, and osvr::vbtracker::FakeImageSource.

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