Document metadata

Application name

CSK_Module_MultiImageEdgeMatcher

Version

2.0.1

Date

2025-02-05

Author

SICK AG

Crowns

CSK_Module_MultiImageEdgeMatcher

Short description

This is an automatically generated CROWN (description not necessary).

CSK_MultiImageEdgeMatcher

Short description

Module to provide EdgeMatcher 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 instance).
2) Select the instance you want to configur via setInstance().
3) Set the event providing the images to be processed e.g. via setRegisterEvent('CSK_ImagePlayer.OnNewImage').
4) Optionally edit EdgeMatcher parameters via 'setEdgeThreshold', 'setMaximumMatches', 'setDownsampleFactor', …​ (check other 'set…​.' function as well..).
INFO: Regarding further details of the EdgeMatcher parameters please read the AppSpace API documentation.
5) Press the "Teach Mode" button within the UI. It will provide a ROI (Region of interest) editor to select an object and show its tought edges. Press the button again to confirm the tought structure.
6) Define the minimum valid score via 'setMinScore'.
7) The module will align the image in relation to the first found object. Other modules can register on the 'CSK_MultiImageEdgeMatcher.OnNewAlignedImage[NUM]' event to receive the aligned image for further processing, on the 'CSK_MultiImageEdgeMatcher.OnNewTransformation[NUM]' event to receive the transformation itself or on 'CSK_MultiImageEdgeMatcher.OnNewStatusFoundMatchesNUM' / 'CSK_MultiImageEdgeMatcher.OnNewStatusMatchScoreResultNUM' to receive the processing result values.

Overview

Functions

CSK_MultiImageEdgeMatcher.addInstance()
Short description

Function to add an additional instance.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.addInstance()
CSK_MultiImageEdgeMatcher.clearFlowConfigRelevantConfiguration()
Short description

Function to clear FlowConfig relevant configurations.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.clearFlowConfigRelevantConfiguration()
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.getInstancesAmount()
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.getParameters(instanceNo)
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.getStatusModuleActive()
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.loadParameters()
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.pageCalled()
CSK_MultiImageEdgeMatcher.processInstanceNUM()
Short description

Example of dynamically served function to process internally coded function.
NUM will be replaced by the numeric identifier 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

1

Image

Return values
Name Type Multiplicity Description

result

BOOL

?

Processing result (optional).

Sample (auto-generated)
result = CSK_MultiImageEdgeMatcher.processInstanceNUM(image)
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.resetInstances()
CSK_MultiImageEdgeMatcher.resetModule()
Short description

Function to reset main configuration of module.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.resetModule()
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.sendParameters(noDataSave)
CSK_MultiImageEdgeMatcher.setBackgroundClutter()
Short description

Function to set background clutter level.

Parameters
Name Type Multiplicity Description

level

ENUM
CSK_MultiImageEdgeMatcher.BackgroundClutterLevel

1

Expected background clutter level.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setBackgroundClutter(level)
CSK_MultiImageEdgeMatcher.setDownsampleFactor()
Short description

Function to set downsample factor of edge matcher.
Setting this parameter will invalidate any previous teach call!

Parameters
Name Type Multiplicity Description

factor

INT

1

Downsample factor.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setDownsampleFactor(factor)
CSK_MultiImageEdgeMatcher.setEdgeThreshold()
Short description

Function to set edge threshold.

Parameters
Name Type Multiplicity Description

threshold

INT

1

Edge threshold

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setEdgeThreshold(threshold)
CSK_MultiImageEdgeMatcher.setFineSearch()
Short description

Function to set status if fine search should be performed.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Default is true.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setFineSearch(status)
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.setFlowConfigPriority(status)
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.setLoadOnReboot(status)
CSK_MultiImageEdgeMatcher.setMaximumMatches()
Short description

Function to set maximum amount of matches to find.

Parameters
Name Type Multiplicity Description

max

INT

1

Maximum amount of matches.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setMaximumMatches(max)
CSK_MultiImageEdgeMatcher.setMaxScale()
Short description

Function to set maximum of scale interval to search relative to the teach size.

Parameters
Name Type Multiplicity Description

value

FLOAT

1

The largest scale factor to search for. Upper limit is 1.2. Default value is 1.0.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setMaxScale(value)
CSK_MultiImageEdgeMatcher.setMinimumValidScore()
Short description

Function to set minimal valid match score.

Parameters
Name Type Multiplicity Description

minScore

FLOAT

1

Minimal valid match score.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setMinimumValidScore(minScore)
CSK_MultiImageEdgeMatcher.setMinScale()
Short description

Function to set minimum of scale interval to search relative to the teach size.

Parameters
Name Type Multiplicity Description

value

FLOAT

1

The smallest scale factor to search for. Lower limit is 0.8. Default value is 1.0.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setMinScale(value)
CSK_MultiImageEdgeMatcher.setMinSeparation()
Short description

Function to set the minimum separation between the centers of object matches.

Parameters
Name Type Multiplicity Description

minSeparation

FLOAT

1

The minimum separation between the centers of two objects in image world units. The default value is 50.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setMinSeparation(minSeparation)
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.setParameterName(name)
CSK_MultiImageEdgeMatcher.setPriorRotation()
Short description

Function to set prior orientation for rotation interval (see TODO).

Parameters
Name Type Multiplicity Description

orientation

FLOAT

1

Prior orientation in degrees. The orientation search range is centered around this orientation. Default is zero (i.e. same orientation as teach object).

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setPriorRotation(orientation)
CSK_MultiImageEdgeMatcher.setPriorScale()
Short description

Function to set prior scale factor of scale interval to search relative to the teach size.

Parameters
Name Type Multiplicity Description

value

FLOAT

1

Set to the expected scale of the object to find, relative to the size of the teach object. E.g. 1.25 if the object to find is 25% larger than the teach object. Min: 0.1. Max: 10

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setPriorScale(value)
CSK_MultiImageEdgeMatcher.setRegisterEvent()
Short description

Configure event that this module should listen to. If this event is notified, it will be linked to the internal processing function.
(Will be set to currently active instance, see 'setSelectedObject')

Parameters
Name Type Multiplicity Description

event

STRING

1

Event name to listen to.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setRegisterEvent(event)
CSK_MultiImageEdgeMatcher.setResultTransX()
Short description

Function to set image translation in x direction added to found object position.

Parameters
Name Type Multiplicity Description

value

INT

1

Pixel in x direction.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setResultTransX(value)
CSK_MultiImageEdgeMatcher.setResultTransY()
Short description

Function to set image translation in y direction added to found object position.

Parameters
Name Type Multiplicity Description

value

INT

1

Pixel in y direction.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setResultTransY(value)
CSK_MultiImageEdgeMatcher.setRotationRange()
Short description

Function to set rotation interval to search in relative to the teach orientation.

Parameters
Name Type Multiplicity Description

range

FLOAT

1

Angle in degree unit, the maximum deviation from the original object orientation to search for. The default value is 180 degrees, i.e., full rotation.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setRotationRange(range)
CSK_MultiImageEdgeMatcher.setSelectedInstance()
Short description

Select one of the multiple instances.

Parameters
Name Type Multiplicity Description

instance

INT

1

Instance to select.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setSelectedInstance(instance)
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.setShowImage(status)
CSK_MultiImageEdgeMatcher.setTeachMode()
Short description

Set status of teach mode for edge matcher.
If TRUE, the viewer in the UI will install an editor for the ROI.
If FALSE it will update the masks accordingly.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setTeachMode(status)
CSK_MultiImageEdgeMatcher.setTileCount()
Short description

Function to set into how many tile images the match image should be splitted into.

Parameters
Name Type Multiplicity Description

value

INT

1

Number of tile images to split into. 0 gives automatic selection. 1 disables tiling. Default: 0.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setTileCount(value)
CSK_MultiImageEdgeMatcher.setTimeout()
Short description

Function to set the time the match call should abort if time exceeds.

Parameters
Name Type Multiplicity Description

value

FLOAT

1

Time in seconds after which the algorithm should abort. The default value is 5 seconds.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.setTimeout(value)
CSK_MultiImageEdgeMatcher.unteach()
Short description

Function to unteach matcher.

Sample (auto-generated)
CSK_MultiImageEdgeMatcher.unteach()

Events

CSK_MultiImageEdgeMatcher.OnDataLoadedOnReboot
Short description

Event to call after module tried to load parameters and is ready.

Sample (auto-generated)
function handleOnDataLoadedOnReboot()
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_MultiImageEdgeMatcher.OnNewAlignedImageNUM
Short description

Example of dynamically created event to provide aligned image to be used for post processing.
NUM will be replaced by the numeric identifier of instance (e.g. "OnNewAlignedImage1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

image

OBJECT
Image

1

Aligned image

Sample (auto-generated)
function handleOnNewAlignedImageNUM(image)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewAlignedImageNUM", "handleOnNewAlignedImageNUM")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewInstanceList", "handleOnNewInstanceList")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewParameterName", "handleOnNewParameterName")
CSK_MultiImageEdgeMatcher.OnNewProcessingParameter
Short description

Event to share processing parameters to the instances.

Callback arguments
Name Type Multiplicity Description

objectNo

INT

1

Numeric identifier of the instance to receive the parameter.

parameter

STRING

1

Name of the parameter.

value

AUTO

?

Value of the parameter.

internalObjectNo

INT

?

Numeric identifier, if parameter is for specific internal used object.

Sample (auto-generated)
function handleOnNewProcessingParameter(objectNo, parameter, value, internalObjectNo)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewProcessingParameter", "handleOnNewProcessingParameter")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewSelectedInstance", "handleOnNewSelectedInstance")
CSK_MultiImageEdgeMatcher.OnNewStatusBackgroundClutter
Short description

Notify background clutter level.

Callback arguments
Name Type Multiplicity Description

level

STRING

1

Background clutter level.

Sample (auto-generated)
function handleOnNewStatusBackgroundClutter(level)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusBackgroundClutter", "handleOnNewStatusBackgroundClutter")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
CSK_MultiImageEdgeMatcher.OnNewStatusDownsampleFactor
Short description

Notify currently used downsample factor of edge matcher.

Callback arguments
Name Type Multiplicity Description

factor

INT

1

Downsample factor

Sample (auto-generated)
function handleOnNewStatusDownsampleFactor(factor)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusDownsampleFactor", "handleOnNewStatusDownsampleFactor")
CSK_MultiImageEdgeMatcher.OnNewStatusEdgeThreshold
Short description

Notify currently used edge threshold.

Callback arguments
Name Type Multiplicity Description

threshold

INT

1

Edge threshold.

Sample (auto-generated)
function handleOnNewStatusEdgeThreshold(threshold)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusEdgeThreshold", "handleOnNewStatusEdgeThreshold")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
CSK_MultiImageEdgeMatcher.OnNewStatusFoundMatches
Short description

Notify amount of found matches of currently selected EdgeMatcher instance.

Callback arguments
Name Type Multiplicity Description

amount

STRING

1

Amount of found matches.

Sample (auto-generated)
function handleOnNewStatusFoundMatches(amount)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusFoundMatches", "handleOnNewStatusFoundMatches")
CSK_MultiImageEdgeMatcher.OnNewStatusFoundMatchesNUM
Short description

Example of dynamically created event to provide result of found matches.
NUM will be replaced by the numeric identifier of instance (e.g. "OnNewStatusFoundMatches1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

amount

INT

1

Amount of found matches.

Sample (auto-generated)
function handleOnNewStatusFoundMatchesNUM(amount)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusFoundMatchesNUM", "handleOnNewStatusFoundMatchesNUM")
CSK_MultiImageEdgeMatcher.OnNewStatusFoundValidMatches
Short description

Notify amount of found matches with valid score of currently selected EdgeMatcher instance.

Callback arguments
Name Type Multiplicity Description

amount

STRING

1

Amount of found matches.

Sample (auto-generated)
function handleOnNewStatusFoundValidMatches(amount)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusFoundValidMatches", "handleOnNewStatusFoundValidMatches")
CSK_MultiImageEdgeMatcher.OnNewStatusFoundValidMatchesNUM
Short description

Example of dynamically created event to provide result of found matches with valid score.
NUM will be replaced by the number of instance (e.g. "OnNewStatusFoundValidMatches1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

amount

INT

1

Amount of found matches with valid score.

Sample (auto-generated)
function handleOnNewStatusFoundValidMatchesNUM(amount)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusFoundValidMatchesNUM", "handleOnNewStatusFoundValidMatchesNUM")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_MultiImageEdgeMatcher.OnNewStatusMatchScoreResult
Short description

Notify score of found match of currently selected EdgeMatcher instance.

Callback arguments
Name Type Multiplicity Description

score

STRING

1

Score of match.

Sample (auto-generated)
function handleOnNewStatusMatchScoreResult(score)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusMatchScoreResult", "handleOnNewStatusMatchScoreResult")
CSK_MultiImageEdgeMatcher.OnNewStatusMatchScoreResultNUM
Short description

Notify score of match. Example of dynamically created event to provide score of match.
NUM will be replaced by the numeric identifier of instance (e.g. "OnNewStatusMatchScoreResult1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

score

FLOAT

*

Scores of matches.

Sample (auto-generated)
function handleOnNewStatusMatchScoreResultNUM(score)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusMatchScoreResultNUM", "handleOnNewStatusMatchScoreResultNUM")
CSK_MultiImageEdgeMatcher.OnNewStatusMaxMatches
Short description

Notify maximum amount of matches to find.

Callback arguments
Name Type Multiplicity Description

max

INT

1

Maximum amount of matches.

Sample (auto-generated)
function handleOnNewStatusMaxMatches(max)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusMaxMatches", "handleOnNewStatusMaxMatches")
CSK_MultiImageEdgeMatcher.OnNewStatusMaxScale
Short description

Notify largest scale factor to search for.

Callback arguments
Name Type Multiplicity Description

maxScale

FLOAT

1

Upper limit is 1.2. Default value is 1.0.

Sample (auto-generated)
function handleOnNewStatusMaxScale(maxScale)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusMaxScale", "handleOnNewStatusMaxScale")
CSK_MultiImageEdgeMatcher.OnNewStatusMinimalScore
Short description

Notify currently minimal valid match score.

Callback arguments
Name Type Multiplicity Description

score

FLOAT

1

Minimal valid match score.

Sample (auto-generated)
function handleOnNewStatusMinimalScore(score)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusMinimalScore", "handleOnNewStatusMinimalScore")
CSK_MultiImageEdgeMatcher.OnNewStatusMinimumSeparation
Short description

Notify minimum separation between the center of object matches.

Callback arguments
Name Type Multiplicity Description

minSeparation

FLOAT

1

The minimum separation between the centers of two objects in image world units.

Sample (auto-generated)
function handleOnNewStatusMinimumSeparation(minSeparation)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusMinimumSeparation", "handleOnNewStatusMinimumSeparation")
CSK_MultiImageEdgeMatcher.OnNewStatusMinScale
Short description

Notify smallest scale factor to search for.

Callback arguments
Name Type Multiplicity Description

minScale

FLOAT

1

Lower limit is 0.8. Default value is 1.0

Sample (auto-generated)
function handleOnNewStatusMinScale(minScale)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusMinScale", "handleOnNewStatusMinScale")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
CSK_MultiImageEdgeMatcher.OnNewStatusPerformFineSearch
Short description

Notify if the fine search should be perfromed.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewStatusPerformFineSearch(status)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusPerformFineSearch", "handleOnNewStatusPerformFineSearch")
CSK_MultiImageEdgeMatcher.OnNewStatusPriorRotation
Short description

Notify prior orientation for rotation range.

Callback arguments
Name Type Multiplicity Description

priorRotation

FLOAT

1

Prior orientation in degree.

Sample (auto-generated)
function handleOnNewStatusPriorRotation(priorRotation)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusPriorRotation", "handleOnNewStatusPriorRotation")
CSK_MultiImageEdgeMatcher.OnNewStatusPriorScale
Short description

Notfiy prior scale factor for scale ranger.

Callback arguments
Name Type Multiplicity Description

priorScale

FLOAT

1

Min: 0.1. Max: 10

Sample (auto-generated)
function handleOnNewStatusPriorScale(priorScale)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusPriorScale", "handleOnNewStatusPriorScale")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewStatusRegisteredEvent", "handleOnNewStatusRegisteredEvent")
CSK_MultiImageEdgeMatcher.OnNewStatusResultTranslateX
Short description

Notify pixel to transform result in x direction.

Callback arguments
Name Type Multiplicity Description

value

INT

1

Pixel in x direction.

Sample (auto-generated)
function handleOnNewStatusResultTranslateX(value)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusResultTranslateX", "handleOnNewStatusResultTranslateX")
CSK_MultiImageEdgeMatcher.OnNewStatusResultTranslateY
Short description

Notify pixel to transform result in y direction.

Callback arguments
Name Type Multiplicity Description

value

INT

1

Pixel in y direction.

Sample (auto-generated)
function handleOnNewStatusResultTranslateY(value)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusResultTranslateY", "handleOnNewStatusResultTranslateY")
CSK_MultiImageEdgeMatcher.OnNewStatusRotationRange
Short description

Notify angle in degree, the maximum deviation from the original object orientation to search for.

Callback arguments
Name Type Multiplicity Description

angle

FLOAT

1

Angle in degree.

Sample (auto-generated)
function handleOnNewStatusRotationRange(angle)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusRotationRange", "handleOnNewStatusRotationRange")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnNewStatusShowImage", "handleOnNewStatusShowImage")
CSK_MultiImageEdgeMatcher.OnNewStatusTileCount
Short description

Notify how many tile images the match image should be splitted into.

Callback arguments
Name Type Multiplicity Description

tileCount

INT

1

Number of tile images to split into.

Sample (auto-generated)
function handleOnNewStatusTileCount(tileCount)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusTileCount", "handleOnNewStatusTileCount")
CSK_MultiImageEdgeMatcher.OnNewStatusTimeout
Short description

Notify time in seconds after which the match algorithm should abort.

Callback arguments
Name Type Multiplicity Description

timeoutSeconds

FLOAT

1

Time in seconds after which the algorithm should abort.

Sample (auto-generated)
function handleOnNewStatusTimeout(timeoutSeconds)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusTimeout", "handleOnNewStatusTimeout")
CSK_MultiImageEdgeMatcher.OnNewStatusTought
Short description

Notify if matcher was teached already.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewStatusTought(status)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewStatusTought", "handleOnNewStatusTought")
CSK_MultiImageEdgeMatcher.OnNewTransformationNUM
Short description

Example of dynamically created event to provide transformation data to be used for post processing.
NUM will be replaced by the numeric identifier of instance (e.g. "OnNewTransformation1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

transform

OBJECT
Transform

[?*]

Transformation

Sample (auto-generated)
function handleOnNewTransformationNUM(transform)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewTransformationNUM", "handleOnNewTransformationNUM")
CSK_MultiImageEdgeMatcher.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 numeric identifier of instance (e.g. "OnNewValueToForward1").

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_MultiImageEdgeMatcher.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")
CSK_MultiImageEdgeMatcher.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 numeric identifier of instance (e.g. "OnNewValueUpdate1").

Callback arguments
Name Type Multiplicity Description

instance

INT

1

Instance the new value is coming from.

parameter

STRING

1

Name of the paramter to update/sync.

value

AUTO

1

Value to update.

selectedObject

INT

?

Optional: If internal parameter should be used for internal objects.

Sample (auto-generated)
function handleOnNewValueUpdateNUM(instance, parameter, value, selectedObject)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewValueUpdateNUM", "handleOnNewValueUpdateNUM")
CSK_MultiImageEdgeMatcher.OnNewViewerID
Short description

Notify viewerID for viewer in UI for currently selected instance.

Callback arguments
Name Type Multiplicity Description

id

STRING

1

ViewerID

Sample (auto-generated)
function handleOnNewViewerID(id)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnNewViewerID", "handleOnNewViewerID")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_MultiImageEdgeMatcher.OnROIEditorActive
Short description

Notify if ROI editor is currently active in UI.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnROIEditorActive(status)
  -- Do something
end

Script.register("CSK_MultiImageEdgeMatcher.OnROIEditorActive", "handleOnROIEditorActive")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_MultiImageEdgeMatcher.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_MultiImageEdgeMatcher.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

MultiImageEdgeMatcher_FC

Short description

Crown to provide CSK_FlowConfig relevant features.

Overview

MultiImageEdgeMatcher_FC.ImageSource

Short description

Set source of images to process.

Functions

MultiImageEdgeMatcher_FC.ImageSource.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 = MultiImageEdgeMatcher_FC.ImageSource.create(Instance)
MultiImageEdgeMatcher_FC.ImageSource.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)
MultiImageEdgeMatcher_FC.ImageSource.imageSource(handle, imageSource)

MultiImageEdgeMatcher_FC.OnNewImage

Short description

Provide image aligned according to found object match.

Functions

MultiImageEdgeMatcher_FC.OnNewImage.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 = MultiImageEdgeMatcher_FC.OnNewImage.create(Instance)
MultiImageEdgeMatcher_FC.OnNewImage.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 = MultiImageEdgeMatcher_FC.OnNewImage.register(handle, eventname, callback)

Events

MultiImageEdgeMatcher_FC.OnNewImage.OnNewImage
Short description

Provide image aligned according to found object match.

Callback arguments
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

OnNewImage

STRING

1

'CSK_MultiImageEdgeMatcher.OnNewAlignedImage[InstanceNUM]' Parameter: 1: aligned image (IMAGE)

Sample (auto-generated)
function handleOnNewImage(handle, OnNewImage)
  -- Do something
end

Script.register("MultiImageEdgeMatcher_FC.OnNewImage.OnNewImage", "handleOnNewImage")

MultiImageEdgeMatcher_FC.OnNewTransformation

Short description

Provide transformation of found match.

Functions

MultiImageEdgeMatcher_FC.OnNewTransformation.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 = MultiImageEdgeMatcher_FC.OnNewTransformation.create(Instance)
MultiImageEdgeMatcher_FC.OnNewTransformation.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 = MultiImageEdgeMatcher_FC.OnNewTransformation.register(handle, eventname, callback)

Events

MultiImageEdgeMatcher_FC.OnNewTransformation.OnNewTransformation
Short description

Provide transformation of found match.

Callback arguments
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

OnNewTransformation

STRING

1

'CSK_MultiImageEdgeMatcher.OnNewTransformation[InstanceNUM]' Parameter: 1: transformation (TRANSFORM)

Sample (auto-generated)
function handleOnNewTransformation(handle, OnNewTransformation)
  -- Do something
end

Script.register("MultiImageEdgeMatcher_FC.OnNewTransformation.OnNewTransformation", "handleOnNewTransformation")

MultiImageEdgeMatcher_FC.Process

Short description

Set source of images to process and provide image aligned to found match and related transformation.

Overview

Functions

MultiImageEdgeMatcher_FC.Process.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 = MultiImageEdgeMatcher_FC.Process.create(Instance)
MultiImageEdgeMatcher_FC.Process.process()
Short description

Set source of images to process and provide image aligned to found match and related transformation.

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

OnNewImage

STRING

1

'CSK_MultiImageEdgeMatcher.OnNewAlignedImage[InstanceNUM]' Parameter: 1: aligned image (IMAGE)

OnNewTransformation

STRING

1

'CSK_MultiImageEdgeMatcher.OnNewTransformation[InstanceNUM]' Parameter: 1: transformation (TRANSFORM)

Sample (auto-generated)
OnNewImage, OnNewTransformation = MultiImageEdgeMatcher_FC.Process.process(handle, imageSource)

Enumerations

CSK_MultiImageEdgeMatcher.BackgroundClutterLevel

Background clutter level.

Items
Value Name Description
HIGH

HIGH

Set if image contains a lot of other edges, structures, noise, clutter in areas not belonging to the object of interest (like barcodes and text which generate a lot of edge responses).

MEDIUM

MEDIUM

Set for clean scenes to gain speed.

LOW

LOW

Set for clean scenes to gain speed.