Home > C: Programming > Obsolete functions > History back  Previous chapter  Next chapter  Print  

is_SetBadPixelCorrectionTable

uEye Camera Manual Version 4.00

is_SetBadPixelCorrectionTable

Windows_Logo

Linux_Logo

USB 2.0

GigE

USB 2.0

GigE

Syntax

INT is_SetBadPixelCorrectionTable (HIDS hCam, INT nMode, WORD* pList)

Description

Achtung

This function is obsolete and should not be used anymore. We recommend to use the is_HotPixel() function instead (see also Obsolete functions).

is_SetBadPixelCorrectionTable() can be used to set the table containing the hot pixel positions which will be used by the user-defined hot pixel correction function. You can enable hot pixel correction by calling is_SetBadPixelCorrection(). Each value in the table consists of a 2-byte WORD data type. The first value indicates the number of pixel coordinates in the table, the coordinates are listed subsequently (first X, then Y).

A table with 3 hot pixels must be structured as follows:

3

X1

Y1

X2

Y2

X3

Y3

Input parameters

hCam

Camera handle

IS_SET_BADPIXEL_LIST

Sets a new user-defined list.

The pList parameter points to a list which has the format described above.

IS_GET_LIST_SIZE

Returns the number of pixel coordinates included in the user-defined list.

If the list contains no coordinates, the return value is -1.

IS_GET_BADPIXEL_LIST

Copies the user-defined list to the pList parameter. Make sure to allocate the memory accordingly.

pList

Pointer to the starting address of the hot pixel table

Return values

IS_SUCCESS

Function executed successfully

IS_NO_SUCCESS

General error message

When used with

IS_GET_LIST_SIZE

Number of coordinates in the list

If the list contains no coordinates, the return value is -1.

Related functions

is_LoadBadPixelCorrectionTable()

is_SaveBadPixelCorrectionTable()

is_SetBadPixelCorrection()

Example

WORD *pList = NULL;
 
// Number of coordinates in the list
INT nCount = is_SetBadPixelCorrectionTable (hCam, IS_GET_LIST_SIZE, NULL);
 
if (nCount > 0)
{
  // Allocate memory for the entire list
  pList = new WORD[1 + 2 * nCount];
 
  // Read out list
  is_SetBadPixelCorrectionTable (hCam, IS_GET_BADPIXEL_LIST, pList);
 
  // Release the list again
  delete [] pList;
}
else
{
  // No hot pixel list programmed
}


Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.


© 2012 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com