BaseImageProcessingVariationCapableElement Class

This is the base class for all image processing elements that are capable of varying parameters. This process can be controlled in a loop for semi-automatic finding of useful parameter values. Not all properties defined here are used in all image processing elements. E.g. the LineThickness is used only in the searchers.

Inheritance Hierarchy

SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.JobElement.ImageProcessingBaseImageProcessingElement
      RAYLASE.Marker.JobElement.ImageProcessingBaseImageProcessingVariationCapableElement
        RAYLASE.Marker.JobElement.ImageProcessingBaseImageProcessingSearcherElement

Namespace: RAYLASE.Marker.JobElement.ImageProcessing
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.19.0

Syntax

Copy

public abstract class BaseImageProcessingVariationCapableElement : BaseImageProcessingElement

The BaseImageProcessingVariationCapableElement type exposes the following members.

Constructors

	Name	Description
	BaseImageProcessingVariationCapableElement	This is the base class for all image processing elements that are capable of varying parameters. This process can be controlled in a loop for semi-automatic finding of useful parameter values. Not all properties defined here are used in all image processing elements. E.g. the LineThickness is used only in the searchers.

Top

Properties

	Name	Description
	AreLoopPermutations	If testing parameters in a loop while executing is enabled, this parameter controls if all possible combinations should be tried.
	AreParametersExpanded	If true the expander of the parameters in the GUI is expanded. Ignorable in case the API is used.
	AreVariationsExpanded	If true the expander of the failure handling in the GUI is expanded. Ignorable in case the API is used.
	ConfigurationManager	(Inherited from BasePlugin)
	ElapsedTimeMsg	A notification string containing the time the element's execution has lasted. (Inherited from BaseImageProcessingElement)
	ExecutionStartPointIndex	When testing parameters (especially in a loop), this parameter controls where to start the execution. Relevant only in the GUI.
	ImageProcessingAutomation	The image processing automation object this image processing element belongs to. (Inherited from BaseImageProcessingElement)
	ImageProcessingAutomationView	The GUI of the automation object. Only needed in case used by the GUI for showing some kind of progress. null in case used by the API. (Inherited from BaseImageProcessingElement)
	IsAborted	Is set to true if the user aborts the execution of this element. (Inherited from BaseImageProcessingElement)
	IsAdvancedMode	If true, in an image processing dialog the advanced parameters will be shown. (Inherited from BaseImageProcessingElement)
	IsAutoTest	If true the testing is done immediately when changing a parameter. Ignorable in case the API is used.
	IsAutoTestWhenOpened	If true the image processing of this object is started immediately when the dialog is opened. (Inherited from BaseImageProcessingElement)
	IsExecutionStartedByGui	If true the appropriate GUI elements are updated to show the progress in case of looping. (Inherited from BaseImageProcessingElement)
	IsExecutionStartedByOwnGui	Is set to true only if the execution is started by the own GUI dialog, not by the image processing dialog. (Inherited from BaseImageProcessingElement)
	IsOk	Flag to indicate if the search has been successful.
	IsSaveResultImage	If true, the final result image of an image processing job element is saved if this mechanism is activated in StoreImages. (Inherited from BaseImageProcessingElement)
	IsSettingsDialogOpen	Is true if the settings dialog is currently open. (Inherited from BaseImageProcessingElement)
	IsSingleObjectFound	Is true if only a single object is found, rather than no object or several objects.
	IsTestingExpanded	If true the expander of the testing controls in the GUI is expanded. Ignorable in case the API is used.
	IsTimedOut	When the TimeoutTime is exceeded while executing the job element this flag is set to true. (Inherited from BaseImageProcessingElement)
	LogDirectory	The directory of the log file. (Inherited from BasePlugin)
	Logger	The common logger. (Inherited from BasePlugin)
	NameInGui	This string is shown in the GUI in the list of available elements. (Inherited from BaseImageProcessingElement)
	PluginMetadata	The metadata of the plugin instances. If the concrete class inherits from the BasePluginSetup interface, the metadata of the BasePluginSetup will be prefilled. (Inherited from BasePlugin)
	ShouldLoop	Only if true the looping with variation of the parameters given in VariationParameters will be done.
	TimeoutTime	If this time (in milliseconds) is exceeded while executing the job element, the execution will be aborted and the property IsTimedOut will be set to true. (Inherited from BaseImageProcessingElement)
	VariationParameters	The list of all parameters that should be varied during looping.

Top

Methods

	Name	Description
	AreAllLoopsFinished	Loops through all variation parameters defined in this searcher and checks if all parameter's loop counters have reached their end values.
	ClearSettingView	Cleans up the setting view of an image processing element when its settings dialog is closed. (Inherited from BaseImageProcessingElement)
	CreateVariationParameter	Creates the variation parameter with the given property name and fills it with the values of the relevant properties of this image processing element. Which properties are filled is defined in the list in PropertyNameToLabelMap.
	Dispose	(Inherited from BasePlugin)
	Dispose(Boolean)	(Inherited from BasePlugin)
	DisposeUI	(Inherited from BaseImageProcessingElement)
	DoDisposeUI	(Inherited from BasePlugin)
	DoExecute	Does the native execution of an object; i. e. the execution is done directly and not triggered by the image processing object; no thread is started. (Inherited from BaseImageProcessingElement)
	DoExecuteWithLooping	Executes the image processing element with looping over the variation parameters.
	DoExecuteWithoutLooping	Executes the image processing element, but without variation looping.
	DoShowUI	Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view. (Inherited from BasePlugin)
	DoShowUICallback	Invokes the callback that can be used when the DoShowUI method is done. (Inherited from BasePlugin)
	EnDisableTimeout	Enables and disables the timeout feature in this image processing element if available. (Inherited from BaseImageProcessingElement)
	Execute	Does the image processing. Method is used as delegate method for ImageProcessing.ExecuteImgProcElWithTimeout() and may be started in an own thread to allow aborting in case of a timeout. (Overrides BaseImageProcessingElementExecute(CancellationToken))
	GetModel	Gets the data model of the given view. If the view is not derived from IIImageProcessingModelView, the model is fetched from the image processing element itself.
	GetSettingsFromView	Retrieves possibly changed data from an image processing job element's Settings dialog. (Overrides BaseImageProcessingElementGetSettingsFromView(IImageProcessingView, Boolean))
	GetVariationProperties	Creates a dictionary of property names of all the currently (according to advanced mode) usable (and therefore visible) parameters. Used to show the usable parameters in the GUI's combo box to select them for looping.
	Initialize	Plug-in specific initialization can be done here if necessary. (Inherited from BasePlugin)
	LimitInputValues	Checks all input values on exceeding ranges. If any range is exceeded, the value is set to the min. or max. allowed value. (Inherited from BaseImageProcessingElement)
	ResetParameter	Resets the given looping parameter to its base value as defined in the variation parameter list, and sets the counter to 0.
	ResetVariationParameter	Resets the given variation parameter back to its base value. The infrastructure of BaseImageProcessingSearcherElement.VaryParameterSequential() is used; the counter is patched to achieve setting the value.
	ResetVariationsCounters	Resets the counter of all variation parameters of the given model (it is in the view) and of the variation parameters in the model which is referenced in the variation parameter itself. Furthermore the current value is set to the base value.
	RestoreInputData	Resets the parameters to the beforehand saved input data values. Called when the Cancel button is pressed. (Overrides BaseImageProcessingElementRestoreInputData)
	SaveInputData	Saves some input data when the dialog opens to set them back in case the Cancel button is pressed. (Overrides BaseImageProcessingElementSaveInputData)
	ShowUI	(Inherited from BaseImageProcessingElement)
	ShowUICallback	(Inherited from BaseImageProcessingElement)
	ShowUICancelCallback	(Inherited from BaseImageProcessingElement)
	StoreOrResetVariationParameters	Copies the data model of an image processing element to a backup memory or restores it from there. If true the property is put into the backup, if false it is recreated from there.
	ToString	Returns a string representation in the form "shortLabel (NameInGui)". (Inherited from BaseImageProcessingElement)
	UpdateUsedVariationParameters	Fills the list of currently used variation parameters with the values derived from this image processing element.
	UpdateUsedVariationParametersEditableState	Updates in a model the editable state a variation parameters. This is used to gray out parameters of "foreign" elements. E.g. the filter parameters are grayed in the circle searcher dialog.
	UpdateVariationParameterInView	Updates in the variation parameter table of the given view the variation parameter with the given property name and the possibly new base value.
	UpdateVariationParameters	Updates all the looping parameters in the given list to the current values in the image processing object. Necessary because it can happen that these are not the ones that are demanded during looping due to range restrictions in OpenCV; these restrictions are checked and corrected while an image processing object is executed.
	VaryParameter	Changes the property of the image processing object that is referenced by the given variation parameter in its PropertyName property by the value given in its Delta property. There may be different situations: - If the image processing element is open in the GUI we want to change the edit fields in it, i. e. in guiView. The values will be transferred later into the image processing element before execution. - If the image processing element is not open in the GUI we must modify the properties directly in the image processing element. This is the case either because the execution is done via API, or because it is e. g. a PictureFilter but the CircleSearcher settings dialog is open in the GUI.
	VaryParameterPermutational	Increments or decrements the first parameter that is found whose counter has not reached the wanted tryCount. The search is done permutationally, i.e. a "lower" parameter's counter is reset as soon a "higher" parameter has reached its max. counter value.
	VaryParameterSequential	Increments or decrements the first parameter that is found whose counter has not reached the wanted tryCount.

Top

Fields

	Name	Description
	_stopwatch	(Inherited from BaseImageProcessingElement)

Top

Reference

RAYLASE.Marker.JobElement.ImageProcessing Namespace