Binning

Functions
PEAK_API_STATUS	peak_IPL_Binning_FactorX_GetList (peak_camera_handle hCam, uint32_t *binningFactorXList, size_t *binningFactorXCount)
	Get the list of currently selectable factors for the host binning in x direction.
PEAK_API_STATUS	peak_IPL_Binning_FactorY_GetList (peak_camera_handle hCam, uint32_t *binningFactorYList, size_t *binningFactorYCount)
	Get the list of currently selectable factors for the host binning in y direction.
PEAK_API_STATUS	peak_IPL_Binning_Set (peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
	Set the host binning factors.
PEAK_API_STATUS	peak_IPL_Binning_Get (peak_camera_handle hCam, uint32_t *binningFactorX, uint32_t *binningFactorY)
	Get the host binning factors.

Detailed Description

Pixel binning related functions and types.

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

Function Documentation

peak_IPL_Binning_FactorX_GetList()

PEAK_API_STATUS peak_IPL_Binning_FactorX_GetList	(	peak_camera_handle	hCam,
		uint32_t *	binningFactorXList,
		size_t *	binningFactorXCount
	)

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

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

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_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.

peak_IPL_Binning_FactorY_GetList()

PEAK_API_STATUS peak_IPL_Binning_FactorY_GetList	(	peak_camera_handle	hCam,
		uint32_t *	binningFactorYList,
		size_t *	binningFactorYCount
	)

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

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

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_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.

peak_IPL_Binning_Get()

PEAK_API_STATUS peak_IPL_Binning_Get	(	peak_camera_handle	hCam,
		uint32_t *	binningFactorX,
		uint32_t *	binningFactorY
	)

Get the host 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_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.

peak_IPL_Binning_Set()

PEAK_API_STATUS peak_IPL_Binning_Set	(	peak_camera_handle	hCam,
		uint32_t	binningFactorX,
		uint32_t	binningFactorY
	)

Set the host 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_IPL_Binning_Get.

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

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.