CogSurfaceFXTool InputVisionData Property Cognex VisionPro 9.8 SR1
Gets or Sets the input vision data container. When a CogSurfaceFXTool is first constructed, the InputVisionData property is pre - populated with a CogVisionDataContainer that has four "null" images. As a convenience, the keys that identify these images are pre - defined to be "LitFromRight", "LitFromBottom", etc. If the user hates these keys they can replace the entire CogVisionDataContainer with a new one that has completely different keys.

When a user replaces the InputVisionData property, the CogSurfaceFXTool will immediately verify that the container has four items, with keys that are suitable as names in a coordinate space tree. Each item must be an ICogImage, or null. We only insist that each image is a CogImage8Grey at runtime. Replacing the InputVisionData container fires a Changed event for that property, and also for the individual image properties if they are different.

At runtime, the CogSurfaceFX operator will check that the InputVisionData property contains exactly four images of type CogImage8Grey. It will assume that the first image in the container was lit from the right, the second image was lit from below, etc. The key strings that are associated with each image will only be used as a space name in the merged coordinate space tree of the output image, if they are used at all.

Namespace: Cognex.VisionPro.SurfaceFX
Assembly: Cognex.VisionPro.SurfaceFX (in Cognex.VisionPro.SurfaceFX.dll) Version: 75.0.0.0
Syntax

public CogVisionDataContainer InputVisionData { get; set; }

Property Value

Type: CogVisionDataContainer
Events

Event TypeReason
ICogChangedEvent Changed Fires when the value of this property changes.
Exceptions

ExceptionCondition
ObjectDisposedException If the object has been disposed.
ArgumentNullException If the value is null.
ArgumentException If the container does not have 4 records.
ArgumentException If any of the 4 keys is an empty space or null.
CogSpaceTreeInvalidNameSyntaxException If any of the 4 keys is not valid coordinate space name.
ArgumentException If any of the non-null values are not an ICogImage.
See Also