peak::common::detail Namespace Reference

Data Structures
struct	c_type_of_
struct	c_type_of_< peak::icv::Archive >
struct	c_type_of_< peak::icv::CalibrationParameters >
struct	c_type_of_< peak::icv::CalibrationPlate >
struct	c_type_of_< peak::icv::CalibrationResult >
struct	c_type_of_< peak::icv::CalibrationView >
struct	c_type_of_< peak::icv::CaptureInformation >
struct	c_type_of_< peak::icv::CoordinateSystem >
struct	c_type_of_< peak::icv::Deserializer >
struct	c_type_of_< peak::icv::detail::DrawingOptions >
struct	c_type_of_< peak::icv::detail::PointCloud< peak::icv::PointCloudXYZ, peak::icv::PointXYZ > >
struct	c_type_of_< peak::icv::detail::PointCloud< peak::icv::PointCloudXYZI, peak::icv::PointXYZI > >
struct	c_type_of_< peak::icv::detail::Polygon< float > >
struct	c_type_of_< peak::icv::Downsampling >
struct	c_type_of_< peak::icv::experimental::CodeReaderResult >
struct	c_type_of_< peak::icv::experimental::HDR >
struct	c_type_of_< peak::icv::experimental::ToneMapping >
struct	c_type_of_< peak::icv::ExtrinsicParameters >
struct	c_type_of_< peak::icv::Image >
struct	c_type_of_< peak::icv::IntrinsicParameters >
struct	c_type_of_< peak::icv::PointCloudXYZ >
struct	c_type_of_< peak::icv::PointCloudXYZI >
struct	c_type_of_< peak::icv::PointXYZ >
struct	c_type_of_< peak::icv::PointXYZI >
struct	c_type_of_< peak::icv::Region >
struct	c_type_of_< peak::icv::ReprojectionError >
struct	c_type_of_< peak::icv::Serializer >
struct	c_type_of_< peak::icv::Undistortion >
struct	c_type_of_< peak::icv::XYZImage >
class	Interval
class	IntervalT
	Represents a continuous numeric interval with inclusive lower and upper bounds. More...
struct	MetadataKeyTraits< MetadataKey::BinningHorizontal >
	Trait specialization for MetadataKey::BinningHorizontal. More...
struct	MetadataKeyTraits< MetadataKey::BinningVertical >
	Trait specialization for MetadataKey::BinningVertical. More...
struct	MetadataKeyTraits< MetadataKey::DeviceExposureTime >
	Trait specialization for MetadataKey::DeviceExposureTime. More...
struct	MetadataKeyTraits< MetadataKey::DeviceFrameID >
	Trait specialization for MetadataKey::DeviceFrameID. More...
struct	MetadataKeyTraits< MetadataKey::DeviceTimestamp >
	Trait specialization for MetadataKey::DeviceTimestamp. More...
struct	MetadataKeyTraits< MetadataKey::Roi >
	Trait specialization for MetadataKey::Roi. More...
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::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::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...

Typedefs
template<typename Type >
using	c_type_of_t = typename c_type_of_<Type>::type

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.
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, 6 >	allMetadataKeys
	List of all MetadataKeys.

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

Typedef Documentation

c_type_of_t

template<typename Type >

using c_type_of_t = typename c_type_of_<Type>::type

Definition at line 349 of file peak_icv_type_traits.hpp.

Function Documentation

CPixelFormatCast()

uint64_t CPixelFormatCast ( peak_common_pixel_format pixelFormat )

constexprnoexcept

Definition at line 34 of file peak_common_pixel_format.hpp.

CPixelFormatToCppPixelFormat()

PixelFormat CPixelFormatToCppPixelFormat ( peak_common_pixel_format pixelFormat )

constexprnoexcept

Definition at line 204 of file peak_common_pixel_format.hpp.

CppPixelFormatToCPixelFormat()

peak_common_pixel_format CppPixelFormatToCPixelFormat ( PixelFormat pixelFormat )

constexprnoexcept

Definition at line 209 of file peak_common_pixel_format.hpp.

Variable Documentation

allMetadataKeys

std::array<MetadataKey, 6> allMetadataKeys

constexpr

Initial value:

{ MetadataKey::DeviceTimestamp, MetadataKey::DeviceFrameID,
    MetadataKey::BinningHorizontal, MetadataKey::BinningVertical, MetadataKey::Roi, MetadataKey::DeviceExposureTime }

List of all MetadataKeys.

Since

ids_peak_common 1.1

Definition at line 168 of file peak_common_metadata_traits.hpp.