IDS peak IPL v1.17.1
Loading...
Searching...
No Matches
peak::ipl Namespace Reference

The "peak::ipl" namespace contains the whole image processing library. More...

Namespaces

namespace  container
namespace  encoder

Classes

class  Binning
 Performs spatial binning on 2D images. More...
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...
class  ChromaticAdapter
 Adjust to changes in lighting conditions to maintain consistent color perception despite variations in light sources. 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
 Performs spatial decimation on 2D images. More...
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 digital black and gamma correction to the image 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  Interval
 Interval support and convenience class. 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  Lut
 Applies a LUT to the input image data. 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 {
  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 class  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::Mono16 = PEAK_IPL_PIXEL_FORMAT_MONO_16 ,
  PixelFormatName::Confidence8 = PEAK_IPL_PIXEL_FORMAT_CONFIDENCE_8 ,
  PixelFormatName::Confidence16 = PEAK_IPL_PIXEL_FORMAT_CONFIDENCE_16 ,
  PixelFormatName::Coord3D_C8 = PEAK_IPL_PIXEL_FORMAT_COORD3D_C8 ,
  PixelFormatName::Coord3D_C16 = PEAK_IPL_PIXEL_FORMAT_COORD3D_C16 ,
  PixelFormatName::Coord3D_C32f = PEAK_IPL_PIXEL_FORMAT_COORD3D_C32F ,
  PixelFormatName::Coord3D_ABC32f = PEAK_IPL_PIXEL_FORMAT_COORD3D_ABC32F ,
  PixelFormatName::YUV420_8_YY_UV_SemiplanarIDS = PEAK_IPL_PIXEL_FORMAT_YUV420_8_YY_UV_SemiplanarIDS ,
  PixelFormatName::YUV420_8_YY_VU_SemiplanarIDS = PEAK_IPL_PIXEL_FORMAT_YUV420_8_YY_VU_SemiplanarIDS ,
  PixelFormatName::YUV422_8_UYVY = PEAK_IPL_PIXEL_FORMAT_YUV422_8_UYVY ,
  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 class  BayerPattern {
  BayerPattern::Unknown = PEAK_IPL_BAYER_PATTERN_UNKNOWN ,
  BayerPattern::None = PEAK_IPL_BAYER_PATTERN_NONE ,
  BayerPattern::Bayer_GR = PEAK_IPL_BAYER_PATTERN_BAYER_GR ,
  BayerPattern::Bayer_RG = PEAK_IPL_BAYER_PATTERN_BAYER_RG ,
  BayerPattern::Bayer_GB = PEAK_IPL_BAYER_PATTERN_BAYER_GB ,
  BayerPattern::Bayer_BG = PEAK_IPL_BAYER_PATTERN_BAYER_BG
}
 Enum holding the possible bayer patterns. More...
enum class  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 class  Orientation {
  Orientation::Horizontal = PEAK_IPL_ORIENTATION_HORIZONTAL ,
  Orientation::Vertical = PEAK_IPL_ORIENTATION_VERTICAL
}
 Enum holding the possible orientation. More...
enum class  InterpolationAlgorithm {
  InterpolationAlgorithm::nearest = PEAK_IPL_INTERPOLATION_NEAREST ,
  InterpolationAlgorithm::linear = PEAK_IPL_INTERPOLATION_LINEAR ,
  InterpolationAlgorithm::cubic = PEAK_IPL_INTERPOLATION_CUBIC ,
  InterpolationAlgorithm::area = PEAK_IPL_INTERPOLATION_AREA ,
  InterpolationAlgorithm::lanczos4 = PEAK_IPL_INTERPOLATION_LANCZOS4 ,
  InterpolationAlgorithm::linear_exact = PEAK_IPL_INTERPOLATION_LINEAR_EXACT ,
  InterpolationAlgorithm::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)
constexpr bool operator== (const Rect2D &lhs, const Rect2D &rhs)
constexpr bool operator!= (const Rect2D &lhs, const Rect2D &rhs)
constexpr bool operator== (const Size2D &lhs, const Size2D &rhs)
 Compare two Size2D for equality.
constexpr bool operator!= (const Size2D &lhs, const Size2D &rhs)
 Compare two Size2D for inequality.
constexpr bool operator== (const Point2D &lhs, const Point2D &rhs)
 Compare two Point2D for equality.
constexpr 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.

Detailed Description

The "peak::ipl" namespace contains the whole image processing library.

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 )
constexpr

Compare two Point2D for inequality.

◆ operator!=() [2/4]

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

◆ 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 )
constexpr

Compare two Size2D for inequality.

◆ operator==() [1/4]

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

Compare two Point2D for equality.

◆ operator==() [2/4]

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

◆ 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 )
constexpr

Compare two Size2D for equality.

◆ StringFromPEAK_IPL_RETURN_CODE()

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