Gamma

Functions
peak_access_status	peak_Gamma_GetAccessStatus (peak_camera_handle hCam)
	Query the gamma access status.
peak_status	peak_Gamma_GetRange (peak_camera_handle hCam, double *minGamma, double *maxGamma, double *incGamma)
	Get the current range of valid gamma values.
peak_status	peak_Gamma_Set (peak_camera_handle hCam, double gamma)
	Set the gamma value.
peak_status	peak_Gamma_Get (peak_camera_handle hCam, double *gamma)
	Get the gamma value.

Detailed Description

Gamma related functions and types.

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

Function Documentation

peak_Gamma_Get()

peak_status peak_Gamma_Get	(	peak_camera_handle	hCam,
		double *	gamma
	)

Get the gamma value.

Reads the current gamma value.

Parameters

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

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The gamma feature is not available for read access. Check the access status via peak_Gamma_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER gamma 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_Gamma_GetAccessStatus()

peak_access_status peak_Gamma_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the gamma access status.

Provides the current access status for the gamma feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The gamma feature is readable and writeable.

PEAK_ACCESS_READONLY The gamma feature is readable only.

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

PEAK_ACCESS_NONE The gamma feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The gamma 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_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_Gamma_GetRange()

peak_status peak_Gamma_GetRange	(	peak_camera_handle	hCam,
		double *	minGamma,
		double *	maxGamma,
		double *	incGamma
	)

Get the current range of valid gamma values.

Queries the current range of valid values for the gamma feature.

Parameters

[in]	hCam	The camera handle.
[out]	minGamma	The minimum gamma value.
[out]	maxGamma	The maximum gamma value.
[out]	incGamma	The gamma value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The gamma feature is not accessible. Check the access status via peak_Gamma_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minGamma, maxGamma and incGamma 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_Gamma_Set()

peak_status peak_Gamma_Set	(	peak_camera_handle	hCam,
		double	gamma
	)

Set the gamma value.

Writes the desired gamma value.

Parameters

[in]	hCam	The camera handle.
[in]	gamma	The gamma value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE gamma value is out of range. Check the range of valid values via peak_Gamma_GetRange.

PEAK_STATUS_ACCESS_DENIED The gamma feature is not available for write access. Check the access status via peak_Gamma_GetAccessStatus.

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.