BaseImageProcessingElement Class

Represents the base categorical class of all plug-ins of type image processing element.

Inheritance Hierarchy

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

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

Syntax

Copy

public abstract class BaseImageProcessingElement : BasePlugin

The BaseImageProcessingElement type exposes the following members.

Constructors

	Name	Description
	BaseImageProcessingElement	Initializes a new instance of the BaseImageProcessingElement class

Top

Properties

	Name	Description
	ConfigurationManager	(Inherited from BasePlugin)
	ElapsedTimeMsg	A notification string containing the time the element's execution has lasted.
	ImageProcessingAutomation	The image processing automation object this image processing element belongs to.
	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.
	IsAborted	Is set to true if the user aborts the execution of this element.
	IsAdvancedMode	If true, in an image processing dialog the advanced parameters will be shown.
	IsAutoTestWhenOpened	If true the image processing of this object is started immediately when the dialog is opened.
	IsExecutionStartedByGui	If true the appropriate GUI elements are updated to show the progress in case of looping.
	IsExecutionStartedByOwnGui	Is set to true only if the execution is started by the own GUI dialog, not by the image processing dialog.
	IsSaveResultImage	If true, the final result image of an image processing job element is saved if this mechanism is activated in StoreImages.
	IsSettingsDialogOpen	Is true if the settings dialog is currently open.
	IsTimedOut	When the TimeoutTime is exceeded while executing the job element this flag is set to true.
	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.
	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)
	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.

Top

Methods

	Name	Description
	ClearSettingView	Cleans up the setting view of an image processing element when its settings dialog is closed.
	Dispose	(Inherited from BasePlugin)
	Dispose(Boolean)	(Inherited from BasePlugin)
	DisposeUI	(Overrides BasePluginDisposeUI(PluginSettingsView))
	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.
	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.
	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.
	GetSettingsFromView	Retrieves possibly changed data from an image processing job element's Settings dialog.
	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.
	RestoreInputData	When the Cancel button of an image processing job element's settings dialog is pressed, all values are restored to the values when the dialog has been opened.
	SaveInputData	When opening a dialog the current values are saved to be restored, when the Cancel button is pressed.
	ShowUI	(Overrides BasePluginShowUI(String))
	ShowUICallback	(Overrides BasePluginShowUICallback(PluginSettingsView))
	ShowUICancelCallback	(Overrides BasePluginShowUICancelCallback(PluginSettingsView))
	ToString	Returns a string representation in the form "shortLabel (NameInGui)". (Overrides BasePluginToString)

Top

Fields

	Name	Description
	_stopwatch

Top

Reference

RAYLASE.Marker.JobElement.ImageProcessing Namespace