Namespaces
	container

	encoder

Classes
class	Binning

class	BufferTooSmallException
	The exception thrown when an given buffer is to small for for the data. More...

class	BusyException
	The exception thrown when 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	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 an given image format can not be used on this data e.g. during reading from file. More...

class	ImageFormatNotSupportedException
	The exception thrown when an image format is not 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 an given image format can not be used on this data e.g. during reading from file. 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 of 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 of a horizontal line of pixels in an image. More...

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

class	Range
	Range. More...

class	Rect2D
	Rectangle. 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...

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

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

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

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

enum	Orientation { Orientation::Horizontal = PEAK_IPL_ORIENTATION_HORIZONTAL, Orientation::Vertical = PEAK_IPL_ORIENTATION_VERTICAL }
	Enum holding the possible orientation. 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)

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

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

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

std::string	ToString (ConversionMode entry)

std::string	ToString (PixelFormatName entry)

std::string	ToString (Endianness entry)

std::string	ToString (Orientation entry)

Enumeration Type Documentation

◆ ConversionMode

enum peak::ipl::ConversionMode

strong

Enum holding the possible conversion modes.

Enumerator
Fast
HighQuality
Classic

◆ Endianness

enum peak::ipl::Endianness

strong

Enum holding the possible endianness (the byte order).

Enumerator
Unknown
LittleEndian
BigEndian

◆ Orientation

enum peak::ipl::Orientation

strong

Enum holding the possible orientation.

Enumerator
Horizontal
Vertical

◆ PixelFormatName

enum peak::ipl::PixelFormatName

strong

Enum holding the possible pixel format names.

Enumerator
Invalid
BayerGR8
BayerGR10
BayerGR12
BayerRG8
BayerRG10
BayerRG12
BayerGB8
BayerGB10
BayerGB12
BayerBG8
BayerBG10
BayerBG12
Mono8
Mono10
Mono12
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	Attention This pixel format is preliminary and its name and value may change in a future product version.
BayerGB10g40IDS	Attention This pixel format is preliminary and its name and value may change in a future product version.
BayerGR10g40IDS	Attention This pixel format is preliminary and its name and value may change in a future product version.
BayerBG10g40IDS	Attention This pixel format is preliminary and its name and value may change in a future product version.
BayerRG12g24IDS	Attention This pixel format is preliminary and its name and value may change in a future product version.
BayerGB12g24IDS	Attention This pixel format is preliminary and its name and value may change in a future product version.
BayerGR12g24IDS	Attention This pixel format is preliminary and its name and value may change in a future product version.
BayerBG12g24IDS	Attention This pixel format is preliminary and its name and value may change in a future product version.
Mono10g40IDS	Attention This pixel format is preliminary and its name and value may change in a future product version.
Mono12g24IDS	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 Rect2D &	lhs,
		const Rect2D &	rhs
	)

inline

◆ operator!=() [2/4]

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

inline

◆ operator!=() [3/4]

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

inline

◆ operator!=() [4/4]

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

inline

◆ operator==() [1/4]

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

inline

◆ operator==() [2/4]

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

inline

◆ operator==() [3/4]

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

inline

◆ operator==() [4/4]

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

inline

◆ 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

◆ ToString() [2/4]

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

inline

◆ ToString() [3/4]

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

inline

◆ ToString() [4/4]

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

inline

Namespaces

Classes

Enumerations

Functions

Enumeration Type Documentation

◆ ConversionMode

◆ Endianness

◆ 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]