Chunk Data Control
Chunk Data allows you the ability to send additional information with the image data. This can be helpful when debugging issues or looking at what settings have been applied to the acquired image.
Use ChunkModeActive to enable chunk data for images.
The following information is available as chunk data:
Image - enabled by default and cannot be disabled.
Image CRC - enabled by default and cannot be disabled.
FrameID
OffsetX
OffsetY
Width
Height
Exposure Time
Gain
Black Level
Pixel Format
ImageTimestamp
Sequencer Set Active
Use ChunkSelector to select a chunk then use ChunkEnable to enable or disable it. Image and ImageCRC cannot be disabled.
Once acquisition has started Chunk data can not be altered. To enable or disable chunks acquisition must be stopped.
Lossless Compression
Lossless compression is a feature that uses a lossless compression algorithm to reduce the amount of data transmitted from the camera. This can be used to either lower bandwidth or increase frame rate.
Lossless compression adds the following information in Chunk Data:
- Chunk Compression Mode: Specifies whether image data is compressed.
- Chunk Current Datarate: Current datarate as calculated by the bitrate control algorithm in B/s. This is only used if frame is compressed.
- Chunk Compression Ratio: Specifies compression ratio for the current frame. This is only used if frame is compressed.
Summary Table
| Name | Interface | Access | Visibility | Description |
|---|---|---|---|---|
| Chunk Mode Active | IBoolean | RW | Expert | Activates the inclusion of Chunk data in the payload of the image. |
| Chunk Selector | IEnumeration | RW | Expert | Selects which chunk data to enable or disable. |
| Chunk Enable [Chunk Selector] | IBoolean | RW | Expert | Enables the inclusion of the selected Chunk data in the payload of the image. |
| Chunk Image | IInteger | RO | Expert | Returns the image payload. |
| Image CRC | IInteger | RO | Expert | Returns the CRC of the image payload. |
| Chunk Frame ID | IInteger | RO | Expert | Returns the image frame ID. |
| Chunk Offset X | IInteger | RO | Expert | Returns the Offset X of the image included in the payload. |
| Chunk Offset Y | IInteger | RO | Expert | Returns the Offset Y of the image included in the payload. |
| Chunk Width | IInteger | RO | Expert | Returns the width of the image included in the payload. |
| Chunk Height | IInteger | RO | Expert | Returns the height of the image included in the payload. |
| Chunk Pixel Format | IEnumeration | Expert | Format of the pixel provided by the camera | |
| Chunk Exposure Time | IFloat | RO | Expert | Returns the exposure time used to capture the image. |
| Chunk Gain Selector | IEnumeration | Expert | Selects which gain to retrieve | |
| Chunk Gain [Chunk Gain Selector] | IFloat | RO | Expert | Returns the gain used to capture the image. |
| Chunk Black Level Selector | IEnumeration | Expert | Selects which black level to retrieve | |
| Chunk Black Level [Chunk Black Level Selector] | IFloat | RO | Expert | Returns the black level used to capture the image. |
| Chunk Timestamp | IInteger | RO | Expert | Returns the Timestamp of the image. |
| Chunk Sequencer Set Active | IInteger | RO | Expert | Returns the index of the active set of the running sequencer included in the payload. |
| Chunk Exposure End Line Status All | IInteger | RO | Expert | Returns the status of all the I/O lines at the end of exposure event. |
| Chunk Compression Mode | IInteger | RO | Expert | Returns the compression mode of the last image payload. |
| Chunk Current Datarate | IInteger | RO | Expert | Returns the current datarate of the last image payload. |
| Chunk Compression Ratio | IFloat | RO | Expert | Returns the compression ratio of the last image payload. |
| Chunk Serial Data Length | IInteger | RO | Expert | Returns the length of the received serial data that was included in the payload. |
| Chunk Serial Data | IStringReg | Expert | Returns the serial data that was received. | |
| Chunk Serial Receive Overflow | IBoolean | RO | Expert | Returns the status of the chunk serial receive overflow. |
Chunk Data Control Features
Chunk Mode Active
Activates the inclusion of Chunk data in the payload of the image.
| Property | Value |
|---|---|
| Name | ChunkModeActive |
| Interface | IBoolean |
| Access | RW |
| Visibility | Expert |
Chunk Selector
Selects which chunk data to enable or disable.
| Property | Value |
|---|---|
| Name | ChunkSelector |
| Interface | IEnumeration |
| Access | RW |
| Visibility | Expert |
| Enumeration Values |
|---|
| Image |
| CRC |
| FrameID |
| OffsetX |
| OffsetY |
| Width |
| Height |
| ExposureTime |
| Gain |
| BlackLevel |
| PixelFormat |
| Timestamp |
| SequencerSetActive |
| SerialData |
| ExposureEndLineStatusAll |
| CompressionMode |
| CompressionRatio |
| CurrentDatarate |
Chunk Enable
Enables the inclusion of the selected Chunk data in the payload of the image.
| Property | Value |
|---|---|
| Name | ChunkEnable [Chunk Selector] |
| Interface | IBoolean |
| Access | RW |
| Visibility | Expert |
Chunk Image
Returns the image payload.
| Property | Value |
|---|---|
| Name | ChunkImage |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Image CRC
Returns the CRC of the image payload.
| Property | Value |
|---|---|
| Name | ChunkCRC |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Frame ID
Returns the image frame ID.
| Property | Value |
|---|---|
| Name | ChunkFrameID |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Offset X
Returns the Offset X of the image included in the payload.
| Property | Value |
|---|---|
| Name | ChunkOffsetX |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Offset Y
Returns the Offset Y of the image included in the payload.
| Property | Value |
|---|---|
| Name | ChunkOffsetY |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Width
Returns the width of the image included in the payload.
| Property | Value |
|---|---|
| Name | ChunkWidth |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Height
Returns the height of the image included in the payload.
| Property | Value |
|---|---|
| Name | ChunkHeight |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Pixel Format
Format of the pixel provided by the camera
| Property | Value |
|---|---|
| Name | ChunkPixelFormat |
| Interface | IEnumeration |
| Access | |
| Visibility | Expert |
| Enumeration Values |
|---|
| Mono8 |
| Mono12Packed |
| Mono16 |
| RGB8Packed |
| YUV422Packed |
| BayerGR8 |
| BayerRG8 |
| BayerGB8 |
| BayerBG8 |
| YCbCr601_422_8_CbYCrY |
Chunk Exposure Time
Returns the exposure time used to capture the image.
| Property | Value |
|---|---|
| Name | ChunkExposureTime |
| Interface | IFloat |
| Access | RO |
| Unit | us |
| Visibility | Expert |
Chunk Gain Selector
Selects which gain to retrieve
| Property | Value |
|---|---|
| Name | ChunkGainSelector |
| Interface | IEnumeration |
| Access | |
| Visibility | Expert |
| Enumeration Values |
|---|
| All |
| Red |
| Green |
| Blue |
Chunk Gain
Returns the gain used to capture the image.
| Property | Value |
|---|---|
| Name | ChunkGain [Chunk Gain Selector] |
| Interface | IFloat |
| Access | RO |
| Unit | dB |
| Visibility | Expert |
Chunk Black Level Selector
Selects which black level to retrieve
| Property | Value |
|---|---|
| Name | ChunkBlackLevelSelector |
| Interface | IEnumeration |
| Access | |
| Visibility | Expert |
| Enumeration Values |
|---|
| All |
Chunk Black Level
Returns the black level used to capture the image.
| Property | Value |
|---|---|
| Name | ChunkBlackLevel [Chunk Black Level Selector] |
| Interface | IFloat |
| Access | RO |
| Unit | % |
| Visibility | Expert |
Chunk Timestamp
Returns the Timestamp of the image.
| Property | Value |
|---|---|
| Name | ChunkTimestamp |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Sequencer Set Active
Returns the index of the active set of the running sequencer included in the payload.
| Property | Value |
|---|---|
| Name | ChunkSequencerSetActive |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Exposure End Line Status All
Returns the status of all the I/O lines at the end of exposure event.
| Property | Value |
|---|---|
| Name | ChunkExposureEndLineStatusAll |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Compression Mode
Returns the compression mode of the last image payload.
| Property | Value |
|---|---|
| Name | ChunkCompressionMode |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Current Datarate
Returns the current datarate of the last image payload.
| Property | Value |
|---|---|
| Name | ChunkCurrentDatarate |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Compression Ratio
Returns the compression ratio of the last image payload.
| Property | Value |
|---|---|
| Name | ChunkCompressionRatio |
| Interface | IFloat |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Serial Data Length
Returns the length of the received serial data that was included in the payload.
| Property | Value |
|---|---|
| Name | ChunkSerialDataLength |
| Interface | IInteger |
| Access | RO |
| Unit | |
| Visibility | Expert |
Chunk Serial Data
Returns the serial data that was received.
| Property | Value |
|---|---|
| Name | ChunkSerialData |
| Interface | IStringReg |
| Access | |
| Visibility | Expert |
Chunk Serial Receive Overflow
Returns the status of the chunk serial receive overflow.
| Property | Value |
|---|---|
| Name | ChunkSerialReceiveOverflow |
| Interface | IBoolean |
| Access | RO |
| Visibility | Expert |
