md_frame_header_v3 Struct Reference

Data Fields
uns32	signature
uns8	version
uns32	frameNr
uns16	roiCount
ulong64	timestampBOF
ulong64	timestampEOF
ulong64	exposureTime
uns8	bitDepth
uns8	colorMask
uns8	flags
uns16	extendedMdSize
uns8	imageFormat
uns8	imageCompression
uns8	_reserved [6]

Detailed Description

Version 3 of the frame header with improved timestamp and exposure time accuracy. When the md_frame_header.version is reported as 3, users are expected to use reinterpret_cast to cast the md_frame.header pointer to md_frame_header_v3 type.

Field Documentation

_reserved

uns8 md_frame_header_v3::_reserved[6]

bitDepth

uns8 md_frame_header_v3::bitDepth

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

colorMask

uns8 md_frame_header_v3::colorMask

1B - Corresponds to PL_COLOR_MODES.

exposureTime

ulong64 md_frame_header_v3::exposureTime

8B - Exposure time, in picoseconds.

extendedMdSize

uns16 md_frame_header_v3::extendedMdSize

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

flags

uns8 md_frame_header_v3::flags

1B - Frame flags, see PL_MD_FRAME_FLAGS.

frameNr

uns32 md_frame_header_v3::frameNr

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

imageCompression

uns8 md_frame_header_v3::imageCompression

1B - Image pixel data compression, see PL_IMAGE_COMPRESSIONS

imageFormat

uns8 md_frame_header_v3::imageFormat

1B - Image data format, see PL_IMAGE_FORMATS

roiCount

uns16 md_frame_header_v3::roiCount

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

signature

uns32 md_frame_header_v3::signature

4B - Equal to PL_MD_FRAME_SIGNATURE.

timestampBOF

ulong64 md_frame_header_v3::timestampBOF

8B - Beginning of frame timestamp, in picoseconds.

timestampEOF

ulong64 md_frame_header_v3::timestampEOF

8B - End of frame timestamp, in picoseconds.

version

uns8 md_frame_header_v3::version

1B - Header version.