Document metadata
Application name |
CSK_Module_MultiDeepLearning |
---|---|
Version |
5.0.0 |
Date |
2024-10-11 |
Author |
SICK AG |
Crowns
- C
- M
CSK_Module_MultiDeepLearning
Short description
This is an automatically generated CROWN (description not necessary).
CSK_MultiDeepLearning
Short description
Module to provide DeepLearning functionality. Multiple instances can be created and will run in multiple threads on the device.
This module provides a UI for most 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()
2) Select the interface you want to configur via setInstance()
3) Set the event providing the images to be processed e.g. via setRegisterEvent('CSK_ImagePlayer.OnNewImage')
4) Other modules can react on the results of this module (see OnNewResultNUM and OnNewFullResultWithImageNUM)
Overview
Functions
addInstance()
Short description
Function to add an additional deepLearning instance.
Sample (auto-generated)
CSK_MultiDeepLearning.addInstance()
clearFlowConfigRelevantConfiguration()
Short description
Function to clear FlowConfig relevant configurations.
Sample (auto-generated)
CSK_MultiDeepLearning.clearFlowConfigRelevantConfiguration()
downloadFromDevice()
Short description
Download models from device.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiDeepLearning.downloadFromDevice(status)
getInstancesAmount()
Short description
Get amount of created DeepLearning instances.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
amount |
INT |
1 |
Amount |
Sample (auto-generated)
amount = CSK_MultiDeepLearning.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_MultiDeepLearning.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_MultiDeepLearning.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_MultiDeepLearning.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_MultiDeepLearning.pageCalled()
processImageNUM()
Short description
Example of dynamically served function to execute Deep Neural Network (DNN) on an image.
NUM will be replaced by the number of instance (e.g. "processImage1").
INFO: Other modules can check via "Script.isServedAsFunction" if function of sepecific instance exists.
Needs then to be called via "Script.callFunction()" (INFO: By using this, the first return value is just the "success" of this callFunction(), see AppEngine docu)
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
image |
OBJECT |
1 |
Image to process. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
validScore |
BOOL |
? |
Result score acceptable. |
score |
FLOAT |
[?*] |
Score result. |
class |
STRING |
[?*] |
Result class. |
Sample (auto-generated)
validScore, score, class = CSK_MultiDeepLearning.processImageNUM(image)
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_MultiDeepLearning.resetInstances()
resetModule()
Short description
Function to reset main configuration of module.
Sample (auto-generated)
CSK_MultiDeepLearning.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_MultiDeepLearning.sendParameters(noDataSave)
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_MultiDeepLearning.setFlowConfigPriority(status)
setForwardImage()
Short description
Functin to set if the image incl. result should be forwarded after processing.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiDeepLearning.setForwardImage(status)
setInstance()
Short description
Set instance to select.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
dnnInstance |
INT |
1 |
Single instance to select. |
Sample (auto-generated)
CSK_MultiDeepLearning.setInstance(dnnInstance)
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 |
Status |
Sample (auto-generated)
CSK_MultiDeepLearning.setLoadOnReboot(status)
setModelByName()
Short description
Set Deep Neural Network (DNN) model to use.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
modelName |
STRING |
1 |
Model name |
Sample (auto-generated)
CSK_MultiDeepLearning.setModelByName(modelName)
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_MultiDeepLearning.setParameterName(name)
setProcessWithScores()
Short description
Function to set if the scores for all classes should be returned in the processing result.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Status if it was possible to configure. |
Sample (auto-generated)
success = CSK_MultiDeepLearning.setProcessWithScores(status)
setRegisterEvent()
Short description
Set event to listen for incoming images to process. Will be set for currently selected instance (see "setInstance").
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
event |
STRING |
1 |
Event name to register to. |
Sample (auto-generated)
CSK_MultiDeepLearning.setRegisterEvent(event)
setSortResultByIndex()
Short description
Function to set if the processing result should be sorted by class index instead of highest score.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Sample (auto-generated)
CSK_MultiDeepLearning.setSortResultByIndex(status)
setValidScore()
Short description
Set the value of a score to be a valid result.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
value |
INT |
1 |
Acceptable value. |
Sample (auto-generated)
CSK_MultiDeepLearning.setValidScore(value)
setViewerActive()
Short description
Set if viewer on UI should display the image.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiDeepLearning.setViewerActive(status)
uploadFinished()
Short description
Upload of models to device finished.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status of success. |
Sample (auto-generated)
CSK_MultiDeepLearning.uploadFinished(status)
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_MultiDeepLearning.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
OnNewFullResultWithImageNUM
Short description
Example of dynamically created event to notify measured result incl. class name and score of instance incl. the image.
NUM will be replaced by the number of instance (e.g. "OnNewResultWithImage1").
Check "setProcessWithScores" regarding result configuration (single or multiple result).
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
result |
BOOL |
1 |
Result |
class |
STRING |
[1+] |
Class |
score |
FLOAT |
[1+] |
Score |
img |
OBJECT |
1 |
Image |
Sample (auto-generated)
function handleOnNewFullResultWithImageNUM(result, class, score, img)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewFullResultWithImageNUM", "handleOnNewFullResultWithImageNUM")
OnNewImageProcessingParameter
Short description
Event to share processing parameters to the instances.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
instanceNo |
INT |
1 |
Number of the instance to receive the parameter. |
parameter |
STRING |
1 |
Name of the parameter. |
value |
AUTO |
1 |
Value to set. |
Sample (auto-generated)
function handleOnNewImageProcessingParameter(instanceNo, parameter, value)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewImageProcessingParameter", "handleOnNewImageProcessingParameter")
OnNewInstanceList
Short description
Notify list of created instances.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
list |
STRING |
1 |
List of instances |
Sample (auto-generated)
function handleOnNewInstanceList(list)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewInstanceList", "handleOnNewInstanceList")
OnNewMeasuredClass
Short description
Notify measured class of currently selected instance.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
class |
STRING |
1 |
Class |
Sample (auto-generated)
function handleOnNewMeasuredClass(class)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewMeasuredClass", "handleOnNewMeasuredClass")
OnNewMeasuredClassNUM
Short description
Example of dynamically created event to notify measured class of instance.
NUM will be replaced by the number of instance (e.g. "OnNewMeasuredClass1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
class |
STRING |
1 |
Class |
Sample (auto-generated)
function handleOnNewMeasuredClassNUM(class)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewMeasuredClassNUM", "handleOnNewMeasuredClassNUM")
OnNewMeasuredScore
Short description
Notify measured score of currently selected instance.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
score |
STRING |
1 |
Score |
Sample (auto-generated)
function handleOnNewMeasuredScore(score)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewMeasuredScore", "handleOnNewMeasuredScore")
OnNewMeasuredScoreNUM
Short description
Example of dynamically created event to notify measured score of instance.
NUM will be replaced by the number of instance (e.g. "OnNewMeasuredScore1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
score |
STRING |
1 |
Score |
Sample (auto-generated)
function handleOnNewMeasuredScoreNUM(score)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewMeasuredScoreNUM", "handleOnNewMeasuredScoreNUM")
OnNewModelFilename
Short description
Notify currently set model filename.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
filename |
STRING |
1 |
Filename |
Sample (auto-generated)
function handleOnNewModelFilename(filename)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewModelFilename", "handleOnNewModelFilename")
OnNewModelLabels
Short description
Notify labels of the currently set model.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
labels |
STRING |
1 |
Labels |
Sample (auto-generated)
function handleOnNewModelLabels(labels)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewModelLabels", "handleOnNewModelLabels")
OnNewModelList
Short description
Notify list of available models.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
list |
STRING |
+ |
List of models. |
Sample (auto-generated)
function handleOnNewModelList(list)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewModelList", "handleOnNewModelList")
OnNewNumberOfInstances
Short description
Notifies about the number of instances.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
numberOfInstances |
STRING |
1 |
Number of instances. |
Sample (auto-generated)
function handleOnNewNumberOfInstances(numberOfInstances)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewNumberOfInstances", "handleOnNewNumberOfInstances")
OnNewParameterName
Short description
Notify name of the parameters if saved/loaded via the CSK_PersistentData module for currently selected camera instance.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
parametersName |
STRING |
1 |
Name |
Sample (auto-generated)
function handleOnNewParameterName(parametersName)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewParameterName", "handleOnNewParameterName")
OnNewResult
Short description
Notify result of currently selected instance.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
result |
BOOL |
1 |
Result |
Sample (auto-generated)
function handleOnNewResult(result)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewResult", "handleOnNewResult")
OnNewResultNUM
Short description
Example of dynamically created event to notify result if the class for this instance was determined with the necessary score.
NUM will be replaced by the number of instance (e.g. "OnNewResult1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
result |
BOOL |
1 |
Result |
Sample (auto-generated)
function handleOnNewResultNUM(result)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewResultNUM", "handleOnNewResultNUM")
OnNewSelectedInstance
Short description
Notify selected instance.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
selectedDeepLearning |
INT |
1 |
Selected instance |
Sample (auto-generated)
function handleOnNewSelectedInstance(selectedDeepLearning)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewSelectedInstance", "handleOnNewSelectedInstance")
OnNewSelectedModel
Short description
Notify currently selected Deep Neural Network (DNN) model.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
model |
STRING |
1 |
Model |
Sample (auto-generated)
function handleOnNewSelectedModel(model)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewSelectedModel", "handleOnNewSelectedModel")
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_MultiDeepLearning.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_MultiDeepLearning.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
OnNewStatusForwardImage
Short description
Notify if image should be forwarded with result.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusForwardImage(status)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewStatusForwardImage", "handleOnNewStatusForwardImage")
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_MultiDeepLearning.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_MultiDeepLearning.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_MultiDeepLearning.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
OnNewStatusProcessWithScores
Short description
Notify if the scores for all classes should be returned in the processing result.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusProcessWithScores(status)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewStatusProcessWithScores", "handleOnNewStatusProcessWithScores")
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_MultiDeepLearning.OnNewStatusRegisteredEvent", "handleOnNewStatusRegisteredEvent")
OnNewStatusShowImage
Short description
Notify status if image should be shown in UI viewer of this module.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusShowImage(status)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewStatusShowImage", "handleOnNewStatusShowImage")
OnNewStatusSortResultByIndex
Short description
Notify if the processing result should be sorted by class index instead of highest score.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusSortResultByIndex(status)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewStatusSortResultByIndex", "handleOnNewStatusSortResultByIndex")
OnNewUploadPath
Short description
Notify upload path for the models.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
path |
STRING |
1 |
Path |
Sample (auto-generated)
function handleOnNewUploadPath(path)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewUploadPath", "handleOnNewUploadPath")
OnNewValidScore
Short description
Notify currently set score to be valid.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
score |
INT |
1 |
Score |
Sample (auto-generated)
function handleOnNewValidScore(score)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewValidScore", "handleOnNewValidScore")
OnNewValueToForwardNUM
Short description
Example of dynamically created event to Forward thread internal values to e.g. be notified with single event related to UI.
NUM will be replaced by the number of instance (e.g. "OnNewValueToForward1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
event |
STRING |
1 |
Related, general event. |
value |
AUTO |
1 |
Value to notify. |
Sample (auto-generated)
function handleOnNewValueToForwardNUM(event, value)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")
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_MultiDeepLearning.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_MultiDeepLearning.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 of Admin userlevel. |
Sample (auto-generated)
function handleOnUserLevelAdminActive(status)
-- Do something
end
Script.register("CSK_MultiDeepLearning.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 of Maintenance userlevel. |
Sample (auto-generated)
function handleOnUserLevelMaintenanceActive(status)
-- Do something
end
Script.register("CSK_MultiDeepLearning.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 of Operator userlevel. |
Sample (auto-generated)
function handleOnUserLevelOperatorActive(status)
-- Do something
end
Script.register("CSK_MultiDeepLearning.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 of Service userlevel. |
Sample (auto-generated)
function handleOnUserLevelServiceActive(status)
-- Do something
end
Script.register("CSK_MultiDeepLearning.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")
TestImage
Short description
Internal test event to provide an image to process (as an example).
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
img |
OBJECT |
1 |
Image to process |
Sample (auto-generated)
function handleTestImage(img)
-- Do something
end
Script.register("CSK_MultiDeepLearning.TestImage", "handleTestImage")
MultiDeepLearning_FC
Short description
Crown to provide CSK_FlowConfig relevant features.
Overview
MultiDeepLearning_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 = MultiDeepLearning_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) |
Sample (auto-generated)
MultiDeepLearning_FC.ImageSource.imageSource(handle, imageSource)
MultiDeepLearning_FC.OnNewResult
Short description
Provide result of classification.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
Instance |
INT |
1 |
Numeric identifier of processing instance. |
Mode |
1 |
Mode of result to provide. 'CLASS' = Measured class 'CLASS_VALID' = Class was measured with necessary score |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = MultiDeepLearning_FC.OnNewResult.create(Instance, Mode)
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 = MultiDeepLearning_FC.OnNewResult.register(handle, eventname, callback)
Events
OnNewResult
Short description
Provide result of classification.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
OnNewResult |
STRING |
1 |
'CSK_MultiDeepLearning.OnNewResult[InstanceNUM]' or 'CSK_MultiDeepLearning.OnNewMeasuredClass[InstanceNUM]' Parameter: 1: Result if class was determined with necessary score (BOOL) if MODE = 'CLASS_VALID' or measured class (STRING) if MODE = 'CLASS' |
Sample (auto-generated)
function handleOnNewResult(handle, OnNewResult)
-- Do something
end
Script.register("MultiDeepLearning_FC.OnNewResult.OnNewResult", "handleOnNewResult")
MultiDeepLearning_FC.Process
Short description
Set source of images to process and provide classification result.
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
Instance |
INT |
1 |
Numeric identifier of processing instance. |
Mode |
1 |
Mode of result to provide. 'CLASS' = Measured class 'CLASS_VALID' = Class was measured with necessary score |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = MultiDeepLearning_FC.Process.create(Instance, Mode)
process()
Short description
Set source of images to process and provide classification result.
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) |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
OnNewResult |
STRING |
1 |
'CSK_MultiDeepLearning.OnNewResult[InstanceNUM]' or 'CSK_MultiDeepLearning.OnNewMeasuredClass[InstanceNUM]' Parameter: 1: Result if class was determined with necessary score (BOOL) if MODE = 'CLASS_VALID' or measured class (STRING) if MODE = 'CLASS' |
Sample (auto-generated)
OnNewResult = MultiDeepLearning_FC.Process.process(handle, imageSource)
Enumerations
MultiDeepLearning_FC.ResultType
Types of results to provide.
Value | Name | Description |
---|---|---|
CLASS |
CLASS |
Name of the measured class (see 'CSK_MultiDeepLearning.OnNewMeasuredClass[InstanceNUM]'). |
CLASS_VALID |
CLASS_VALID |
Boolean if class was measured with necessary score (see 'CSK_MultiDeepLearning.OnNewResult[InstanceNUM]'). |