Decimation manual

Functions
PEAK_API_ACCESS_STATUS	peak_DecimationManual_GetAccessStatus (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine)
	Query the decimation manual access status.
PEAK_API_STATUS	peak_DecimationManual_FactorX_GetList (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorXList, size_t *decimationFactorXCount)
	Get the list of currently selectable factors for the decimation in x direction.
PEAK_API_STATUS	peak_DecimationManual_FactorY_GetList (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorYList, size_t *decimationFactorYCount)
	Get the list of currently selectable factors for the decimation in y direction.
PEAK_API_STATUS	peak_DecimationManual_Set (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t decimationFactorX, uint32_t decimationFactorY)
	Set the decimation factors.
PEAK_API_STATUS	peak_DecimationManual_Get (peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
	Get the decimation factors.

Detailed Description

Pixel decimation related functions and types.
Pixel decimation is also referred to as pixel skipping.

Note

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

Function Documentation

peak_DecimationManual_FactorX_GetList()

PEAK_API_STATUS peak_DecimationManual_FactorX_GetList	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine,
		uint32_t *	decimationFactorXList,
		size_t *	decimationFactorXCount
	)

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

Queries the list of currently selectable decimation factors in x direction for the given subsampling engine.

The list of selectable decimation 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]	decimationFactorXList	Pointer to a user allocated array buffer to receive the decimation factor list. If this parameter is NULL, decimationFactorXCount will contain the current number of decimation factors. The required size of decimationFactorXList in bytes is decimationFactorXCount x sizeof(uint32_t).
[in,out]	decimationFactorXCount	decimationFactorXList equal NULL: out: minimal number of decimation factors decimationFactorXList must be large enough to hold decimationFactorXList unequal NULL: in: number of decimation factors decimationFactorXList can hold out: number of decimation factors filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_ACCESS_DENIED The decimation feature is not accessible. Check the access status via peak_DecimationManual_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER decimationFactorXCount 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 decimation 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.

peak_DecimationManual_FactorY_GetList()

PEAK_API_STATUS peak_DecimationManual_FactorY_GetList	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine,
		uint32_t *	decimationFactorYList,
		size_t *	decimationFactorYCount
	)

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

Queries the list of currently selectable decimation factors in y direction for the given subsampling engine.

The list of selectable decimation 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]	decimationFactorYList	Pointer to a user allocated array buffer to receive the decimation factor list. If this parameter is NULL, decimationFactorYCount will contain the current number of decimation factors. The required size of decimationFactorYList in bytes is decimationFactorYCount x sizeof(uint32_t).
[in,out]	decimationFactorYCount	decimationFactorYList equal NULL: out: minimal number of decimation factors decimationFactorYList must be large enough to hold decimationFactorYList unequal NULL: in: number of decimation factors decimationFactorYList can hold out: number of decimation factors filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_ACCESS_DENIED The decimation feature is not accessible. Check the access status via peak_DecimationManual_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER decimationFactorYCount 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 decimation 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.

peak_DecimationManual_Get()

PEAK_API_STATUS peak_DecimationManual_Get	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine,
		uint32_t *	decimationFactorX,
		uint32_t *	decimationFactorY
	)

Get the decimation factors.

Reads the current decimation factors for the given subsampling engine.

Parameters

[in]	hCam	The camera handle.
[in]	subsamplingEngine	The engine for the subsampling algorithm.
[out]	decimationFactorX	The decimation factor in x direction.
[out]	decimationFactorY	The decimation factor in y direction.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The decimation feature is not available for read access. Check the access status via peak_DecimationManual_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER decimationFactorX and/or decimationFactorY 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_DecimationManual_GetAccessStatus()

PEAK_API_ACCESS_STATUS peak_DecimationManual_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine
	)

Query the decimation manual access status.

Provides the current access status for the decimation feature for the given subsampling engine.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The decimation feature is readable and writeable.

PEAK_ACCESS_READONLY The decimation feature is readable only.

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

PEAK_ACCESS_NONE The decimation feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The decimation 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_DecimationManual_Set()

PEAK_API_STATUS peak_DecimationManual_Set	(	peak_camera_handle	hCam,
		peak_subsampling_engine	subsamplingEngine,
		uint32_t	decimationFactorX,
		uint32_t	decimationFactorY
	)

Set the decimation factors.

Writes the desired decimation factors for the given subsampling engine.

Parameters

[in]	hCam	The camera handle.
[in]	subsamplingEngine	The engine for the subsampling algorithm.
[in]	decimationFactorX	The decimation factor in x direction to set.
[in]	decimationFactorY	The decimation 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_DecimationManual_Get.

PEAK_STATUS_OUT_OF_RANGE decimationFactorX and/or decimationFactorY are out of range. Check the range of valid values via peak_DecimationManual_FactorX_GetList and peak_DecimationManual_FactorY_GetList.

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