Changelog

List of changes in each version

v1.13.1

Bug Fixes

• Keep the saturation value when the image size changes

  When the image size is changed or when the first image is received, the processing modules are reset in the call to peak_IPL_ProcessFrame. Restoring this saturation value was missing after resetting the modules.

v1.13

Breaking changes

• Add new status code PEAK_STATUS_NOT_SUPPORTED for functions that process a frame with unsupported pixel format

• Fix return codes for get list functions

  When given a buffer that is too small, the functions peak_AutoBrightness_Exposure_Mode_GetList, peak_AutoBrightness_Gain_Mode_GetList and peak_AutoWhiteBalance_Mode_GetList returned with status PEAK_STATUS_INVALID_PARAMETER. Now the correct status PEAK_STATUS_BUFFER_TOO_SMALL is returned.

• peak_IPL_AutoBrightness_SkipFrames_Set and peak_IPL_AutoWhiteBalance_SkipFrames_GetRange now return PEAK_STATUS_OUT_OF_RANGE when the given values are out of range
• Fix misleading return code PEAK_STATUS_OUT_OF_RANGE for peak_IOChannel_Level_SetHigh. It now returns PEAK_STATUS_ACCESS_DENIED.

Features

• Add functions for reading and setting the shutter mode
• Add interface to control chunks and demonstrating sample

• Add chromatic adaption

  Chromatic adaption provides a solution to adjust the image's colors to changes in lighting conditions to maintain consistent color perception, even if white balancing fails.

Bug Fixes

• Fix issue when a TIFF image is saved with incorrect file extension. Extend possible return status code for peak_Frame_Save and peak_IPL_ImageWriter_Save
• Fix access status for binning and decimation with different engines, where the camera supports the feature only in vertical or horizontal direction
• Fix last error when calling peak_IPL_AutoFocus_ROI_Get with a buffer that is too small

v1.12

Features

• Add new functions to control digital black
• Add host side lookup table(LUT)

Bug Fixes

• Fix compatibility issues with XCP and XC models regarding trigger and auto features
• Fix ROI offset for auto white balance and brightness when ROI is changed
• Fix potential compilation error when building samples without CMake

v1.11

• Add new functions to rotate image via pixel pipeline. See peak_IPL_Rotation_Angle_Set
• Add new functions to create a histogram. See Histogram
• Add new functions to control the black level. See BlackLevel
• Revise the IO channel interface:
  • Rename io channels
    • Add new enumeration entries for io channels PEAK_IO_CHANNEL_LINE_0, ... PEAK_IO_CHANNEL_LINE_7
    • Add new functions that return the new io channels:
      • peak_IOChannel_GetListForDirection
      • peak_Trigger_Mode_Config_Get
      • peak_Flash_Mode_Config_Get
    • Mark as deprecated:
      • PEAK_IO_CHANNEL_TRIGGER_INPUT
      • PEAK_IO_CHANNEL_FLASH_OUTPUT
      • PEAK_IO_CHANNEL_GPIO_1
      • PEAK_IO_CHANNEL_GPIO_2
      • peak_IOChannel_GetList
      • peak_Trigger_Mode_Get
      • peak_Flash_Mode_Get
    • Use the PEAK_NO_WARN_DEPRECATED define to ignore deprecation warnings
  • Add new function to set a constant level of an io channel peak_IOChannel_Level_SetHigh
  • Add new peak_io_direction and related functions peak_IOChannel_Direction_GetAccessStatus, and peak_IOChannel_Direction_Get
  • Add new peak_io_type and related functions peak_IOChannel_Type_GetAccessStatus and peak_IOChannel_Type_Get
• Add new functions to control bandwidth via ThroughputLimit, see Bandwidth
• Add new functions to control IPO thread, see IPO
• Fix a bug that the input frame was modified within the pixel pipeline when peak_IPL_ProcessFrame was used.

v1.10

• Add new functions to control binning and decimation via subsampling engine. See Binning manual and Decimation manual
• Add new functions to control binning and decimation via pixel pipeline. See Binning and Decimation
• Add new functions to retrieve a list of supported pixel formats for sharpness measurement. See peak_IPL_Sharpness_GetList
• Add new functions to set scaling factors. See Scaling
• Fix a bug that Binning or Decimation could not be used if the camera does not support a horizontal or vertical factor

v1.9

• Add new functions to control camera status LED and camera network LED. See LED
• Add new functions to save frames as images to the filesystem. See ImageWriter
• Add new functions and associated messages for camera firmware upload. See Firmware Update
• Add new functions to set roi size and offset. See ROI (Region Of Interest)
• Add new functions to control image test pattern. See Test pattern
• Add new functions to control the buffer handling mode. See Buffer handling
• Add new functions to control the loss handling mode. See Loss handling

v1.8

• Add functions to change brightness algorithm for Auto brightness control
• Add functions to specify the Auto brightness control gain component
• Fix peak_CameraMemory_Area_Data_Write always writing the entire memory area

v1.7

• Add functions to control skip frames for Auto brightness control
• Add functions to control skip frames for Auto white balance control
• Add functions to control exposure limit for Auto brightness control
• Fix ROI (Region Of Interest) increment calculation with some sensors

v1.6.1

• Improve performance of binning and decimation functions

v1.6

• Add functions for Reconnect.
• Add function peak_Library_InterfaceTechnology_IsSupported to retrieve supported interface technologies.
• Add function peak_Camera_IsConnected
• Add function peak_Camera_Reboot
• Add new messages device found, device lost, device reconnected, device disconnected and the corresponding functions.

v1.5.1

• Speed up initial device list update for Ethernet cameras.

v1.5

• Add new functions for a Message Queue.
• Add new functions for I2C.

v1.4

• Add new functions for running inferences.
• Add new function peak_IPL_Sharpness_Measure for measuring sharpness of an image.
• Add new functions for host side edge enhancement
• Fix user provided hotpixel list getting overwritten on first call to peak_IPL_ProcessFrame or peak_IPL_ProcessFrameInplace.
• Fix user provided hotpixel list getting reset when calling peak_IPL_HotpixelCorrection_Sensitivity_Set or changing the region of interest
• Fix hotpixel list passed to peak_IPL_HotpixelCorrection_SetList as non-const pointer.
• Fix peak_camera_descriptor.userDefinedName not updated if the name has been changed. The name will now be updated when calling peak_CameraList_Update.
• Breaking changes
  • peak_IPL_HotpixelCorrection_Sensitivity_Set will no longer reset the hotpixel list, if provided by the user
  • The hotpixel list will no longer be reset when the region of interest changes, if the list was manually provided by the user

v1.3

• Add access to the user defined name property of a camera.
• Add new functions for controlling the active focus and auto focus.
• Add new functions peak_Camera_UserDefinedName_Set and peak_Camera_UserDefinedName_Get to control the user defined name of a camera.
• Add new function peak_Camera_ID_FromUserDefinedName to enable opening a camera by its user defined name.
• Add the user defined name to the peak_camera_descriptor.
• Add the property saturation to the host color correction feature.
  • Add new functions peak_IPL_ColorCorrection_Saturation_Get, peak_IPL_ColorCorrection_Saturation_Set, and peak_IPL_ColorCorrection_Saturation_GetRange.
• Fix possible use after free if the process is closed and peak_Library_Exit has not been called.
• Fix an issue where peak_IPL_AutoBrightness_TargetTolerance_Set sets the target value instead of the tolerance value
• Fix an issue where peak_Binning_Set and peak_Decimation_Set returns PEAK_STATUS_SUCCESS instead of PEAK_STATUS_OUT_OF_RANGE
• Fix an issue where peak_PixelFormat_GetList reports non-selectable pixelformats

v1.2

• Add new Video functions to encode frames and append them inside a video file
• Add new CameraMemory functions to access file storage on cameras
• Fix an issue where peak_ColorCorrection_GetAccessStatus for uEye camera models returns PEAK_ACCESS_READWRITE instead of PEAK_ACCESS_READONLY
• Fix an issue where peak_IOChannel_Xxx_GetAccessStatus returns PEAK_ACCESS_INVALID instead of PEAK_ACCESS_NOT_SUPPORTED for not supported io channels
• Fix an issue where peak_Acquisition_Start would return an error when starting the acquisition a second time in manual buffer management mode if buffers are not revoked between acquisitions

v1.1

• Add functionality to save and load .ini parameterset files from uEye to peak_CameraSettings_DiskFile_Store and peak_CameraSettings_DiskFile_Apply.
• Add new functions peak_IPL_AutoBrightness_ROI_Offset_GetRange and peak_IPL_AutoBrightness_ROI_Size_GetRange to query the current range of valid values for the host auto brightness ROI offset and dimensions
• Add new functions peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange and peak_IPL_AutoWhiteBalance_ROI_Size_GetRange to query the current range of valid values for the auto white balance ROI offset and dimensions
• Add PEAK_STATUS_VALUE_ADJUSTED as return value to the function peak_PixelClock_Set to address an issue for uEye camera models with a discrete list of valid pixel clock values.
• Add new cmake function ids_peak_comfort_c_generate_starter_script to generate a .sh script to start your application, which will take care of setting LD_LIBRARY_PATH, GENICAM_GENTL32_PATH and GENICAM_GENTL64_PATH, especially when using the .tar.gz package
• The cmake function peak_windeploy has been marked as deprecated and replaced by ids_peak_comfort_c_deploy to resolve naming conflicts with generic SDK packages
• Fix an issue where the C99 standard would not be set automatically when using newer cmake versions (>= 3.8)
• Fix an issue where peak_IPL_ColorCorrection_Matrix_Set did not work as expected
• Fix an issue where all peak_AutoBrightness_ROI_Xxx and peak_AutoWhiteBalance_ROI_Xxx functions return PEAK_STATUS_OUT_OF_RANGE instead of PEAK_STATUS_ACCESS_DENIED
• Fix an issue where peak_GFA_Enumeration_GetList reports all existing entries and not just the selectable ones
• Fix an issue where peak_Trigger_Mode_Set returned PEAK_STATUS_OUT_OF_RANGE instead of PEAK_STATUS_ACCESS_DENIED
• Fix an issue where peak_IPL_AutoBrightness_TargetPercentile_Set did not work as expected
• Fix an issue with the internal image buffer management in Manual Buffer Preparation mode
• Breaking changes
  • peak_Acquisition_Stop always returns PEAK_STATUS_SUCCESS now, even if no acquisition is running.
  • peak_Acquisition_Stop will now block until parallel stop calls (or the automatic stop in case of a finite acquisition sequence) have finished

v1.0

• Initial release