peak::common Namespace Reference

Root namespace for common types and interfaces shared across multiple libraries. More...

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
	2D point with 32-bit signed integer coordinates.
using	PointF
	2D point with single-precision floating-point coordinates.
using	PointU
	2D point with 32-bit unsigned integer coordinates.
using	Rectangle
	Rectangle with integer coordinates and unsigned dimensions.
using	RectangleF
	Rectangle with floating-point coordinates and dimensions.
using	RectangleU
	Rectangle with unsigned coordinates and unsigned dimensions.
using	Size
	Size with unsigned 32-bit integer dimensions.
using	SizeF
	Size with floating-point dimensions.
using	VectorF
	Alias for a 2D point with floating point coordinates.
using	IntervalU
	Interval with unsigned 32-bit integer boundaries.
using	Interval
	Interval with signed 32-bit integer boundaries.
using	IntervalF
	Interval with floating-point boundaries.
using	RangeU
	Alias for a range of 32-bit unsigned integers.
using	Range
	Alias for a range of 32-bit signed integers.
using	RangeF
	Alias for a range of 32-bit floating-point numbers.
using	RangeU8
	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 }
	Enumerates all compile-time known metadata keys. More...
enum class	PixelFormat : uint64_t {   BayerGR8 , BayerGR10 , BayerGR12 , BayerRG8 ,   BayerRG10 , BayerRG12 , BayerGB8 , BayerGB10 ,   BayerGB12 , BayerBG8 , BayerBG10 , BayerBG12 ,   Mono8 , Mono10 , Mono12 , Mono16 ,   Confidence8 , Confidence16 , Coord3D_C8 , Coord3D_C16 ,   Coord3D_C32f , Coord3D_ABC32f , YUV420_8_YY_UV_SemiplanarIDS , YUV420_8_YY_VU_SemiplanarIDS ,   YUV422_8_UYVY , RGB8 , RGB10 , RGB12 ,   BGR8 , BGR10 , BGR12 , RGBa8 ,   RGBa10 , RGBa12 , BGRa8 , BGRa10 ,   BGRa12 , BayerBG10p , BayerBG12p , BayerGB10p ,   BayerGB12p , BayerGR10p , BayerGR12p , BayerRG10p ,   BayerRG12p , Mono10p , Mono12p , RGB10p32 ,   BGR10p32 , BayerRG10g40IDS , BayerGB10g40IDS , BayerGR10g40IDS ,   BayerBG10g40IDS , BayerRG12g24IDS , BayerGB12g24IDS , BayerGR12g24IDS ,   BayerBG12g24IDS , Mono10g40IDS , Mono12g24IDS }
	Enum listing all supported pixel formats and their internal IDs. More...

Detailed Description

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:

• Core data types and structures
• Publicly exposed aliases for internal types
• Interfaces and helper utilities for consistent API design

All components within this namespace are suitable for use in production code and are maintained with a stable API guarantee.

Since

ids_peak_common 1.0

Enumeration Type Documentation

MetadataKey

enum class MetadataKey

strong

Enumerates all compile-time known metadata keys.

Since

ids_peak_common 1.0

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. Since ids_peak_common 1.0
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. Since ids_peak_common 1.0
BinningHorizontal	Horizontal pixel binning factor. Indicates how many adjacent pixels are combined horizontally. Since ids_peak_common 1.1
BinningVertical	Vertical pixel binning factor. Indicates how many adjacent pixels are combined vertically. Since ids_peak_common 1.1
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. Since ids_peak_common 1.1