Color correction

Functions
peak_status	peak_IPL_ColorCorrection_Matrix_Set (peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
	Sets the cost color correction matrix. More...
peak_status	peak_IPL_ColorCorrection_Matrix_Get (peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
	Get the host color correction matrix. More...
peak_status	peak_IPL_ColorCorrection_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the host color correction. More...
peak_bool	peak_IPL_ColorCorrection_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the host color correction. More...

Detailed Description

Color correction related functions and types.

This feature is applied in the host.
There is also a camera implementation. See Color correction.

Function Documentation

peak_IPL_ColorCorrection_Enable()

peak_status peak_IPL_ColorCorrection_Enable	(	peak_camera_handle	hCam,
		peak_bool	enabled
	)

Enable/Disable the host color correction.

Sets the host color correction to enabled or disabled.

Parameters

[in]	hCam	The camera handle.
[in]	enabled	The desired enabled status. PEAK_TRUE for enabled, PEAK_FALSE for disabled.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_IPL_ColorCorrection_IsEnabled()

peak_bool peak_IPL_ColorCorrection_IsEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the host color correction.

Queries whether the host color correction is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_TRUE The color correction feature is currently enabled.

PEAK_FALSE The color correction feature is currently disabled or the query failed.

peak_IPL_ColorCorrection_Matrix_Get()

peak_status peak_IPL_ColorCorrection_Matrix_Get	(	peak_camera_handle	hCam,
		peak_matrix *	colorCorrectionMatrix
	)

Get the host color correction matrix.

Reads the current host color correction matrix.

Parameters

[in]	hCam	The camera handle.
[out]	colorCorrectionMatrix	The color correction matrix.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER colorCorrectionMatrix is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_IPL_ColorCorrection_Matrix_Set()

peak_status peak_IPL_ColorCorrection_Matrix_Set	(	peak_camera_handle	hCam,
		peak_matrix	colorCorrectionMatrix
	)

Sets the cost color correction matrix.

Writes the desired image color correction matrix.

Parameters

[in]	hCam	The camera handle.
[in]	colorCorrectionMatrix	The color correction matrix to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.