Types

General-purpose types and interfaces used throughout the library. More...

Topics
	Geometry
	Types representing geometric concepts such as points, sizes, rectangles, and vectors.

Classes
class	peak::common::Any
	A type-erased container for any copyable value. More...
class	peak::common::IImageView
	Interface for viewing image pixel data from arbitrary sources. More...
class	peak::common::detail::IntervalT< T >
	Represents a continuous numeric interval with inclusive lower and upper bounds. More...
class	peak::common::Metadata
	Type-safe container for image acquisition metadata. More...
class	peak::common::PixelFormatInfo
	Provides information and utility functions for pixel formats. More...
class	peak::common::detail::RangeT< T >
	Represents a numeric range with defined boundaries and a fixed increment. More...
class	peak::common::Version
	Represents a structured version identifier with four components: major, minor, subminor, and patch. More...

Typedefs
using	peak::common::IntervalU = detail::IntervalT<uint32_t>
	Interval with unsigned 32-bit integer boundaries.
using	peak::common::Interval = detail::IntervalT<int32_t>
	Interval with signed 32-bit integer boundaries.
using	peak::common::IntervalF = detail::IntervalT<float>
	Interval with floating-point boundaries.
using	peak::common::RangeU = detail::RangeT<uint32_t>
	Alias for a range of 32-bit unsigned integers.
using	peak::common::Range = detail::RangeT<int32_t>
	Alias for a range of 32-bit signed integers.
using	peak::common::RangeF = detail::RangeT<float>
	Alias for a range of 32-bit floating-point numbers.
using	peak::common::RangeU8 = detail::RangeT<uint8_t>
	Alias for a range of 8-bit unsigned integers.

Enumerations
enum class	peak::common::Channel {   peak::common::Channel::Intensity ,   peak::common::Channel::Red ,   peak::common::Channel::Green ,   peak::common::Channel::Blue ,   peak::common::Channel::Alpha ,   peak::common::Channel::X ,   peak::common::Channel::Y ,   peak::common::Channel::Z ,   peak::common::Channel::Bayer ,   peak::common::Channel::ChromaU ,   peak::common::Channel::ChromaV }
	Represents the various data channels in image or spatial data formats. More...
enum class	peak::common::PixelFormat : uint64_t {   peak::common::PixelFormat::BayerGR8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8 ,   peak::common::PixelFormat::BayerGR10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10 ,   peak::common::PixelFormat::BayerGR12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12 ,   peak::common::PixelFormat::BayerRG8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8 ,   peak::common::PixelFormat::BayerRG10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10 ,   peak::common::PixelFormat::BayerRG12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12 ,   peak::common::PixelFormat::BayerGB8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8 ,   peak::common::PixelFormat::BayerGB10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10 ,   peak::common::PixelFormat::BayerGB12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12 ,   peak::common::PixelFormat::BayerBG8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8 ,   peak::common::PixelFormat::BayerBG10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10 ,   peak::common::PixelFormat::BayerBG12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12 ,   peak::common::PixelFormat::Mono8 = PEAK_COMMON_PIXEL_FORMAT_MONO_8 ,   peak::common::PixelFormat::Mono10 = PEAK_COMMON_PIXEL_FORMAT_MONO_10 ,   peak::common::PixelFormat::Mono12 = PEAK_COMMON_PIXEL_FORMAT_MONO_12 ,   peak::common::PixelFormat::Mono16 = PEAK_COMMON_PIXEL_FORMAT_MONO_16 ,   peak::common::PixelFormat::Confidence8 = PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_8 ,   peak::common::PixelFormat::Confidence16 = PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_16 ,   peak::common::PixelFormat::Coord3D_C8 = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C8 ,   peak::common::PixelFormat::Coord3D_C16 = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C16 ,   peak::common::PixelFormat::Coord3D_C32f = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C32F ,   peak::common::PixelFormat::Coord3D_ABC32f = PEAK_COMMON_PIXEL_FORMAT_COORD3D_ABC32F ,   peak::common::PixelFormat::YUV420_8_YY_UV_SemiplanarIDS = PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_UV_SemiplanarIDS ,   peak::common::PixelFormat::YUV420_8_YY_VU_SemiplanarIDS = PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_VU_SemiplanarIDS ,   peak::common::PixelFormat::YUV422_8_UYVY = PEAK_COMMON_PIXEL_FORMAT_YUV422_8_UYVY ,   peak::common::PixelFormat::RGB8 = PEAK_COMMON_PIXEL_FORMAT_RGB_8 ,   peak::common::PixelFormat::RGB10 = PEAK_COMMON_PIXEL_FORMAT_RGB_10 ,   peak::common::PixelFormat::RGB12 = PEAK_COMMON_PIXEL_FORMAT_RGB_12 ,   peak::common::PixelFormat::BGR8 = PEAK_COMMON_PIXEL_FORMAT_BGR_8 ,   peak::common::PixelFormat::BGR10 = PEAK_COMMON_PIXEL_FORMAT_BGR_10 ,   peak::common::PixelFormat::BGR12 = PEAK_COMMON_PIXEL_FORMAT_BGR_12 ,   peak::common::PixelFormat::RGBa8 = PEAK_COMMON_PIXEL_FORMAT_RGBA_8 ,   peak::common::PixelFormat::RGBa10 = PEAK_COMMON_PIXEL_FORMAT_RGBA_10 ,   peak::common::PixelFormat::RGBa12 = PEAK_COMMON_PIXEL_FORMAT_RGBA_12 ,   peak::common::PixelFormat::BGRa8 = PEAK_COMMON_PIXEL_FORMAT_BGRA_8 ,   peak::common::PixelFormat::BGRa10 = PEAK_COMMON_PIXEL_FORMAT_BGRA_10 ,   peak::common::PixelFormat::BGRa12 = PEAK_COMMON_PIXEL_FORMAT_BGRA_12 ,   peak::common::PixelFormat::BayerBG10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED ,   peak::common::PixelFormat::BayerBG12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED ,   peak::common::PixelFormat::BayerGB10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED ,   peak::common::PixelFormat::BayerGB12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED ,   peak::common::PixelFormat::BayerGR10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED ,   peak::common::PixelFormat::BayerGR12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED ,   peak::common::PixelFormat::BayerRG10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED ,   peak::common::PixelFormat::BayerRG12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED ,   peak::common::PixelFormat::Mono10p = PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED ,   peak::common::PixelFormat::Mono12p = PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED ,   peak::common::PixelFormat::RGB10p32 = PEAK_COMMON_PIXEL_FORMAT_RGB_10_PACKED_32 ,   peak::common::PixelFormat::BGR10p32 = PEAK_COMMON_PIXEL_FORMAT_BGR_10_PACKED_32 ,   peak::common::PixelFormat::BayerRG10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS ,   peak::common::PixelFormat::BayerGB10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS ,   peak::common::PixelFormat::BayerGR10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS ,   peak::common::PixelFormat::BayerBG10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS ,   peak::common::PixelFormat::BayerRG12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS ,   peak::common::PixelFormat::BayerGB12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS ,   peak::common::PixelFormat::BayerGR12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS ,   peak::common::PixelFormat::BayerBG12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS ,   peak::common::PixelFormat::Mono10g40IDS = PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS ,   peak::common::PixelFormat::Mono12g24IDS = PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS ,   peak::common::PixelFormat::Mono32fIDS = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_32F_IDS) ,   peak::common::PixelFormat::RGB32fIDS = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_RGB_32F_IDS) ,   peak::common::PixelFormat::Mono10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerRG12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerBG12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGR12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::BayerGB12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED_INTERLEAVED_A_B) ,   peak::common::PixelFormat::Mono8_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono10_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono12_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono10p_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono12p_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono10g40IDS_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono12g24IDS_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS_INTERLEAVED_AB_CD) ,   peak::common::PixelFormat::Mono10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_AB) ,   peak::common::PixelFormat::BayerRG10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_AB) ,   peak::common::PixelFormat::BayerBG10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_AB) ,   peak::common::PixelFormat::BayerGR10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_AB) ,   peak::common::PixelFormat::BayerGB10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_AB) ,   peak::common::PixelFormat::Mono12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_AB) ,   peak::common::PixelFormat::BayerRG12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_AB) ,   peak::common::PixelFormat::BayerBG12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_AB) ,   peak::common::PixelFormat::BayerGR12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_AB) ,   peak::common::PixelFormat::BayerGB12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_AB) ,   peak::common::PixelFormat::Mono8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_AB) ,   peak::common::PixelFormat::BayerRG8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8_AB) ,   peak::common::PixelFormat::BayerBG8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8_AB) ,   peak::common::PixelFormat::BayerGR8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8_AB) ,   peak::common::PixelFormat::BayerGB8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8_AB) ,   peak::common::PixelFormat::Mono8_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_ABCD) ,   peak::common::PixelFormat::Mono10_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_ABCD) ,   peak::common::PixelFormat::Mono12_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_ABCD) }
	Enum listing all supported pixel formats and their internal IDs. More...

Detailed Description

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.

Since

ids_peak_common 1.0

Typedef Documentation

Interval

using peak::common::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.

Since

ids_peak_common 1.0

IntervalF

using peak::common::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.

Since

ids_peak_common 1.0

IntervalU

using peak::common::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.

Since

ids_peak_common 1.0

Range

using peak::common::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.

Since

ids_peak_common 1.0

RangeF

using peak::common::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.

Since

ids_peak_common 1.0

RangeU

using peak::common::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.

Since

ids_peak_common 1.0

RangeU8

using peak::common::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.

Since

ids_peak_common 1.0

Enumeration Type Documentation

Channel

enum class peak::common::Channel

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.

Since

ids_peak_common 1.0

Enumerator
Intensity	Luminance or grayscale intensity channel. Common in single-channel images.
Red	Red color channel. May appear in various layouts (e.g., RGB, ARGB).
Green	Green color channel. Commonly part of multichannel color formats.
Blue	Blue color channel. Present in formats like BGR, RGBA, etc.
Alpha	Alpha (opacity or transparency) channel. Often used for blending and masking.
X	Represents the X coordinate channel (e.g., in point clouds).
Y	Represents the Y coordinate channel (e.g., in point clouds).
Z	Represents the Z coordinate channel (e.g., in point clouds).
Bayer	Raw Bayer pattern data from image sensors (e.g., BGGR, RGGB).
ChromaU	Chrominance U channel (Cb). Represents the blue-difference chroma component in YUV/YCbCr color spaces.
ChromaV	Chrominance V channel (Cr). Represents the red-difference chroma component in YUV/YCbCr color spaces.

PixelFormat

enum class peak::common::PixelFormat : uint64_t

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.

Since

ids_peak_common 1.0

Enumerator
BayerGR8	BayerGR 8-Bit pixel format.
BayerGR10	BayerGR 10-Bit pixel format.
BayerGR12	BayerGR 12-Bit pixel format.
BayerRG8	BayerRG 8-Bit pixel format.
BayerRG10	BayerRG 10-Bit pixel format.
BayerRG12	BayerRG 12-Bit pixel format.
BayerGB8	BayerGB 8-Bit pixel format.
BayerGB10	BayerGB 10-Bit pixel format.
BayerGB12	BayerGB 12-Bit pixel format.
BayerBG8	BayerBG 8-Bit pixel format.
BayerBG10	BayerBG 10-Bit pixel format.
BayerBG12	BayerBG 12-Bit pixel format.
Mono8	Mono 8-Bit pixel format.
Mono10	Mono 10-Bit pixel format.
Mono12	Mono 12-Bit pixel format.
Mono16	Mono 16-Bit pixel format.
Confidence8	Confidence 8-Bit format.
Confidence16	Confidence 16-Bit format.
Coord3D_C8	3D coordinate C 8-Bit format
Coord3D_C16	3D coordinate C 16-Bit format
Coord3D_C32f	3D coordinate C 32-Bit float format
Coord3D_ABC32f	3D coordinates A, B, C 32-Bit float format
YUV420_8_YY_UV_SemiplanarIDS	YUV4:2:0 8-Bit YY/UV semiplanar (IDS)
YUV420_8_YY_VU_SemiplanarIDS	YUV4:2:0 8-Bit YY/VU semiplanar (IDS)
YUV422_8_UYVY	UYVY 4:2:2 8-Bit format.
RGB8	RGB 8-Bit pixel format.
RGB10	RGB 10-Bit pixel format.
RGB12	RGB 12-Bit pixel format.
BGR8	BGR 8-Bit pixel format.
BGR10	BGR 10-Bit pixel format.
BGR12	BGR 12-Bit pixel format.
RGBa8	RGBA 8-Bit pixel format.
RGBa10	RGBA 10-Bit pixel format.
RGBa12	RGBA 12-Bit pixel format.
BGRa8	BGRA 8-Bit pixel format.
BGRa10	BGRA 10-Bit pixel format.
BGRa12	BGRA 12-Bit pixel format.
BayerBG10p	BayerBG 10-Bit packed format.
BayerBG12p	BayerBG 12-Bit packed format.
BayerGB10p	BayerGB 10-Bit packed format.
BayerGB12p	BayerGB 12-Bit packed format.
BayerGR10p	BayerGR 10-Bit packed format.
BayerGR12p	BayerGR 12-Bit packed format.
BayerRG10p	BayerRG 10-Bit packed format.
BayerRG12p	BayerRG 12-Bit packed format.
Mono10p	Mono 10-Bit packed format.
Mono12p	Mono 12-Bit packed format.
RGB10p32	RGB 10-Bit packed 32-bit format.
BGR10p32	BGR 10-Bit packed 32-bit format.
BayerRG10g40IDS	BayerRG 10-Bit grouped 40-bit (IDS)
BayerGB10g40IDS	BayerGB 10-Bit grouped 40-bit (IDS)
BayerGR10g40IDS	BayerGR 10-Bit grouped 40-bit (IDS)
BayerBG10g40IDS	BayerBG 10-Bit grouped 40-bit (IDS)
BayerRG12g24IDS	BayerRG 12-Bit grouped 24-bit (IDS)
BayerGB12g24IDS	BayerGB 12-Bit grouped 24-bit (IDS)
BayerGR12g24IDS	BayerGR 12-Bit grouped 24-bit (IDS)
BayerBG12g24IDS	BayerBG 12-Bit grouped 24-bit (IDS)
Mono10g40IDS	Mono 10-Bit grouped 40-bit (IDS)
Mono12g24IDS	Mono 12-Bit grouped 24-bit (IDS)
Mono32fIDS	Mono 32-Bit float format (IDS)
RGB32fIDS	RGB 32-Bit float format (IDS)
Mono10g40IDS_I_A_B	Mono 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
BayerRG10g40IDS_I_A_B	BayerRG 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
BayerBG10g40IDS_I_A_B	BayerBG 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
BayerGR10g40IDS_I_A_B	BayerGR 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
BayerGB10g40IDS_I_A_B	BayerGB 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
Mono12g24IDS_I_A_B	Mono 12-Bit grouped 24-bit (IDS) line Interleaved Components A, B.
BayerRG12g24IDS_I_A_B	BayerRG 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
BayerBG12g24IDS_I_A_B	BayerBG 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
BayerGR12g24IDS_I_A_B	BayerGR 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
BayerGB12g24IDS_I_A_B	BayerGB 10-Bit grouped 40-bit (IDS) line Interleaved Components A, B.
Mono8_I_A_B	Mono 8-Bit pixel format line Interleaved Components A, B.
BayerRG8_I_A_B	BayerRG 8-Bit pixel format line Interleaved Components A, B.
BayerBG8_I_A_B	BayerBG 8-Bit pixel format line Interleaved Components A, B.
BayerGR8_I_A_B	BayerGR 8-Bit pixel format line Interleaved Components A, B.
BayerGB8_I_A_B	BayerGB 8-Bit pixel format line Interleaved Components A, B.
Mono10_I_A_B	Mono 10-Bit pixel format line Interleaved Components A, B.
BayerRG10_I_A_B	BayerRG 10-Bit pixel format line Interleaved Components A, B.
BayerBG10_I_A_B	BayerBG 10-Bit pixel format line Interleaved Components A, B.
BayerGR10_I_A_B	BayerGR 10-Bit pixel format line Interleaved Components A, B.
BayerGB10_I_A_B	BayerGB 10-Bit pixel format line Interleaved Components A, B.
Mono12_I_A_B	Mono 12-Bit pixel format line Interleaved Components A, B.
BayerRG12_I_A_B	BayerRG 12-Bit pixel format line Interleaved Components A, B.
BayerBG12_I_A_B	BayerBG 12-Bit pixel format line Interleaved Components A, B.
BayerGR12_I_A_B	BayerGR 12-Bit pixel format line Interleaved Components A, B.
BayerGB12_I_A_B	BayerGB 12-Bit pixel format line Interleaved Components A, B.
Mono10p_I_A_B	Mono 10-Bit packed format line Interleaved Components A, B.
BayerRG10p_I_A_B	BayerRG 10-Bit packed format line Interleaved Components A, B.
BayerBG10p_I_A_B	BayerBG 10-Bit packed format line Interleaved Components A, B.
BayerGR10p_I_A_B	BayerGR 10-Bit packed format line Interleaved Components A, B.
BayerGB10p_I_A_B	BayerGB 10-Bit packed format line Interleaved Components A, B.
Mono12p_I_A_B	Mono 12-Bit packed format line Interleaved Components A, B.
BayerRG12p_I_A_B	BayerRG 12-Bit packed format line Interleaved Components A, B.
BayerBG12p_I_A_B	BayerBG 12-Bit packed format line Interleaved Components A, B.
BayerGR12p_I_A_B	BayerGR 12-Bit packed format line Interleaved Components A, B.
BayerGB12p_I_A_B	BayerGB 12-Bit packed format line Interleaved Components A, B.
Mono8_I_AB_CD	Mono 8-Bit pixel format pixel Interleaved Components A, B, C, D.
Mono10_I_AB_CD	Mono 10-Bit pixel format pixel Interleaved Components A, B, C, D.
Mono12_I_AB_CD	Mono 12-Bit pixel format pixel Interleaved Components A, B, C, D.
Mono10p_I_AB_CD	Mono 10-Bit packed format pixel Interleaved Components A, B, C, D.
Mono12p_I_AB_CD	Mono 12-Bit packed format pixel Interleaved Components A, B, C, D.
Mono10g40IDS_I_AB_CD	Mono 10-Bit grouped 40-bit (IDS) pixel Interleaved Components A, B, C, D.
Mono12g24IDS_I_AB_CD	Mono 12-Bit grouped 24-bit (IDS) pixel Interleaved Components A, B, C, D.
Mono10_AB	Mono 10-Bit pixel format Components A, B.
BayerRG10_AB	BayerRG 10-Bit pixel format Components A, B.
BayerBG10_AB	BayerBG 10-Bit pixel format Components A, B.
BayerGR10_AB	BayerGR 10-Bit pixel format Components A, B.
BayerGB10_AB	BayerGB 10-Bit pixel format Components A, B.
Mono12_AB	Mono 12-Bit pixel format Components A, B.
BayerRG12_AB	BayerRG 12-Bit pixel format Components A, B.
BayerBG12_AB	BayerBG 12-Bit pixel format Components A, B.
BayerGR12_AB	BayerGR 12-Bit pixel format Components A, B.
BayerGB12_AB	BayerGB 12-Bit pixel format Components A, B.
Mono8_AB	Mono 8-Bit pixel format Components A, B.
BayerRG8_AB	BayerRG 8-Bit pixel format Components A, B.
BayerBG8_AB	BayerBG 8-Bit pixel format Components A, B.
BayerGR8_AB	BayerGR 8-Bit pixel format Components A, B.
BayerGB8_AB	BayerGB 8-Bit pixel format Components A, B.
Mono8_ABCD	Mono 8-Bit pixel format Components A, B, C, D.
Mono10_ABCD	Mono 10-Bit pixel format Components A, B, C, D.
Mono12_ABCD	Mono 12-Bit pixel format Components A, B, C, D.