MetadataKey Class Reference

Inheritance diagram for MetadataKey:

Public Member Functions
str	string_value (self)
	Return the string_value for this metadata key.
Type[Any]	type (self)
	Return the expected Python type for this metadata key.
Type[Any]	c_type (self)
	Return the expected c type for this metadata key.
MetadataKey	create_from_string_value (cls, str s)
str	__str__ (self)
	Return a human-readable string of the MetadataKey object.
str	__repr__ (self)
	Return an unambiguous string of the MetadataKey object.

Static Public Attributes
	DEVICE_TIMESTAMP = _MetadataKeyInfo("DeviceTimestamp", int, ctypes.c_uint64)
	DEVICE_FRAME_ID = _MetadataKeyInfo("DeviceFrameID", int, ctypes.c_uint64)
	BINNING_HORIZONTAL = _MetadataKeyInfo("BinningHorizontal", int, ctypes.c_uint64)
	BINNING_VERTICAL = _MetadataKeyInfo("BinningVertical", int, ctypes.c_uint64)
	ROI = _MetadataKeyInfo("Roi", Rectangle, ctypes.c_void_p)
	DEVICE_EXPOSURE_TIME = _MetadataKeyInfo("DeviceExposureTime", float, ctypes.c_double)
	SYSTEM_TIMESTAMP = _MetadataKeyInfo("SystemTimestamp", int, ctypes.c_uint64)
	DEVICE_EXPOSURE_TIME_SEQUENCE = _MetadataKeyInfo("DeviceExposureTimeSequence", list[float], list[ctypes.c_double])
	DEVICE_GAIN = _MetadataKeyInfo("DeviceGain", float, ctypes.c_double)
	DEVICE_GAIN_SEQUENCE = _MetadataKeyInfo("DeviceGainSequence", list[float], list[ctypes.c_double])

Detailed Description

Enumerates all compile-time known metadata keys.

Each enum value carries both:

• A string identifier (used internally in Metadata).
• The expected Python type of its value.

This makes it easy to use type-safe keys without an extra trait class.

Example::

key = MetadataKey.DEVICE_TIMESTAMP
print(key.string_value) # outputs: device_timestamp
print(key.type) # outputs: <class 'int'>

Member Function Documentation

__repr__()

str __repr__

(

self

)

Return an unambiguous string of the MetadataKey object.

__str__()

str __str__

(

self

)

Return a human-readable string of the MetadataKey object.

c_type()

Type[Any] c_type

(

self

)

Return the expected c type for this metadata key.

create_from_string_value()

MetadataKey create_from_string_value	(		cls,
		str	s )

string_value()

str string_value

(

self

)

Return the string_value for this metadata key.

type()

Type[Any] type

(

self

)

Return the expected Python type for this metadata key.

Field Documentation

BINNING_HORIZONTAL

BINNING_HORIZONTAL = _MetadataKeyInfo("BinningHorizontal", int, ctypes.c_uint64)

static

BINNING_VERTICAL

BINNING_VERTICAL = _MetadataKeyInfo("BinningVertical", int, ctypes.c_uint64)

static

DEVICE_EXPOSURE_TIME

DEVICE_EXPOSURE_TIME = _MetadataKeyInfo("DeviceExposureTime", float, ctypes.c_double)

static

DEVICE_EXPOSURE_TIME_SEQUENCE

DEVICE_EXPOSURE_TIME_SEQUENCE = _MetadataKeyInfo("DeviceExposureTimeSequence", list[float], list[ctypes.c_double])

static

DEVICE_FRAME_ID

DEVICE_FRAME_ID = _MetadataKeyInfo("DeviceFrameID", int, ctypes.c_uint64)

static

DEVICE_GAIN

DEVICE_GAIN = _MetadataKeyInfo("DeviceGain", float, ctypes.c_double)

static

DEVICE_GAIN_SEQUENCE

DEVICE_GAIN_SEQUENCE = _MetadataKeyInfo("DeviceGainSequence", list[float], list[ctypes.c_double])

static

DEVICE_TIMESTAMP

DEVICE_TIMESTAMP = _MetadataKeyInfo("DeviceTimestamp", int, ctypes.c_uint64)

static

ROI

ROI = _MetadataKeyInfo("Roi", Rectangle, ctypes.c_void_p)

static

SYSTEM_TIMESTAMP

SYSTEM_TIMESTAMP = _MetadataKeyInfo("SystemTimestamp", int, ctypes.c_uint64)

static