Edge Enhancement

Functions
peak_status	peak_IPL_EdgeEnhancement_Enable (peak_camera_handle hCam, peak_bool enable)
	Enable/Disable the host edge enhancement.
peak_bool	peak_IPL_EdgeEnhancement_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the edge enhancement feature.
peak_status	peak_IPL_EdgeEnhancement_Factor_Set (peak_camera_handle hCam, uint32_t factor)
	Set the host edge enhancement factor.
peak_status	peak_IPL_EdgeEnhancement_Factor_Get (peak_camera_handle hCam, uint32_t *factor)
	Get the currently set host edge enhancement factor.
peak_status	peak_IPL_EdgeEnhancement_Factor_GetDefault (peak_camera_handle hCam, uint32_t *defaultFactor)
	Get the default host edge enhancement factor.
peak_status	peak_IPL_EdgeEnhancement_Factor_GetRange (peak_camera_handle hCam, uint32_t *minFactor, uint32_t *maxFactor, uint32_t *incFactor)
	Get the range for the host edge enhancement factor.

Detailed Description

Edge Enhancement related functions and types.

Function Documentation

peak_IPL_EdgeEnhancement_Enable()

peak_status peak_IPL_EdgeEnhancement_Enable	(	peak_camera_handle	hCam,
		peak_bool	enable )

Enable/Disable the host edge enhancement.

Sets the edge enhancement host feature to enabled or disabled. Enabling it causes a higher CPU load.

Parameters

[in]	hCam	The camera handle.
[in]	enable	The desired enabled status. PEAK_TRUE for enabled, PEAK_FALSE for disabled.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

peak_IPL_EdgeEnhancement_Factor_Get()

peak_status peak_IPL_EdgeEnhancement_Factor_Get	(	peak_camera_handle	hCam,
		uint32_t *	factor )

Get the currently set host edge enhancement factor.

Gets the currently set host edge enhancement factor.

Parameters

[in]	hCam	The camera handle.
[out]	factor	Pointer to a variable which will contain the current edge enhancement factor.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER factor is an invalid factor 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.

Since

1.5

peak_IPL_EdgeEnhancement_Factor_GetDefault()

peak_status peak_IPL_EdgeEnhancement_Factor_GetDefault	(	peak_camera_handle	hCam,
		uint32_t *	defaultFactor )

Get the default host edge enhancement factor.

Gets the currently set host edge enhancement factor.

Parameters

[in]	hCam	The camera handle.
[out]	defaultFactor	Pointer to a variable which will contain the default edge enhancement factor.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER factor is an invalid factor 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.

Since

1.5

peak_IPL_EdgeEnhancement_Factor_GetRange()

peak_status peak_IPL_EdgeEnhancement_Factor_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	minFactor,
		uint32_t *	maxFactor,
		uint32_t *	incFactor )

Get the range for the host edge enhancement factor.

Gets the range of valid host edge enhancement factors.

Parameters

[in]	hCam	The camera handle.
[out]	minFactor	Minimum of possible Factor.
[out]	maxFactor	Maximum of possible Factor.
[out]	incFactor	Increment of possible Factor.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER minFactor, maxFactor or incFactor 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.

Since

1.5

peak_IPL_EdgeEnhancement_Factor_Set()

peak_status peak_IPL_EdgeEnhancement_Factor_Set	(	peak_camera_handle	hCam,
		uint32_t	factor )

Set the host edge enhancement factor.

Sets the specified host edge enhancement factor. Call peak_IPL_EdgeEnhancement_Factor_GetRange to get the range of valid values.

Parameters

[in]	hCam	The camera handle.
[in]	factor	The edge enhancement factor.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER factor is an invalid factor.

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

peak_IPL_EdgeEnhancement_IsEnabled()

peak_bool peak_IPL_EdgeEnhancement_IsEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the edge enhancement feature.

Queries whether the edge enhancement is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_TRUE The edge enhancement feature is currently enabled.

PEAK_FALSE The edge enhancement feature is currently disabled or the query failed.

Since

1.5