The Blur class selects keyframes based on blur/sharpness values computed by the selected BlurAlgorithm. More...

#include <blur.h>

Inheritance diagram for Blur:

Public Member Functions
	Blur ()
	Blur Constructor which creates an instance of every BlurAlgorithm and stets standard values (WindowSize = 30, LocalDeviation = 95)

PLUG::SettingsWidgetResult	getSettingsWidget () override
	getSettingsWidget creates and returns a settings QWidget for this plugin.

QString	getName () const override
	getName Returns the plugin Name

QMap< QString, QVariant >	getSettings () const override
	getSettings retrieves the current settings of the plugin as a map of key-value pairs. The settings are stored in the history within iVS3D and in combination with applySettings allow for saving and restoring plugin configurations.

PLUG::ApplySettingsResult	applySettings (const QMap< QString, QVariant > &settings) override
	applySettings applies the provided settings to the plugin. This method is used to restore plugin configurations from the history within iVS3D.

void	activate () override
	activate is called when the plugin is activated in iVS3D. Plugins can override this method to perform any necessary setup when they become active.

void	deactivate () override
	deactivate is called when the plugin is deactivated in iVS3D. Plugins can override this method to perform any necessary cleanup when they are no longer active.

void	onCudaChanged (bool enabled) override
	onCudaChanged is called when the CUDA usage setting is changed in iVS3D.

PLUG::InputLoadedResult	onInputLoaded (const PLUG::InputData &input) override
	onInputLoaded is called when a new input video or image set is loaded.

void	onIndexChanged (uint index) override
	onIndexChanged is called when the currently displayed frame index changes in the viewer.

VIS::VisualizationResult	generatePreview (const PLUG::PreviewData &data) override
	Generates a preview visualization based on the provided data. This function is executed asynchronously by iVS3D, such that expensive operations such as neural network inference do not block the main thread and GUI. Plugins should ensure that communication with the settings widget is thread-safe, e.g. by using signals and slots!

PLUG::SelectionResult	selectImages (const PLUG::SelectionData &data, volatile bool &cancelFlag) override
	Selects images based on the provided selection data.

Public Member Functions inherited from PLUG::IBase
virtual QString	getSettingsString () const
	getSettingsString is a helper method that converts the plugin settings into a human-readable string format.

virtual MetaDataLoadedResult	onMetaDataLoaded (const InputMetaData &inputMetaData)
	onMetaDataLoaded is called whenever metadata was loaded or refreshed for the currently active input.

virtual void	onSelectedImagesChanged (const std::vector< uint > &selectedImages)
	onSelectedImagesChanged is called when the current keyframe / selected-image list changed.

Additional Inherited Members
Signals inherited from PLUG::IBase
void	updatePreview (bool clearOldPreview=true)
	[signal] updatePreview(bool clearOldPreview) can be emitted when the plugin requests an update of the preview visualization.

void	updateSelectedImages (std::vector< uint > selectedImages)
	[signal] updateSelectedImages(std::vector<uint> selectedImages) can be emitted when the plugin wants to update the selection of images in the video player. iVS3D will only handle this signal if the plugin is currently active.

void	updateProgress (int progress, QString message=QString())
	[signal] updateProgress(int progress, QString message) can be emitted to inform iVS3D about the progress of a long-running operation.

Detailed Description

The Blur class selects keyframes based on blur/sharpness values computed by the selected BlurAlgorithm.

Author: Daniel Brommer

Date: 2021/02/19

Member Function Documentation

◆ applySettings()

ApplySettingsResult Blur::applySettings ( const QMap< QString, QVariant > & settings )

overridevirtual

applySettings applies the provided settings to the plugin. This method is used to restore plugin configurations from the history within iVS3D.

See also: getSettings

Parameters

settings A QMap containing the plugin settings as key-value pairs.

Implements PLUG::IBase.

◆ generatePreview()

VisualizationResult Blur::generatePreview ( const PLUG::PreviewData & data )

overridevirtual

Generates a preview visualization based on the provided data. This function is executed asynchronously by iVS3D, such that expensive operations such as neural network inference do not block the main thread and GUI. Plugins should ensure that communication with the settings widget is thread-safe, e.g. by using signals and slots!

Parameters

data	The PreviewData containing the image and its index.

Returns: A VisualizationResult containing either the generated Visualization or an Error if the preview generation failed.

Implements PLUG::IPreview.

◆ getName()

QString Blur::getName ( ) const

overridevirtual

getName Returns the plugin Name

Returns: "Blur"

Implements PLUG::IBase.

◆ getSettings()

QMap< QString, QVariant > Blur::getSettings ( ) const

overridevirtual

getSettings retrieves the current settings of the plugin as a map of key-value pairs. The settings are stored in the history within iVS3D and in combination with applySettings allow for saving and restoring plugin configurations.

See also: applySettings

Returns: A QMap containing the plugin settings as key-value pairs.

Implements PLUG::IBase.

◆ getSettingsWidget()

SettingsWidgetResult Blur::getSettingsWidget ( )

overridevirtual

getSettingsWidget creates and returns a settings QWidget for this plugin.

Ownership contract:

The plugin must allocate and return a std::unique_ptr<QWidget>.
Returning the unique_ptr transfers ownership to the caller.
The plugin must NOT keep ownership of, or store a pointer to, the returned widget.
The caller (core application) owns the widget and may assign a QObject/QWidget parent.

Threading contract:

The widget is part of the UI and must only be accessed from the UI thread.
Plugins may run in worker threads and therefore must not directly access the widget after handing it over.

If a plugin needs to reflect state changes in the UI later (e.g. from applySettings), it must do so via Qt signals/slots connected during widget creation.

Returns: A unique_ptr to the created settings QWidget or an Error if the widget could not be created.

Implements PLUG::IBase.

◆ onCudaChanged()

void Blur::onCudaChanged ( bool enabled )

overridevirtual

onCudaChanged is called when the CUDA usage setting is changed in iVS3D.

Parameters

enabled Indicates whether CUDA is enabled (true) or disabled (false).

Plugins can override this method to adjust their behavior based on the CUDA setting.

Implements PLUG::IBase.

◆ onIndexChanged()

void Blur::onIndexChanged ( uint index )

overridevirtual

onIndexChanged is called when the currently displayed frame index changes in the viewer.

Plugins can use this notification to update index-dependent internal state (for example temporal caches, active-frame labels, or lazy loading windows).

Threading contract:

Called on the plugin worker thread.

Parameters

index New current frame index.

Implements PLUG::IBase.

◆ onInputLoaded()

InputLoadedResult Blur::onInputLoaded ( const PLUG::InputData & input )

overridevirtual

onInputLoaded is called when a new input video or image set is loaded.

Plugins can override this method to reset caches or initialize state that depends on the current input.

Implements PLUG::IBase.

◆ selectImages()

SelectionResult Blur::selectImages	(	const PLUG::SelectionData &	data,
		volatile bool &	cancelFlag
	)

overridevirtual

Selects images based on the provided selection data.

This method should be implemented by the plugin to select images according to the specified criteria in SelectionData.

Parameters

data	The SelectionData containing selected indices, working resolution, and ROI.
cancelFlag	A volatile boolean flag that can be set to true to cancel the selection process.

Returns: A SelectionResult containing either the selected image indices or an Error if the selection failed.

Implements PLUG::ISelection.

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

iVS3D/src/iVS3D-blurPlugin/blur.h
iVS3D/src/iVS3D-blurPlugin/blur.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applySettings()

◆ generatePreview()

◆ getName()

◆ getSettings()

◆ getSettingsWidget()

◆ onCudaChanged()

◆ onIndexChanged()

◆ onInputLoaded()

◆ selectImages()