Namespaces
namespace	container

namespace	dynamic

namespace	encoder

Data Structures
class	Binning

class	BufferTooSmallException
	The exception thrown when a given buffer is too small for the data. More...

class	BusyException
	The exception thrown when the resource busy. More...

struct	ColorCorrectionFactors
	The Factors of the Color Correction Matrix. More...

class	ColorCorrector
	Applies a 3x3 color correction matrix to the data. More...

class	Decimation

class	EdgeEnhancement
	Edge Enhancement for a given image. More...

class	Exception
	The base class for all exceptions thrown by the library. More...

class	Gain
	Applies gain to the data. More...

class	GammaCorrector
	Applies gamma correction to the data. More...

class	Histogram
	Stores the histogram values. More...

class	HotpixelCorrection
	Algorithm for (adaptive) hotpixel detection and correction. More...

class	Image
	Stores the pixel format, width and height of an image and the pointer to the image buffer. More...

class	ImageConverter
	Converts images from one PixelFormat to another. More...

class	ImageFormatInterpretationException
	The exception thrown when a given image format can't be used on this data, e.g. during reading from file. More...

class	ImageFormatNotSupportedException
	The exception thrown when an image format isn't supported by a function. More...

class	ImageReader
	Reads an image from a file. More...

class	ImageTransformer
	Performs transformations like mirror and rotate on images. More...

class	ImageWriter
	Writes an image to a file. More...

class	InvalidArgumentException
	The exception thrown when passing an invalid parameter to a function. More...

class	InvalidHandleException
	The exception thrown when passing an invalid handle to a function. More...

class	IOException
	The exception thrown when a given image format can't be used on this data, e.g. during reading from file. More...

class	Library
	Library related functions. More...

class	NotPermittedException
	The exception thrown when the operation not permitted. More...

class	OutOfRangeException
	The exception thrown for trying to access a value being out of range. More...

class	PixelColumn
	Represents the values for a vertical line of pixels in an image. More...

class	PixelFormat
	Represents a pixel format and its specific properties. More...

class	PixelLine
	Represents the values of a horizontal or vertical line of pixels in an image. More...

class	PixelRow
	Represents the values for a horizontal line of pixels in an image. More...

struct	Point2D
	2D position in an image. More...

class	Range
	Range support and convenience class. More...

class	Rect2D
	Rectangle type. More...

struct	ScaleFactor
	Scale Factors of an image. More...

class	Sharpness
	Configure and measure the sharpness of a given image. More...

struct	Size2D
	2D size of an image. More...

class	TimeoutException
	The exception thrown when the operation times out. More...

struct	Version_t

class	VideoWriter
	Writes images to a file in the form of a video. More...

Enumerations
enum class	ConversionMode { Fast = PEAK_IPL_CONVERSION_MODE_FAST , HighQuality = PEAK_IPL_CONVERSION_MODE_HIGH_QUALITY , Classic = PEAK_IPL_CONVERSION_MODE_CLASSIC }
	Enum holding the possible conversion modes. More...

enum class	PixelFormatName { Invalid = PEAK_IPL_PIXEL_FORMAT_INVALID , BayerGR8 = PEAK_IPL_PIXEL_FORMAT_BAYER_GR_8 , BayerGR10 = PEAK_IPL_PIXEL_FORMAT_BAYER_GR_10 , BayerGR12 = PEAK_IPL_PIXEL_FORMAT_BAYER_GR_12 , BayerRG8 = PEAK_IPL_PIXEL_FORMAT_BAYER_RG_8 , BayerRG10 = PEAK_IPL_PIXEL_FORMAT_BAYER_RG_10 , BayerRG12 = PEAK_IPL_PIXEL_FORMAT_BAYER_RG_12 , BayerGB8 = PEAK_IPL_PIXEL_FORMAT_BAYER_GB_8 , BayerGB10 = PEAK_IPL_PIXEL_FORMAT_BAYER_GB_10 , BayerGB12 = PEAK_IPL_PIXEL_FORMAT_BAYER_GB_12 , BayerBG8 = PEAK_IPL_PIXEL_FORMAT_BAYER_BG_8 , BayerBG10 = PEAK_IPL_PIXEL_FORMAT_BAYER_BG_10 , BayerBG12 = PEAK_IPL_PIXEL_FORMAT_BAYER_BG_12 , Mono8 = PEAK_IPL_PIXEL_FORMAT_MONO_8 , Mono10 = PEAK_IPL_PIXEL_FORMAT_MONO_10 , Mono12 = PEAK_IPL_PIXEL_FORMAT_MONO_12 , Mono16 = PEAK_IPL_PIXEL_FORMAT_MONO_16 , Confidence8 = PEAK_IPL_PIXEL_FORMAT_CONFIDENCE_8 , Confidence16 = PEAK_IPL_PIXEL_FORMAT_CONFIDENCE_16 , Coord3D_C8 = PEAK_IPL_PIXEL_FORMAT_COORD3D_C8 , Coord3D_C16 = PEAK_IPL_PIXEL_FORMAT_COORD3D_C16 , Coord3D_C32f = PEAK_IPL_PIXEL_FORMAT_COORD3D_C32F , Coord3D_ABC32f = PEAK_IPL_PIXEL_FORMAT_COORD3D_ABC32F , YUV420_8_YY_UV_SemiplanarIDS = PEAK_IPL_PIXEL_FORMAT_YUV420_8_YY_UV_SemiplanarIDS , YUV420_8_YY_VU_SemiplanarIDS = PEAK_IPL_PIXEL_FORMAT_YUV420_8_YY_VU_SemiplanarIDS , YUV422_8_UYVY = PEAK_IPL_PIXEL_FORMAT_YUV422_8_UYVY , RGB8 = PEAK_IPL_PIXEL_FORMAT_RGB_8 , RGB10 = PEAK_IPL_PIXEL_FORMAT_RGB_10 , RGB12 = PEAK_IPL_PIXEL_FORMAT_RGB_12 , BGR8 = PEAK_IPL_PIXEL_FORMAT_BGR_8 , BGR10 = PEAK_IPL_PIXEL_FORMAT_BGR_10 , BGR12 = PEAK_IPL_PIXEL_FORMAT_BGR_12 , RGBa8 = PEAK_IPL_PIXEL_FORMAT_RGBA_8 , RGBa10 = PEAK_IPL_PIXEL_FORMAT_RGBA_10 , RGBa12 = PEAK_IPL_PIXEL_FORMAT_RGBA_12 , BGRa8 = PEAK_IPL_PIXEL_FORMAT_BGRA_8 , BGRa10 = PEAK_IPL_PIXEL_FORMAT_BGRA_10 , BGRa12 = PEAK_IPL_PIXEL_FORMAT_BGRA_12 , BayerBG10p = PEAK_IPL_PIXEL_FORMAT_BAYER_BG_10_PACKED , BayerBG12p = PEAK_IPL_PIXEL_FORMAT_BAYER_BG_12_PACKED , BayerGB10p = PEAK_IPL_PIXEL_FORMAT_BAYER_GB_10_PACKED , BayerGB12p = PEAK_IPL_PIXEL_FORMAT_BAYER_GB_12_PACKED , BayerGR10p = PEAK_IPL_PIXEL_FORMAT_BAYER_GR_10_PACKED , BayerGR12p = PEAK_IPL_PIXEL_FORMAT_BAYER_GR_12_PACKED , BayerRG10p = PEAK_IPL_PIXEL_FORMAT_BAYER_RG_10_PACKED , BayerRG12p = PEAK_IPL_PIXEL_FORMAT_BAYER_RG_12_PACKED , Mono10p = PEAK_IPL_PIXEL_FORMAT_MONO_10_PACKED , Mono12p = PEAK_IPL_PIXEL_FORMAT_MONO_12_PACKED , RGB10p32 = PEAK_IPL_PIXEL_FORMAT_RGB_10_PACKED_32 , BGR10p32 = PEAK_IPL_PIXEL_FORMAT_BGR_10_PACKED_32 , BayerRG10g40IDS = PEAK_IPL_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS , BayerGB10g40IDS = PEAK_IPL_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS , BayerGR10g40IDS = PEAK_IPL_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS , BayerBG10g40IDS = PEAK_IPL_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS , BayerRG12g24IDS = PEAK_IPL_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS , BayerGB12g24IDS = PEAK_IPL_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS , BayerGR12g24IDS = PEAK_IPL_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS , BayerBG12g24IDS = PEAK_IPL_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS , Mono10g40IDS = PEAK_IPL_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS , Mono12g24IDS = PEAK_IPL_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS }
	Enum holding the possible pixel format names. More...

enum class	BayerPattern { Unknown = PEAK_IPL_BAYER_PATTERN_UNKNOWN , None = PEAK_IPL_BAYER_PATTERN_NONE , Bayer_GR = PEAK_IPL_BAYER_PATTERN_BAYER_GR , Bayer_RG = PEAK_IPL_BAYER_PATTERN_BAYER_RG , Bayer_GB = PEAK_IPL_BAYER_PATTERN_BAYER_GB , Bayer_BG = PEAK_IPL_BAYER_PATTERN_BAYER_BG }
	Enum holding the possible bayer patterns. More...

enum class	Endianness { Unknown = PEAK_IPL_ENDIANNESS_UNKNOWN , LittleEndian = PEAK_IPL_ENDIANNESS_LITTLE_ENDIAN , BigEndian = PEAK_IPL_ENDIANNESS_BIG_ENDIAN }
	Enum holding the possible endianness (the byte order). More...

enum class	Orientation { Horizontal = PEAK_IPL_ORIENTATION_HORIZONTAL , Vertical = PEAK_IPL_ORIENTATION_VERTICAL }
	Enum holding the possible orientation. More...

enum class	InterpolationAlgorithm { nearest = PEAK_IPL_INTERPOLATION_NEAREST , linear = PEAK_IPL_INTERPOLATION_LINEAR , cubic = PEAK_IPL_INTERPOLATION_CUBIC , area = PEAK_IPL_INTERPOLATION_AREA , lanczos4 = PEAK_IPL_INTERPOLATION_LANCZOS4 , linear_exact = PEAK_IPL_INTERPOLATION_LINEAR_EXACT , nearest_exact = PEAK_IPL_INTERPOLATION_NEAREST_EXACT }
	Enum holding the possible interpolation algorithm. More...

Functions
bool	operator== (const Sharpness::SharpnessROI &lhs, const Sharpness::SharpnessROI &rhs)

bool	operator!= (const Sharpness::SharpnessROI &lhs, const Sharpness::SharpnessROI &rhs)

std::string	StringFromPEAK_IPL_RETURN_CODE (PEAK_IPL_RETURN_CODE_t entry)

template<class CallableType >
void	ExecuteAndMapReturnCodes (const CallableType &callableObject)

bool	operator== (const Rect2D &lhs, const Rect2D &rhs)

bool	operator!= (const Rect2D &lhs, const Rect2D &rhs)

bool	operator== (const Size2D &lhs, const Size2D &rhs)
	Compare two Size2D for equality.

bool	operator!= (const Size2D &lhs, const Size2D &rhs)
	Compare two Size2D for inequality.

bool	operator== (const Point2D &lhs, const Point2D &rhs)
	Compare two Point2D for equality.

bool	operator!= (const Point2D &lhs, const Point2D &rhs)
	Compare two Point2D for inequality.

std::string	ToString (ConversionMode entry)
	Convert a ConversionMode to a string.

std::string	ToString (PixelFormatName entry)
	Convert a PixelFormatName to a string.

std::string	ToString (Endianness entry)
	Convert an Endianness to a string.

std::string	ToString (Orientation entry)
	Convert an Orientation to a string.

Enumeration Type Documentation

◆ BayerPattern

enum class peak::ipl::BayerPattern

strong

Enum holding the possible bayer patterns.

Enumerator
Unknown	Unknown pattern.
None	No pattern.
Bayer_GR	BayerGR pattern.
Bayer_RG	BayerRG pattern.
Bayer_GB	BayerGB pattern.
Bayer_BG	BayerBG pattern.

◆ ConversionMode

enum class peak::ipl::ConversionMode

strong

Enum holding the possible conversion modes.

Enumerator
Fast	Fast conversion mode.
HighQuality	High-Quality conversion mode.
Classic	Classic conversion mode.

◆ Endianness

enum class peak::ipl::Endianness

strong

Enum holding the possible endianness (the byte order).

Enumerator
Unknown	Unknown endianness.
LittleEndian	Little endian (lower bytes first)
BigEndian	Big endian (higher bytes first)

◆ InterpolationAlgorithm

enum class peak::ipl::InterpolationAlgorithm

strong

Enum holding the possible interpolation algorithm.

Enumerator
nearest	nearest neighbor interpolation
linear	bilinear interpolation
cubic	bicubic interpolation
area	resampling using pixel area relation
lanczos4	Lanczos interpolation over 8x8 neighborhood.
linear_exact	Bit-exact bilinear interpolation.
nearest_exact	Bit-exact bicubic interpolation.

◆ Orientation

enum class peak::ipl::Orientation

strong

Enum holding the possible orientation.

Enumerator
Horizontal	Horizontal orientation.
Vertical	Vertical orientation.

◆ PixelFormatName

enum class peak::ipl::PixelFormatName

strong

Enum holding the possible pixel format names.

Enumerator
Invalid	Invalid Pixel Format.
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 12-Bit pixel format.
Confidence8	Confidence 8-Bit.
Confidence16	Confidence 16-Bit.
Coord3D_C8	3D coordinate C 8-Bit
Coord3D_C16	3D coordinate C 16-Bit
Coord3D_C32f	3D coordinate C 32-Bit floating point
Coord3D_ABC32f	3D coordinates A, B and C 32-Bit floating point
YUV420_8_YY_UV_SemiplanarIDS	YUV 4:2:0 8-bit YY/UV Semiplanar.
YUV420_8_YY_VU_SemiplanarIDS	YUV 4:2:0 8-bit YY/VU Semiplanar.
YUV422_8_UYVY	UYVY 4:2:2 8-bit.
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 pixel format.
BayerBG12p	BayerBG 12-Bit packed pixel format.
BayerGB10p	BayerGB 10-Bit packed pixel format.
BayerGB12p	BayerGB 12-Bit packed pixel format.
BayerGR10p	BayerGR 10-Bit packed pixel format.
BayerGR12p	BayerGR 12-Bit packed pixel format.
BayerRG10p	BayerRG 10-Bit packed pixel format.
BayerRG12p	BayerRG 12-Bit packed pixel format.
Mono10p	Mono 10-Bit packed pixel format.
Mono12p	Mono 10-Bit packed pixel format.
RGB10p32	BayerBG 10-Bit packed pixel format.
BGR10p32	BayerBG 10-Bit packed pixel format.
BayerRG10g40IDS	BayerRG 10-Bit packed 40bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
BayerGB10g40IDS	BayerGB 10-Bit packed 40bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
BayerGR10g40IDS	BayerGR 10-Bit packed 40bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
BayerBG10g40IDS	BayerBG 10-Bit packed 40bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
BayerRG12g24IDS	BayerRG 12-Bit packed 24bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
BayerGB12g24IDS	BayerGB 12-Bit packed 24bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
BayerGR12g24IDS	BayerGR 12-Bit packed 24bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
BayerBG12g24IDS	BayerBG 12-Bit packed 24bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
Mono10g40IDS	Mono 10-Bit packed 40bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.
Mono12g24IDS	Mono 12-Bit packed 24bit grouped pixel format. Attention This pixel format is preliminary, and its name and value may change in a future product version.

Function Documentation

◆ ExecuteAndMapReturnCodes()

template<class CallableType >

void peak::ipl::ExecuteAndMapReturnCodes ( const CallableType & callableObject )

◆ operator!=() [1/4]

bool peak::ipl::operator!=	(	const Point2D &	lhs,
		const Point2D &	rhs
	)

inline

Compare two Point2D for inequality.

◆ operator!=() [2/4]

bool peak::ipl::operator!=	(	const Rect2D &	lhs,
		const Rect2D &	rhs
	)

inline

◆ operator!=() [3/4]

bool peak::ipl::operator!=	(	const Sharpness::SharpnessROI &	lhs,
		const Sharpness::SharpnessROI &	rhs
	)

inline

◆ operator!=() [4/4]

bool peak::ipl::operator!=	(	const Size2D &	lhs,
		const Size2D &	rhs
	)

inline

Compare two Size2D for inequality.

◆ operator==() [1/4]

bool peak::ipl::operator==	(	const Point2D &	lhs,
		const Point2D &	rhs
	)

inline

Compare two Point2D for equality.

◆ operator==() [2/4]

bool peak::ipl::operator==	(	const Rect2D &	lhs,
		const Rect2D &	rhs
	)

inline

◆ operator==() [3/4]

bool peak::ipl::operator==	(	const Sharpness::SharpnessROI &	lhs,
		const Sharpness::SharpnessROI &	rhs
	)

inline

◆ operator==() [4/4]

bool peak::ipl::operator==	(	const Size2D &	lhs,
		const Size2D &	rhs
	)

inline

Compare two Size2D for equality.

◆ StringFromPEAK_IPL_RETURN_CODE()

std::string peak::ipl::StringFromPEAK_IPL_RETURN_CODE ( PEAK_IPL_RETURN_CODE_t entry )

inline

◆ ToString() [1/4]

std::string peak::ipl::ToString ( ConversionMode entry )

inline

Convert a ConversionMode to a string.

Parameters

entry ConversionMode to convert.

Returns: String representation of entry.

◆ ToString() [2/4]

std::string peak::ipl::ToString ( Endianness entry )

inline

Convert an Endianness to a string.

Parameters

entry Endianness to convert.

Returns: String representation of entry.

◆ ToString() [3/4]

std::string peak::ipl::ToString ( Orientation entry )

inline

Convert an Orientation to a string.

Parameters

entry Orientation to convert.

Returns: String representation of entry.

◆ ToString() [4/4]

std::string peak::ipl::ToString ( PixelFormatName entry )

inline

Convert a PixelFormatName to a string.

Parameters

entry PixelFormatName to convert.

Returns: String representation of entry.

Namespaces

Data Structures

Enumerations

Functions

Enumeration Type Documentation

◆ BayerPattern

◆ ConversionMode

◆ Endianness

◆ InterpolationAlgorithm

◆ Orientation

◆ PixelFormatName

Function Documentation

◆ ExecuteAndMapReturnCodes()

◆ operator!=() [1/4]

◆ operator!=() [2/4]

◆ operator!=() [3/4]

◆ operator!=() [4/4]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ StringFromPEAK_IPL_RETURN_CODE()

◆ ToString() [1/4]

◆ ToString() [2/4]

◆ ToString() [3/4]

◆ ToString() [4/4]