OpenPose  1.0.0rc2
OpenPose: A Real-Time Multi-Person Key-Point Detection And Multi-Threading C++ Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
op::VideoReader Class Reference

#include <videoReader.hpp>

Inherits op::VideoCaptureReader.

Public Member Functions

 VideoReader (const std::string &videoPath, const unsigned int imageDirectoryStereo=1, const std::string &cameraParameterPath="")
 
virtual ~VideoReader ()
 
std::vector< cv::Mat > getCameraMatrices ()
 
std::vector< cv::Mat > getCameraExtrinsics ()
 
std::vector< cv::Mat > getCameraIntrinsics ()
 
std::string getNextFrameName ()
 
bool isOpened () const
 
double get (const int capProperty)
 
void set (const int capProperty, const double value)
 
- Public Member Functions inherited from op::VideoCaptureReader
 VideoCaptureReader (const int index, const bool throwExceptionIfNoOpened)
 
 VideoCaptureReader (const std::string &path, const ProducerType producerType)
 
virtual ~VideoCaptureReader ()
 
void release ()
 
- Public Member Functions inherited from op::Producer
 Producer (const ProducerType type)
 
virtual ~Producer ()
 
cv::Mat getFrame ()
 
std::vector< cv::Mat > getFrames ()
 
void setProducerFpsMode (const ProducerFpsMode fpsMode)
 
ProducerType getType ()
 
double get (const ProducerProperty property)
 
void set (const ProducerProperty property, const double value)
 

Additional Inherited Members

- Protected Member Functions inherited from op::VideoCaptureReader
void resetWebcam (const int index, const bool throwExceptionIfNoOpened)
 
- Protected Member Functions inherited from op::Producer
void checkFrameIntegrity (cv::Mat &frame)
 
void flipAndRotate (cv::Mat &cvMat) const
 
void ifEndedResetOrRelease ()
 
void keepDesiredFrameRate ()
 

Detailed Description

VideoReader is a wrapper of the cv::VideoCapture class for video. It allows controlling a video (e.g. extracting frames, setting resolution & fps, etc).

Constructor & Destructor Documentation

op::VideoReader::VideoReader ( const std::string &  videoPath,
const unsigned int  imageDirectoryStereo = 1,
const std::string &  cameraParameterPath = "" 
)
explicit

Constructor of VideoReader. It opens the video as a wrapper of cv::VideoCapture. It includes a flag to indicate whether the video should be repeated once it is completely read.

Parameters
videoPathconst std::string parameter with the full video path location.
imageDirectoryStereoconst int parameter with the number of images per iteration (>1 would represent stereo processing).
cameraParameterPathconst std::string parameter with the folder path containing the camera parameters (only required if imageDirectorystereo > 1).
virtual op::VideoReader::~VideoReader ( )
virtual

Member Function Documentation

double op::VideoReader::get ( const int  capProperty)
virtual

This function is a wrapper of cv::VideoCapture::get. It allows getting different properties of the Producer (fps, width, height, etc.). See the OpenCV documentation for all the available properties.

Parameters
capPropertyint indicating the property to be modified.
Returns
double returning the property value.

Implements op::VideoCaptureReader.

std::vector<cv::Mat> op::VideoReader::getCameraExtrinsics ( )
virtual

It retrieves and returns the camera extrinsic parameters from the frames producer.

Returns
std::vector<cv::Mat> with the camera extrinsic parameters.

Implements op::Producer.

std::vector<cv::Mat> op::VideoReader::getCameraIntrinsics ( )
virtual

It retrieves and returns the camera intrinsic parameters from the frames producer.

Returns
std::vector<cv::Mat> with the camera intrinsic parameters.

Implements op::Producer.

std::vector<cv::Mat> op::VideoReader::getCameraMatrices ( )
virtual

It retrieves and returns the camera matrixes from the frames producer.

Returns
std::vector<cv::Mat> with the camera matrices.

Implements op::Producer.

std::string op::VideoReader::getNextFrameName ( )
virtual

This function returns a unique frame name (e.g. the frame number for video, the frame counter for webcam, the image name for image directory reader, etc.).

Returns
std::string with an unique frame name.

Implements op::VideoCaptureReader.

bool op::VideoReader::isOpened ( ) const
inlinevirtual

This function returns whether the Producer instance is still opened and able to retrieve more frames.

Returns
bool indicating whether the Producer is opened.

Reimplemented from op::VideoCaptureReader.

void op::VideoReader::set ( const int  capProperty,
const double  value 
)
virtual

This function is a wrapper of cv::VideoCapture::set. It allows setting different properties of the Producer (fps, width, height, etc.). See the OpenCV documentation for all the available properties.

Parameters
capPropertyint indicating the property to be modified.
valuedouble indicating the new value to be assigned.

Implements op::VideoCaptureReader.


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