#include <ImFusion/GUI/AlgorithmController.h>

Specialization of the Controller interface to be used with Algorithm instances. More...

Inherits Controller, and SignalReceiver.

Inherited by ASCAlgorithmController, AnatomyController, InspectStyleSheetsController, BasicImageProcessingController, BullseyeVisualizationController, ConeBeamGeometryController, ConeBeamSimulationController, DefaultAlgorithmController, DeformationEditorController, DescriptorsRegistrationController, DisplayRecorderController, EvaluateLinearShapeModelController, FilterController, CreateDeviceController, ImFusionFileIoController, ImageRegistrationController, ImageResamplingController, ImageStatisticsController, InteractiveSegmentationController, IoController, LabelingController, LiftChartOverlayController, LiveHandEyeCalibrationController, LiveHandEyeEvaluationController, LiveStereoCalibrationController, MaskEditorController, MeshCollisionDetectionController, MeshDistanceController, MeshMeasurementsController, MeshPointCloudCroppingController, ParametricImageRegistrationController, PlottingAlgorithmController, PointCloudAnalysisController, PointCorrespondenceController, PointCorrespondencesController, RegistrationResultsController, StructuresViewAlgorithmController, SetModalityController, SpineBaseController, SplineSlicingController, StreamControllerBase, StreamRecorderController, ToolVisualizationController, TrackedSharedImageSetProperties, TrackedSharedImageSetPropertiesLegacy, TrackingStreamProperties, TrackingToolCalibrationWizard, BoneSegmentationController, ExportCalibrationController, FrameGeometryPropertiesController, FrameGrabbingConfigEditorController, FrameGrabbingController, ImportCalibrationController, LiveSweepRecordingVisualizationController, NeedleSweepCalibrationController, SweepGlobalInitController, SweepPointCorrController, SweepRecorderController, UltrasoundCalibrationController, UltrasoundCalibrationWizard, UltrasoundRegistrationController, and VideoCameraStreamPropertiesInspectorController.

Detailed Description

Specialization of the Controller interface to be used with Algorithm instances.

An AlgorithmController is supposed to provide a GUI enabling the user to configure and control the underlying Algorithm. In contrast to the Algorithm interface the AlgorithmController has access to the parent MainWindowBase instance and can therefore also access entities that usually would not be accessible by the Algorithm (e.g. DisplayWidget, DataModel, other Algorithms, ...).

AlgorithmControllers receive different callbacks:

onSelectedDataChanged() is called whenever the selection in the DataWidget changes.
onVisibleDataChanged() is called whenever the visible data in the DisplayWidgetMulti changes.
onAlgorithmParametersChanged() is called whenever the underlying Algorithm::signalParametersChanged was emitted.
onAlgorithmOutputChanged() is called whenever the underlying Algorithm::signalOutputChanged was emitted.

Furthermore, it extends the base Controller interface with extra functionality specific to Algorithms. If wrapped in a DefaultControllerContainer, it will decorate it with additional buttons for showInputData() and showHelp().

Note: AlgorithmControllers should be registered with the AlgorithmControllerFactory interface so that MainWindowBase can instantiate them automatically together with their Algorithm.

See also: Algorithm, AlgorithmControllerFactory, MainWindowBase, ControllerDecorator, DataController

Examples: StreamAlgorithmFactory.cpp.

Public Types
enum class	InputDataVisibility { None = 0 , All = 1 , Some = 2 }
	Enumeration of possible return values for showsInputData(). More...

Public Types inherited from Controller
enum class	Location : int { Unknown = -1 , Naked = 0 , PrimaryDock = 1 , SecondaryDock = 2 , Detached = 3 , ToolBar = 4 , UserLocation = 100 }
	Enumeration of possible placement/decoration options of a Controller. More...

Public Member Functions
	AlgorithmController (Algorithm *algorithm)
	Creates a new AlgorithmController wrapping the given algorithm, which must not be null.

const Algorithm *	algorithm () const
	Returns the underlying Algorithm instance.

Algorithm *	algorithm ()

void	showInputData ()
	Shows the input data in the DisplayWidget.

InputDataVisibility	showsInputData ()
	Checks if the input data is currently visible in the DisplayWidget.

void	showHelp ()
	Attempts to open the user documentation page for the underlying algorithm.

std::optional< Filesystem::Path >	helpPath () const
	Returns the path to the user documentation page if it is available, std::nullopt otherwise.

std::string	title () const override
	Returns the original factory name of the underlying Algorithm.

Public Member Functions inherited from Controller
void	setMainWindowBase (MainWindowBase *mw)
	Complete the initialization by providing the parent MainWindowBase instance hosting the controller by setting `m_main` and `m_disp` and eventually call init().

virtual void	onSelectedDataChanged (const DataList &)
	Called by MainWindowBase in the case that the selection in the data model has changed.

virtual void	onVisibleDataChanged (const DataList &)
	Called by MainWindowBase in the case that the currently visible data has changed.

virtual std::vector< Location >	supportedLocations () const
	Returns the list of locations in which this controller is allowed to be placed by the parent MainWindowBase.

virtual Location	preferredLocation () const
	Returns the preferred location in which the parent MainWindowBase should place this controller.

virtual void	onLocationChanged (Location newLocation)
	Callback function called by the parent MainWindowBase/ControllerDecorator whenever the place was changed.

Location	location () const
	Convenience function to query the current controller Location from the parent ControllerDecorator.

ControllerDecorator *	getDecorator () const
	Convenience function to return `m_main->getControllerDecorator(this)` if m_main is set or `nullptr` otherwise.

template<typename T>
T *	getDecorator () const
	Convenience function to `dynamic_cast` the return value of getDecorator() to a derived type.

Public Member Functions inherited from Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.

virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.

virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.

void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().

void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.

	Configurable (const Configurable &rhs)

	Configurable (Configurable &&rhs) noexcept

Configurable &	operator= (const Configurable &)

Configurable &	operator= (Configurable &&) noexcept

Public Member Functions inherited from SignalReceiver
	SignalReceiver ()=default
	Default constructor.

	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.

SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.

virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Protected Member Functions
virtual void	closeAlgorithm (bool executed=false)
	Removes the algorithm from the ApplicationController and closes the controller.

virtual void	onAlgorithmParametersChanged ()
	Callback called when the Algorithm's signalParametersChanged signal was emitted.

virtual void	onAlgorithmOutputChanged ()
	Callback called when the Algorithm's signalOutputChanged signal was emitted.

virtual void	duplicateAlgorithmOnSelectedData () const
	Instantiates a new copy of underlying Algorithm on the currently selected Data in the DataModel and adds it to the ApplicationController.

void	addToDataAndAnnotationModels (OwningDataList data)
	Adds the contents of data to the DataModel of the parent MainWindowBase.

Protected Member Functions inherited from Controller
virtual void	init ()=0
	Two-step initialization function to be implemented by subclasses.

Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Protected Attributes
Algorithm *	m_algorithm = nullptr
	The underlying algorithm.

Protected Attributes inherited from Controller
MainWindowBase *	m_main = nullptr
	The parent MainWindowBase instance hosting this Controller.

DisplayWidgetMulti *	m_disp = nullptr
	The main DisplayWidget instance, convenience shortcut for `m_main->display()`.

Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Additional Inherited Members
Public Attributes inherited from Controller
Signal	signalTitleChanged
	Signal emitted when the title() has changed.

Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Member Enumeration Documentation

◆ InputDataVisibility

enum class InputDataVisibility

strong

Enumeration of possible return values for showsInputData().

Enumerator
None	None of the input data is currently visible.
All	All of the input data is currently visible.
Some	A subset of the input data is currently visible.

Constructor & Destructor Documentation

◆ AlgorithmController()

AlgorithmController ( Algorithm * algorithm )

explicit

Creates a new AlgorithmController wrapping the given algorithm, which must not be null.

The Algorithm::signalParametersChanged and Algorithm::signalOutputChanged signals will be connected to the corresponding member functions.

Member Function Documentation

◆ showHelp()

void showHelp ( )

Attempts to open the user documentation page for the underlying algorithm.

See also: UserDocumentation

◆ title()

std::string title ( ) const

overridevirtual

Returns the original factory name of the underlying Algorithm.

Implements Controller.

◆ closeAlgorithm()

virtual void closeAlgorithm ( bool executed = false )

protectedvirtual

Removes the algorithm from the ApplicationController and closes the controller.

Warning: Since this method deletes the algorithm and the controller, the this pointer becomes invalid immediately. Therefore this method should be called last. If you need to wait for certain events (e.g. Qt signals) before doing so you should override this function and implement the necessary custom logic.

◆ onAlgorithmParametersChanged()

virtual void onAlgorithmParametersChanged ( )

inlineprotectedvirtual

Callback called when the Algorithm's signalParametersChanged signal was emitted.

Reimplemented in BasicImageProcessingController, Gl2D3DRegistrationController, XRay2D3DRegistrationAlgorithmController, DefaultAlgorithmController, ImageResamplingController, InteractiveSegmentationController, LabelingController, StreamRecorderController, BoneSegmentationController, and SweepRecorderController.

◆ onAlgorithmOutputChanged()

virtual void onAlgorithmOutputChanged ( )

inlineprotectedvirtual

Callback called when the Algorithm's signalOutputChanged signal was emitted.

Reimplemented in DefaultAlgorithmController, InteractiveSegmentationController, LabelingController, StreamRecorderController, ThresholdingFiducialExtractionController, TrackingToolCalibrationWizard, BoneSegmentationController, GeometryDetectionController, SweepRecorderController, UltrasoundCalibrationWizard, and VertebraDissectionLegacyController.

◆ duplicateAlgorithmOnSelectedData()

virtual void duplicateAlgorithmOnSelectedData ( ) const

protectedvirtual

Instantiates a new copy of underlying Algorithm on the currently selected Data in the DataModel and adds it to the ApplicationController.

Reimplemented in DefaultAlgorithmController.

◆ addToDataAndAnnotationModels()

void addToDataAndAnnotationModels ( OwningDataList data )

protected

Adds the contents of data to the DataModel of the parent MainWindowBase.

If a dataset is annotation data (Data::isAnnotationType()) it will take care of also adding it to the AnnotationModel.

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

ImFusion/GUI/AlgorithmController.h