VisionCommandGroup

Bases: ModuleCommandGroupBase

This command group contains functions for working with SENTIO's vision module. You are not meant to instantiate this class directly. Access it via the vision attribute of the SentioProber class.

Attributes:

Name	Type	Description
`camera`	`VisionCameraCommandGroup`	A subgroup to provide logic for camera specific functions.
`imagpro`	`VisionIMagProCommandGroup`	A subgroup to provide logic for IMagPro specific functions.
`compensation`	`VisionCompensationGroup`	A subgroup to provide logic for compensation specific functions.

`align_die(threshold=0.05)`

Perform a die alignment.

Die alignment compensates for positional differences when working with diced wafers which contain single dies.

Parameters:

Name	Type	Description	Default
`threshold`	`float`	The alignment threshold.	`0.05`

Returns:

Type	Description
`Tuple[float, float, float]`	A tuple with the x, y and theta offset in micrometer.

`align_wafer(mode)`

Perform a wafer alignment.

Parameters:

Name	Type	Description	Default
`mode`	`AutoAlignCmd`	The alignment procedure to use.	required

Returns:

Type	Description
`Response`	A Response object.

`auto_focus(af_cmd=AutoFocusCmd.Focus)`

Perform an auto focus operation.

Parameters:

Name	Type	Description	Default
`af_cmd`	`AutoFocusCmd`	The auto focus command to execute.	`Focus`

Returns:

Type	Description
`float`	The focus height in micrometer

`detect_probetips(camera, detector=DetectionAlgorithm.ProbeDetector, coords=DetectionCoordindates.Roi)`

Executes a built in detector on a given camera and return a list of detection results.

Parameters:

Name	Type	Description	Default
`camera`	`CameraMountPoint`	The camera to use for detection.	required
`detector`	`DetectionAlgorithm`	The detection algorithm to use.	`ProbeDetector`
`coords`	`DetectionCoordindates`	The coordinates to use for the returned detection results.	`Roi`

Returns:

Type	Description
`list`	A list of detected tips. Each detection result is a tuply of 6 values: x, y, width, height, score, class_id.

`enable_follow_mode(stat)`

Enable or disable the scope follow mode.

If scope follow mode is active the scope will move in sync with the chuck. This is useful for keeping the image in focus while moving the chuck.

This function wraps the "vis:enable_follow_mode" remote command.

Parameters:

Name	Type	Description	Default
`stat`	`bool`	A flag indicating whether to enable or disable the follow mode.	required

Returns:

Type	Description
`Response`	A Response object.

`find_home()`

Find home position.

This function uses a pre-trained pattern to fully automatically find the home position.

Returns:

Type	Description
`Response`	A Response object.

`find_pattern(name, threshold=70, pattern_index=0, reference=FindPatternReference.CenterOfRoi)`

Find a trained pattern in the camera image.

Parameters:

Name	Type	Description	Default
`name`	`str`	The name of the pattern to find.	required
`threshold`	`float`	The detection threshold. The higher the threshold, the more certain the detection must be.	`70`
`pattern_index`	`int`	The index of the pattern to find. In SENTIO each pattern may have up to 5 alternate patterns. This is the index of the alternate pattern.	`0`
`reference`	`FindPatternReference`	The reference point to use for the pattern detection.	`CenterOfRoi`

`has_camera(camera)`

Check wether a given camera is present in the system.

This function wraps the "vis:has_camera" remote command.

Parameters:

Name	Type	Description	Default
`camera`	`CameraMountPoint`	The camera mount point to check.	required

Returns:

Type	Description
`bool`	True if the camera is present, False otherwise.

`match_tips(ptpa_type)`

For internal use only! This function is subject to change without any prior warning. MPI will not maintain backwards compatibility or provide support.

`remove_probetip_marker()`

Remove probetip marker from the camera display.

Returns:

Type	Description
`Response`	A Response object.

`snap_image(file, what=SnapshotType.CameraRaw, where=SnapshotLocation.Prober)`

Save a snapshot of the current camera image to a file.

Parameters:

Name	Type	Description	Default
`file`	`str`	The file name to save the image to.	required
`what`	`SnapshotType`	The type of snapshot to take.	`CameraRaw`
`where`	`SnapshotLocation`	The location where to store the snapshot. By default this is the prober control computer. If SnapshotLocation.Local is specified the image is download from the probe computer and stored loacally.	`Prober`

Returns:

Type	Description
`None`	A Response object.

`start_fast_track()`

Start the fast track process as defined in SENTIO.

FastTrack is a feature that combines multiple preparation steps into one command. You need to have set up FastTrack in the VisionModule/Automation/FastTrack side panel editor to use this command.

Returns:

Type	Description
`Response`	A Response object.

`switch_all_lights(stat)`

Switch all camera lights on or off.

This function wraps the "vis:switch_all_lights" remote command.

Parameters:

Name	Type	Description	Default
`stat`	`bool`	A flag indicating whether to switch the lights on or off.	required

Returns:

Type	Description
`Response`	A Response object.

`switch_camera(camera)`

Switch the camera to use for the vision module.

Parameters:

Name	Type	Description	Default
`camera`	`CameraMountPoint`	The camera to switch to.	required

Returns:

Type	Description
`Response`	A Response object.

`switch_light(camera, stat)`

Switch the light of a given camera on or off.

Parameters:

Name	Type	Description	Default
`camera`	`CameraMountPoint`	The camera to switch the light for.	required
`stat`	`bool`	A flag indicating whether to switch the light on or off.	required

Returns:

Type	Description
`Response`	A Response object.

handler: python options: members: VisionCommandGroup