32
•
Features and Configuration Options
Calibir 640 GigE IR Camera User's Manual
Metadata
Along with each image, the Calibir camera can output metadata associated to that image. Metadata
is appended to the image data.
The current implementation sets the value of chunkDataType feature to IncreaseImageDataSize to
indicate that the metadata is appended to the image data.
Metadata includes pixel statistics located within a measurement ROI, as well as statistics for the
whole image. By default, the measurement ROI is a 31x31 region with top-left corner located at
(305,225) (in the current implementation, the ROI position cannot be changed).
The metadata contains the following values:
Type
Value
Description
UINT64
reserved1;
Reserved for future use.
UINT32
reserved2;
Reserved for future use.
UINT64
trigTimestamp;
value of the camera’s internal clock (increments every microsecond) at
the moment where an external trigger is received. Only valid when the
camera is configured for external frame triggers.
UINT16
imageWidth;
Width of the image, in pixels.
UINT16
imageHeight;
Height of the image, in pixels.
UINT64
frameTimestamp;
Value of the camera’s internal clock (increments every microsecond) at
the moment where the sensor started outputting an image.
UINT16
roiX;
X-coordinate of the top-left corner of the ROI.
UINT16
roiY;
Y-coordinate of the top-left corner of the ROI.
UINT16
roiW;
ROI width, in pixels.
UINT16
roiH;
ROI height, in pixels.
UINT16
roiStatsMax;
Maximum pixel value in the measurement ROI.
UINT16
roiStatsMin;
Minimum pixel value in the measurement ROI.
UINT16
roiStatsAvg;
Average pixel value in the measurement ROI.
UINT16
imgStatsMax;
Maximum pixel value in the image.
UINT16
imgStatsMin;
Minimum pixel value in the image.
UINT16
imgStatsAvg;
Average pixel value in the image.
The installation MetadataDemo directory contains a modified version of Sapera LT’s
GigeCameraDemo (with executables and source code) that illustrates how to work with the Sapera
LT API to receive and use the Calibir’s metadata. It demonstrates how extra lines are added to the
host buffer to append the metadata and how to extract the metadata values.
Related GigE Vision Features
To enable metadate, the ChunkModeActive feature must be set to ON.
The feature chunkDataType indicates how that data is transferred on the Ethernet link. These
features are part of the Metadata Controls Category category.