Reader Interface Reference

The Reader interface defines functions which are used for reading and parsing the import. More...

#include <reader.h>

Inheritance diagram for Reader:

Public Member Functions
virtual cv::Mat	getPic (unsigned int index, PictureProcessingFlags flags=APPLY_ALL)=0
	Returns the frame to a given index.
virtual unsigned int	getPicCount ()=0
	Returns the number of frame.
virtual QString	getInputPath ()=0
	Returns the input path.
virtual double	getFPS ()=0
	Returns the video FPS.
virtual double	getVideoDuration ()=0
	Returns the video duration.
virtual bool	isDir ()=0
	Returns wether the input is a direcory or not.
virtual Reader *	copy (std::shared_ptr< ReaderParams > params=nullptr)=0
	Creates this reader again and returns it. Optionally, one can provide a shared ptr to a different set of parameters.
virtual std::vector< std::string >	getFileVector ()=0
	Returns a vector with filepaths (only valid, if the reader is a imagereader)
virtual void	enableMultithreading ()
	enableMultithreading This method has to be called once in the plugins to use the reader while multithreading
virtual void	addMetaData (MetaData *md)=0
	addMetaData Used to add MetaData to the reader
virtual MetaData *	getMetaData ()=0
	getMetaData Returns the currently saved MetaData
virtual bool	isValid ()=0
	isValid Retruns wether the reader is valid or not

Detailed Description

The Reader interface defines functions which are used for reading and parsing the import.

Author

Daniel Brommer

Date

2021/02/05

Member Function Documentation

addMetaData()

virtual void Reader::addMetaData ( MetaData *  md )

pure virtual

addMetaData Used to add MetaData to the reader

Parameters

md	The MetaData to be saved

Implemented in ImageReader, and VideoReader.

copy()

virtual Reader * Reader::copy ( std::shared_ptr< ReaderParams >  params = nullptr )

pure virtual

Creates this reader again and returns it. Optionally, one can provide a shared ptr to a different set of parameters.

Parameters

params

The new parameters to use. Uses the same as the original reader if nullptr is provided.

Returns

New instance of this reader

Implemented in ImageReader, and VideoReader.

getFileVector()

virtual std::vector< std::string > Reader::getFileVector ( )

pure virtual

Returns a vector with filepaths (only valid, if the reader is a imagereader)

Returns

Vector with filepaths

Implemented in ImageReader, and VideoReader.

getFPS()

virtual double Reader::getFPS ( )

pure virtual

Returns the video FPS.

Returns

double with the FPS, -1 if input isn't a video

Implemented in ImageReader, and VideoReader.

getInputPath()

virtual QString Reader::getInputPath ( )

pure virtual

Returns the input path.

Returns

Qstring with the input path

Implemented in ImageReader, and VideoReader.

getMetaData()

virtual MetaData * Reader::getMetaData ( )

pure virtual

getMetaData Returns the currently saved MetaData

Returns

The currently saved MetaData

Implemented in ImageReader, and VideoReader.

getPic()

virtual cv::Mat Reader::getPic ( unsigned int  index, PictureProcessingFlags  flags = APPLY_ALL  )

pure virtual

Returns the frame to a given index.

Parameters

index	Index of the frame to be returned
useMultipleAccess	optinal paramter, if multipleAccess should be used (set to false by default)

Returns

cv::Mat of the selected frame

Implemented in ImageReader, and VideoReader.

getPicCount()

virtual unsigned int Reader::getPicCount ( )

pure virtual

Returns the number of frame.

Returns

Number of frame

Implemented in ImageReader, and VideoReader.

getVideoDuration()

virtual double Reader::getVideoDuration ( )

pure virtual

Returns the video duration.

Returns

double with the video duration, -1 if input isn't a video

Implemented in ImageReader, and VideoReader.

isDir()

virtual bool Reader::isDir ( )

pure virtual

Returns wether the input is a direcory or not.

Returns

true if the input is based on a directory, false otherwise

Implemented in ImageReader, and VideoReader.

isValid()

virtual bool Reader::isValid ( )

pure virtual

isValid Retruns wether the reader is valid or not

Returns

true if the reader is valid, false otherwise

Implemented in ImageReader, and VideoReader.

---

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

• iVS3D/src/iVS3D-core/model/reader/reader.h