Syntax

INT is_HotPixel (HIDS hCam, UINT nCommand, void* pParam, UINT nSizeOfParam)

Description

is_HotPixel() configures the correction of sensor hot pixels. The correction is performed by the software. The hot pixel list is stored in the camera's non-volatile EEPROM. Some sensor models can also correct hot pixels directly in the sensor.

For further information on hot pixel correction, please refer to Basics: Hot pixels.

The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the nSizeOfParam input parameter.

Input parameters

Return values

Example 1

// Enable/disable correction

INT nRet = is_HotPixel(hCam, IS_HOTPIXEL_DISABLE_CORRECTION, NULL, NULL);

nRet = is_HotPixel(hCam, IS_HOTPIXEL_ENABLE_CAMERA_CORRECTION, NULL, NULL);

nRet = is_HotPixel(hCam, IS_HOTPIXEL_ENABLE_SOFTWARE_USER_CORRECTION, NULL, NULL);

nRet = is_HotPixel(hCam, IS_HOTPIXEL_ENABLE_SENSOR_CORRECTION, NULL, NULL);

nRet = is_HotPixel(hCam, IS_HOTPIXEL_DISABLE_SENSOR_CORRECTION, NULL, NULL);

Example 2

// Read out current mode

INT nMode = 0;

INT nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_CORRECTION_MODE,
                      (void*)&nMode, sizeof(nMode));

// Query supported modes

INT nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_SUPPORTED_CORRECTION_MODES,
                      (void*)&nMode, sizeof(nMode));

Example 3

// Query user-defined hot pixel list

INT nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_SOFTWARE_USER_LIST_EXISTS, NULL, NULL);

if (nRet == IS_SUCCESS)

{

  // Query the number of hot pixels in the user-defined list

  INT nNumber = 0;

  nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_SOFTWARE_USER_LIST_NUMBER,
                      (void*)&nNumber, sizeof(nNumber));

  if (nRet == IS_SUCCESS)

  {

      // Allocate sufficient memory. Each hot pixel needs two WORDS

       // memory space.

       // Additional memory space of one WORD per hot pixel is required for numbering.

      WORD *pList = new WORD[1 + 2 * nNumber];

      nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_SOFTWARE_USER_LIST,
                          (void*)pList, (1 + 2 * nNumber) * sizeof(WORD));

 

      // Change a value and save the list.

       // The number of the hot pixel has to be specified in pList[0]

      pList[1] = 100;

      nRet = is_HotPixel(hCam, IS_HOTPIXEL_SET_SOFTWARE_USER_LIST,
                          (void*)pList, (1 + 2 * nNumber) * sizeof(WORD));

 

      // Delete unneeded list

      delete [] pList;

  }

}

Example 4

// Save user-defined list to file

char File1[100];

ZeroMemory(File1, sizeof(File1));

strcpy(File1, "c:\\test.txt");

 

nRet = is_HotPixel(hCam, IS_HOTPIXEL_LOAD_SOFTWARE_USER_LIST, (void*)File1, 0);

 

nRet = is_HotPixel(hCam, IS_HOTPIXEL_SAVE_SOFTWARE_USER_LIST, (void*)File1, 0);

 

// Unicode

wchar_t File2[100];

ZeroMemory(File2, sizeof(File2));

wcscpy(File2, L"c:\\test.txt");

 

nRet = is_HotPixel(hCam, IS_HOTPIXEL_LOAD_SOFTWARE_USER_LIST_UNICODE, (void*)File2, 0);

 

nRet = is_HotPixel(hCam, IS_HOTPIXEL_SAVE_SOFTWARE_USER_LIST_UNICODE, (void*)File2, 0);

Example 5

// Save user-defined list to the camera EEPROM

INT nNumber = 0;

INT nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_CAMERA_USER_LIST_MAX_NUMBER,
                    (void*)&nNumber , sizeof(nNumber));

if (nRet == IS_SUCCESS)

{

  // Write the maximum number of hot pixels to EEPROM

  WORD *pList = new WORD[1 + 2 * nNumber];

  pList[0] = nNumber;

  for (int i = 0; i < nNumber; i++)

  {

      pList[1 + 2 * i] = x_value;

      pList[2 + 2 * i] = y_value;

  }

 

  nRet = is_HotPixel(hCam, IS_HOTPIXEL_SET_CAMERA_USER_LIST,
                      (void*)pList, (1 + 2 * nNumber) * sizeof(WORD));

 

  delete [] pList;

 

  // Delete user-defined EEPROM list

  nRet = is_HotPixel(hCam, IS_HOTPIXEL_DELETE_CAMERA_USER_LIST, NULL, NULL);

}

Example 6

// Return combined list

INT nNumber = 0;

INT nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_MERGED_CAMERA_LIST_NUMBER,
                      (void*)&nNumber , sizeof(nNumber));

if (nRet == IS_SUCCESS)

{

    // Allocate sufficient memory. Each hot pixel needs two WORDS

    // memory space.

    // Additional memory space of one WORD per hot pixel is required for numbering.

    WORD *pList = new WORD[1 + 2 * nNumber];

  nRet = is_HotPixel(hCam, IS_HOTPIXEL_GET_MERGED_CAMERA_LIST,
                      (void*)pList, (1 + 2 * nNumber) * sizeof(WORD));

 

  // Delete unneeded list

  delete [] pList;

}

---

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