Host Features

Topics
	Pixel format
	Gain
	LUT
	LUT related functions and types.
	Gamma
	Digital Black
	Digital black is a technique used in image processing to adjust the black point before gamma correction is applied. Gamma correction often causes dark areas of an image to appear gray by lifting the overall brightness and redistributing tonal values. By pulling down the black point with digital black, the noisy pixels are eliminated first so the gamma correction does not multiply the noise.
	Color correction
	Auto brightness control
	Auto white balance control
	Auto focus control
	Hotpixel Correction
	Mirror
	Rotation
	Image rotation related functions and types.
	Binning
	Decimation
	Sharpness measurement
	Edge Enhancement
	Video
	ImageWriter
	Histogram
	Creates a histogram for a given peak_frame.

Functions
peak_status	peak_IPL_ProcessFrame (peak_camera_handle hCam, peak_frame_handle hFrame, peak_frame_handle *hResultFrame)
	Process a frame with the host image processing pipeline and store the result in a new frame.
peak_status	peak_IPL_ProcessFrameInplace (peak_camera_handle hCam, peak_frame_handle hFrame)
	Process a frame with the host image processing pipeline and replace the original frame.
peak_status	peak_IPL_ReadImage (peak_camera_handle hCam, const char *path, peak_frame_handle *hFrame)
	Reads an image file from the disk and returns the peak_frame_handle for it.

Detailed Description

Image processing functions, executed on the host system.

Function Documentation

peak_IPL_ProcessFrame()

peak_status peak_IPL_ProcessFrame	(	peak_camera_handle	hCam,
		peak_frame_handle	hFrame,
		peak_frame_handle *	hResultFrame )

Process a frame with the host image processing pipeline and store the result in a new frame.

Processes a frame with the host image processing pipeline and stores the result in a new frame. The host image processing pipeline can be configured with functions in the Host Features group.

The new frames create by this function are stored in the hResultFrame parameter. These frames must be released via peak_Frame_Release.

Parameters

[in]	hCam	The camera handle.
[in]	hFrame	Handle to the input frame.
[out]	hResultFrame	Handle to the processed output frame.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_CONFIGURATION The image processing pipeline was misconfigured and can't apply the required operations on the input image. Check the last error for more information.

PEAK_STATUS_INVALID_PARAMETER hResultFrame is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hFrame and/or hCam are invalid handles.

PEAK_STATUS_NOT_SUPPORTED hFrame has an unsupported pixel format.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_ProcessFrameInplace()

peak_status peak_IPL_ProcessFrameInplace	(	peak_camera_handle	hCam,
		peak_frame_handle	hFrame )

Process a frame with the host image processing pipeline and replace the original frame.

Processes a frame with the host image processing pipeline and replaces the original frame. The host image processing pipeline can be configured with functions in the Host Features group.

Note

Since debayered images require more memory than the corresponding Bayer image, it's not possible to convert from Bayer formats to RGB(a)/BGR(a) with this in-place function. Also packed image formats are not possible to convert with this in-place function.

The hFrame must still be released via peak_Frame_Release.

Parameters

[in]	hCam	The camera handle.
[in]	hFrame	Handle to the input frame.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_CONFIGURATION The image processing pipeline was misconfigured and can't apply the required operations on the input image. Check the last error for more information.

PEAK_STATUS_BUFFER_TOO_SMALL The image processing pipeline is configured for debayering, which can't be done in-place.

PEAK_STATUS_INVALID_HANDLE hFrame and/or hCam are invalid handles.

PEAK_STATUS_NOT_SUPPORTED hFrame has an unsupported pixel format.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_ReadImage()

peak_status peak_IPL_ReadImage	(	peak_camera_handle	hCam,
		const char *	path,
		peak_frame_handle *	hFrame )

Reads an image file from the disk and returns the peak_frame_handle for it.

The supported file extensions for the image file include png, bmp, jpg and tiff. If the frame is no longer needed it needs to be released by a call to peak_Frame_Release.

Parameters

[in]	hCam	The camera handle.
[in]	path	The path to the image file on the disk.
[out]	hFrame	Handle to the frame.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_INVALID_PARAMETER path or hFrame are invalid pointer.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.11