
Topics | |
| Geometry | |
| Types representing geometric concepts such as points, sizes, rectangles, and vectors. | |
| Geometry | |
| Types representing geometric concepts such as points, sizes, rectangles, and vectors. | |
Data Structures | |
| class | Any |
| A type-erased container for any copyable value. More... | |
| class | IImageView |
| Interface for viewing image pixel data from arbitrary sources. More... | |
| class | IntervalT< T > |
| Represents a continuous numeric interval with inclusive lower and upper bounds. More... | |
| class | Metadata |
| Type-safe container for image acquisition metadata. More... | |
| class | PixelFormatInfo |
| Provides information and utility functions for pixel formats. More... | |
| class | RangeT< T > |
| Represents a numeric range with defined boundaries and a fixed increment. More... | |
| class | Version |
| Represents a structured version identifier with four components: major, minor, subminor, and patch. More... | |
Typedefs | |
| 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 | 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... | |
General-purpose types and interfaces used throughout the library.
This module contains a collection of core types that are widely used across different components of the library. These types among others include utility types such as ranges, intervals, type-erased containers (e.g., Any), pixel formats, image view interfaces, and other foundational constructs.
The types in this group are intended to provide reusable, versatile building blocks for applications and other libraries built on top of this component.
| using Interval = detail::IntervalT<int32_t> |
Interval with signed 32-bit integer boundaries.
Provides a stable and public alias for a numerical range using int32_t as the underlying type, suitable for representing ranges that include both negative and positive values.
This alias is intended for general use in user code.
Direct usage of detail::IntervalT<int32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.
Definition at line 230 of file peak_common_interval.hpp.
| using IntervalF = detail::IntervalT<float> |
Interval with floating-point boundaries.
Provides a stable and public alias for a numerical range using float, supporting decimal precision and continuous ranges.
This alias is intended for general use in user code.
Direct usage of detail::IntervalT<float> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.
Definition at line 246 of file peak_common_interval.hpp.
| using IntervalU = detail::IntervalT<uint32_t> |
Interval with unsigned 32-bit integer boundaries.
Provides a stable and public alias for a numerical range where both the minimum and maximum values are represented as uint32_t, suitable for positive-only ranges.
This alias is intended for general use in user code.
Direct usage of detail::IntervalT<uint32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.
Definition at line 214 of file peak_common_interval.hpp.
| using Range = detail::RangeT<int32_t> |
Alias for a range of 32-bit signed integers.
Represents a numerical range with int32_t as the underlying type, allowing for negative and positive values.
This alias is intended for general use in user code.
Direct usage of detail::RangeT<int32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.
Definition at line 187 of file peak_common_range.hpp.
| using RangeF = detail::RangeT<float> |
Alias for a range of 32-bit floating-point numbers.
Represents a numerical range using float, supporting fractional and continuous ranges.
This alias is intended for general use in user code.
Direct usage of detail::RangeT<float> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.
Definition at line 202 of file peak_common_range.hpp.
| using RangeU = detail::RangeT<uint32_t> |
Alias for a range of 32-bit unsigned integers.
Represents a numerical range where both the minimum and maximum values are of type uint32_t.
This alias is intended for general use in user code.
Direct usage of detail::RangeT<uint32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.
Definition at line 172 of file peak_common_range.hpp.
| using RangeU8 = detail::RangeT<uint8_t> |
Alias for a range of 8-bit unsigned integers.
Represents a numerical range where both minimum and maximum values are uint8_t.
This alias is intended for general use in user code.
Direct usage of detail::RangeT<uint8_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.
Definition at line 217 of file peak_common_range.hpp.
|
strong |
Represents the various data channels in image or spatial data formats.
This enumeration defines semantic labels for the different components that can be found in pixel-based or point cloud data representations.
Definition at line 27 of file peak_common_channel.hpp.
|
strong |
Enum listing all supported pixel formats and their internal IDs.
Each enumerator represents a specific pixel layout and bit depth, used for interpreting raw image data correctly.
Definition at line 50 of file peak_common_pixel_format.hpp.