 |
IDS peak IPL
v1.3.2
|
|
IDS peak IPL
v1.3.2
|
Go to the source code of this file.
Classes | |
| struct | PEAK_IPL_POINT_2D |
Macros | |
| #define | PEAK_IPL_C_API PEAK_IPL_PUBLIC PEAK_IPL_RETURN_CODE PEAK_IPL_CALL_CONV |
Typedefs | |
| typedef int8_t | PEAK_IPL_BOOL8 |
| typedef int32_t | PEAK_IPL_RETURN_CODE |
| typedef int32_t | PEAK_IPL_CONVERSION_MODE |
| typedef int32_t | PEAK_IPL_PIXEL_FORMAT |
| typedef int32_t | PEAK_IPL_ENDIANNESS |
| typedef int32_t | PEAK_IPL_ORIENTATION |
| typedef int32_t | PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY |
| typedef uint16_t | PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE |
| typedef struct PEAK_IPL_IMAGE_CONVERTER * | PEAK_IPL_IMAGE_CONVERTER_HANDLE |
| typedef struct PEAK_IPL_IMAGE_transformer * | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE |
| typedef struct PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR * | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE |
| typedef struct PEAK_IPL_COLOR_CORRECTOR * | PEAK_IPL_COLOR_CORRECTOR_HANDLE |
| typedef struct PEAK_IPL_GAIN * | PEAK_IPL_GAIN_HANDLE |
| typedef struct PEAK_IPL_GAMMA_CORRECTOR * | PEAK_IPL_GAMMA_CORRECTOR_HANDLE |
| typedef struct PEAK_IPL_IMAGE * | PEAK_IPL_IMAGE_HANDLE |
| typedef struct PEAK_IPL_HISTOGRAM * | PEAK_IPL_HISTOGRAM_HANDLE |
| typedef struct PEAK_IPL_PIXEL_LINE * | PEAK_IPL_PIXEL_LINE_HANDLE |
Functions | |
| PEAK_IPL_C_API | PEAK_IPL_Library_GetVersionMajor (uint32_t *libraryVersionMajor) |
| Queries the library major version. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Library_GetVersionMinor (uint32_t *libraryVersionMinor) |
| Queries the library minor version. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Library_GetVersionSubminor (uint32_t *libraryVersionSubminor) |
| Queries the library subminor version. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Library_GetLastError (PEAK_IPL_RETURN_CODE *lastErrorCode, char *lastErrorDescription, size_t *lastErrorDescriptionSize) |
| Queries the last error. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageConverter_Construct (PEAK_IPL_IMAGE_CONVERTER_HANDLE *imageConverterHandle) |
| Creates an image converter. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageConverter_GetConversionMode (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_CONVERSION_MODE *conversionMode) |
| Queries the given image converter's current conversion mode. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageConverter_SetConversionMode (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_CONVERSION_MODE conversionMode) |
| Sets the given image converter's conversion mode. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageConverter_GetSupportedOutputPixelFormats (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_PIXEL_FORMAT inputPixelFormat, PEAK_IPL_PIXEL_FORMAT *outputPixelFormats, size_t *outputPixelFormatsSize) |
| Queries the supported output pixel formats for a given input pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageConverter_Convert (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Creates a new image containing the data of the input image converted to the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageConverter_ConvertToBuffer (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, uint8_t *outputImageBuffer, size_t outputImageBufferSize, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Creates a new image containing the data of the input image converted to the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageConverter_Destruct (PEAK_IPL_IMAGE_CONVERTER_HANDLE imageConverterHandle) |
| Destroys the image converter associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_Construct (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE *adaptiveHotpixelCorrectorHandle) |
| Creates an adaptive hotpixel corrector algorithm. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_SetSensitivity (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY sensitivityLevel) |
| Sets the given adaptive hotpixel corrector algorithm's sensitivity. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_GetSensitivity (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY *sensitivityLevel) |
| Queries the given adaptive hotpixel corrector algorithm's current sensitivity. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_SetGainFactorPercent (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, uint32_t gainFactorPercent) |
| Sets the given adaptive hotpixel corrector algorithm's gain factor in percent. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_GetGainFactorPercent (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, uint32_t *gainFactorPercent) |
| Queries the given adaptive hotpixel corrector algorithm's current gain factor in percent. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_Detect (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle) |
| Detects hotpixels in the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_GetHotpixels (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_POINT_2D *hotpixels, size_t *hotpixelsSize) |
| Queries previously detected hotpixels. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_Correct (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle, const PEAK_IPL_POINT_2D *hotpixels, size_t hotpixelsSize, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Corrects the given hotpixels in the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_CorrectAdaptive (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle, PEAK_IPL_IMAGE_HANDLE inputImageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Detects and corrects hotpixels in the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_AdaptiveHotpixelCorrector_Destruct (PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE adaptiveHotpixelCorrectorHandle) |
| Destroys the adaptive hotpixel corrector algorithm associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ColorCorrector_Construct (PEAK_IPL_COLOR_CORRECTOR_HANDLE *colorCorrectorHandle) |
| Creates a color corrector. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ColorCorrector_SetColorCorrectionFactors (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, float *colorCorrectorFactors) |
| Sets the factors of the color correction matrix. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ColorCorrector_GetColorCorrectionFactors (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, float *colorCorrectorFactors, size_t *colorCorrectorFactorsSize) |
| Returns the color corrector 3x3 matrix factors and its size. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ColorCorrector_GetIsPixelFormatSupported (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported) |
| Asks the given color corrector whether it supports the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ColorCorrector_Process (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Corrects the colors of the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ColorCorrector_ProcessInPlace (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle) |
| Corrects the colors of the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ColorCorrector_Destruct (PEAK_IPL_COLOR_CORRECTOR_HANDLE colorCorrectorHandle) |
| Destroys the color corrector associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_Construct (PEAK_IPL_GAIN_HANDLE *gainHandle) |
| Creates a gain. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_SetMasterGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *masterGainValue) |
| Sets the value of the master gain. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetMasterGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *masterGainValue) |
| Returns the master gain value. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetMasterGainMax (PEAK_IPL_GAIN_HANDLE gainHandle, float *masterGainMax) |
| Returns the maximum master gain value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetMasterGainMin (PEAK_IPL_GAIN_HANDLE gainHandle, float *masterGainMin) |
| Returns the minimum master gain value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_SetRedGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *redGainValue) |
| Sets the value of the red gain. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetRedGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *redGainValue) |
| Returns the red gain value. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetRedGainMax (PEAK_IPL_GAIN_HANDLE gainHandle, float *redGainMax) |
| Returns the maximum red gain value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetRedGainMin (PEAK_IPL_GAIN_HANDLE gainHandle, float *redGainMin) |
| Returns the minimum red gain value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_SetGreenGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *greenGainValue) |
| Sets the value of the green gain. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetGreenGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *greenGainValue) |
| Returns the green gain value. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetGreenGainMax (PEAK_IPL_GAIN_HANDLE gainHandle, float *greenGainMax) |
| Returns the maximum green gain value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetGreenGainMin (PEAK_IPL_GAIN_HANDLE gainHandle, float *greenGainMin) |
| Returns the minimum green gain value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_SetBlueGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *blueGainValue) |
| Sets the value of the blue gain. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetBlueGainValue (PEAK_IPL_GAIN_HANDLE gainHandle, float *blueGainValue) |
| Returns the blue gain value. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetBlueGainMax (PEAK_IPL_GAIN_HANDLE gainHandle, float *blueGainMax) |
| Returns the maximum blue gain value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetBlueGainMin (PEAK_IPL_GAIN_HANDLE gainHandle, float *blueGainMin) |
| Returns the minimum blue gain value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_GetIsPixelFormatSupported (PEAK_IPL_GAIN_HANDLE gainHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported) |
| Asks the given gamma corrector whether it supports the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_Process (PEAK_IPL_GAIN_HANDLE gainHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Apply the gain on the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_ProcessInPlace (PEAK_IPL_GAIN_HANDLE gainHandle, PEAK_IPL_IMAGE_HANDLE imageHandle) |
| Apply the gain on the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Gain_Destruct (PEAK_IPL_GAIN_HANDLE gainHandle) |
| Destroys the gain associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_Construct (PEAK_IPL_GAMMA_CORRECTOR_HANDLE *gammaCorrectorHandle) |
| Creates a gamma corrector. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_SetGammaCorrectionValue (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaValue) |
| Sets the value of the gamma correction. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_GetGammaCorrectionValue (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaValue) |
| Returns the gamma corrector value. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_GetGammaCorrectionMax (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaMax) |
| Returns the maximum gamma corrector value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_GetGammaCorrectionMin (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaMin) |
| Returns the minimum gamma corrector value which can be set. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_GetIsPixelFormatSupported (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported) |
| Asks the given gamma corrector whether it supports the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_Process (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Corrects the gammas of the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_ProcessInPlace (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle) |
| Corrects the gammas of the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_GammaCorrector_Destruct (PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle) |
| Destroys the gamma corrector associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_Construct (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t width, size_t height, PEAK_IPL_IMAGE_HANDLE *imageHandle) |
| Creates an image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_ConstructFromBuffer (PEAK_IPL_PIXEL_FORMAT pixelFormat, uint8_t *buffer, uint64_t bufferSize, size_t width, size_t height, PEAK_IPL_IMAGE_HANDLE *imageHandle) |
| Creates an image from a given buffer. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_GetWidth (PEAK_IPL_IMAGE_HANDLE imageHandle, size_t *width) |
| Queries the width of the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_GetHeight (PEAK_IPL_IMAGE_HANDLE imageHandle, size_t *height) |
| Queries the height of the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_GetPixelPointer (PEAK_IPL_IMAGE_HANDLE imageHandle, size_t xPos, size_t yPos, uint8_t **pixelPointer) |
| Queries the pointer to the given pixel position. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_GetByteCount (PEAK_IPL_IMAGE_HANDLE imageHandle, size_t *byteCount) |
| Queries the size of the given image in number of bytes. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_GetPixelFormat (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_PIXEL_FORMAT *pixelFormat) |
| Queries the pixel format of the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_GetData (PEAK_IPL_IMAGE_HANDLE imageHandle, uint8_t **data) |
| Queries the data pointer of the given image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_Clone (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Returns a new created image containing the data of the current image as deep copy. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_ConvertTo (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, PEAK_IPL_CONVERSION_MODE conversionMode, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Creates a new image containing the data of the current image converted to the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_ConvertToBuffer (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_PIXEL_FORMAT outputPixelFormat, uint8_t *outputImageBuffer, size_t outputImageBufferSize, PEAK_IPL_CONVERSION_MODE conversionMode, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Stores the data of the current image converted to the given pixel format into a destination buffer and creates a new image. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Image_Destruct (PEAK_IPL_IMAGE_HANDLE imageHandle) |
| Destroys the image associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_Construct (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE *imageTransformerHandle) |
| Creates an image transformer. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_MirrorUpDown (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Creates a new image containing the data of the current image mirrored in up-down direction. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_MirrorLeftRight (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Creates a new image containing the data of the current image mirrored in left-right direction. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_MirrorUpDownLeftRight (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Creates a new image containing the data of the current image mirrored in up-down and left-right direction. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_MirrorUpDownInPlace (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle) |
| Mirrors the image in up-down direction in place i.e. it will change the input image itself. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_MirrorLeftRightInPlace (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle) |
| Mirrors the image left-right direction in place i.e. it will change the input image itself. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_MirrorUpDownLeftRightInPlace (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle) |
| Mirrors the image in up-down and left-right direction in place i.e. it will change the input image itself. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_Rotate (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle, PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t rotationAngle) |
| Creates a new image containing the data of the current image rotated in direction and value of the rotation angle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_RotateInPlace (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t rotationAngle) |
| Rotates the image in in direction and value of the rotation angle in place i.e. it will change the input image itself. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageTransformer_Destruct (PEAK_IPL_IMAGE_TRANSFORMER_HANDLE imageTransformerHandle) |
| Destroys the image transformer associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Histogram_Construct (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_HISTOGRAM_HANDLE *histogramHandle) |
| Creates a histogram from image data. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Histogram_GetPixelFormat (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, PEAK_IPL_PIXEL_FORMAT *pixelFormat) |
| Queries the pixel format of the given histogram. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Histogram_GetNumChannels (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, size_t *numChannels) |
| Queries the number of the given histogram's channels. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Histogram_GetPixelSumForChannel (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, size_t channelIndex, uint64_t *pixelSum) |
| Queries the pixel sum for the channel with the given index. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Histogram_GetPixelCountForChannel (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, size_t channelIndex, uint64_t *pixelCount) |
| Queries the pixel count for the channel with the given index. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Histogram_GetBinsForChannel (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle, size_t channelIndex, uint64_t *bins, size_t *binsSize) |
| Queries the bin list of the channel with the given index. More... | |
| PEAK_IPL_C_API | PEAK_IPL_Histogram_Destruct (PEAK_IPL_HISTOGRAM_HANDLE histogramHandle) |
| Destroys the histogram associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelLine_Construct (PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_ORIENTATION orientation, size_t offset, PEAK_IPL_PIXEL_LINE_HANDLE *pixelLineHandle) |
| Creates a pixel line depending on the given orientation. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelLine_GetPixelFormat (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, PEAK_IPL_PIXEL_FORMAT *pixelFormat) |
| Queries the pixel format of the given pixel line. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelLine_GetOrientation (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, PEAK_IPL_ORIENTATION *orientation) |
| Queries the orientation of the given pixel line. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelLine_GetOffset (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, size_t *offset) |
| Queries the offset of the given pixel line. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelLine_GetNumChannels (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, size_t *numChannels) |
| Queries the number of the given pixel line's channels. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelLine_GetValuesForChannel (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle, size_t channelIndex, uint32_t *values, size_t *valuesSize) |
| Queries the value list for the channel with the given index. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelLine_Destruct (PEAK_IPL_PIXEL_LINE_HANDLE pixelLineHandle) |
| Destroys the pixel line associated with the given handle. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelFormat_GetNumChannels (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numChannels) |
| Queries the number of channels of the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelFormat_GetNumSignificantBitsPerChannel (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numSignificantBits) |
| Queries the number of significant bits per pixel per channel of the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelFormat_GetNumStorageBitsPerChannel (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numStorageBits) |
| Queries the number of storage bits per pixel per channel of the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelFormat_GetMaximumValuePerChannel (PEAK_IPL_PIXEL_FORMAT pixelFormat, uint32_t *channelMaximumValue) |
| Queries the maximum value of one pixel channel of the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelFormat_GetNumSignificantBitsPerPixel (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numSignificantBits) |
| Queries the number of significant bits per pixel of the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelFormat_GetNumStorageBitsPerPixel (PEAK_IPL_PIXEL_FORMAT pixelFormat, size_t *numStorageBits) |
| Queries the number of storage bits per pixel of the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelFormat_GetEndianness (PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_ENDIANNESS *endianness) |
| Queries the endianness of the given pixel format. More... | |
| PEAK_IPL_C_API | PEAK_IPL_PixelFormat_CalculateStorageSizeOfPixels (PEAK_IPL_PIXEL_FORMAT pixelFormat, uint64_t numPixels, uint64_t *size) |
| Calculates the storage size of the given number of pixels of the given pixel format in bytes. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageWriter_WriteAsRAW (PEAK_IPL_IMAGE_HANDLE inputImageHandle, const char *filePath, size_t filePathSize) |
| Writes an image as raw data binary file. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageWriter_WriteAsBMP (PEAK_IPL_IMAGE_HANDLE inputImageHandle, const char *filePath, size_t filePathSize) |
| Writes an image as BMP image file. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageWriter_WriteAsPNG (PEAK_IPL_IMAGE_HANDLE inputImageHandle, uint32_t quality, const char *filePath, size_t filePathSize) |
| Writes an image as PNG image file. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageWriter_WriteAsJPG (PEAK_IPL_IMAGE_HANDLE inputImageHandle, uint32_t quality, const char *filePath, size_t filePathSize) |
| Writes an image as JPEG image file. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageWriter_Write (PEAK_IPL_IMAGE_HANDLE inputImageHandle, const char *filePath, size_t filePathSize) |
| Writes an image to file and selects the format by file ending. In case the format has parameters, the default parameters are chosen. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageReader_Read (const char *filePath, size_t filePathSize, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Reads an image from a file. Image type is determined by the file ending. More... | |
| PEAK_IPL_C_API | PEAK_IPL_ImageReaderRead_ReadAsPixelFormat (const char *filePath, size_t filePathSize, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_IMAGE_HANDLE *outputImageHandle) |
| Reads an image from a file. Image type is determined by the file ending. More... | |
Copyright (c) 2019, IDS Imaging Development Systems GmbH. All rights reserved.
| #define PEAK_IPL_C_API PEAK_IPL_PUBLIC PEAK_IPL_RETURN_CODE PEAK_IPL_CALL_CONV |
| typedef struct PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR* PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE |
The type of adaptive hotpixel corrector handles.
| typedef int8_t PEAK_IPL_BOOL8 |
| typedef struct PEAK_IPL_COLOR_CORRECTOR* PEAK_IPL_COLOR_CORRECTOR_HANDLE |
The type of color corrector handles.
| typedef int32_t PEAK_IPL_CONVERSION_MODE |
| typedef int32_t PEAK_IPL_ENDIANNESS |
| typedef struct PEAK_IPL_GAIN* PEAK_IPL_GAIN_HANDLE |
The type of gamma corrector handles.
| typedef struct PEAK_IPL_GAMMA_CORRECTOR* PEAK_IPL_GAMMA_CORRECTOR_HANDLE |
The type of gamma corrector handles.
| typedef struct PEAK_IPL_HISTOGRAM* PEAK_IPL_HISTOGRAM_HANDLE |
The type of histogram handles.
| typedef int32_t PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY |
| typedef struct PEAK_IPL_IMAGE_CONVERTER* PEAK_IPL_IMAGE_CONVERTER_HANDLE |
The type of image converter handles.
| typedef struct PEAK_IPL_IMAGE* PEAK_IPL_IMAGE_HANDLE |
The type of image handles.
| typedef struct PEAK_IPL_IMAGE_transformer* PEAK_IPL_IMAGE_TRANSFORMER_HANDLE |
The type of image transformer handles.
| typedef uint16_t PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE |
| typedef int32_t PEAK_IPL_ORIENTATION |
| typedef int32_t PEAK_IPL_PIXEL_FORMAT |
| typedef struct PEAK_IPL_PIXEL_LINE* PEAK_IPL_PIXEL_LINE_HANDLE |
The type of pixel line handles.
| typedef int32_t PEAK_IPL_RETURN_CODE |
Sensitivity parameter for the hotpixel correction algorithm
The enum holding the possible pixel formats.
The enum holding the possible function return codes.
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_Construct | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE * | adaptiveHotpixelCorrectorHandle | ) |
Creates an adaptive hotpixel corrector algorithm.
| [out] | adaptiveHotpixelCorrectorHandle | The handle to the created adaptive hotpixel corrector algorithm. |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_Correct | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle, |
| PEAK_IPL_IMAGE_HANDLE | inputImageHandle, | ||
| const PEAK_IPL_POINT_2D * | hotpixels, | ||
| size_t | hotpixelsSize, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Corrects the given hotpixels in the given image.
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| [in] | inputImageHandle | The handle to the input image. |
| [in] | hotpixels | The list of hotpixels to be corrected. |
| [in] | hotpixelsSize | Size of the given hotpixels list. |
| [out] | outputImageHandle | The handle associated with the image containing the corrected data. |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_CorrectAdaptive | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle, |
| PEAK_IPL_IMAGE_HANDLE | inputImageHandle, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Detects and corrects hotpixels in the given image.
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| [in] | inputImageHandle | The handle to the input image. |
| [out] | outputImageHandle | The handle associated with the image containing the corrected data. |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_Destruct | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle | ) |
Destroys the adaptive hotpixel corrector algorithm associated with the given handle.
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_Detect | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle, |
| PEAK_IPL_IMAGE_HANDLE | inputImageHandle | ||
| ) |
Detects hotpixels in the given image.
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| [in] | inputImageHandle | The handle to the input image. |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_GetGainFactorPercent | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle, |
| uint32_t * | gainFactorPercent | ||
| ) |
Queries the given adaptive hotpixel corrector algorithm's current gain factor in percent.
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| [out] | gainFactorPercent | The current gain factor in percent. |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_GetHotpixels | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle, |
| PEAK_IPL_POINT_2D * | hotpixels, | ||
| size_t * | hotpixelsSize | ||
| ) |
Queries previously detected hotpixels.
For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| [out] | hotpixels | The list of hotpixels. |
| [in,out] | hotpixelsSize | IN: Size of the given buffer - OUT: Size of the queried data |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_GetSensitivity | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle, |
| PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY * | sensitivityLevel | ||
| ) |
Queries the given adaptive hotpixel corrector algorithm's current sensitivity.
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| [out] | sensitivityLevel | The current sensitivity level factor. |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_SetGainFactorPercent | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle, |
| uint32_t | gainFactorPercent | ||
| ) |
Sets the given adaptive hotpixel corrector algorithm's gain factor in percent.
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| [in] | gainFactorPercent | The gain factor in percent to set. |
| PEAK_IPL_C_API PEAK_IPL_AdaptiveHotpixelCorrector_SetSensitivity | ( | PEAK_IPL_ADAPTIVE_HOTPIXEL_CORRECTOR_HANDLE | adaptiveHotpixelCorrectorHandle, |
| PEAK_IPL_HOTPIXELCORRECTION_SENSITIVITY | sensitivityLevel | ||
| ) |
Sets the given adaptive hotpixel corrector algorithm's sensitivity.
| [in] | adaptiveHotpixelCorrectorHandle | The handle to the adaptive hotpixel corrector algorithm of interest. |
| [in] | sensitivityLevel | The sensitivity level to set. |
| PEAK_IPL_C_API PEAK_IPL_ColorCorrector_Construct | ( | PEAK_IPL_COLOR_CORRECTOR_HANDLE * | colorCorrectorHandle | ) |
Creates a color corrector.
| [out] | colorCorrectorHandle | The handle to the created color corrector. |
| PEAK_IPL_C_API PEAK_IPL_ColorCorrector_Destruct | ( | PEAK_IPL_COLOR_CORRECTOR_HANDLE | colorCorrectorHandle | ) |
Destroys the color corrector associated with the given handle.
| [in] | colorCorrectorHandle | The handle to the color corrector to destroy. |
| PEAK_IPL_C_API PEAK_IPL_ColorCorrector_GetColorCorrectionFactors | ( | PEAK_IPL_COLOR_CORRECTOR_HANDLE | colorCorrectorHandle, |
| float * | colorCorrectorFactors, | ||
| size_t * | colorCorrectorFactorsSize | ||
| ) |
Returns the color corrector 3x3 matrix factors and its size.
| [in] | colorCorrectorHandle | The handle to the color corrector |
| [out] | colorCorrectorFactors | The current color corrector factors. |
| [out] | colorCorrectorFactorsSize | The current color corrector factors size, default 3x3 = 9. |
| PEAK_IPL_C_API PEAK_IPL_ColorCorrector_GetIsPixelFormatSupported | ( | PEAK_IPL_COLOR_CORRECTOR_HANDLE | colorCorrectorHandle, |
| PEAK_IPL_PIXEL_FORMAT | pixelFormat, | ||
| PEAK_IPL_BOOL8 * | isPixelFormatSupported | ||
| ) |
Asks the given color corrector whether it supports the given pixel format.
| [in] | colorCorrectorHandle | The handle to the color corrector to use. |
| [in] | pixelFormat | The pixel format of interest. |
| [out] | isPixelFormatSupported | The flag telling whether the given pixel format is supported. |
| PEAK_IPL_C_API PEAK_IPL_ColorCorrector_Process | ( | PEAK_IPL_COLOR_CORRECTOR_HANDLE | colorCorrectorHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Corrects the colors of the given image.
| [in] | colorCorrectorHandle | The handle to the color corrector to use. |
| [in] | imageHandle | The handle to the image on which the color correction matrix is applied. |
| [out] | outputImageHandle | The handle to the image on which the color correction matrix was applied. |
| PEAK_IPL_C_API PEAK_IPL_ColorCorrector_ProcessInPlace | ( | PEAK_IPL_COLOR_CORRECTOR_HANDLE | colorCorrectorHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle | ||
| ) |
Corrects the colors of the given image.
| [in] | colorCorrectorHandle | The handle to the color corrector to use. |
| [in] | imageHandle | The handle to the image on which the color correction matrix is applied. |
| PEAK_IPL_C_API PEAK_IPL_ColorCorrector_SetColorCorrectionFactors | ( | PEAK_IPL_COLOR_CORRECTOR_HANDLE | colorCorrectorHandle, |
| float * | colorCorrectorFactors | ||
| ) |
Sets the factors of the color correction matrix.
| [in] | colorCorrectorHandle | The handle to the color corrector. |
| [in] | colorCorrectorFactors | The color corrector factors that are set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_Construct | ( | PEAK_IPL_GAIN_HANDLE * | gainHandle | ) |
Creates a gain.
| [out] | gainHandle | The handle to the created gain. |
| PEAK_IPL_C_API PEAK_IPL_Gain_Destruct | ( | PEAK_IPL_GAIN_HANDLE | gainHandle | ) |
Destroys the gain associated with the given handle.
| [in] | gainHandle | The handle to the gamma corrector to destroy. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetBlueGainMax | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | blueGainMax | ||
| ) |
Returns the maximum blue gain value which can be set.
| [in] | gainHandle | The handle to the gain |
| [out] | blueGainMax | The maximum blue gain value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetBlueGainMin | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | blueGainMin | ||
| ) |
Returns the minimum blue gain value which can be set.
| [in] | gainHandle | The handle to the master gain |
| [out] | blueGainMin | The minimum blue gain value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetBlueGainValue | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | blueGainValue | ||
| ) |
Returns the blue gain value.
| [in] | gainHandle | The handle to the gain |
| [out] | blueGainValue | The current blue gain value. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetGreenGainMax | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | greenGainMax | ||
| ) |
Returns the maximum green gain value which can be set.
| [in] | gainHandle | The handle to the gain |
| [out] | greenGainMax | The maximum green gain value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetGreenGainMin | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | greenGainMin | ||
| ) |
Returns the minimum green gain value which can be set.
| [in] | gainHandle | The handle to the master gain |
| [out] | greenGainMin | The minimum green gain value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetGreenGainValue | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | greenGainValue | ||
| ) |
Returns the green gain value.
| [in] | gainHandle | The handle to the gain |
| [out] | greenGainValue | The current green gain value. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetIsPixelFormatSupported | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| PEAK_IPL_PIXEL_FORMAT | pixelFormat, | ||
| PEAK_IPL_BOOL8 * | isPixelFormatSupported | ||
| ) |
Asks the given gamma corrector whether it supports the given pixel format.
| [in] | gainHandle | The handle to the gamma corrector to use. |
| [in] | pixelFormat | The pixel format of interest. |
| [out] | isPixelFormatSupported | The flag telling whether the given pixel format is supported. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetMasterGainMax | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | masterGainMax | ||
| ) |
Returns the maximum master gain value which can be set.
| [in] | gainHandle | The handle to the gain |
| [out] | masterGainMax | The maximum master gain value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetMasterGainMin | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | masterGainMin | ||
| ) |
Returns the minimum master gain value which can be set.
| [in] | gainHandle | The handle to the master gain |
| [out] | masterGainMin | The minimum master gain value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetMasterGainValue | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | masterGainValue | ||
| ) |
Returns the master gain value.
| [in] | gainHandle | The handle to the gain |
| [out] | masterGainValue | The current master gain value. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetRedGainMax | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | redGainMax | ||
| ) |
Returns the maximum red gain value which can be set.
| [in] | gainHandle | The handle to the gain |
| [out] | redGainMax | The maximum red gain value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetRedGainMin | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | redGainMin | ||
| ) |
Returns the minimum red gain value which can be set.
| [in] | gainHandle | The handle to the master gain |
| [out] | redGainMin | The minimum red gain value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_GetRedGainValue | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | redGainValue | ||
| ) |
Returns the red gain value.
| [in] | gainHandle | The handle to the gain |
| [out] | redGainValue | The current red gain value. |
| PEAK_IPL_C_API PEAK_IPL_Gain_Process | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Apply the gain on the given image.
| [in] | gainHandle | The handle to the gamma corrector to use. |
| [in] | imageHandle | The handle to the image on which the gamma correction matrix is applied. |
| [out] | outputImageHandle | The handle to the image on which the gamma correction matrix was applied. |
| PEAK_IPL_C_API PEAK_IPL_Gain_ProcessInPlace | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle | ||
| ) |
Apply the gain on the given image.
| [in] | gainHandle | The handle to the gamma corrector to use. |
| [in] | imageHandle | The handle to the image on which the gamma correction matrix is applied. |
| PEAK_IPL_C_API PEAK_IPL_Gain_SetBlueGainValue | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | blueGainValue | ||
| ) |
Sets the value of the blue gain.
| [in] | gainHandle | The handle to the gain. |
| [in] | blueGainValue | The blue gain value that is set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_SetGreenGainValue | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | greenGainValue | ||
| ) |
Sets the value of the green gain.
| [in] | gainHandle | The handle to the gain. |
| [in] | greenGainValue | The green gain value that is set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_SetMasterGainValue | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | masterGainValue | ||
| ) |
Sets the value of the master gain.
| [in] | gainHandle | The handle to the gain. |
| [in] | masterGainValue | The master gain value that is set. |
| PEAK_IPL_C_API PEAK_IPL_Gain_SetRedGainValue | ( | PEAK_IPL_GAIN_HANDLE | gainHandle, |
| float * | redGainValue | ||
| ) |
Sets the value of the red gain.
| [in] | gainHandle | The handle to the gain. |
| [in] | redGainValue | The red gain value that is set. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Construct | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE * | gammaCorrectorHandle | ) |
Creates a gamma corrector.
| [out] | gammaCorrectorHandle | The handle to the created gamma corrector. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Destruct | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE | gammaCorrectorHandle | ) |
Destroys the gamma corrector associated with the given handle.
| [in] | gammaCorrectorHandle | The handle to the gamma corrector to destroy. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionMax | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE | gammaCorrectorHandle, |
| float * | gammaMax | ||
| ) |
Returns the maximum gamma corrector value which can be set.
| [in] | gammaCorrectorHandle | The handle to the gamma corrector |
| [out] | gammaMax | The maximum gamma corrector value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionMin | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE | gammaCorrectorHandle, |
| float * | gammaMin | ||
| ) |
Returns the minimum gamma corrector value which can be set.
| [in] | gammaCorrectorHandle | The handle to the gamma corrector |
| [out] | gammaMin | The minimum gamma corrector value which can be set. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionValue | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE | gammaCorrectorHandle, |
| float * | gammaValue | ||
| ) |
Returns the gamma corrector value.
| [in] | gammaCorrectorHandle | The handle to the gamma corrector |
| [out] | gammaValue | The current gamma corrector value. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetIsPixelFormatSupported | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE | gammaCorrectorHandle, |
| PEAK_IPL_PIXEL_FORMAT | pixelFormat, | ||
| PEAK_IPL_BOOL8 * | isPixelFormatSupported | ||
| ) |
Asks the given gamma corrector whether it supports the given pixel format.
| [in] | gammaCorrectorHandle | The handle to the gamma corrector to use. |
| [in] | pixelFormat | The pixel format of interest. |
| [out] | isPixelFormatSupported | The flag telling whether the given pixel format is supported. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Process | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE | gammaCorrectorHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Corrects the gammas of the given image.
| [in] | gammaCorrectorHandle | The handle to the gamma corrector to use. |
| [in] | imageHandle | The handle to the image on which the gamma correction matrix is applied. |
| [out] | outputImageHandle | The handle to the image on which the gamma correction matrix was applied. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_ProcessInPlace | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE | gammaCorrectorHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle | ||
| ) |
Corrects the gammas of the given image.
| [in] | gammaCorrectorHandle | The handle to the gamma corrector to use. |
| [in] | imageHandle | The handle to the image on which the gamma correction matrix is applied. |
| PEAK_IPL_C_API PEAK_IPL_GammaCorrector_SetGammaCorrectionValue | ( | PEAK_IPL_GAMMA_CORRECTOR_HANDLE | gammaCorrectorHandle, |
| float * | gammaValue | ||
| ) |
Sets the value of the gamma correction.
| [in] | gammaCorrectorHandle | The handle to the gamma corrector. |
| [in] | gammaValue | The gamma corrector value that are set. |
| PEAK_IPL_C_API PEAK_IPL_Histogram_Construct | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| PEAK_IPL_HISTOGRAM_HANDLE * | histogramHandle | ||
| ) |
Creates a histogram from image data.
| [in] | imageHandle | The handle to the image of interest. |
| [out] | histogramHandle | The handle to the created histogram. |
| PEAK_IPL_C_API PEAK_IPL_Histogram_Destruct | ( | PEAK_IPL_HISTOGRAM_HANDLE | histogramHandle | ) |
Destroys the histogram associated with the given handle.
| [in] | histogramHandle | The handle to the histogram to destroy. |
| PEAK_IPL_C_API PEAK_IPL_Histogram_GetBinsForChannel | ( | PEAK_IPL_HISTOGRAM_HANDLE | histogramHandle, |
| size_t | channelIndex, | ||
| uint64_t * | bins, | ||
| size_t * | binsSize | ||
| ) |
Queries the bin list of the channel with the given index.
For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().
| [in] | histogramHandle | The handle to the histogram of interest. |
| [in] | channelIndex | The index of the channel of interest. |
| [out] | bins | The bin list of the given channel. |
| [in,out] | binsSize | IN: Size of the given buffer - OUT: Size of the queried data |
| PEAK_IPL_C_API PEAK_IPL_Histogram_GetNumChannels | ( | PEAK_IPL_HISTOGRAM_HANDLE | histogramHandle, |
| size_t * | numChannels | ||
| ) |
Queries the number of the given histogram's channels.
| [in] | histogramHandle | The handle to the histogram of interest. |
| [out] | numChannels | The number of channels. |
| PEAK_IPL_C_API PEAK_IPL_Histogram_GetPixelCountForChannel | ( | PEAK_IPL_HISTOGRAM_HANDLE | histogramHandle, |
| size_t | channelIndex, | ||
| uint64_t * | pixelCount | ||
| ) |
Queries the pixel count for the channel with the given index.
| [in] | histogramHandle | The handle to the histogram of interest. |
| [in] | channelIndex | The index of the channel of interest. |
| [out] | pixelCount | The pixel count of the given channel. |
| PEAK_IPL_C_API PEAK_IPL_Histogram_GetPixelFormat | ( | PEAK_IPL_HISTOGRAM_HANDLE | histogramHandle, |
| PEAK_IPL_PIXEL_FORMAT * | pixelFormat | ||
| ) |
Queries the pixel format of the given histogram.
| [in] | histogramHandle | The handle to the histogram of interest. |
| [out] | pixelFormat | The pixel format. |
| PEAK_IPL_C_API PEAK_IPL_Histogram_GetPixelSumForChannel | ( | PEAK_IPL_HISTOGRAM_HANDLE | histogramHandle, |
| size_t | channelIndex, | ||
| uint64_t * | pixelSum | ||
| ) |
Queries the pixel sum for the channel with the given index.
| [in] | histogramHandle | The handle to the histogram of interest. |
| [in] | channelIndex | The index of the channel of interest. |
| [out] | pixelSum | The pixel sum of the given channel. |
| PEAK_IPL_C_API PEAK_IPL_Image_Clone | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Returns a new created image containing the data of the current image as deep copy.
| [in] | imageHandle | The handle to the image of interest. |
| [out] | outputImageHandle | The handle associated with the image containing the converted data. |
| PEAK_IPL_C_API PEAK_IPL_Image_Construct | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| size_t | width, | ||
| size_t | height, | ||
| PEAK_IPL_IMAGE_HANDLE * | imageHandle | ||
| ) |
Creates an image.
| [in] | pixelFormat | The desired pixel format of the image. |
| [in] | width | The desired width of the image. |
| [in] | height | The desired height of the image. |
| [out] | imageHandle | The handle to the created image. |
| PEAK_IPL_C_API PEAK_IPL_Image_ConstructFromBuffer | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| uint8_t * | buffer, | ||
| uint64_t | bufferSize, | ||
| size_t | width, | ||
| size_t | height, | ||
| PEAK_IPL_IMAGE_HANDLE * | imageHandle | ||
| ) |
Creates an image from a given buffer.
| [in] | pixelFormat | The desired pixel format of the image. |
| [in] | buffer | The buffer to use for the image. |
| [in] | bufferSize | The size of *buffer. |
| [in] | width | The desired width of the image in pixels. |
| [in] | height | The desired height of the image in lines. |
| [out] | imageHandle | The handle to the created image. |
| PEAK_IPL_C_API PEAK_IPL_Image_ConvertTo | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| PEAK_IPL_PIXEL_FORMAT | outputPixelFormat, | ||
| PEAK_IPL_CONVERSION_MODE | conversionMode, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Creates a new image containing the data of the current image converted to the given pixel format.
| [in] | imageHandle | The handle to the image of interest. |
| [in] | outputPixelFormat | The output pixel format. |
| [in] | conversionMode | The conversion mode. |
| [out] | outputImageHandle | The handle associated with the image containing the converted data. |
| PEAK_IPL_C_API PEAK_IPL_Image_ConvertToBuffer | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| PEAK_IPL_PIXEL_FORMAT | outputPixelFormat, | ||
| uint8_t * | outputImageBuffer, | ||
| size_t | outputImageBufferSize, | ||
| PEAK_IPL_CONVERSION_MODE | conversionMode, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Stores the data of the current image converted to the given pixel format into a destination buffer and creates a new image.
| [in] | imageHandle | The handle to the image of interest. |
| [in] | outputPixelFormat | The output pixel format. |
| [out] | outputImageBuffer | Pointer to the destination buffer. |
| [in] | outputImageBufferSize | Size of the destination buffer. |
| [in] | conversionMode | The conversion mode. |
| [out] | outputImageHandle | The handle associated with the image containing the converted data. |
| PEAK_IPL_C_API PEAK_IPL_Image_Destruct | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle | ) |
Destroys the image associated with the given handle.
| [in] | imageHandle | The handle to the image to destroy. |
| PEAK_IPL_C_API PEAK_IPL_Image_GetByteCount | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| size_t * | byteCount | ||
| ) |
Queries the size of the given image in number of bytes.
| [in] | imageHandle | The handle to the image of interest. |
| [out] | byteCount | The size of the given image in number of bytes. |
| PEAK_IPL_C_API PEAK_IPL_Image_GetData | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| uint8_t ** | data | ||
| ) |
Queries the data pointer of the given image.
| [in] | imageHandle | The handle to the image of interest. |
| [out] | data | The data pointer of the given image. |
| PEAK_IPL_C_API PEAK_IPL_Image_GetHeight | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| size_t * | height | ||
| ) |
Queries the height of the given image.
| [in] | imageHandle | The handle to the image of interest. |
| [out] | height | The height of the image in lines. |
| PEAK_IPL_C_API PEAK_IPL_Image_GetPixelFormat | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| PEAK_IPL_PIXEL_FORMAT * | pixelFormat | ||
| ) |
Queries the pixel format of the given image.
| [in] | imageHandle | The handle to the image of interest. |
| [out] | pixelFormat | The pixel format of the given image. |
| PEAK_IPL_C_API PEAK_IPL_Image_GetPixelPointer | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| size_t | xPos, | ||
| size_t | yPos, | ||
| uint8_t ** | pixelPointer | ||
| ) |
Queries the pointer to the given pixel position.
| [in] | imageHandle | The handle to the image of interest. |
| [in] | xPos | The x position of the pixel of interest. |
| [in] | yPos | The y position of the pixel of interest. |
| [out] | pixelPointer | The pointer to the given pixel position. |
| PEAK_IPL_C_API PEAK_IPL_Image_GetWidth | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| size_t * | width | ||
| ) |
Queries the width of the given image.
| [in] | imageHandle | The handle to the image of interest. |
| [out] | width | The width of the image in pixels. |
| PEAK_IPL_C_API PEAK_IPL_ImageConverter_Construct | ( | PEAK_IPL_IMAGE_CONVERTER_HANDLE * | imageConverterHandle | ) |
Creates an image converter.
| [out] | imageConverterHandle | The handle to the created image converter. |
| PEAK_IPL_C_API PEAK_IPL_ImageConverter_Convert | ( | PEAK_IPL_IMAGE_CONVERTER_HANDLE | imageConverterHandle, |
| PEAK_IPL_IMAGE_HANDLE | inputImageHandle, | ||
| PEAK_IPL_PIXEL_FORMAT | outputPixelFormat, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Creates a new image containing the data of the input image converted to the given pixel format.
| [in] | imageConverterHandle | The handle to the image converter of interest. |
| [in] | inputImageHandle | The handle to the created image. |
| [in] | outputPixelFormat | The output pixel format. |
| [out] | outputImageHandle | The handle associated with the image containing the converted data. |
| PEAK_IPL_C_API PEAK_IPL_ImageConverter_ConvertToBuffer | ( | PEAK_IPL_IMAGE_CONVERTER_HANDLE | imageConverterHandle, |
| PEAK_IPL_IMAGE_HANDLE | inputImageHandle, | ||
| PEAK_IPL_PIXEL_FORMAT | outputPixelFormat, | ||
| uint8_t * | outputImageBuffer, | ||
| size_t | outputImageBufferSize, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Creates a new image containing the data of the input image converted to the given pixel format.
| [in] | imageConverterHandle | The handle to the image converter of interest. |
| [in] | inputImageHandle | The handle to the input image. |
| [in] | outputPixelFormat | The output pixel format. |
| [out] | outputImageBuffer | Pointer to the destination buffer. |
| [in] | outputImageBufferSize | Size of the destination buffer. |
| [out] | outputImageHandle | The handle associated with the image containing the converted data. |
| PEAK_IPL_C_API PEAK_IPL_ImageConverter_Destruct | ( | PEAK_IPL_IMAGE_CONVERTER_HANDLE | imageConverterHandle | ) |
Destroys the image converter associated with the given handle.
| [in] | imageConverterHandle | The handle to the image converter of interest. |
| PEAK_IPL_C_API PEAK_IPL_ImageConverter_GetConversionMode | ( | PEAK_IPL_IMAGE_CONVERTER_HANDLE | imageConverterHandle, |
| PEAK_IPL_CONVERSION_MODE * | conversionMode | ||
| ) |
Queries the given image converter's current conversion mode.
| [in] | imageConverterHandle | The handle to the image converter of interest. |
| [out] | conversionMode | The current conversion mode. |
| PEAK_IPL_C_API PEAK_IPL_ImageConverter_GetSupportedOutputPixelFormats | ( | PEAK_IPL_IMAGE_CONVERTER_HANDLE | imageConverterHandle, |
| PEAK_IPL_PIXEL_FORMAT | inputPixelFormat, | ||
| PEAK_IPL_PIXEL_FORMAT * | outputPixelFormats, | ||
| size_t * | outputPixelFormatsSize | ||
| ) |
Queries the supported output pixel formats for a given input pixel format.
For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().
| [in] | imageConverterHandle | The handle to the image converter of interest. |
| [in] | inputPixelFormat | The input pixel format. |
| [out] | outputPixelFormats | The list of supported output pixel formats. |
| [in,out] | outputPixelFormatsSize | IN: Size of the given buffer - OUT: Size of the queried data |
| PEAK_IPL_C_API PEAK_IPL_ImageConverter_SetConversionMode | ( | PEAK_IPL_IMAGE_CONVERTER_HANDLE | imageConverterHandle, |
| PEAK_IPL_CONVERSION_MODE | conversionMode | ||
| ) |
Sets the given image converter's conversion mode.
| [in] | imageConverterHandle | The handle to the image converter of interest. |
| [in] | conversionMode | The conversion mode to set. |
| PEAK_IPL_C_API PEAK_IPL_ImageReader_Read | ( | const char * | filePath, |
| size_t | filePathSize, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Reads an image from a file. Image type is determined by the file ending.
| [in] | filePath | The file to read from. |
| [in] | filePathSize | The size of the given string. |
| [out] | outputImageHandle | The handle to the read image. |
| PEAK_IPL_C_API PEAK_IPL_ImageReaderRead_ReadAsPixelFormat | ( | const char * | filePath, |
| size_t | filePathSize, | ||
| PEAK_IPL_PIXEL_FORMAT | pixelFormat, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Reads an image from a file. Image type is determined by the file ending.
| [in] | filePath | The file to read from. |
| [in] | filePathSize | The size of the given string. |
| [in] | pixelFormat | The pixel format of the data to read. |
| [out] | outputImageHandle | The handle to read image. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_Construct | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE * | imageTransformerHandle | ) |
Creates an image transformer.
| [out] | imageTransformerHandle | The handle to the created image transformer. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_Destruct | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle | ) |
Destroys the image transformer associated with the given handle.
| [in] | imageTransformerHandle | The handle to the image converter of interest. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorLeftRight | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Creates a new image containing the data of the current image mirrored in left-right direction.
If the transformed image is a bayer-format image and the number of columns is even, the format will change. (e.g. BayerBG8 -> BayerGB8)
| [in] | imageTransformerHandle | The handle to the image transformer to use. |
| [in] | imageHandle | The handle to the created image. |
| [out] | outputImageHandle | The handle associated with the image containing the converted data. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorLeftRightInPlace | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle | ||
| ) |
Mirrors the image left-right direction in place i.e. it will change the input image itself.
If the transformed image is a bayer-format image and the number of columns is even, the format will change. (e.g. BayerBG8 -> BayerGB8)
| [in] | imageTransformerHandle | The handle to the image transformer to use. |
| [in,out] | imageHandle | The handle to the image to be mirrored. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorUpDown | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Creates a new image containing the data of the current image mirrored in up-down direction.
If the transformed image is a bayer-format image and the number of rows is even, the format will change. (e.g. BayerBG8 -> BayerGR8)
| [in] | imageTransformerHandle | The handle to the image transformer to use. |
| [in] | imageHandle | The handle to the created image. |
| [out] | outputImageHandle | The handle associated with the image containing the converted data. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorUpDownInPlace | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle | ||
| ) |
Mirrors the image in up-down direction in place i.e. it will change the input image itself.
If the transformed image is a bayer-format image and the number of rows is even, the format will change. (e.g. BayerBG8 -> BayerGR8)
| [in] | imageTransformerHandle | The handle to the image transformer to use. |
| [in,out] | imageHandle | The handle to the image to be mirrored. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorUpDownLeftRight | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle | ||
| ) |
Creates a new image containing the data of the current image mirrored in up-down and left-right direction.
If the transformed image is a bayer-format image and the number of rows or columns are even, the format will change. (e.g. BayerBG8 -> BayerRG8)
| [in] | imageTransformerHandle | The handle to the image transformer to use. |
| [in] | imageHandle | The handle to the created image. |
| [out] | outputImageHandle | The handle associated with the image containing the converted data. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_MirrorUpDownLeftRightInPlace | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle | ||
| ) |
Mirrors the image in up-down and left-right direction in place i.e. it will change the input image itself.
If the transformed image is a bayer-format image and the number of rows or columns are even, the format will change. (e.g. BayerBG8 -> BayerRG8)
| [in] | imageTransformerHandle | The handle to the image transformer to use. |
| [in,out] | imageHandle | The handle to the image to be mirrored. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_Rotate | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle, | ||
| PEAK_IPL_IMAGE_HANDLE * | outputImageHandle, | ||
| PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t | rotationAngle | ||
| ) |
Creates a new image containing the data of the current image rotated in direction and value of the rotation angle.
If the transformed image is a bayer-format image and the number of rows or columns are even, the format will change. (e.g. 90_COUNTERCLOCKWISE & an image with even width: BayerGB8 -> BayerBG8)
| [in] | imageTransformerHandle | The handle to the image transformer to use. |
| [in] | imageHandle | The handle to the created image. |
| [in] | rotationAngle | The rotation angle for the image transformer rotation algorithm |
| [out] | outputImageHandle | The handle associated with the image containing the rotated data. |
| PEAK_IPL_C_API PEAK_IPL_ImageTransformer_RotateInPlace | ( | PEAK_IPL_IMAGE_TRANSFORMER_HANDLE | imageTransformerHandle, |
| PEAK_IPL_IMAGE_HANDLE | imageHandle, | ||
| PEAK_IPL_IMAGE_TRANSFORMER_ROTATION_ANGLE_t | rotationAngle | ||
| ) |
Rotates the image in in direction and value of the rotation angle in place i.e. it will change the input image itself.
If the transformed image is a bayer-format image and the number of rows or columns are even, the format will change. (e.g. 90_COUNTERCLOCKWISE & an image with even width: BayerGB8 -> BayerBG8)
| [in] | imageTransformerHandle | The handle to the image transformer to use. |
| [in] | rotationAngle | The rotation angle for the image transformer rotation algorithm |
| [in,out] | imageHandle | The handle to the image to be mirrored. |
| PEAK_IPL_C_API PEAK_IPL_ImageWriter_Write | ( | PEAK_IPL_IMAGE_HANDLE | inputImageHandle, |
| const char * | filePath, | ||
| size_t | filePathSize | ||
| ) |
Writes an image to file and selects the format by file ending. In case the format has parameters, the default parameters are chosen.
| [in] | inputImageHandle | The handle to the image to save. |
| [in] | filePath | The file to write the given image to. |
| [in] | filePathSize | The size of the given string. |
| PEAK_IPL_C_API PEAK_IPL_ImageWriter_WriteAsBMP | ( | PEAK_IPL_IMAGE_HANDLE | inputImageHandle, |
| const char * | filePath, | ||
| size_t | filePathSize | ||
| ) |
Writes an image as BMP image file.
Supported for the following formats: MONO_8, MONO_10, MONO_12, RGB_8, RGB_10, BGR_8, BGR_10, RGBA_8, BGRA_8, RGB_10_PACKED_32, BGR_10_PACKED_32 Written as MONO: BAYER_GR_8, BAYER_RG_8, BAYER_GB_8, BAYER_BG_8, BAYER_GR_10, BAYER_RG_10, BAYER_GB_10, BAYER_BG_10
| [in] | inputImageHandle | The handle to the image to save. |
| [in] | filePath | The file to write the given image to. |
| [in] | filePathSize | The size of the given string. |
| PEAK_IPL_C_API PEAK_IPL_ImageWriter_WriteAsJPG | ( | PEAK_IPL_IMAGE_HANDLE | inputImageHandle, |
| uint32_t | quality, | ||
| const char * | filePath, | ||
| size_t | filePathSize | ||
| ) |
Writes an image as JPEG image file.
Supported for the following formats: MONO_8, RGB_8, BGR_8, RGBA_8, BGRA_8 Written as MONO: BAYER_GR_8, BAYER_RG_8, BAYER_GB_8, BAYER_BG_8
| [in] | inputImageHandle | The handle to the image to save. |
| [in] | quality | Specifies the output image quality from 0 to 100. |
| [in] | filePath | The file to write the given image to. |
| [in] | filePathSize | The size of the given string. |
| PEAK_IPL_C_API PEAK_IPL_ImageWriter_WriteAsPNG | ( | PEAK_IPL_IMAGE_HANDLE | inputImageHandle, |
| uint32_t | quality, | ||
| const char * | filePath, | ||
| size_t | filePathSize | ||
| ) |
Writes an image as PNG image file.
Supported for following formats: MONO_8, MONO_10, MONO_12, RGB_8, RGB_10, RGB_12, RGBA_8, RGBA_10, RGBA_12 Written as MONO: BAYER_GR_8, BAYER_RG_8, BAYER_GB_8, BAYER_BG_8, BAYER_GR_10, BAYER_RG_10, BAYER_GB_10, BAYER_BG_10, BAYER_GR_12, BAYER_RG_12, BAYER_GB_12, BAYER_BG_12 Written as RGB: BGR_8, BGR_10, BGR_12, BGRA_8, BGRA_10, BGRA_12
| [in] | inputImageHandle | The handle to the image to save. |
| [in] | quality | Specifies the output image quality from 0 to 100. |
| [in] | filePath | The file to write the given image to. |
| [in] | filePathSize | The size of the given string. |
| PEAK_IPL_C_API PEAK_IPL_ImageWriter_WriteAsRAW | ( | PEAK_IPL_IMAGE_HANDLE | inputImageHandle, |
| const char * | filePath, | ||
| size_t | filePathSize | ||
| ) |
Writes an image as raw data binary file.
This is supported by all formats.
| [in] | inputImageHandle | The handle to the image to save. |
| [in] | filePath | The file to write the given image to. |
| [in] | filePathSize | The size of the given string. |
| PEAK_IPL_C_API PEAK_IPL_Library_GetLastError | ( | PEAK_IPL_RETURN_CODE * | lastErrorCode, |
| char * | lastErrorDescription, | ||
| size_t * | lastErrorDescriptionSize | ||
| ) |
Queries the last error.
This function is normally used by applying a two-step procedure. First of all, you call the function with all arguments except of lastErrorDescription.
The function then gives you the last error code and the size of the error description. You could stop now if you only want to query the last error code. If you want to query the error description as well, you have to go on.
This two-step procedure may not be necessary if you just pass a buffer big enough for holding the description at the first function call.
| [out] | lastErrorCode | The last function error code. |
| [out] | lastErrorDescription | The description for the last error. |
| [in,out] | lastErrorDescriptionSize | IN: Size of the given buffer - OUT: Size of the queried data |
| PEAK_IPL_C_API PEAK_IPL_Library_GetVersionMajor | ( | uint32_t * | libraryVersionMajor | ) |
Queries the library major version.
| [out] | libraryVersionMajor | The major version of the library. |
| PEAK_IPL_C_API PEAK_IPL_Library_GetVersionMinor | ( | uint32_t * | libraryVersionMinor | ) |
Queries the library minor version.
| [out] | libraryVersionMinor | The minor version of the library. |
| PEAK_IPL_C_API PEAK_IPL_Library_GetVersionSubminor | ( | uint32_t * | libraryVersionSubminor | ) |
Queries the library subminor version.
| [out] | libraryVersionSubminor | The subminor version of the library. |
| PEAK_IPL_C_API PEAK_IPL_PixelFormat_CalculateStorageSizeOfPixels | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| uint64_t | numPixels, | ||
| uint64_t * | size | ||
| ) |
Calculates the storage size of the given number of pixels of the given pixel format in bytes.
| [in] | pixelFormat | The pixel format of interest. |
| [in] | numPixels | The number of pixels. |
| [out] | size | The size of the pixels in bytes. |
| PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetEndianness | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| PEAK_IPL_ENDIANNESS * | endianness | ||
| ) |
Queries the endianness of the given pixel format.
| [in] | pixelFormat | The pixel format of interest. |
| [out] | endianness | The endianness. |
| PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetMaximumValuePerChannel | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| uint32_t * | channelMaximumValue | ||
| ) |
Queries the maximum value of one pixel channel of the given pixel format.
| [in] | pixelFormat | The pixel format of interest. |
| [out] | channelMaximumValue | The maximum value of one pixel channel. |
| PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumChannels | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| size_t * | numChannels | ||
| ) |
Queries the number of channels of the given pixel format.
| [in] | pixelFormat | The pixel format of interest. |
| [out] | numChannels | The number of channels. |
| PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumSignificantBitsPerChannel | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| size_t * | numSignificantBits | ||
| ) |
Queries the number of significant bits per pixel per channel of the given pixel format.
| [in] | pixelFormat | The pixel format of interest. |
| [out] | numSignificantBits | The number of significant bits per pixel per channel. |
| PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumSignificantBitsPerPixel | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| size_t * | numSignificantBits | ||
| ) |
Queries the number of significant bits per pixel of the given pixel format.
| [in] | pixelFormat | The pixel format of interest. |
| [out] | numSignificantBits | The number of significant bits per pixel. |
| PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumStorageBitsPerChannel | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| size_t * | numStorageBits | ||
| ) |
Queries the number of storage bits per pixel per channel of the given pixel format.
| [in] | pixelFormat | The pixel format of interest. |
| [out] | numStorageBits | The number of storage bits per pixel per channel. |
| PEAK_IPL_C_API PEAK_IPL_PixelFormat_GetNumStorageBitsPerPixel | ( | PEAK_IPL_PIXEL_FORMAT | pixelFormat, |
| size_t * | numStorageBits | ||
| ) |
Queries the number of storage bits per pixel of the given pixel format.
| [in] | pixelFormat | The pixel format of interest. |
| [out] | numStorageBits | The number of significant bits per pixel. |
| PEAK_IPL_C_API PEAK_IPL_PixelLine_Construct | ( | PEAK_IPL_IMAGE_HANDLE | imageHandle, |
| PEAK_IPL_ORIENTATION | orientation, | ||
| size_t | offset, | ||
| PEAK_IPL_PIXEL_LINE_HANDLE * | pixelLineHandle | ||
| ) |
Creates a pixel line depending on the given orientation.
A pixel line is a whole line or a whole column of the image's pixels.
| [in] | imageHandle | The image to create the pixel line from. |
| [in] | orientation | The orientation of the line. |
| [in] | offset | The offset from the reference border. The reference border depends on the given orientation (vertical: left - horizontal: top). |
| [out] | pixelLineHandle | The handle to the created pixel line. |
| PEAK_IPL_C_API PEAK_IPL_PixelLine_Destruct | ( | PEAK_IPL_PIXEL_LINE_HANDLE | pixelLineHandle | ) |
Destroys the pixel line associated with the given handle.
| [in] | pixelLineHandle | The handle to the pixel line to destroy. |
| PEAK_IPL_C_API PEAK_IPL_PixelLine_GetNumChannels | ( | PEAK_IPL_PIXEL_LINE_HANDLE | pixelLineHandle, |
| size_t * | numChannels | ||
| ) |
Queries the number of the given pixel line's channels.
| [in] | pixelLineHandle | The handle to the pixel line of interest. |
| [out] | numChannels | The number of channels. |
| PEAK_IPL_C_API PEAK_IPL_PixelLine_GetOffset | ( | PEAK_IPL_PIXEL_LINE_HANDLE | pixelLineHandle, |
| size_t * | offset | ||
| ) |
Queries the offset of the given pixel line.
| [in] | pixelLineHandle | The handle to the pixel line of interest. |
| [out] | offset | The offset. The reference border depends on the orientation of the collection line (vertical: left - horizontal: top). |
| PEAK_IPL_C_API PEAK_IPL_PixelLine_GetOrientation | ( | PEAK_IPL_PIXEL_LINE_HANDLE | pixelLineHandle, |
| PEAK_IPL_ORIENTATION * | orientation | ||
| ) |
Queries the orientation of the given pixel line.
| [in] | pixelLineHandle | The handle to the pixel line of interest. |
| [out] | orientation | The orientation. |
| PEAK_IPL_C_API PEAK_IPL_PixelLine_GetPixelFormat | ( | PEAK_IPL_PIXEL_LINE_HANDLE | pixelLineHandle, |
| PEAK_IPL_PIXEL_FORMAT * | pixelFormat | ||
| ) |
Queries the pixel format of the given pixel line.
| [in] | pixelLineHandle | The handle to the pixel line of interest. |
| [out] | pixelFormat | The pixel format. |
| PEAK_IPL_C_API PEAK_IPL_PixelLine_GetValuesForChannel | ( | PEAK_IPL_PIXEL_LINE_HANDLE | pixelLineHandle, |
| size_t | channelIndex, | ||
| uint32_t * | values, | ||
| size_t * | valuesSize | ||
| ) |
Queries the value list for the channel with the given index.
For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().
| [in] | pixelLineHandle | The handle to the pixel line of interest. |
| [in] | channelIndex | The index of the channel of interest. |
| [out] | values | The value list of the given channel. |
| [in,out] | valuesSize | IN: Size of the given buffer - OUT: Size of the queried data |