Gain

Enumerations
enum	peak_gain_type { PEAK_GAIN_TYPE_INVALID , PEAK_GAIN_TYPE_ANALOG , PEAK_GAIN_TYPE_DIGITAL , PEAK_GAIN_TYPE_COMBINED }
	peak Gain type More...
enum	peak_gain_channel {   PEAK_GAIN_CHANNEL_INVALID , PEAK_GAIN_CHANNEL_RED , PEAK_GAIN_CHANNEL_GREEN , PEAK_GAIN_CHANNEL_BLUE ,   PEAK_GAIN_CHANNEL_MASTER }
	peak Gain channel More...

Functions
peak_access_status	peak_Gain_GetAccessStatus (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel)
	Query the gain access status for the specified gain type and gain channel.
peak_status	peak_Gain_GetChannelList (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel *gainChannelList, size_t *gainChannelCount)
	Get the list of available gain channels for the given gain type.
peak_status	peak_Gain_GetRange (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double *minGain, double *maxGain, double *incGain)
	Get the current range of valid gain values for the specified gain type and gain channel.
peak_status	peak_Gain_Set (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double gain)
	Set the gain for the specified gain type and gain channel.
peak_status	peak_Gain_Get (peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double *gain)
	Get the gain value for the specified gain type and gain channel.

Detailed Description

Gain related functions and types.

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

Enumeration Type Documentation

peak_gain_channel

enum peak_gain_channel

peak Gain channel

The gain channel is used in the gain related functions and specifies which channel of gain is addressed or used.

Enumerator
PEAK_GAIN_CHANNEL_INVALID	Invalid gain channel. Use this value for the initialization of variables of type peak_gain_channel.
PEAK_GAIN_CHANNEL_RED	Red channel.
PEAK_GAIN_CHANNEL_GREEN	Green channel.
PEAK_GAIN_CHANNEL_BLUE	Blue channel.
PEAK_GAIN_CHANNEL_MASTER	Master channel.

peak_gain_type

enum peak_gain_type

peak Gain type

The gain type is used in the gain related functions and specifies which type of gain is addressed or used.

Enumerator
PEAK_GAIN_TYPE_INVALID	Invalid gain type. Use this value for the initialization of variables of type peak_gain_type.
PEAK_GAIN_TYPE_ANALOG	Analog gain is used.
PEAK_GAIN_TYPE_DIGITAL	Digital gain is used.
PEAK_GAIN_TYPE_COMBINED	Combined gain is used.

Function Documentation

peak_Gain_Get()

peak_status peak_Gain_Get	(	peak_camera_handle	hCam,
		peak_gain_type	gainType,
		peak_gain_channel	gainChannel,
		double *	gain
	)

Get the gain value for the specified gain type and gain channel.

Reads the current gain value for the specified gain type and gain channel.

Parameters

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

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The gain feature is not available for read access. Check the access status via peak_Gain_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER gainType is an invalid gain type or gainChannel is an invalid gain channel or gain is an invalid pointer. Check peak_gain_type and 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_Gain_GetAccessStatus()

peak_access_status peak_Gain_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_gain_type	gainType,
		peak_gain_channel	gainChannel
	)

Query the gain access status for the specified gain type and gain channel.

Provides the current access status of the gain feature for the specified gain type and gain channel.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	gainType	The gain type.
[in]	gainChannel	The gain channel.

Returns

PEAK_ACCESS_READWRITE The gain feature is readable and writeable.

PEAK_ACCESS_READONLY The gain feature is readable only.

PEAK_ACCESS_GFA_LOCK The gain feature is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The gain feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The gain feature is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

• PEAK_STATUS_INVALID_PARAMETER gainType is an invalid gain type or gainChannel is an invalid gain channel. Check peak_gain_type and 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_Gain_GetChannelList()

peak_status peak_Gain_GetChannelList	(	peak_camera_handle	hCam,
		peak_gain_type	gainType,
		peak_gain_channel *	gainChannelList,
		size_t *	gainChannelCount
	)

Get the list of available gain channels for the given gain type.

Queries the list of available gain channels for the specified gain type.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	gainType	The addressed gain type.
[out]	gainChannelList	Pointer to a user allocated array buffer to receive the gain channel list. If this parameter is NULL, gainChannelCount will contain the number of gain channels. The required size of gainChannelList in bytes is gainChannelCount x sizeof(peak_gain_channel).
[in,out]	gainChannelCount	gainChannelList equal NULL: out: minimal number of gain channels gainChannelList must be large enough to hold gainChannelList unequal NULL: in: number of gain channels gainChannelList can hold out: number of gain channels filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_BUFFER_TOO_SMALL gainChannelList is not NULL and the value of *gainChannelCount is too small to receive the expected amount of data.

PEAK_STATUS_ACCESS_DENIED The gain feature is not accessible. Check the access status via peak_Gain_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER gainType is an invalid gain channel or gainChannelCount 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_Gain_GetRange()

peak_status peak_Gain_GetRange	(	peak_camera_handle	hCam,
		peak_gain_type	gainType,
		peak_gain_channel	gainChannel,
		double *	minGain,
		double *	maxGain,
		double *	incGain
	)

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

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

The range of valid gain values may depend on the camera configuration and the camera status.

Parameters

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

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The gain is not accessible. Check the access status via peak_Gain_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER gainType is an invalid gain type or gainChannel is an invalid gain channel or at least one of minGain, maxGain, and incGain is an invalid pointer. Check peak_gain_type and 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_Gain_Set()

peak_status peak_Gain_Set	(	peak_camera_handle	hCam,
		peak_gain_type	gainType,
		peak_gain_channel	gainChannel,
		double	gain
	)

Set the gain for the specified gain type and gain channel.

Writes the desired gain value for the specified gain type and gain channel.

Parameters

[in]	hCam	The camera handle.
[in]	gainType	The addressed gain type.
[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_ACCESS_DENIED The gain feature is not available for write access. Check the access status via peak_Gain_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER gainType is an invalid gain type or gainChannel is an invalid gain channel. Check peak_gain_type and 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.