op::ImageDirectoryReader Class Reference

#include <imageDirectoryReader.hpp>

Inheritance diagram for op::ImageDirectoryReader:

Public Member Functions
	ImageDirectoryReader (const std::string &imageDirectoryPath, const std::string &cameraParameterPath="", const bool undistortImage=false, const int numberViews=-1)
virtual	~ImageDirectoryReader ()
std::string	getNextFrameName ()
bool	isOpened () const
void	release ()
double	get (const int capProperty)
void	set (const int capProperty, const double value)
Public Member Functions inherited from op::Producer
	Producer (const ProducerType type, const std::string &cameraParameterPath, const bool undistortImage, const int mNumberViews)
virtual	~Producer ()
Matrix	getFrame ()
std::vector< Matrix >	getFrames ()
virtual std::vector< Matrix >	getCameraMatrices ()
virtual std::vector< Matrix >	getCameraExtrinsics ()
virtual std::vector< Matrix >	getCameraIntrinsics ()
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::Producer
void	checkFrameIntegrity (Matrix &frame)
void	ifEndedResetOrRelease ()
void	keepDesiredFrameRate ()

Detailed Description

ImageDirectoryReader is an abstract class to extract frames from a image directory. Its interface imitates the cv::VideoCapture class, so it can be used quite similarly to the cv::VideoCapture class. Thus, it is quite similar to VideoReader and WebcamReader.

Definition at line 14 of file imageDirectoryReader.hpp.

Constructor & Destructor Documentation

ImageDirectoryReader()

op::ImageDirectoryReader::ImageDirectoryReader ( const std::string &  imageDirectoryPath, const std::string &  cameraParameterPath = "", const bool  undistortImage = false, const int  numberViews = -1  )

explicit

Constructor of ImageDirectoryReader. It sets the image directory path from which the images will be loaded and generates a std::vector<std::string> with the list of images on that directory.

Parameters

imageDirectoryPath	const std::string parameter with the folder path containing the images.
cameraParameterPath	const std::string parameter with the folder path containing the camera parameters (only required if imageDirectorystereo > 1).
numberViews	const int parameter with the number of images per iteration (>1 would represent stereo processing).

~ImageDirectoryReader()

virtual op::ImageDirectoryReader::~ImageDirectoryReader ( )

virtual

Member Function Documentation

get()

double op::ImageDirectoryReader::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

capProperty

int indicating the property to be modified.

Returns

double returning the property value.

Implements op::Producer.

getNextFrameName()

std::string op::ImageDirectoryReader::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::Producer.

isOpened()

bool op::ImageDirectoryReader::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.

Implements op::Producer.

Definition at line 34 of file imageDirectoryReader.hpp.

release()

void op::ImageDirectoryReader::release ( )

inlinevirtual

This function releases and closes the Producer. After it is called, no more frames can be retrieved from Producer::getFrames.

Implements op::Producer.

Definition at line 39 of file imageDirectoryReader.hpp.

set()

void op::ImageDirectoryReader::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

capProperty	int indicating the property to be modified.
value	double indicating the new value to be assigned.

Implements op::Producer.

---

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

• include/openpose/producer/imageDirectoryReader.hpp