Gain

Functions
peak_status	peak_IPL_Gain_GetRange (peak_camera_handle hCam, peak_gain_channel gainChannel, double *minGain, double *maxGain, double *incGain)
	Get the current range of valid host gain values for the specified gain channel. More...
peak_status	peak_IPL_Gain_Set (peak_camera_handle hCam, peak_gain_channel gainChannel, double gain)
	Set the host gain for the specified gain channel. More...
peak_status	peak_IPL_Gain_Get (peak_camera_handle hCam, peak_gain_channel gainChannel, double *gain)
	Get the host gain value for the specified gain channel. More...

Detailed Description

Gain related functions and types.

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

Function Documentation

peak_IPL_Gain_Get()

peak_status peak_IPL_Gain_Get	(	peak_camera_handle	hCam,
		peak_gain_channel	gainChannel,
		double *	gain
	)

Get the host gain value for the specified gain channel.

Reads the current host gain value for the specified gain channel.

Parameters

[in]	hCam	The camera handle.
[in]	gainChannel	The addressed gain channel.
[out]	gain	The gain value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER gainChannel is an invalid gain channel or gain is an invalid pointer. Check peak_gain_channel.

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_Gain_GetRange()

peak_status peak_IPL_Gain_GetRange	(	peak_camera_handle	hCam,
		peak_gain_channel	gainChannel,
		double *	minGain,
		double *	maxGain,
		double *	incGain
	)

Get the current range of valid host gain values for the specified gain channel.

Queries the current range of valid values for the host gain for the specified gain channel.

Parameters

[in]	hCam	The camera handle.
[in]	gainChannel	The addressed gain channel.
[out]	minGain	The minimum gain value.
[out]	maxGain	The maximum gain value.
[out]	incGain	The increment gain value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of minGain, maxGain and incGain 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_Gain_Set()

peak_status peak_IPL_Gain_Set	(	peak_camera_handle	hCam,
		peak_gain_channel	gainChannel,
		double	gain
	)

Set the host gain for the specified gain channel.

Writes the desired host gain value for the specified gain channel.

Parameters

[in]	hCam	The camera handle.
[in]	gainChannel	The addressed gain channel.
[in]	gain	The gain value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE gain is out of range. Check the range of valid values via peak_Gain_GetRange.

PEAK_STATUS_INVALID_PARAMETER gainChannel is an invalid gain channel. Check peak_gain_channel.

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.