Document metadata
Application name |
CSK_Module_MultiImageFilter |
---|---|
Version |
2.0.0 |
Date |
2024-10-11 |
Author |
SICK AG |
Crowns
- C
- M
CSK_Module_MultiImageFilter
Short description
This is an automatically generated CROWN (description not necessary).
CSK_MultiImageFilter
Short description
Module to provide image filter processing functionality. Multiple instances can be created and will run in multiple threads on the device.
This module provides a UI for all relevant features.
Typically to configure this module to work with other modules you should do this:
1) If multiple instances are needed, these can be added via 'addInstance()' (not needed if you only use 1 single instace).
2) Select the instance you want to configur via setInstance().
3) Set the image filter type via 'setFilterType' and optionally set according filter values if necessary.
4) Set the event providing the images to be processed e.g. via setRegisterEvent('CSK_ImagePlayer.OnNewImage').
5) Other modules can register on the 'CSK_MultiImageFilter.OnNewImage[NUM]' event to receive the filtred image for further processing.
INFO: It is possible to combine multiple filters / instances by adding instances and to register to the related preprocessed image like described in step 5).
Overview
Functions
addInstance()
Short description
Function to add an additional instance.
Sample (auto-generated)
CSK_MultiImageFilter.addInstance()
clearFlowConfigRelevantConfiguration()
Short description
Function to clear FlowConfig relevant configurations.
Sample (auto-generated)
CSK_MultiImageFilter.clearFlowConfigRelevantConfiguration()
getInstancesAmount()
Short description
Get the amount of created instances of this module.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
amount |
INT |
1 |
Amount of created instances. |
Sample (auto-generated)
amount = CSK_MultiImageFilter.getInstancesAmount()
getParameters()
Short description
Function to get all parameters of the client in JSON format.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
instanceNo |
INT |
1 |
Number of instance to get parameters from. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonParameters |
STRING |
1 |
JSON string with all parameters. |
Sample (auto-generated)
jsonParameters = CSK_MultiImageFilter.getParameters(instanceNo)
getStatusModuleActive()
Short description
Function to get status if module is active.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
status = CSK_MultiImageFilter.getStatusModuleActive()
loadParameters()
Short description
Load parameters for this module from the CSK_PersistentData module if possible and use them.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Success to load parameters. |
Sample (auto-generated)
success = CSK_MultiImageFilter.loadParameters()
pageCalled()
Short description
Function to register "OnResume" of the module UI (only as helper function).
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
empty |
STRING |
1 |
Empty string (only needed to simplify binding). |
Sample (auto-generated)
empty = CSK_MultiImageFilter.pageCalled()
processInstanceNUM()
Short description
Example of dynamically served function to process internally coded function.
NUM will be replaced by the number of instance (e.g. "processInstance1").
INFO: Other modules can check via "Script.isServedAsFunction" if function of sepecific instance exists.
Needs then to be called via "Script.callFunction".
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
image |
OBJECT |
? |
Image to process |
translation |
OBJECT |
[?*] |
Optional transformation data (xTrans, yTrans) |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
result |
BOOL |
? |
Processing result (optional). |
Sample (auto-generated)
result = CSK_MultiImageFilter.processInstanceNUM(image, translation)
resetInstances()
Short description
Function to reset instances to one single instance.
IMPORTANT: As instances start their own threads, the module needs to be restarted if new instances are needed… (see AppEngine docu for "Script.startScript").
Sample (auto-generated)
CSK_MultiImageFilter.resetInstances()
resetModule()
Short description
Function to reset main configuration of module.
Sample (auto-generated)
CSK_MultiImageFilter.resetModule()
sendParameters()
Short description
Send parameters to CSK_PersistentData module if possible to save them.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
noDataSave |
BOOL |
? |
[Optional] Set to TRUE if the data should NOT be saved immediately after sending. |
Sample (auto-generated)
CSK_MultiImageFilter.sendParameters(noDataSave)
setBlurKernelSizePix()
Short description
Function to set kernel size of blur filter.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
kernelSize |
INT |
1 |
Size of the kernel. Must be positive. |
Sample (auto-generated)
CSK_MultiImageFilter.setBlurKernelSizePix(kernelSize)
setCannyThreshold()
Short description
Function to set threshold range of canny filter.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
range |
FLOAT |
+ |
Threshold |
Sample (auto-generated)
CSK_MultiImageFilter.setCannyThreshold(range)
setCropHeight()
Short description
Function to set height of cropped image.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
height |
INT |
1 |
The height of the cropped image. |
Sample (auto-generated)
CSK_MultiImageFilter.setCropHeight(height)
setCropPositionSource()
Short description
Function to set source of crop position.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
source |
STRING |
1 |
Source (MANUAL or EXTERNAL) |
Sample (auto-generated)
CSK_MultiImageFilter.setCropPositionSource(source)
setCropPosX()
Short description
Function to set x position to crop image.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
posX |
INT |
1 |
The x position of the top-left corner of the cropped image in the source image. |
Sample (auto-generated)
CSK_MultiImageFilter.setCropPosX(posX)
setCropPosY()
Short description
Function to set y position to crop image.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
posY |
INT |
1 |
The y position of the top-left corner of the cropped image in the source image. |
Sample (auto-generated)
CSK_MultiImageFilter.setCropPosY(posY)
setCropWidth()
Short description
Function to set widht of cropped image.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
width |
INT |
1 |
The width of the cropped image. |
Sample (auto-generated)
CSK_MultiImageFilter.setCropWidth(width)
setFilterType()
Short description
Function to set filter type.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
filterType |
1 |
Filter type. |
Sample (auto-generated)
CSK_MultiImageFilter.setFilterType(filterType)
setFlowConfigPriority()
Short description
Function to configure if FlowConfig should have priority for FlowConfig relevant configuration.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiImageFilter.setFlowConfigPriority(status)
setLoadOnReboot()
Short description
Configure if this module should load its saved parameters at app/ device boot up.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Set status |
Sample (auto-generated)
CSK_MultiImageFilter.setLoadOnReboot(status)
setParameterName()
Short description
Function to set the name of the parameters if saved/loaded via the CSK_PersistentData module.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
name |
STRING |
1 |
Name of the parameter |
Sample (auto-generated)
CSK_MultiImageFilter.setParameterName(name)
setRegisterCropPositionEvent()
Short description
Function to set event to receive transformation position data to crop image.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
event |
STRING |
1 |
Event (needs to provide translation data as 'Transform' object). |
Sample (auto-generated)
CSK_MultiImageFilter.setRegisterCropPositionEvent(event)
setRegisterEvent()
Short description
Configure event that this module should listen to. If this one is notified, it will be linked to internal processing function.
(Will be set to currently active instance, see "setSelectedObject")
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
event |
STRING |
1 |
(external) Event name to listen to. |
Sample (auto-generated)
CSK_MultiImageFilter.setRegisterEvent(event)
setRegisterTransformationEvent()
Short description
Function to set event to receive transformation data to align image.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
event |
STRING |
1 |
Event (needs to provide translation data as 'Transform' object). |
Sample (auto-generated)
CSK_MultiImageFilter.setRegisterTransformationEvent(event)
setSelectedInstance()
Short description
Select one of the multiple instances.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
instance |
INT |
1 |
Instance to select. |
Sample (auto-generated)
CSK_MultiImageFilter.setSelectedInstance(instance)
setShowImage()
Short description
Function to select if image should be shown on UI.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiImageFilter.setShowImage(status)
setTransformationAngle()
Short description
Functin to set manual transformation angle.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
angle |
INT |
1 |
Transformation angle in degree between -180 and +180. |
Sample (auto-generated)
CSK_MultiImageFilter.setTransformationAngle(angle)
setTransformationAngleOriginX()
Short description
Function to set xPos of origin for manual angle transformation.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
xPos |
INT |
1 |
x position |
Sample (auto-generated)
CSK_MultiImageFilter.setTransformationAngleOriginX(xPos)
setTransformationAngleOriginY()
Short description
Function to set yPos of origin for manual angle transformation.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
yPos |
INT |
1 |
y position |
Sample (auto-generated)
CSK_MultiImageFilter.setTransformationAngleOriginY(yPos)
setTransformationSource()
Short description
Function to set source of transformation data.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
source |
1 |
Source |
Sample (auto-generated)
CSK_MultiImageFilter.setTransformationSource(source)
setTransformationX()
Short description
Functin to set manual transformation in x direction.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
x |
INT |
1 |
Translation in x direction. |
Sample (auto-generated)
CSK_MultiImageFilter.setTransformationX(x)
setTransformationY()
Short description
Functin to set manual transformation in y direction.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
y |
INT |
1 |
Translation in y direction. |
Sample (auto-generated)
CSK_MultiImageFilter.setTransformationY(y)
Events
OnDataLoadedOnReboot
Short description
Event to call if module tried to load parameters and should be ready.
Sample (auto-generated)
function handleOnDataLoadedOnReboot()
-- Do something
end
Script.register("CSK_MultiImageFilter.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
OnNewImageNUM
Short description
Example of dynamically created event to provide result image of instance.
NUM will be replaced by the number of instance (e.g. "OnNewImage1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
resultImage |
OBJECT |
? |
Result image. |
Sample (auto-generated)
function handleOnNewImageNUM(resultImage)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewImageNUM", "handleOnNewImageNUM")
OnNewInstanceList
Short description
Event to provide list of created instances.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
list |
STRING |
1 |
List of created instances. |
Sample (auto-generated)
function handleOnNewInstanceList(list)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewInstanceList", "handleOnNewInstanceList")
OnNewParameterName
Short description
Notify name of persistent data parameter.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
name |
STRING |
1 |
Parameter name |
Sample (auto-generated)
function handleOnNewParameterName(name)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewParameterName", "handleOnNewParameterName")
OnNewProcessingParameter
Short description
Event to share processing parameters to the instances.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
objectNo |
INT |
1 |
Number of the instance to receive the parameter. |
parameter |
STRING |
1 |
Name of the parameter. |
value |
AUTO |
1 |
Value of the parameter. |
internalObjectNo |
INT |
? |
If parameter is for specific internal used object, its number. |
Sample (auto-generated)
function handleOnNewProcessingParameter(objectNo, parameter, value, internalObjectNo)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewProcessingParameter", "handleOnNewProcessingParameter")
OnNewResult
Short description
Generic event to notify results. E.g. to forward results from single instances.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
result |
BOOL |
1 |
Result |
Sample (auto-generated)
function handleOnNewResult(result)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewResult", "handleOnNewResult")
OnNewSelectedInstance
Short description
Notify if new instance is selected.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
selectedObject |
INT |
1 |
Selected instance. |
Sample (auto-generated)
function handleOnNewSelectedInstance(selectedObject)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewSelectedInstance", "handleOnNewSelectedInstance")
OnNewStatusBlurKernelSizePix
Short description
Notify kernel size of blur filter.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
size |
INT |
1 |
Size of the kernel. |
Sample (auto-generated)
function handleOnNewStatusBlurKernelSizePix(size)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusBlurKernelSizePix", "handleOnNewStatusBlurKernelSizePix")
OnNewStatusCannyThresholds
Short description
Notify threshold values of canny filter.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
threshold |
FLOAT |
+ |
Threshold values. |
Sample (auto-generated)
function handleOnNewStatusCannyThresholds(threshold)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusCannyThresholds", "handleOnNewStatusCannyThresholds")
OnNewStatusCropHeight
Short description
Notify height of cropped image.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
height |
INT |
1 |
The height of the cropped image. |
Sample (auto-generated)
function handleOnNewStatusCropHeight(height)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusCropHeight", "handleOnNewStatusCropHeight")
OnNewStatusCropPositionSource
Short description
Notify source for crop position.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
source |
STRING |
1 |
Source |
Sample (auto-generated)
function handleOnNewStatusCropPositionSource(source)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusCropPositionSource", "handleOnNewStatusCropPositionSource")
OnNewStatusCropPosX
Short description
Notify x position to crop image.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
posX |
INT |
1 |
The x position of the top-left corner of the cropped image in the source image. |
Sample (auto-generated)
function handleOnNewStatusCropPosX(posX)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusCropPosX", "handleOnNewStatusCropPosX")
OnNewStatusCropPosY
Short description
Notify y position to crop image.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
poxY |
INT |
1 |
The y position of the top-left corner of the cropped image in the source image. |
Sample (auto-generated)
function handleOnNewStatusCropPosY(poxY)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusCropPosY", "handleOnNewStatusCropPosY")
OnNewStatusCropWidth
Short description
Notify width of cropped image.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
width |
INT |
1 |
The width of the cropped image. |
Sample (auto-generated)
function handleOnNewStatusCropWidth(width)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusCropWidth", "handleOnNewStatusCropWidth")
OnNewStatusCSKStyle
Short description
Notify UI style to use for CSK modules.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
theme |
STRING |
1 |
UI style |
Sample (auto-generated)
function handleOnNewStatusCSKStyle(theme)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
OnNewStatusFlowConfigPriority
Short description
Notify if FlowConfig should have priority for FlowConfig relevant configurations.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusFlowConfigPriority(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
OnNewStatusImageFilterType
Short description
Notify selected image filter type.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
filterType |
STRING |
1 |
Filter type. |
Sample (auto-generated)
function handleOnNewStatusImageFilterType(filterType)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusImageFilterType", "handleOnNewStatusImageFilterType")
OnNewStatusLoadParameterOnReboot
Short description
Notify status if parameters should be loaded on app/device boot up.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusLoadParameterOnReboot(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
OnNewStatusModuleIsActive
Short description
Notify if module can be used on device.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusModuleIsActive(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
OnNewStatusModuleVersion
Short description
Notify version of module.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
version |
STRING |
1 |
Version |
Sample (auto-generated)
function handleOnNewStatusModuleVersion(version)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
OnNewStatusRegisteredCropPositionEvent
Short description
Notify event to receive transformation data to crop specific part in image.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
eventName |
STRING |
1 |
Name of event. |
Sample (auto-generated)
function handleOnNewStatusRegisteredCropPositionEvent(eventName)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusRegisteredCropPositionEvent", "handleOnNewStatusRegisteredCropPositionEvent")
OnNewStatusRegisteredEvent
Short description
Notify event instance is registered to receive new image to process.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
eventname |
STRING |
1 |
Name of event. |
Sample (auto-generated)
function handleOnNewStatusRegisteredEvent(eventname)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusRegisteredEvent", "handleOnNewStatusRegisteredEvent")
OnNewStatusRegisteredTransformationEvent
Short description
Notify event to receive transformation data to align image.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
eventName |
STRING |
1 |
Name of event. |
Sample (auto-generated)
function handleOnNewStatusRegisteredTransformationEvent(eventName)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusRegisteredTransformationEvent", "handleOnNewStatusRegisteredTransformationEvent")
OnNewStatusShowImage
Short description
Notify if image should be showed in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusShowImage(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusShowImage", "handleOnNewStatusShowImage")
OnNewStatusTransformationAngle
Short description
Notify manual transformation angle.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
angle |
INT |
1 |
Transformation angle. |
Sample (auto-generated)
function handleOnNewStatusTransformationAngle(angle)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusTransformationAngle", "handleOnNewStatusTransformationAngle")
OnNewStatusTransformationAngleOriginX
Short description
Notify transformation angle origin x position.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
xPos |
INT |
1 |
x position |
Sample (auto-generated)
function handleOnNewStatusTransformationAngleOriginX(xPos)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusTransformationAngleOriginX", "handleOnNewStatusTransformationAngleOriginX")
OnNewStatusTransformationAngleOriginY
Short description
Notify transformation angle origin y position.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
yPos |
INT |
1 |
y position |
Sample (auto-generated)
function handleOnNewStatusTransformationAngleOriginY(yPos)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusTransformationAngleOriginY", "handleOnNewStatusTransformationAngleOriginY")
OnNewStatusTransformationSource
Short description
Notify source for transformation data.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
mode |
STRING |
1 |
Mode |
Sample (auto-generated)
function handleOnNewStatusTransformationSource(mode)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusTransformationSource", "handleOnNewStatusTransformationSource")
OnNewStatusTransformationX
Short description
Notify manual transformation in x direction.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
xTrans |
INT |
1 |
Transformation in x direction. |
Sample (auto-generated)
function handleOnNewStatusTransformationX(xTrans)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusTransformationX", "handleOnNewStatusTransformationX")
OnNewStatusTransformationY
Short description
Notify manual transformation in y direction.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
yTrans |
INT |
1 |
Transformation in y direction. |
Sample (auto-generated)
function handleOnNewStatusTransformationY(yTrans)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusTransformationY", "handleOnNewStatusTransformationY")
OnNewStatusUIMessage
Short description
Notfiy message to show in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
STRING |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusUIMessage(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewStatusUIMessage", "handleOnNewStatusUIMessage")
OnNewValueToForwardNUM
Short description
Example of dynamically created event to forward data from instance thread to Controller part of module, e.g. to forward values to UI.
NUM will be replaced by the number of instance (e.g. "OnNewResult1").
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
eventname |
STRING |
1 |
Eventname to use to forward value. |
value |
AUTO |
1 |
Value to forward. |
Sample (auto-generated)
function handleOnNewValueToForwardNUM(eventname, value)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")
OnNewValueUpdateNUM
Short description
Example of dynamically created event to sync paramters between instance threads and Controller part of module.
NUM will be replaced by the number of instance (e.g. "OnNewResult1").
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
instance |
INT |
1 |
Instance new value is coming from. |
parameter |
STRING |
1 |
Name of the paramter to update/sync. |
value |
AUTO |
1 |
Value to update. |
selectedObject |
INT |
? |
Optionally if internal parameter should be used for internal objects. |
Sample (auto-generated)
function handleOnNewValueUpdateNUM(instance, parameter, value, selectedObject)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewValueUpdateNUM", "handleOnNewValueUpdateNUM")
OnNewViewerID
Short description
Notify currently used viewerID (e.g. to show correct viewer in UI).
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
viewerID |
STRING |
1 |
viewerID |
Sample (auto-generated)
function handleOnNewViewerID(viewerID)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnNewViewerID", "handleOnNewViewerID")
OnPersistentDataModuleAvailable
Short description
Notify status if features of CSK_PersistentData module are available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnPersistentDataModuleAvailable(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
OnUserLevelAdminActive
Short description
Status of Admin userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelAdminActive(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
OnUserLevelMaintenanceActive
Short description
Status of Maintenance userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelMaintenanceActive(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
OnUserLevelOperatorActive
Short description
Status of Operator userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelOperatorActive(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
OnUserLevelServiceActive
Short description
Status of Service userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelServiceActive(status)
-- Do something
end
Script.register("CSK_MultiImageFilter.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")
MultiImageFilter_FC
Short description
Crown to provide CSK_FlowConfig relevant features.
Overview
MultiImageFilter_FC.ImageSource
Short description
Set source of images to process.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
Instance |
INT |
1 |
Numeric identifier of processing instance. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = MultiImageFilter_FC.ImageSource.create(Instance)
imageSource()
Short description
Set source of images to process.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
imageSource |
STRING |
1 |
Set source of images to process. Parameter: 1: image (IMAGE) |
transformationSource |
STRING |
? |
(optional) Set source of transformation to use on image. Parameter: 1: transformation (TRANSFORM) |
Sample (auto-generated)
MultiImageFilter_FC.ImageSource.imageSource(handle, imageSource, transformationSource)
MultiImageFilter_FC.OnNewImage
Short description
Provide filtered image.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
Instance |
INT |
1 |
Numeric identifier of processing instance. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = MultiImageFilter_FC.OnNewImage.create(Instance)
register()
Short description
Internally used CSK_FlowConfig register function.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
eventname |
STRING |
1 |
Internal parameter (not used). |
callback |
STRING |
1 |
Internally used callback function. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Success of register process. |
Sample (auto-generated)
success = MultiImageFilter_FC.OnNewImage.register(handle, eventname, callback)
Events
OnNewImage
Short description
Provide filtered image.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
OnNewImage |
STRING |
1 |
'CSK_MultiImageFilter.OnNewImage[InstanceNUM]' Parameter: 1: (optional) filterd image (IMAGE) |
Sample (auto-generated)
function handleOnNewImage(handle, OnNewImage)
-- Do something
end
Script.register("MultiImageFilter_FC.OnNewImage.OnNewImage", "handleOnNewImage")
MultiImageFilter_FC.Process
Short description
Set source of images to filter and provide filtered images.
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
Instance |
INT |
1 |
Number of processing instance. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = MultiImageFilter_FC.Process.create(Instance)
process()
Short description
Set source event of incoming images and provide result image event.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
imageSource |
STRING |
1 |
Set source of images to process. Parameter: 1: image (IMAGE) |
transformationSource |
STRING |
? |
(optional) Set source of transformation to use on image. Parameter: 1: transformation (TRANSFORM) |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
OnNewImage |
STRING |
1 |
'CSK_MultiImageFilter.OnNewImage[InstanceNUM]' Parameter: 1: (optional) filterd image (IMAGE) |
Sample (auto-generated)
OnNewImage = MultiImageFilter_FC.Process.process(handle, imageSource, transformationSource)
Enumerations
CSK_MultiImageFilter.ImageFilter
Available image filter.
Value | Name | Description |
---|---|---|
Gray |
Gray |
Convert RGB image to gray image. |
Canny |
Canny |
Canny filter. |
Blur |
Blur |
Blur filter. |
Crop |
Crop |
Crop image. |
Transform |
Transform |
Transform image. |
CSK_MultiImageFilter.TransformationSource
Source for transformation data.
Value | Name | Description |
---|---|---|
MANUAL |
MANUAL |
Manually set config to transform image. |
EXTERNAL |
EXTERNAL |
Receive config to transform image from external source via event. |