VisualSimilarity Class Reference

Inheritance diagram for VisualSimilarity:

Public Member Functions
QWidget *	getSettingsWidget (QWidget *parent) override
	returns a widget to change parameters of this plugin.
std::vector< uint >	sampleImages (const std::vector< unsigned int > &imageList, Progressable *receiver, volatile bool *stopped, bool useCuda, LogFileParent *logFile) override
	sampleImages Create an keyframe list with indices of the keyframes. The algorithm reports progress to the Progressable *receiver by calling Progressable::slot_makeProgress. If the *stopped bool is set to true the algorithm should abort the calculations and exit.
QString	getName () const override
	getName Returns the plugin name
void	initialize (Reader *reader, QMap< QString, QVariant > buffer, signalObject *sigObj) override
	initialize is called after new images have been loaded. the plugin parameters can be selected based on the images.
void	setSettings (QMap< QString, QVariant > settings) override
	setter for plugin's settings
QMap< QString, QVariant >	generateSettings (Progressable *receiver, bool useCuda, volatile bool *stopped) override
	generateSettings tries to generate the best settings for the current input
QMap< QString, QVariant >	getSettings () override
	getter for plugin's settings
Public Member Functions inherited from IAlgorithm
virtual std::vector< uint >	sampleImages (const std::vector< uint > &imageList, Progressable *receiver, volatile bool *stopped, bool useCuda, LogFileParent *logFile)=0
	sampleImages selects the keyframes from the given images. The computation is based on the images provided by the given Reader. The imageList provides indices for the currently selected keyframes. This way the current selection can be taken in account in the calculation. Since the algorithm can be very time consuming, it is recommended to report progress to the given Progressable by invoking Progressable::slot_makeProgress. It should be possible to abort calculation by setting the value of stopped to true. Therefore it is necessary to repeatedly check its state. To speedup calculation, data can be buffered to accelerate the next call of sampleImages. On some systems the gpu can be utilized for acceleration as well, but only if useCuda is true. See following example implementation for sampleImages:

Additional Inherited Members
Signals inherited from IAlgorithm
void	updateKeyframes (std::vector< uint > keyframes)
	updateKeyframes updates the keyframe list in the core object.
void	updateBuffer (QMap< QString, QVariant > buffer)
	updateBuffer stores the given buffer for future uses of the buffered data.

Member Function Documentation

generateSettings()

QMap< QString, QVariant > VisualSimilarity::generateSettings ( Progressable *  receiver, bool  useCuda, volatile bool *  stopped  )

overridevirtual

generateSettings tries to generate the best settings for the current input

Parameters

receiver	is a progressable, which displays the already made progress
buffer	QVariant with the buffered data form last call to sampleImages
useCuda	true if cv::cuda can be used
stopped	is set if the algorithm should abort

Returns

QMap with the settings

Implements IAlgorithm.

getName()

QString VisualSimilarity::getName ( ) const

overridevirtual

getName Returns the plugin name

Returns

"orbslam"

Implements IAlgorithm.

getSettings()

QMap< QString, QVariant > VisualSimilarity::getSettings ( )

overridevirtual

getter for plugin's settings

Returns

QMap with the settings

Implements IAlgorithm.

getSettingsWidget()

QWidget * VisualSimilarity::getSettingsWidget ( QWidget *  parent )

overridevirtual

returns a widget to change parameters of this plugin.

Parameters

parent

The parent for the SettingsWidget.

Implements IAlgorithm.

initialize()

void VisualSimilarity::initialize ( Reader *  reader, QMap< QString, QVariant >  buffer, signalObject *  sigObj  )

overridevirtual

initialize is called after new images have been loaded. the plugin parameters can be selected based on the images.

Parameters

reader	for the images
buffer	contains persistently stored plugin data from the project file. This includes data stored using getSettings() and generateSettings()
sigObj	provides signals from the core

Implements IAlgorithm.

sampleImages()

std::vector< uint > VisualSimilarity::sampleImages ( const std::vector< unsigned int > &  imageList, Progressable *  receiver, volatile bool *  stopped, bool  useCuda, LogFileParent *  logFile  )

override

sampleImages Create an keyframe list with indices of the keyframes. The algorithm reports progress to the Progressable *receiver by calling Progressable::slot_makeProgress. If the *stopped bool is set to true the algorithm should abort the calculations and exit.

Parameters

imageList	is a preselection of frames
receiver	is a progressable, which displays the progress made so far
stopped	Pointer to a bool indication if user wants to stop the computation
useCuda	defines if the compution should run on graphics card
logFile	can be used to protocoll progress or problems

Returns

A list of indices, which represent the selected keyframes.

setSettings()

void VisualSimilarity::setSettings ( QMap< QString, QVariant >  settings )

overridevirtual

setter for plugin's settings

Parameters

QMap	with the settings

Implements IAlgorithm.

---

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

• iVS3D/src/iVS3D-visualSimilarityPlugin/visualSimilarity.h
• iVS3D/src/iVS3D-visualSimilarityPlugin/visualSimilarity.cpp