Auto gain

Functions
peak_status	peak_IPL_AutoBrightness_Gain_Mode_Set (peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
	Set the host auto gain control mode.
peak_status	peak_IPL_AutoBrightness_Gain_Mode_Get (peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
	Get the host auto gain control mode.
peak_status	peak_IPL_AutoBrightness_GainLimit_Set (peak_camera_handle hCam, peak_double_limit gainLimit)
	Set the host auto gain limit.
peak_status	peak_IPL_AutoBrightness_GainLimit_Get (peak_camera_handle hCam, peak_double_limit *gainLimit)
	Get the host auto gain limit.
peak_status	peak_IPL_AutoBrightness_GainLimit_GetRange (peak_camera_handle hCam, peak_double_limit *gainLimit)
	Get the host auto gain limit range.

Detailed Description

Auto brightness gain control related functions and types.

This feature is applied in the host.
There is also a camera implementation. See Auto brightness control.

Function Documentation

peak_IPL_AutoBrightness_Gain_Mode_Get()

peak_status peak_IPL_AutoBrightness_Gain_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_mode *	autoGainMode )

Get the host auto gain control mode.

Reads the current host auto gain control mode.

Parameters

[in]	hCam	The camera handle.
[out]	autoGainMode	The current auto gain control mode.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER autoGainMode 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.

Since

1.0

peak_IPL_AutoBrightness_Gain_Mode_Set()

peak_status peak_IPL_AutoBrightness_Gain_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_mode	autoGainMode )

Set the host auto gain control mode.

Writes the desired host auto gain control mode.

Note

If a specific auto gain mode has been enabled previously all specific auto gain modes will be disabled.

Parameters

[in]	hCam	The camera handle.
[in]	autoGainMode	The auto gain control mode to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER autoGainMode is an invalid auto feature mode. Check peak_auto_feature_mode.

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.

Since

1.0

peak_IPL_AutoBrightness_GainLimit_Get()

peak_status peak_IPL_AutoBrightness_GainLimit_Get	(	peak_camera_handle	hCam,
		peak_double_limit *	gainLimit )

Get the host auto gain limit.

Parameters

[in]	hCam	The camera handle.
[out]	gainLimit	The current gain limit.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER gainLimit 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.

Since

1.6

peak_IPL_AutoBrightness_GainLimit_GetRange()

peak_status peak_IPL_AutoBrightness_GainLimit_GetRange	(	peak_camera_handle	hCam,
		peak_double_limit *	gainLimit )

Get the host auto gain limit range.

The valid values are dependend on the used gain type Default is the complete range.

Parameters

[in]	hCam	The camera handle.
[out]	gainLimit	The valid range for the gain limit.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER gainLimit 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.

Since

1.6

peak_IPL_AutoBrightness_GainLimit_Set()

peak_status peak_IPL_AutoBrightness_GainLimit_Set	(	peak_camera_handle	hCam,
		peak_double_limit	gainLimit )

Set the host auto gain limit.

The valid values are dependend on the used gain type and can be read out by calling peak_IPL_AutoBrightness_GainLimit_GetRange. Default is the complete range.

If any value of the limit is out of range, the value is clamped to be valid. In this case the functions returns with PEAK_STATUS_VALUE_ADJUSTED. It is recommended to check the current values by calling peak_IPL_AutoBrightness_GainLimit_Get after this call.

Parameters

[in]	hCam	The camera handle.
[in]	gainLimit	The gain limit to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER gainLimit 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_VALUE_ADJUSTED At least one value of the limit is out of range. The limit was adjusted accordingly.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.6