Functions
peak_access_status	peak_BinningManual_GetAccessStatus (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine)
	Query the binning manual access status.
peak_status	peak_BinningManual_FactorX_GetList (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t binningFactorXList, size_t binningFactorXCount)
	Get the list of currently selectable factors for the binning in x direction.
peak_status	peak_BinningManual_FactorY_GetList (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t binningFactorYList, size_t binningFactorYCount)
	Get the list of currently selectable factors for the binning in y direction.
peak_status	peak_BinningManual_Set (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t binningFactorX, uint32_t binningFactorY)
	Set the binning factors.
peak_status	peak_BinningManual_Get (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t binningFactorX, uint32_t binningFactorY)
	Get the binning factors.

Detailed Description

Pixel binning related functions and types.

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

Function Documentation

◆ peak_BinningManual_FactorX_GetList()

peak_status peak_BinningManual_FactorX_GetList	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine,
		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 in x direction for the given subsampling engine.

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

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	subsamplingEngine	The engine for the subsampling algorithm.
[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.10

◆ peak_BinningManual_FactorY_GetList()

peak_status peak_BinningManual_FactorY_GetList	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine,
		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 in y direction for the given subsampling engine.

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

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	subsamplingEngine	The engine for the subsampling algorithm.
[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_BinningManual_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.10

◆ peak_BinningManual_Get()

peak_status peak_BinningManual_Get	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine,
		uint32_t *	binningFactorX,
		uint32_t *	binningFactorY )

Get the binning factors.

Reads the current binning factors for the given subsampling engine.

Parameters

[in]	hCam	The camera handle.
[in]	subsamplingEngine	The engine for the subsampling algorithm.
[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_BinningManual_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.10

◆ peak_BinningManual_GetAccessStatus()

peak_access_status peak_BinningManual_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine )

Query the binning manual access status.

Provides the current access status for the given subsampling engine.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	subsamplingEngine	The engine for the subsampling algorithm.

Returns: PEAK_ACCESS_READWRITE The camera is available for read access and for write access and can be opened.; PEAK_ACCESS_NONE The camera is not available for opening.; 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_CAMERA_NOT_FOUND There is no camera with the specified ID.
PEAK_STATUS_NOT_INITIALIZED The library is not initialized.
PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.10

◆ peak_BinningManual_Set()

peak_status peak_BinningManual_Set	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine,
		uint32_t	binningFactorX,
		uint32_t	binningFactorY )

Set the binning factors.

Writes the desired binning factors for the given subsampling engine.

Parameters

[in]	hCam	The camera handle.
[in]	subsamplingEngine	The engine for the subsampling algorithm.
[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_BinningManual_Get.; PEAK_STATUS_OUT_OF_RANGE binningFactorX and/or binningFactorY are out of range. Check the range of valid values via peak_BinningManual_FactorX_GetList and peak_BinningManual_FactorY_GetList.; PEAK_STATUS_ACCESS_DENIED The binning feature is not available for write access. Check the access status via peak_BinningManual_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.

Since: 1.10

Functions

Detailed Description

Function Documentation

◆ peak_BinningManual_FactorX_GetList()

◆ peak_BinningManual_FactorY_GetList()

◆ peak_BinningManual_Get()

◆ peak_BinningManual_GetAccessStatus()

◆ peak_BinningManual_Set()