 |
IDS peak ICV v1.3.0
|
|
IDS peak ICV v1.3.0
|
Namespaces | |
| namespace | detail |
| Namespace for internal implementation details and low-level types. | |
| namespace | serialization |
| Interfaces for defining serialization and deserialization behavior. | |
Data Structures | |
| class | Any |
| A type-erased container for any copyable value. More... | |
| class | BadAllocException |
| Thrown when memory allocation fails. More... | |
| class | Exception |
| Base class for all exceptions thrown by the library. More... | |
| class | IImageView |
| Interface for viewing image pixel data from arbitrary sources. More... | |
| class | InternalErrorException |
| Thrown when an unexpected internal error occurs. More... | |
| class | InvalidCastException |
| Thrown when a cast to an incompatible type is attempted. More... | |
| class | InvalidParameterException |
| Thrown when a function receives an invalid parameter. More... | |
| class | IOException |
| Thrown when an input, output, file or device communication error occurs. More... | |
| class | LibraryNotInitializedException |
| Thrown when the library is used before proper initialization. More... | |
| class | Metadata |
| Type-safe container for image acquisition metadata. More... | |
| class | NotSupportedException |
| Thrown when an unsupported operation or feature is used. More... | |
| class | OutOfRangeException |
| Thrown when a parameter is outside the valid range. More... | |
| class | PixelFormatInfo |
| Provides information and utility functions for pixel formats. More... | |
| class | TimeoutException |
| Thrown when an operation exceeds its time limit. More... | |
| class | Version |
| Represents a structured version identifier with four components: major, minor, subminor, and patch. More... | |
Typedefs | |
| using | Point = detail::PointT<int32_t> |
| 2D point with 32-bit signed integer coordinates. | |
| using | PointF = detail::PointT<float> |
| 2D point with single-precision floating-point coordinates. | |
| using | PointU = detail::PointT<uint32_t> |
| 2D point with 32-bit unsigned integer coordinates. | |
| using | Rectangle = detail::RectangleT<int32_t, uint32_t> |
| Rectangle with integer coordinates and unsigned dimensions. | |
| using | RectangleF = detail::RectangleT<float, float> |
| Rectangle with floating-point coordinates and dimensions. | |
| using | RectangleU = detail::RectangleT<uint32_t, uint32_t> |
| Rectangle with unsigned coordinates and unsigned dimensions. | |
| using | Size = detail::SizeT<uint32_t> |
| Size with unsigned 32-bit integer dimensions. | |
| using | SizeF = detail::SizeT<float> |
| Size with floating-point dimensions. | |
| using | VectorF = peak::common::PointF |
| Alias for a 2D point with floating point coordinates. | |
| using | IntervalU = detail::IntervalT<uint32_t> |
| Interval with unsigned 32-bit integer boundaries. | |
| using | Interval = detail::IntervalT<int32_t> |
| Interval with signed 32-bit integer boundaries. | |
| using | IntervalF = detail::IntervalT<float> |
| Interval with floating-point boundaries. | |
| using | RangeU = detail::RangeT<uint32_t> |
| Alias for a range of 32-bit unsigned integers. | |
| using | Range = detail::RangeT<int32_t> |
| Alias for a range of 32-bit signed integers. | |
| using | RangeF = detail::RangeT<float> |
| Alias for a range of 32-bit floating-point numbers. | |
| using | RangeU8 = detail::RangeT<uint8_t> |
| Alias for a range of 8-bit unsigned integers. | |
Enumerations | |
| enum class | Channel { Intensity , Red , Green , Blue , Alpha , X , Y , Z , Bayer , ChromaU , ChromaV } |
| Represents the various data channels in image or spatial data formats. More... | |
| enum class | MetadataKey { DeviceTimestamp , DeviceFrameID , BinningHorizontal , BinningVertical , Roi , DeviceExposureTime , SystemTimestamp , DeviceExposureTimeSequence , DeviceGain , DeviceGainSequence } |
| Enumerates all compile-time known metadata keys. More... | |
| enum class | PixelFormat : uint64_t { BayerGR8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8 , BayerGR10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10 , BayerGR12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12 , BayerRG8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8 , BayerRG10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10 , BayerRG12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12 , BayerGB8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8 , BayerGB10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10 , BayerGB12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12 , BayerBG8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8 , BayerBG10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10 , BayerBG12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12 , Mono8 = PEAK_COMMON_PIXEL_FORMAT_MONO_8 , Mono10 = PEAK_COMMON_PIXEL_FORMAT_MONO_10 , Mono12 = PEAK_COMMON_PIXEL_FORMAT_MONO_12 , Mono16 = PEAK_COMMON_PIXEL_FORMAT_MONO_16 , Confidence8 = PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_8 , Confidence16 = PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_16 , Coord3D_C8 = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C8 , Coord3D_C16 = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C16 , Coord3D_C32f = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C32F , Coord3D_ABC32f = PEAK_COMMON_PIXEL_FORMAT_COORD3D_ABC32F , YUV420_8_YY_UV_SemiplanarIDS = PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_UV_SemiplanarIDS , YUV420_8_YY_VU_SemiplanarIDS = PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_VU_SemiplanarIDS , YUV422_8_UYVY = PEAK_COMMON_PIXEL_FORMAT_YUV422_8_UYVY , RGB8 = PEAK_COMMON_PIXEL_FORMAT_RGB_8 , RGB10 = PEAK_COMMON_PIXEL_FORMAT_RGB_10 , RGB12 = PEAK_COMMON_PIXEL_FORMAT_RGB_12 , BGR8 = PEAK_COMMON_PIXEL_FORMAT_BGR_8 , BGR10 = PEAK_COMMON_PIXEL_FORMAT_BGR_10 , BGR12 = PEAK_COMMON_PIXEL_FORMAT_BGR_12 , RGBa8 = PEAK_COMMON_PIXEL_FORMAT_RGBA_8 , RGBa10 = PEAK_COMMON_PIXEL_FORMAT_RGBA_10 , RGBa12 = PEAK_COMMON_PIXEL_FORMAT_RGBA_12 , BGRa8 = PEAK_COMMON_PIXEL_FORMAT_BGRA_8 , BGRa10 = PEAK_COMMON_PIXEL_FORMAT_BGRA_10 , BGRa12 = PEAK_COMMON_PIXEL_FORMAT_BGRA_12 , BayerBG10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED , BayerBG12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED , BayerGB10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED , BayerGB12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED , BayerGR10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED , BayerGR12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED , BayerRG10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED , BayerRG12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED , Mono10p = PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED , Mono12p = PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED , RGB10p32 = PEAK_COMMON_PIXEL_FORMAT_RGB_10_PACKED_32 , BGR10p32 = PEAK_COMMON_PIXEL_FORMAT_BGR_10_PACKED_32 , BayerRG10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS , BayerGB10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS , BayerGR10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS , BayerBG10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS , BayerRG12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS , BayerGB12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS , BayerGR12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS , BayerBG12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS , Mono10g40IDS = PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS , Mono12g24IDS = PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS , Mono32fIDS = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_32F_IDS) , RGB32fIDS = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_RGB_32F_IDS) , Mono10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS_INTERLEAVED_A_B) , BayerRG10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS_INTERLEAVED_A_B) , BayerBG10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS_INTERLEAVED_A_B) , BayerGR10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS_INTERLEAVED_A_B) , BayerGB10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS_INTERLEAVED_A_B) , Mono12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS_INTERLEAVED_A_B) , BayerRG12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS_INTERLEAVED_A_B) , BayerBG12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS_INTERLEAVED_A_B) , BayerGR12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS_INTERLEAVED_A_B) , BayerGB12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS_INTERLEAVED_A_B) , Mono8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_INTERLEAVED_A_B) , BayerRG8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8_INTERLEAVED_A_B) , BayerBG8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8_INTERLEAVED_A_B) , BayerGR8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8_INTERLEAVED_A_B) , BayerGB8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8_INTERLEAVED_A_B) , Mono10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_INTERLEAVED_A_B) , BayerRG10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_INTERLEAVED_A_B) , BayerBG10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_INTERLEAVED_A_B) , BayerGR10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_INTERLEAVED_A_B) , BayerGB10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_INTERLEAVED_A_B) , Mono12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_INTERLEAVED_A_B) , BayerRG12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_INTERLEAVED_A_B) , BayerBG12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_INTERLEAVED_A_B) , BayerGR12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_INTERLEAVED_A_B) , BayerGB12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_INTERLEAVED_A_B) , Mono10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED_INTERLEAVED_A_B) , BayerRG10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED_INTERLEAVED_A_B) , BayerBG10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED_INTERLEAVED_A_B) , BayerGR10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED_INTERLEAVED_A_B) , BayerGB10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED_INTERLEAVED_A_B) , Mono12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED_INTERLEAVED_A_B) , BayerRG12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED_INTERLEAVED_A_B) , BayerBG12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED_INTERLEAVED_A_B) , BayerGR12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED_INTERLEAVED_A_B) , BayerGB12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED_INTERLEAVED_A_B) , Mono8_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_INTERLEAVED_AB_CD) , Mono10_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_INTERLEAVED_AB_CD) , Mono12_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_INTERLEAVED_AB_CD) , Mono10p_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED_INTERLEAVED_AB_CD) , Mono12p_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED_INTERLEAVED_AB_CD) , Mono10g40IDS_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS_INTERLEAVED_AB_CD) , Mono12g24IDS_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS_INTERLEAVED_AB_CD) , Mono10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_AB) , BayerRG10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_AB) , BayerBG10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_AB) , BayerGR10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_AB) , BayerGB10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_AB) , Mono12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_AB) , BayerRG12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_AB) , BayerBG12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_AB) , BayerGR12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_AB) , BayerGB12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_AB) , Mono8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_AB) , BayerRG8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8_AB) , BayerBG8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8_AB) , BayerGR8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8_AB) , BayerGB8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8_AB) , Mono8_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_ABCD) , Mono10_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_ABCD) , Mono12_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_ABCD) } |
| Enum listing all supported pixel formats and their internal IDs. More... | |
Functions | |
| std::ostream & | operator<< (std::ostream &os, PixelFormat pixelFormat) |
Root namespace for common types and interfaces shared across multiple libraries.
The peak::common namespace contains all publicly available types, constants, enumerations, and interfaces that form the foundation for other libraries and modules.
This namespace is part of the Common Types and Interfaces module and is intended to provide stable, reusable components for general use.
It includes:
All components within this namespace are suitable for use in production code and are maintained with a stable API guarantee.
|
strong |
Enumerates all compile-time known metadata keys.
| Enumerator | |
|---|---|
| DeviceTimestamp | 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.
|
| DeviceFrameID | 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.
|
| BinningHorizontal | Horizontal pixel binning factor. Indicates how many adjacent pixels are combined horizontally.
|
| BinningVertical | Vertical pixel binning factor. Indicates how many adjacent pixels are combined vertically.
|
| Roi | 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.
|
| DeviceExposureTime | Device exposure time the image was captured with. Specified in microseconds (µs).
|
| SystemTimestamp | 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.
|
| DeviceExposureTimeSequence | 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).
|
| DeviceGain | Device gain the image was captured with.
|
| DeviceGainSequence | Device gain sequence the image was captured with. This feature applies exclusively to HDR pixel formats where multiple gains are acquired 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 30 of file peak_common_metadata_key.hpp.
|
inline |
Definition at line 19 of file peak_common_pixel_format.ipp.