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.
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)
	DEVICE_FRAME_ID = _MetadataKeyInfo("DeviceFrameID", int)
	BINNING_HORIZONTAL = _MetadataKeyInfo("BinningHorizontal", int)
	BINNING_VERTICAL = _MetadataKeyInfo("BinningVertical", int)
	ROI = _MetadataKeyInfo("Roi", Rectangle)
	DEVICE_EXPOSURE_TIME = _MetadataKeyInfo("DeviceExposureTime", float)

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'>

Definition at line 14 of file metadata_key.py.

Member Function Documentation

__repr__()

str __repr__

(

self

)

Return an unambiguous string of the MetadataKey object.

Definition at line 111 of file metadata_key.py.

__str__()

str __str__

(

self

)

Return a human-readable string of the MetadataKey object.

Definition at line 104 of file metadata_key.py.

string_value()

str string_value

(

self

)

Return the string_value for this metadata key.

Definition at line 93 of file metadata_key.py.

type()

Type[Any] type

(

self

)

Return the expected Python type for this metadata key.

Definition at line 99 of file metadata_key.py.

Field Documentation

BINNING_HORIZONTAL

BINNING_HORIZONTAL = _MetadataKeyInfo("BinningHorizontal", int)

static

Definition at line 58 of file metadata_key.py.

BINNING_VERTICAL

BINNING_VERTICAL = _MetadataKeyInfo("BinningVertical", int)

static

Definition at line 66 of file metadata_key.py.

DEVICE_EXPOSURE_TIME

DEVICE_EXPOSURE_TIME = _MetadataKeyInfo("DeviceExposureTime", float)

static

Definition at line 84 of file metadata_key.py.

DEVICE_FRAME_ID

DEVICE_FRAME_ID = _MetadataKeyInfo("DeviceFrameID", int)

static

Definition at line 46 of file metadata_key.py.

DEVICE_TIMESTAMP

DEVICE_TIMESTAMP = _MetadataKeyInfo("DeviceTimestamp", int)

static

Definition at line 34 of file metadata_key.py.

ROI

ROI = _MetadataKeyInfo("Roi", Rectangle)

static

Definition at line 74 of file metadata_key.py.