Companion  1.0.0
Companion is an object recognition framework written with OpenCV.
Public Member Functions | List of all members
Companion::Input::Stream Class Referenceabstract

#include <Stream.h>

Inheritance diagram for Companion::Input::Stream:
Inheritance graph
[legend]

Public Member Functions

virtual cv::Mat ObtainImage ()=0
 
virtual bool IsFinished ()=0
 
virtual void Finish ()=0
 

Detailed Description

Data stream interface class to obtain image processing data for example from a video or a set of images.

Author
Andreas Sekulski, Dimitri Kotlovsky

Member Function Documentation

◆ Finish()

virtual void Companion::Input::Stream::Finish ( )
pure virtual

Stop this stream.

Implemented in Companion::Input::Image, and Companion::Input::Video.

◆ IsFinished()

virtual bool Companion::Input::Stream::IsFinished ( )
pure virtual

Indicator if stream has finished.

Returns
True if video has finished otherwise false.

Implemented in Companion::Input::Image, and Companion::Input::Video.

◆ ObtainImage()

virtual cv::Mat Companion::Input::Stream::ObtainImage ( )
pure virtual

Obtain next image from open video stream.

Returns
An empty cv::Mat object if no image is obtained otherwise an cv::Mat entity from the obtained image.

Implemented in Companion::Input::Image, and Companion::Input::Video.


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