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_Saturation_Get (peak_camera_handle hCam, double *saturation)
	Get the saturation value. More...
peak_status	peak_IPL_ColorCorrection_Saturation_Set (peak_camera_handle hCam, double saturation)
	Sets the saturation value. More...
peak_status	peak_IPL_ColorCorrection_Saturation_GetRange (peak_camera_handle hCam, double *minSaturation, double *maxSaturation, double *incSaturation)
	Get the current range of valid saturation values. 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.

peak_IPL_ColorCorrection_Saturation_Get()

peak_status peak_IPL_ColorCorrection_Saturation_Get	(	peak_camera_handle	hCam,
		double *	saturation
	)

Get the saturation value.

Reads the current host color correction saturation value

Parameters

[in]	hCam	The camera handle.
[out]	saturation	The saturation value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER saturation 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_Saturation_GetRange()

peak_status peak_IPL_ColorCorrection_Saturation_GetRange	(	peak_camera_handle	hCam,
		double *	minSaturation,
		double *	maxSaturation,
		double *	incSaturation
	)

Get the current range of valid saturation values.

Queries the current range of valid values for saturation value.

Parameters

[in]	hCam	The camera handle.
[out]	minSaturation	The minimum saturation value.
[out]	maxSaturation	The maximum saturation value.
[out]	incSaturation	The saturation value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of minSaturation, maxSaturation, and incSaturation 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_Saturation_Set()

peak_status peak_IPL_ColorCorrection_Saturation_Set	(	peak_camera_handle	hCam,
		double	saturation
	)

Sets the saturation value.

Writes the desired saturation value.

Parameters

[in]	hCam	The camera handle.
[in]	saturation	The saturation value to be set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE saturation value is out of range. Check the range of valid values via peak_IPL_ColorCorrection_Saturation_GetRange.

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.