 |
IDS peak ICV v1.3.0
|
|
IDS peak ICV v1.3.0
|
Static Public Attributes | |
| static readonly MetadataKeyT< ulong > | DeviceTimestamp = new("DeviceTimestamp") |
| Device-provided image acquisition timestamp in nanoseconds. | |
| static readonly MetadataKeyT< ulong > | DeviceFrameID = new("DeviceFrameID") |
| A sequentially incremented identifier for the frame. | |
| static readonly MetadataKeyT< uint > | BinningHorizontal = new("BinningHorizontal") |
| Horizontal pixel binning factor. | |
| static readonly MetadataKeyT< uint > | BinningVertical = new("BinningVertical") |
| Vertical pixel binning factor. | |
| static readonly MetadataKeyT< RectangleU > | Roi = new("Roi") |
| Region of interest applied to the image. | |
| static readonly MetadataKeyT< double > | DeviceExposureTime = new("DeviceExposureTime") |
| Device exposure time the image was captured with. | |
| static readonly MetadataKeyT< ulong > | SystemTimestamp = new("SystemTimestamp") |
| Timestamp of the system since unix epoch in nanoseconds. | |
| static readonly MetadataKeyT< List< double > > | DeviceExposureTimeSequence = new("DeviceExposureTimeSequence") |
| Device exposure time sequence the image was captured with. | |
| static readonly MetadataKeyT< double > | DeviceGain = new("DeviceGain") |
| Device gain the image was captured with. | |
| static readonly MetadataKeyT< List< double > > | DeviceGainSequence = new("DeviceGainSequence") |
| Device gain sequence the image was captured with. | |
Provides a centralized registry of predefined MetadataKey instances.
This static class acts as a catalog for metadata keys used throughout the library. Each key is uniquely identified by its name and associated with a specific value type. Using these predefined keys ensures consistency across different components of the peak ecosystem.
Definition at line 83 of file Metadata.cs.
|
static |
Horizontal pixel binning factor.
Indicates how many adjacent pixels are combined horizontally.
Definition at line 124 of file Metadata.cs.
|
static |
Vertical pixel binning factor.
Indicates how many adjacent pixels are combined vertically.
Definition at line 135 of file Metadata.cs.
|
static |
Device exposure time the image was captured with.
Specified in microseconds (µs).
Definition at line 159 of file Metadata.cs.
|
static |
Device exposure time sequence the image was captured with.
This feature applies exclusively to HDR pixel formats where multiple exposures are acquired within a single image frame. During unpacking, the individual exposures are separated into distinct images, and the corresponding exposure time for each image is written to DeviceExposureTime
Specified in microseconds (µs).
Definition at line 193 of file Metadata.cs.
|
static |
A sequentially incremented identifier for the frame.
The frame ID is a sequentially incremented value that increases by one from one frame to the next. It serves as a means to detect missing or out-of-order frames in a stream. Once the maximum value supported by the underlying technology is reached, the frame ID wraps back to zero. The exact wrap-around point is not fixed and depends on the implementation.
Definition at line 113 of file Metadata.cs.
|
static |
Device gain the image was captured with.
Definition at line 201 of file Metadata.cs.
|
static |
Device gain sequence the image was captured with.
This feature applies exclusively to HDR pixel formats where multiple gains are used within a single image frame. During unpacking, the individual gains are separated into distinct images, and the corresponding gain for each image is written to DeviceGain
Definition at line 215 of file Metadata.cs.
|
static |
Device-provided image acquisition timestamp in nanoseconds.
The timestamp is expressed in nanoseconds and is relative to an unspecified reference point (t = 0). It does not represent an absolute wall-clock time, but instead the elapsed time since that reference. The difference between timestamps of consecutive images indicates the time interval between their recordings.
Definition at line 98 of file Metadata.cs.
|
static |
Region of interest applied to the image.
Defines the rectangular area of the image that remains after processing steps such as cropping or scaling were applied. Coordinates and dimensions are expressed in pixels.
Definition at line 148 of file Metadata.cs.
|
static |
Timestamp of the system since unix epoch in nanoseconds.
Provides the system timestamp corresponding to the device timestamp, expressed as nanoseconds since the Unix epoch (00:00:00 UTC on January 1, 1970). This allows data to be associated with a system time, for example for logging or correlating with other system events.
The system timestamp is not intended for high-precision timing due to device-side timestamping and host processing delays. For applications requiring high timing accuracy, use the DeviceTimestamp directly.
Definition at line 177 of file Metadata.cs.