The NthFrame class implements the IBase and ISelection plugin interfaces to select every Nth frame as a keyframe. Users can configure the frame interval N and optionally keep isolated images that would otherwise be skipped. More...

#include <nthframe.h>

Inheritance diagram for NthFrame:

Public Member Functions
	NthFrame ()
	Constructor initializing N to 1 and default settings.

	~NthFrame ()=default
	Destructor.

QString	getName () const override
	getName returns the name of the plugin which will be displayed in the iVS3D interface.

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

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.

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	onIndexChanged (uint index)
	onIndexChanged is called when the currently displayed frame index changes in the viewer.

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

Private Attributes
unsigned int	m_n = 1
	Frame interval (select every Nth frame)

bool	m_keepIsolated = true
	Keep isolated images outside the N-frame pattern.

int	m_fps = 30
	Frames per second from video (for default N calculation)

uint	m_numFrames = 0
	Total frame count of the current input.

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 NthFrame class implements the IBase and ISelection plugin interfaces to select every Nth frame as a keyframe. Users can configure the frame interval N and optionally keep isolated images that would otherwise be skipped.

Author: Dominik Wüst

Date: 2021/02/14

Member Function Documentation

◆ applySettings()

ApplySettingsResult NthFrame::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.

◆ getName()

QString NthFrame::getName ( ) const

overridevirtual

getName returns the name of the plugin which will be displayed in the iVS3D interface.

Returns: The name of the plugin as a QString.

Implements PLUG::IBase.

◆ getSettings()

QMap< QString, QVariant > NthFrame::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 NthFrame::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 NthFrame::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.

◆ onInputLoaded()

InputLoadedResult NthFrame::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 NthFrame::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-nthFramePlugin/nthframe.h
iVS3D/src/iVS3D-nthFramePlugin/nthframe.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applySettings()

◆ getName()

◆ getSettings()

◆ getSettingsWidget()

◆ onCudaChanged()

◆ onInputLoaded()

◆ selectImages()