BaseImageProcessingAutomation Class

This is the base class of the image processing class. It is needed more for internal reasons to provide a stub for the image processing plug-in in the RAYGUIDE Marker API.

Inheritance Hierarchy

SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.JobElementBaseJobElement
      RAYLASE.Marker.JobElementBaseAutomationJobElement
        RAYLASE.Marker.JobElementBaseAutomationJobElementBoolean
          RAYLASE.Marker.JobElement.ImageProcessingBaseImageProcessingAutomation

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

Syntax

Copy

public abstract class BaseImageProcessingAutomation : BaseAutomationJobElement<bool>

The BaseImageProcessingAutomation type exposes the following members.

Constructors

	Name	Description
	BaseImageProcessingAutomation	Initializes a new instance of the BaseImageProcessingAutomation class

Top

Properties

	Name	Description
	ApplicationDataDirectory	The directory where application data, such as logs and configurations, are stored. (Inherited from BaseJobElement)
	AvailableImageProcessingElements	The list of available job elements. This list is recreated each time a new image processing object is created.
	Condition	The binning condition for the holder of the job element. (Inherited from BaseJobElement)
	ConfigurationManager	(Inherited from BasePlugin)
	DeviceManager	(Inherited from BaseJobElement)
	DirtyFlagLocker	The lock object for property modification. (Inherited from BaseJobElement)
	DoHandleConditionPortChangedDelegate	(Inherited from BaseJobElement)
	ErrorCode	An error code as result from any image processing execution.
	ErrorMessage	A string with one or more error messages.
	ExcutionStartPointIndex	This is the index in the list of used image processing elements from which an execution should start.
	IsAutoTestWhenOpened	Flag to indicate if the image processing should start immediately when the dialog is opened.
	IsCameraFieldSizeToReduce	Due to performance reasons the images the camera is capturing should be as small as possible. If this flag is activated, the camera's used image size is reduced (in its hardware) in a way that all regions of interest used in the job fits into this size.
	IsDirty	The flag to indicate whether the content of this job element has been modified. (Inherited from BaseJobElement)
	IsExecutionInProgress	Flag to indicate if an image processing element is currently being executed.
	IsExecutionWithTimeout	If true the execution of a job element is done with the timeout time defined in the job element, and the execution can be aborted. If false, both is not possible.
	IsJobExpanded	If true the job expander in the GUI will be expanded.
	IsPickingModeButtonAvailable	Flag to indicate if the picking mode button in the image capturer dialog is visible or not. If invisible, the picking mode is always on rather to be switched off after each ROI selection.
	IsResultZoomEnabled	If true the user can zoom in/out on the result images in the searcher views
	IsSettingsExpanded	If true the settings expander in the GUI will be expanded.
	IsTestResultExpanded	If true the test result expander in the GUI will be expanded.
	IsVerboseNotificationMode	If true, more notification messages will be displayed in the GUI.
	JobElementID	The unique ID of the job element. If the concrete class inherits from BaseJobElement, the JobElementID of the BaseJobElement will be prefilled. Recommended not to be changed. (Inherited from BaseJobElement)
	LogDirectory	The directory of the log file. (Inherited from BasePlugin)
	Logger	The common logger. (Inherited from BasePlugin)
	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)
	PropertyMask	(Inherited from BaseJobElement)
	ShouldExecute	The flag to indicate whether the job element should be marked. (Inherited from BaseAutomationJobElement)
	ShowConditionControllerUIDelegate	The delegate to show the controller UI because no ports have been defined. (Inherited from BaseJobElement)
	StoreImages	This switch controls under what condition a result image is saved if activated in an image processing element.
	StoreImagesPath	This is the directory images are saved into if activated with StoreImages.
	UsedImageProcessingElements	The list of used image processing elements used in the image processing job.
	VariableManager	(Inherited from BaseJobElement)
	VariableScopeName	(Inherited from BaseJobElement)

Top

Methods

	Name	Description
	ClearResult	Clears intermediate results which are generated during execution.
	CompareWith	(Inherited from BaseJobElement)
	CopyFrom	Copies the source job element into this job element. (Inherited from BaseJobElement)
	Create	Creates an image processing job element based on the given meta data.
	CreateAndAdd	Creates an image processing job element based on the given meta data and adds it to the list of used image processing elements.
	Dispose	(Inherited from BasePlugin)
	Dispose(Boolean)	(Inherited from BasePlugin)
	DisposeUI	(Inherited from BaseJobElement)
	DoCompareWith	(Inherited from BaseJobElement)
	DoDisposeUI	(Inherited from BasePlugin)
	DoGetUIMask	(Inherited from BaseJobElement)
	DoShowUI(String)	(Inherited from BaseJobElement)
	DoShowUI(JobElementHolder, String)	(Inherited from BaseJobElement)
	DoShowUI(JobElementHolder, String, PropertyMask)	(Inherited from BaseJobElement)
	DoShowUICallback(PluginSettingsView)	This callback method is called when a GUI settings dialog is closed with Apply or OK and is used to extract the changed properties from a settings dialog in the GUI. (Inherited from BaseJobElement)
	DoShowUICallback(JobElementHolder, PluginSettingsView)	This callback method is called when a GUI settings dialog is closed with Apply or OK and is used to extract the changed properties from a settings dialog in the GUI. (Inherited from BaseJobElement)
	Execute	Executes the automation and return the result. (Inherited from BaseAutomationJobElementT)
	GenerateLocalTag	(Inherited from BaseJobElement)
	GetCameras	Retrieves the available cameras.
	GetIlluminationControllers	Retrieves the available illumination controllers.
	GetUIMask	(Inherited from BaseJobElement)
	GetUsedImageProcessingElementIndex	Returns the index of the given image processing element in the list of used image processing elements.
	HandleConditionPortChanged	Performs necessary adjustments whenever the controller has updated its ports. (Inherited from BaseJobElement)
	Initialize	Plug-in specific initialization can be done here if necessary. (Inherited from BasePlugin)
	InvokeIPProcElementUIRequested	Callback method to open an image processing job element's settings dialog.
	ShowUI(String)	(Inherited from BaseJobElement)
	ShowUI(JobElementHolder, String)	(Inherited from BaseJobElement)
	ShowUI(JobElementHolder, String, PropertyMask)	(Inherited from BaseAutomationJobElementT)
	ShowUICallback(PluginSettingsView)	(Inherited from BaseJobElement)
	ShowUICallback(JobElementHolder, PluginSettingsView)	(Inherited from BaseAutomationJobElementT)
	ShowUICancelCallback(PluginSettingsView)	Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button (Inherited from BasePlugin)
	ShowUICancelCallback(JobElementHolder, PluginSettingsView)	(Inherited from BaseJobElement)
	ToString	(Inherited from BasePlugin)
	UpdateFieldT	Updates the Property to the value by using DirtyFlagLocker and setting IsDirty . (Inherited from BaseJobElement)
	VaryParameter	Varies the given variation parameter according to the current loop state and updates the GUI.

Top

Events

	Name	Description
	ImageProcessingElementUIRequested	Getting called when an image processing element ui gets requested.

Top

Reference

RAYLASE.Marker.JobElement.ImageProcessing Namespace