Scaling

Functions
peak_access_status	peak_Scaling_GetAccessStatus (peak_camera_handle hCam)
	Query the scaling access status.
peak_status	peak_Scaling_FactorX_GetRange (peak_camera_handle hCam, double *minScalingFactorX, double *maxScalingFactorX, double *incScalingFactorX)
	Get the current range of valid scaling factor x values.
peak_status	peak_Scaling_FactorY_GetRange (peak_camera_handle hCam, double *minScalingFactorY, double *maxScalingFactorY, double *incScalingFactorY)
	Get the current range of valid scaling factor y values.
peak_status	peak_Scaling_Set (peak_camera_handle hCam, double scalingFactorX, double scalingFactorY)
	Set the scaling factors.
peak_status	peak_Scaling_Get (peak_camera_handle hCam, double *scalingFactorX, double *scalingFactorY)
	Get the scaling factors.

Detailed Description

Pixel scaling related functions and types.

Function Documentation

peak_Scaling_FactorX_GetRange()

peak_status peak_Scaling_FactorX_GetRange	(	peak_camera_handle	hCam,
		double *	minScalingFactorX,
		double *	maxScalingFactorX,
		double *	incScalingFactorX
	)

Get the current range of valid scaling factor x values.

Queries the current range of valid values for the scaling factor in x direction.

Parameters

[in]	hCam	The camera handle.
[out]	minScalingFactorX	The minimum scaling factor.
[out]	maxScalingFactorX	The maximum scaling factor.
[out]	incScalingFactorX	The scaling factor increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The scaling control is not accessible. Check the access status via peak_Scaling_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minScalingFactorX, maxScalingFactorX, and incScalingFactorX 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_Scaling_FactorY_GetRange()

peak_status peak_Scaling_FactorY_GetRange	(	peak_camera_handle	hCam,
		double *	minScalingFactorY,
		double *	maxScalingFactorY,
		double *	incScalingFactorY
	)

Get the current range of valid scaling factor y values.

Queries the current range of valid values for the scaling factor in y direction.

Parameters

[in]	hCam	The camera handle.
[out]	minScalingFactorY	The minimum scaling factor.
[out]	maxScalingFactorY	The maximum scaling factor.
[out]	incScalingFactorY	The scaling factor increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The scaling control is not accessible. Check the access status via peak_Scaling_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minScalingFactorY, maxScalingFactorY, and incScalingFactorY 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_Scaling_Get()

peak_status peak_Scaling_Get	(	peak_camera_handle	hCam,
		double *	scalingFactorX,
		double *	scalingFactorY
	)

Get the scaling factors.

Reads the current pixel scaling factors.

Parameters

[in]	hCam	The camera handle.
[out]	scalingFactorX	The scaling factor in x direction.
[out]	scalingFactorY	The scaling factor in y direction.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The scaling feature is not available for read access. Check the access status via peak_Scaling_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER scalingFactorX and/or scalingFactorY 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_Scaling_GetAccessStatus()

peak_access_status peak_Scaling_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the scaling access status.

Provides the current access status for the scaling feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The scaling feature is readable and writeable.

PEAK_ACCESS_READONLY The scaling feature is readable only.

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

PEAK_ACCESS_NONE The scaling feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The scaling 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_Scaling_Set()

peak_status peak_Scaling_Set	(	peak_camera_handle	hCam,
		double	scalingFactorX,
		double	scalingFactorY
	)

Set the scaling factors.

Writes the desired pixel scaling factors.

Parameters

[in]	hCam	The camera handle.
[in]	scalingFactorX	The scaling factor in x direction to set.
[in]	scalingFactorY	The scaling 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 scalingFactorX and/or scalingFactorY are out of range. Check the range of valid values via peak_Scaling_FactorX_GetRange and peak_Scaling_FactorY_GetRange.

PEAK_STATUS_ACCESS_DENIED The scaling feature is not available for write access. Check the access status via peak_Scaling_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 scalingFactorY is applied for both directions.