Camera
Camera - Close
Closes the camera connection
IN
| Name | Type | Description |
|---|---|---|
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - ExecuteTriggerSoftware
Executes a trigger software for the camera device.
IN
| Name | Type | Description |
|---|---|---|
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - GetAOI
Gets the AOI (offset X, offset Y, width and height) of the camera device.
IN
| Name | Type | Description |
|---|---|---|
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutOffsetX | Int | Offset X value |
| OutOffsetY | Int | Offset Y value |
| OutWidth | Int | Width value |
| OutHeight | Int | Height value |
| Error | ErrorState | Gets the execution error message |
Camera - GetDigitalIO
Gets the status of a digital I/O specified by given line number of the camera device.
IN
| Name | Type | Description |
|---|---|---|
| InLineNumber | Int | The index which identifies the line to get the status from. |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutLineStatus | Bool | The line status: true for High , false for Low |
| Error | ErrorState | Gets the execution error message |
Camera - GetExposure
Gets the exposure time of the camera device.
IN
| Name | Type | Description |
|---|---|---|
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutExposureTime | Float | Exposure value |
| Error | ErrorState | Gets the execution error message |
Camera - GetPixelFormat
Gets the pixel format of the camera device.
IN
| Name | Type | Description |
|---|---|---|
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixelFormat | Enum < PIXEL_FORMATS > | Pixel format value |
| Error | ErrorState | Gets the execution error message |
Camera - GetReverse
Gets the ReverseX and ReverseY values of the camera.
IN
| Name | Type | Description |
|---|---|---|
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutReverseX | Bool | The reverse X value. |
| OutReverseY | Bool | The reverse Y value. |
| Error | ErrorState | Gets the execution error message |
Camera - GetTrigger
Gets trigger data of camera device. Remarks: the parameters exposed are commonly used by the majority of camera devices but their values may not be all supported by specific implementation.Check with manufacturer specifications for a correct use.
IN
| Name | Type | Description |
|---|---|---|
| InTriggerSelector | DynamicEnum | Trigger selector value |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutTriggerSource | String | Specifies the trigger source value. |
| OutTriggerActivation | String | Specifies the trigger activation value. |
| OutTriggerDelay | Float | Specifies the trigger delay value, in microseconds. |
| OutTriggerMode | Bool | Specifies the trigger mode value: True if active, otherwise false. |
| AcquisitionBurstFrameCount | Int | Specifies the trigger frames count value. |
| Error | ErrorState | Gets the execution error message |
Camera - GrabImage
Grabs image from selected device.If the device is not grabbing, it will start acquisition using 1 as default NumBuffer for StartAcquisition parameter.
IN
| Name | Type | Description |
|---|---|---|
| InNumBuffers | Int | The buffer length used during acquisition.Value must be changed according to aplication requirements.If acquisition has already started using StartAcquisition this value is ignored. |
| InTimeout | Int | The timeout to wait for an image, in milliseconds. -1 to wait forever. |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | ImageNull | The grabbed image. |
| OutFrameID | Int64Null | Grabbed image's FrameID. |
| OutTimestamp | Int64Null | Grabbed image's Timestamp. |
| Error | ErrorState | Gets the execution error message |
Camera - Open
Opens the camera connection
IN
| Name | Type | Description |
|---|---|---|
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - SetAOI
Sets the AOI (offset X, offset Y, width and height) of the camera
IN
| Name | Type | Description |
|---|---|---|
| InOffsetX | Int | Offset X value |
| InOffsetY | Int | Offset Y value |
| InWidth | Int | Width value |
| InHeight | Int | Height value |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - SetDigitalIO
Sets the status of a digital I/O specified by given line number of the camera device.
IN
| Name | Type | Description |
|---|---|---|
| InLineNumber | Int | The index which identifies the line to get the status from. |
| InLineStatus | Bool | The line status: true for High , false for Low |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - SetExposure
Set exposure value
IN
| Name | Type | Description |
|---|---|---|
| InExposureTime | Float | Exposure value |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - SetPixelFormat
Sets the pixel format of the camera device
IN
| Name | Type | Description |
|---|---|---|
| InPixelFormat | Enum < PIXEL_FORMATS > | Pixel format value |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - SetReverse
Sets the ReverseX and ReverseY values of the camera.
IN
| Name | Type | Description |
|---|---|---|
| InReverseX | Bool | Reverse X value |
| InReverseY | Bool | Reverse Y value |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - SetTrigger
Sets trigger data of camera device. Remarks: the parameters exposed are commonly used by the majority of camera devices but their values may not be all supported by specific implementation.Check with manufacturer specifications for a correct use.
IN
| Name | Type | Description |
|---|---|---|
| InTriggerSelector | DynamicEnum | Trigger selector value |
| InTriggerSource | DynamicEnum | Specifies the trigger source value. |
| InTriggerActivation | DynamicEnum | Specifies the trigger activation value （RisingEdge, FallingEdge or AnyEdge）. |
| InTriggerDelay | Float | Specifies the trigger delay value, in microseconds. |
| InTriggerMode | Bool | Specifies the trigger mode value: True if active, otherwise false. |
| InAcquisitionBurstFrameCount | Int | Specifies the trigger frames count value. |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - StartAcquisition
Start camera acquisition
IN
| Name | Type | Description |
|---|---|---|
| InNumBuffers | Int | The buffer length where images are grabbed. |
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Camera - StopAcquisition
Stops camera acquisition
IN
| Name | Type | Description |
|---|---|---|
| InCameraHandle | DynamicEnum | Camera handle from available created cameras |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |