IDS peak IPL v1.18.0
Loading...
Searching...
No Matches
peak::common::detail Namespace Reference
IDS peak common » C++ » Internal Detail Types

Namespace for internal implementation details and low-level types. More...

Classes

class  IntervalT
 Represents a continuous numeric interval with inclusive lower and upper bounds. More...
struct  MetadataAccessor
struct  MetadataKeyTraits< MetadataKey::BinningHorizontal >
struct  MetadataKeyTraits< MetadataKey::BinningVertical >
struct  MetadataKeyTraits< MetadataKey::DeviceExposureTime >
struct  MetadataKeyTraits< MetadataKey::DeviceExposureTimeSequence >
struct  MetadataKeyTraits< MetadataKey::DeviceFrameID >
struct  MetadataKeyTraits< MetadataKey::DeviceGain >
struct  MetadataKeyTraits< MetadataKey::DeviceGainSequence >
struct  MetadataKeyTraits< MetadataKey::DeviceTimestamp >
struct  MetadataKeyTraits< MetadataKey::Roi >
struct  MetadataKeyTraits< MetadataKey::SystemTimestamp >
struct  PixelFormatTraits< PixelFormat::BayerBG10 >
struct  PixelFormatTraits< PixelFormat::BayerBG10_AB >
struct  PixelFormatTraits< PixelFormat::BayerBG10_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerBG10g40IDS >
struct  PixelFormatTraits< PixelFormat::BayerBG10g40IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerBG10p >
struct  PixelFormatTraits< PixelFormat::BayerBG10p_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerBG12 >
struct  PixelFormatTraits< PixelFormat::BayerBG12_AB >
struct  PixelFormatTraits< PixelFormat::BayerBG12_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerBG12g24IDS >
struct  PixelFormatTraits< PixelFormat::BayerBG12g24IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerBG12p >
struct  PixelFormatTraits< PixelFormat::BayerBG12p_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerBG8 >
struct  PixelFormatTraits< PixelFormat::BayerBG8_AB >
struct  PixelFormatTraits< PixelFormat::BayerBG8_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGB10 >
struct  PixelFormatTraits< PixelFormat::BayerGB10_AB >
struct  PixelFormatTraits< PixelFormat::BayerGB10_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGB10g40IDS >
struct  PixelFormatTraits< PixelFormat::BayerGB10g40IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGB10p >
struct  PixelFormatTraits< PixelFormat::BayerGB10p_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGB12 >
struct  PixelFormatTraits< PixelFormat::BayerGB12_AB >
struct  PixelFormatTraits< PixelFormat::BayerGB12_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGB12g24IDS >
struct  PixelFormatTraits< PixelFormat::BayerGB12g24IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGB12p >
struct  PixelFormatTraits< PixelFormat::BayerGB12p_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGB8 >
struct  PixelFormatTraits< PixelFormat::BayerGB8_AB >
struct  PixelFormatTraits< PixelFormat::BayerGB8_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGR10 >
struct  PixelFormatTraits< PixelFormat::BayerGR10_AB >
struct  PixelFormatTraits< PixelFormat::BayerGR10_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGR10g40IDS >
struct  PixelFormatTraits< PixelFormat::BayerGR10g40IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGR10p >
struct  PixelFormatTraits< PixelFormat::BayerGR10p_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGR12 >
struct  PixelFormatTraits< PixelFormat::BayerGR12_AB >
struct  PixelFormatTraits< PixelFormat::BayerGR12_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGR12g24IDS >
struct  PixelFormatTraits< PixelFormat::BayerGR12g24IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGR12p >
struct  PixelFormatTraits< PixelFormat::BayerGR12p_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerGR8 >
struct  PixelFormatTraits< PixelFormat::BayerGR8_AB >
struct  PixelFormatTraits< PixelFormat::BayerGR8_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerRG10 >
struct  PixelFormatTraits< PixelFormat::BayerRG10_AB >
struct  PixelFormatTraits< PixelFormat::BayerRG10_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerRG10g40IDS >
struct  PixelFormatTraits< PixelFormat::BayerRG10g40IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerRG10p >
struct  PixelFormatTraits< PixelFormat::BayerRG10p_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerRG12 >
struct  PixelFormatTraits< PixelFormat::BayerRG12_AB >
struct  PixelFormatTraits< PixelFormat::BayerRG12_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerRG12g24IDS >
struct  PixelFormatTraits< PixelFormat::BayerRG12g24IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerRG12p >
struct  PixelFormatTraits< PixelFormat::BayerRG12p_I_A_B >
struct  PixelFormatTraits< PixelFormat::BayerRG8 >
struct  PixelFormatTraits< PixelFormat::BayerRG8_AB >
struct  PixelFormatTraits< PixelFormat::BayerRG8_I_A_B >
struct  PixelFormatTraits< PixelFormat::BGR10 >
struct  PixelFormatTraits< PixelFormat::BGR10p32 >
struct  PixelFormatTraits< PixelFormat::BGR12 >
struct  PixelFormatTraits< PixelFormat::BGR8 >
struct  PixelFormatTraits< PixelFormat::BGRa10 >
struct  PixelFormatTraits< PixelFormat::BGRa12 >
struct  PixelFormatTraits< PixelFormat::BGRa8 >
struct  PixelFormatTraits< PixelFormat::Confidence16 >
struct  PixelFormatTraits< PixelFormat::Confidence8 >
struct  PixelFormatTraits< PixelFormat::Coord3D_ABC32f >
struct  PixelFormatTraits< PixelFormat::Coord3D_C16 >
struct  PixelFormatTraits< PixelFormat::Coord3D_C32f >
struct  PixelFormatTraits< PixelFormat::Coord3D_C8 >
struct  PixelFormatTraits< PixelFormat::Mono10 >
struct  PixelFormatTraits< PixelFormat::Mono10_AB >
struct  PixelFormatTraits< PixelFormat::Mono10_ABCD >
struct  PixelFormatTraits< PixelFormat::Mono10_I_A_B >
struct  PixelFormatTraits< PixelFormat::Mono10_I_AB_CD >
struct  PixelFormatTraits< PixelFormat::Mono10g40IDS >
struct  PixelFormatTraits< PixelFormat::Mono10g40IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::Mono10g40IDS_I_AB_CD >
struct  PixelFormatTraits< PixelFormat::Mono10p >
struct  PixelFormatTraits< PixelFormat::Mono10p_I_A_B >
struct  PixelFormatTraits< PixelFormat::Mono10p_I_AB_CD >
struct  PixelFormatTraits< PixelFormat::Mono12 >
struct  PixelFormatTraits< PixelFormat::Mono12_AB >
struct  PixelFormatTraits< PixelFormat::Mono12_ABCD >
struct  PixelFormatTraits< PixelFormat::Mono12_I_A_B >
struct  PixelFormatTraits< PixelFormat::Mono12_I_AB_CD >
struct  PixelFormatTraits< PixelFormat::Mono12g24IDS >
struct  PixelFormatTraits< PixelFormat::Mono12g24IDS_I_A_B >
struct  PixelFormatTraits< PixelFormat::Mono12g24IDS_I_AB_CD >
struct  PixelFormatTraits< PixelFormat::Mono12p >
struct  PixelFormatTraits< PixelFormat::Mono12p_I_A_B >
struct  PixelFormatTraits< PixelFormat::Mono12p_I_AB_CD >
struct  PixelFormatTraits< PixelFormat::Mono16 >
struct  PixelFormatTraits< PixelFormat::Mono32f >
struct  PixelFormatTraits< PixelFormat::Mono32fIDS >
struct  PixelFormatTraits< PixelFormat::Mono8 >
struct  PixelFormatTraits< PixelFormat::Mono8_AB >
struct  PixelFormatTraits< PixelFormat::Mono8_ABCD >
struct  PixelFormatTraits< PixelFormat::Mono8_I_A_B >
struct  PixelFormatTraits< PixelFormat::Mono8_I_AB_CD >
struct  PixelFormatTraits< PixelFormat::RGB10 >
struct  PixelFormatTraits< PixelFormat::RGB10p32 >
struct  PixelFormatTraits< PixelFormat::RGB12 >
struct  PixelFormatTraits< PixelFormat::RGB32f >
struct  PixelFormatTraits< PixelFormat::RGB32fIDS >
struct  PixelFormatTraits< PixelFormat::RGB8 >
struct  PixelFormatTraits< PixelFormat::RGBa10 >
struct  PixelFormatTraits< PixelFormat::RGBa12 >
struct  PixelFormatTraits< PixelFormat::RGBa8 >
struct  PixelFormatTraits< PixelFormat::YUV420_8_YY_UV_SemiplanarIDS >
struct  PixelFormatTraits< PixelFormat::YUV420_8_YY_VU_SemiplanarIDS >
struct  PixelFormatTraits< PixelFormat::YUV422_8_UYVY >
class  PointT
 2D point template type. More...
class  PointXd
 A point in space with configurable dimensionality and coordinate type. More...
class  RangeT
 Represents a numeric range with defined boundaries and a fixed increment. More...
class  RectangleT
 A generic rectangle defined by a point and a size. More...
class  SizeT
 Represents a two-dimensional size with non-negative width and height. More...

Functions

template<typename H>
constexpr bool AreAlmostEqual (H lhs, H rhs, uint32_t ulp)
 Compares two floating-point values for approximate equality using a ULP-based tolerance.
template<typename T>
constexpr T Clamp (T value, T minimum, T maximum)
PEAK_COMMON_NO_DISCARD Channel ToChannel (const std::string &channel)
constexpr uint64_t CPixelFormatCast (peak_common_pixel_format pixelFormat) noexcept
constexpr PixelFormat CPixelFormatToCppPixelFormat (peak_common_pixel_format pixelFormat) noexcept
constexpr peak_common_pixel_format CppPixelFormatToCPixelFormat (PixelFormat pixelFormat) noexcept

Variables

constexpr std::array< MetadataKey, 10 > allMetadataKeys

Detailed Description

Namespace for internal implementation details and low-level types.

The detail namespace contains internal types, helper classes, and low-level implementation components that support the functionality of the public API.

This namespace belongs to the Internal Detail Types module and is not intended for direct use in user code. Types and functions in this namespace are considered implementation details and may change without notice.

When necessary, safe access to internal types is provided via public aliases in the peak::common namespace. User code should rely on these public aliases for forward compatibility and avoid direct dependencies on detail components.

Since
ids_peak_common 1.0

Function Documentation

◆ Clamp()

template<typename T>
T peak::common::detail::Clamp ( T value,
T minimum,
T maximum )
constexpr

◆ CPixelFormatCast()

uint64_t peak::common::detail::CPixelFormatCast ( peak_common_pixel_format pixelFormat)
constexprnoexcept

◆ CPixelFormatToCppPixelFormat()

PixelFormat peak::common::detail::CPixelFormatToCppPixelFormat ( peak_common_pixel_format pixelFormat)
constexprnoexcept

◆ CppPixelFormatToCPixelFormat()

peak_common_pixel_format peak::common::detail::CppPixelFormatToCPixelFormat ( PixelFormat pixelFormat)
constexprnoexcept

◆ ToChannel()

PEAK_COMMON_NO_DISCARD Channel peak::common::detail::ToChannel ( const std::string & channel)
inline
Since
ids_peak_common 2.0

Variable Documentation

◆ allMetadataKeys

std::array<MetadataKey, 10> peak::common::detail::allMetadataKeys
constexpr
Initial value:
{ MetadataKey::DeviceTimestamp, MetadataKey::DeviceFrameID,
MetadataKey::BinningHorizontal, MetadataKey::BinningVertical, MetadataKey::Roi, MetadataKey::DeviceExposureTime,
MetadataKey::SystemTimestamp, MetadataKey::DeviceExposureTimeSequence, MetadataKey::DeviceGain, MetadataKey::DeviceGainSequence }
peak::common::MetadataKey::Roi
@ Roi
Region of interest applied to the image.
Definition peak_common_metadata_key.hpp:80
peak::common::MetadataKey::DeviceGain
@ DeviceGain
Device gain the image was captured with.
Definition peak_common_metadata_key.hpp:126
peak::common::MetadataKey::DeviceExposureTime
@ DeviceExposureTime
Device exposure time the image was captured with.
Definition peak_common_metadata_key.hpp:89
peak::common::MetadataKey::BinningHorizontal
@ BinningHorizontal
Horizontal pixel binning factor.
Definition peak_common_metadata_key.hpp:60
peak::common::MetadataKey::DeviceExposureTimeSequence
@ DeviceExposureTimeSequence
Device exposure time sequence the image was captured with.
Definition peak_common_metadata_key.hpp:119
peak::common::MetadataKey::DeviceTimestamp
@ DeviceTimestamp
Device-provided image acquisition timestamp in nanoseconds.
Definition peak_common_metadata_key.hpp:38
peak::common::MetadataKey::SystemTimestamp
@ SystemTimestamp
Timestamp of the system since unix epoch in nanoseconds.
Definition peak_common_metadata_key.hpp:105
peak::common::MetadataKey::DeviceGainSequence
@ DeviceGainSequence
Device gain sequence the image was captured with.
Definition peak_common_metadata_key.hpp:138
peak::common::MetadataKey::BinningVertical
@ BinningVertical
Vertical pixel binning factor.
Definition peak_common_metadata_key.hpp:69
peak::common::MetadataKey::DeviceFrameID
@ DeviceFrameID
A sequentially incremented identifier for the frame.
Definition peak_common_metadata_key.hpp:51
Since
ids_peak_common 1.1