Detailed Description

This is a frame header that is located before each frame. The size of this structure must remain constant. The structure is generated by the camera and should be 16-byte aligned.

Field Documentation

◆ _reserved

uns8 md_frame_header::_reserved[6]

◆ bitDepth

uns8 md_frame_header::bitDepth

1B - Must be 10, 13, 14, 16, etc.

◆ colorMask

uns8 md_frame_header::colorMask

1B - Corresponds to PL_COLOR_MODES.

◆ exposureTime

uns32 md_frame_header::exposureTime

The final exposure time = exposureTime * exposureTimeResNs (nanoseconds). 4B - Depends on resolution.

◆ exposureTimeResNs

uns32 md_frame_header::exposureTimeResNs

4B - 1=1ns, 1000=1us, 5000000=5ms, ...

◆ extendedMdSize

uns16 md_frame_header::extendedMdSize

2B - Must be 0 or actual ext md data size.

◆ flags

uns8 md_frame_header::flags

1B - Frame flags, see PL_MD_FRAME_FLAGS.

◆ frameNr

uns32 md_frame_header::frameNr

4B - 1-based, reset with each acquisition.

◆ imageCompression

uns8 md_frame_header::imageCompression

1B - Image pixel data compression, see PL_IMAGE_COMPRESSIONS

◆ imageFormat

uns8 md_frame_header::imageFormat

Version 2 header additions. The following entries are available only when the md_frame_header.version is reported as 2 or higher. 1B - Image data format, see PL_IMAGE_FORMATS

◆ roiCount

uns16 md_frame_header::roiCount

2B - Number of ROIs in the frame, at least 1.

◆ roiTimestampResNs

uns32 md_frame_header::roiTimestampResNs

ROI timestamp resolution is stored here, no need to transfer with each ROI. 4B - ROI timestamps resolution.

◆ signature

uns32 md_frame_header::signature

4B - Equal to PL_MD_FRAME_SIGNATURE.

◆ timestampBOF

uns32 md_frame_header::timestampBOF

The final timestamp = timestampBOF * timestampResNs (in nanoseconds). 4B - Depends on resolution.

◆ timestampEOF

uns32 md_frame_header::timestampEOF

4B - Depends on resolution.

◆ timestampResNs

uns32 md_frame_header::timestampResNs