You are here: Technical Reference > Chunk Data Control
FLIR

Firefly®

FFY-U3-16S2C-DL

 

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.

FrameID

OffsetX

OffsetY

Width

Height

Exposure Time

Gain

Black Level

Pixel Format

ImageTimestamp

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.

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.
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 Inference Result IInteger RO Expert Returns the most recent inference classification result.
Chunk Inference Frame ID IInteger RO Expert Returns the frame ID associated with the most recent inference result.
Chunk Inference Bounding Box Result IRegister Expert Returns the bounding boxes of the most recent inference result.
Chunk Inference Confidence IFloat RO Expert Returns the most recent inference confidence result.
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
FrameID
OffsetX
OffsetY
Width
Height
ExposureTime
Gain
BlackLevel
PixelFormat
Timestamp
SerialData
InferenceResult
InferenceConfidence
InferenceFrameId
InferenceBoundingBoxResult

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

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
Mono16
BayerGR8
BayerRG8
BayerGB8
BayerBG8

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

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 Inference Result

Returns the most recent inference classification result.

Property Value
Name ChunkInferenceResult
Interface IInteger
Access RO
Unit
Visibility Expert

Chunk Inference Frame ID

Returns the frame ID associated with the most recent inference result.

Property Value
Name ChunkInferenceFrameId
Interface IInteger
Access RO
Unit
Visibility Expert

Chunk Inference Bounding Box Result

Returns the bounding boxes of the most recent inference result.

Property Value
Name ChunkInferenceBoundingBoxResult
Interface IRegister
Access
Visibility Expert

Chunk Inference Confidence

Returns the most recent inference confidence result.

Property Value
Name ChunkInferenceConfidence
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

 

5/8/2020
© 2015-2020 FLIR® Integrated Imaging Solutions Inc.
All rights reserved.
Legal
| Contact Support

Firefly® FFY-U3-16S2C-DL
Camera Reference