Types

General-purpose types and interfaces used throughout the library. More...

Classes
struct	peak::ipl::ColorCorrectionFactors
	The Factors of the Color Correction Matrix. More...
class	peak::ipl::Interval< T >
	Interval support and convenience class. More...
class	peak::ipl::Range< T >
	Range support and convenience class. More...
class	peak::ipl::Rect2D
	Rectangle type. More...
struct	peak::ipl::Size2D
	2D size of an image. More...
struct	peak::ipl::Point2D
	2D position in an image. More...
struct	peak::ipl::ScaleFactor
	Scale Factors of an image. More...

Enumerations
enum class	peak::ipl::ConversionMode {   peak::ipl::ConversionMode::Fast = PEAK_IPL_CONVERSION_MODE_FAST ,   peak::ipl::ConversionMode::HighQuality = PEAK_IPL_CONVERSION_MODE_HIGH_QUALITY ,   peak::ipl::ConversionMode::Classic = PEAK_IPL_CONVERSION_MODE_CLASSIC }
	Enum holding the possible conversion modes. More...
enum class	peak::ipl::BayerPattern {   peak::ipl::BayerPattern::Unknown = PEAK_IPL_BAYER_PATTERN_UNKNOWN ,   peak::ipl::BayerPattern::None = PEAK_IPL_BAYER_PATTERN_NONE ,   peak::ipl::BayerPattern::Bayer_GR = PEAK_IPL_BAYER_PATTERN_BAYER_GR ,   peak::ipl::BayerPattern::Bayer_RG = PEAK_IPL_BAYER_PATTERN_BAYER_RG ,   peak::ipl::BayerPattern::Bayer_GB = PEAK_IPL_BAYER_PATTERN_BAYER_GB ,   peak::ipl::BayerPattern::Bayer_BG = PEAK_IPL_BAYER_PATTERN_BAYER_BG }
	Enum holding the possible bayer patterns. More...
enum class	peak::ipl::Endianness {   peak::ipl::Endianness::Unknown = PEAK_IPL_ENDIANNESS_UNKNOWN ,   peak::ipl::Endianness::LittleEndian = PEAK_IPL_ENDIANNESS_LITTLE_ENDIAN ,   peak::ipl::Endianness::BigEndian = PEAK_IPL_ENDIANNESS_BIG_ENDIAN }
	Enum holding the possible endianness (the byte order). More...
enum class	peak::ipl::Orientation {   peak::ipl::Orientation::Horizontal = PEAK_IPL_ORIENTATION_HORIZONTAL ,   peak::ipl::Orientation::Vertical = PEAK_IPL_ORIENTATION_VERTICAL }
	Enum holding the possible orientation. More...
enum class	peak::ipl::InterpolationAlgorithm {   peak::ipl::InterpolationAlgorithm::nearest = PEAK_IPL_INTERPOLATION_NEAREST ,   peak::ipl::InterpolationAlgorithm::linear = PEAK_IPL_INTERPOLATION_LINEAR ,   peak::ipl::InterpolationAlgorithm::cubic = PEAK_IPL_INTERPOLATION_CUBIC ,   peak::ipl::InterpolationAlgorithm::area = PEAK_IPL_INTERPOLATION_AREA ,   peak::ipl::InterpolationAlgorithm::lanczos4 = PEAK_IPL_INTERPOLATION_LANCZOS4 ,   peak::ipl::InterpolationAlgorithm::linear_exact = PEAK_IPL_INTERPOLATION_LINEAR_EXACT ,   peak::ipl::InterpolationAlgorithm::nearest_exact = PEAK_IPL_INTERPOLATION_NEAREST_EXACT }
	Enum holding the possible interpolation algorithm. More...

Functions
std::string	peak::ipl::ToString (ConversionMode entry)
	Convert a ConversionMode to a string.
std::string	peak::ipl::ToString (PixelFormatName entry)
	Convert a PixelFormatName to a string.
std::string	peak::ipl::ToString (Endianness entry)
	Convert an Endianness to a string.
std::string	peak::ipl::ToString (Orientation entry)
	Convert an Orientation to a string.

Detailed Description

General-purpose types and interfaces used throughout the library.

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.

Function Documentation

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.