Hotpixel Correction

Enumerations
enum	peak_hotpixel_correction_sensitivity {   PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_INVALID, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_1, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_2, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_3,   PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_4, PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_5 }
	peak hotpixel correction sensitivity level More...

Functions
peak_status	peak_IPL_HotpixelCorrection_Sensitivity_Set (peak_camera_handle hCam, peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity)
	Set the host hotpixel correction sensitivity level. More...
peak_status	peak_IPL_HotpixelCorrection_Sensitivity_Get (peak_camera_handle hCam, peak_hotpixel_correction_sensitivity *hotpixelCorrectionSensitivity)
	Get the host hotpixel correction sensitivity level. More...
peak_status	peak_IPL_HotpixelCorrection_GetList (peak_camera_handle hCam, peak_position *hotpixelList, size_t *hotpixelCount)
	Get the list of detected host hotpixel correction positions/pixels. More...
peak_status	peak_IPL_HotpixelCorrection_SetList (peak_camera_handle hCam, const peak_position *hotpixelList, size_t hotpixelCount)
	Set the list of host hotpixel positions. More...
peak_status	peak_IPL_HotpixelCorrection_ResetList (peak_camera_handle hCam)
	Reset the list of host hotpixel positions. More...
peak_status	peak_IPL_HotpixelCorrection_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the host hotpixel correction. More...
peak_bool	peak_IPL_HotpixelCorrection_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the host hotpixel correction. More...

Detailed Description

Hotpixel correction related functions and types.

Enumeration Type Documentation

peak_hotpixel_correction_sensitivity

enum peak_hotpixel_correction_sensitivity

peak hotpixel correction sensitivity level

Higher sensitivity levels mean more hotpixels will be detected and corrected, but can also lead to more false-positives.

Enumerator
PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_INVALID	Invalid hotpixel correction sensitivity level. Use this value for the initialization of variables of type peak_hotpixel_correction_sensitivity.
PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_1	hotpixel correction sensitivity level 1 This is the lowest sensitivity level, detecting the fewest hotpixels, therefore may miss more hotpixels, creating more false-negatives.
PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_2	hotpixel correction sensitivity level 2
PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_3	hotpixel correction sensitivity level 3 This is the default sensitivity level.
PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_4	hotpixel correction sensitivity level 4
PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_5	hotpixel correction sensitivity level 5 This is the highest sensitivity level, detecting the most hotpixels, but may create more false-positives.

Function Documentation

peak_IPL_HotpixelCorrection_Enable()

peak_status peak_IPL_HotpixelCorrection_Enable	(	peak_camera_handle	hCam,
		peak_bool	enabled
	)

Enable/Disable the host hotpixel correction.

Sets the host hotpixel correction to enabled or disabled. Hotpixel correction is supported for bayer and mono input images.

Parameters

[in]	hCam	The camera handle.
[in]	enabled	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.

peak_IPL_HotpixelCorrection_GetList()

peak_status peak_IPL_HotpixelCorrection_GetList	(	peak_camera_handle	hCam,
		peak_position *	hotpixelList,
		size_t *	hotpixelCount
	)

Get the list of detected host hotpixel correction positions/pixels.

Queries the list of detected host hotpixel correction positions/pixels.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	hotpixelList	Pointer to a user allocated array buffer to receive the hotpixel positions list. If this parameter is NULL, hotpixelCount will contain the current number of hotpixel positions. The required size of hotpixelList in bytes is hotpixelCount x sizeof(peak_position).
[in,out]	hotpixelCount	hotpixelList equal NULL: out: minimal number of hotpixel positions hotpixelList must be large enough to hold hotpixelList unequal NULL: in: number of hotpixel positions hotpixelList can hold out: number of hotpixel positions filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_INVALID_PARAMETER hotpixelCount 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

Please consider that the hotpixel positions 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_IPL_HotpixelCorrection_IsEnabled()

peak_bool peak_IPL_HotpixelCorrection_IsEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the host hotpixel correction.

Queries whether the host hotpixel correction is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_TRUE The host hotpixel correction feature is currently enabled.

PEAK_FALSE The host hotpixel correction feature is currently disabled or the query failed.

peak_IPL_HotpixelCorrection_ResetList()

peak_status peak_IPL_HotpixelCorrection_ResetList

(

peak_camera_handle

hCam

)

Reset the list of host hotpixel positions.

Resets the list of hotpixel positions that should be corrected, so they are automatically detected again.

By default, the host hotpixel correction automatically detects the hotpixel positions once and uses these positions for the hotpixel correction in the following images. This function resets/clears these positions, so they are automatically detected again.

Parameters

[in]

hCam

The camera handle.

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.

peak_IPL_HotpixelCorrection_Sensitivity_Get()

peak_status peak_IPL_HotpixelCorrection_Sensitivity_Get	(	peak_camera_handle	hCam,
		peak_hotpixel_correction_sensitivity *	hotpixelCorrectionSensitivity
	)

Get the host hotpixel correction sensitivity level.

Reads the current host hotpixel correction sensitivity level.

Parameters

[in]	hCam	The camera handle.
[out]	hotpixelCorrectionSensitivity	The color correction mode.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER hotpixelCorrectionSensitivity 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_HotpixelCorrection_Sensitivity_Set()

peak_status peak_IPL_HotpixelCorrection_Sensitivity_Set	(	peak_camera_handle	hCam,
		peak_hotpixel_correction_sensitivity	hotpixelCorrectionSensitivity
	)

Set the host hotpixel correction sensitivity level.

Sets the specified host hotpixel correction sensitivity level. Setting the sensitivity also resets already detected hotpixel positions, so they are automatically detected again, with the new sensitivity (see peak_IPL_HotpixelCorrection_ResetList).

Parameters

[in]	hCam	The camera handle.
[in]	hotpixelCorrectionSensitivity	The hotpixel correction sensitivity level.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER hotpixelCorrectionSensitivity is an invalid hotpixel correction sensitivity. Check peak_hotpixel_correction_sensitivity.

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_HotpixelCorrection_SetList()

peak_status peak_IPL_HotpixelCorrection_SetList	(	peak_camera_handle	hCam,
		const peak_position *	hotpixelList,
		size_t	hotpixelCount
	)

Set the list of host hotpixel positions.

Sets the list of hotpixel positions that should be corrected.

By default, the host hotpixel correction automatically detects and corrects hotpixels. This function overwrites the automatically detected hotpixel positions, so custom values can be used for the hotpixel correction.

Parameters

[in]	hCam	The camera handle.
[in]	hotpixelList	The positions that should be used in the hotpixel correction.
[in]	hotpixelCount	The number of hotpixel positions hotpixelList holds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER hotpixelList 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.