Binning

Functions
peak_access_status	peak_Binning_GetAccessStatus (peak_camera_handle hCam)
	Query the binning access status.
peak_status	peak_Binning_FactorX_GetList (peak_camera_handle hCam, uint32_t *binningFactorXList, size_t *binningFactorXCount)
	Get the list of currently selectable factors for the binning in x direction.
peak_status	peak_Binning_FactorY_GetList (peak_camera_handle hCam, uint32_t *binningFactorYList, size_t *binningFactorYCount)
	Get the list of currently selectable factors for the binning in y direction.
peak_status	peak_Binning_Set (peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
	Set the binning factors.
peak_status	peak_Binning_Get (peak_camera_handle hCam, uint32_t *binningFactorX, uint32_t *binningFactorY)
	Get the binning factors.

Detailed Description

Pixel binning related functions and types.

The function automatically determines the subsampling engine afor the largest possible number of factors. To use the subsampling engine explicitly, it is recommended to use the functions from the Binning manual group.

Note

Please note that the functions from this function group are not compatible with the functions from the Binning manual group and therefore should not be used together.

Function Documentation

peak_Binning_FactorX_GetList()

peak_status peak_Binning_FactorX_GetList	(	peak_camera_handle	hCam,
		uint32_t *	binningFactorXList,
		size_t *	binningFactorXCount )

Get the list of currently selectable factors for the binning in x direction.

Queries the list of currently selectable binning factors for the x direction.

The list of selectable binning factors may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	binningFactorXList	Pointer to a user allocated array buffer to receive the binning factor list. If this parameter is NULL, binningFactorXCount will contain the current number of binning factors. The required size of binningFactorXList in bytes is binningFactorXCount x sizeof(uint32_t).
[in,out]	binningFactorXCount	binningFactorXList equal NULL: out: minimal number of binning factors binningFactorXList must be large enough to hold binningFactorXList unequal NULL: in: number of binning factors binningFactorXList can hold out: number of binning factors filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_ACCESS_DENIED The binning feature is not accessible. Check the access status via peak_Binning_GetAccessStatus.

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

Note

Consider that the binning factor list might change between the size query call and the list query call.
This may be the case if the camera configuration or the camera status have changed in the time between the two function calls.

Since

1.0

peak_Binning_FactorY_GetList()

peak_status peak_Binning_FactorY_GetList	(	peak_camera_handle	hCam,
		uint32_t *	binningFactorYList,
		size_t *	binningFactorYCount )

Get the list of currently selectable factors for the binning in y direction.

Queries the list of currently selectable binning factors for the y direction.

The list of selectable binning factors may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	binningFactorYList	Pointer to a user allocated array buffer to receive the binning factor list. If this parameter is NULL, binningFactorYCount will contain the current number of binning factors. The required size of binningFactorYList in bytes is binningFactorYCount x sizeof(uint32_t).
[in,out]	binningFactorYCount	binningFactorYList equal NULL: out: minimal number of binning factors binningFactorYList must be large enough to hold binningFactorYList unequal NULL: in: number of binning factors binningFactorYList can hold out: number of binning factors filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_ACCESS_DENIED The binning feature is not accessible. Check the access status via peak_Binning_GetAccessStatus.

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

Note

Consider that the binning factor list might change between the size query call and the list query call.
This may be the case if the camera configuration or the camera status have changed in the time between the two function calls.

Since

1.0

peak_Binning_Get()

peak_status peak_Binning_Get	(	peak_camera_handle	hCam,
		uint32_t *	binningFactorX,
		uint32_t *	binningFactorY )

Get the binning factors.

Reads the current pixel binning factors.

Parameters

[in]	hCam	The camera handle.
[out]	binningFactorX	The binning factor in x direction.
[out]	binningFactorY	The binning factor in y direction.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The binning feature is not available for read access. Check the access status via peak_Binning_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER binningFactorX and/or binningFactorY are invalid pointers.

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

peak_access_status peak_Binning_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the binning access status.

Provides the current access status for the binning feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The binning feature is readable and writeable.

PEAK_ACCESS_READONLY The binning feature is readable only.

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

PEAK_ACCESS_NONE The binning feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The binning 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.

Since

1.0

peak_Binning_Set()

peak_status peak_Binning_Set	(	peak_camera_handle	hCam,
		uint32_t	binningFactorX,
		uint32_t	binningFactorY )

Set the binning factors.

Writes the desired pixel binning factors.

Parameters

[in]	hCam	The camera handle.
[in]	binningFactorX	The binning factor in x direction to set.
[in]	binningFactorY	The binning factor in y direction to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_VALUE_ADJUSTED At least one of the values was automatically adjusted. Check the effective values via peak_Binning_Get.

PEAK_STATUS_OUT_OF_RANGE binningFactorX and/or binningFactorY are out of range. Check the range of valid values via peak_Binning_FactorX_GetList and peak_Binning_FactorY_GetList.

PEAK_STATUS_ACCESS_DENIED The binning feature is not available for write access. Check the access status via peak_Binning_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.

Note

For some camera models the factors for the x direction and the y direction are combined. For these cameras the specified binningFactorY is applied for both directions.

Since

1.0