9#ifndef PEAK_COMFORT_C_H
10#define PEAK_COMFORT_C_H
14# ifndef PEAK_NO_DECLSPEC_STATEMENTS
16# define PEAK_EXPORT __declspec(dllexport)
18# define PEAK_EXPORT __declspec(dllimport)
23# if defined(_M_IX86) || defined(__i386__)
24# define PEAK_CALLCONV __cdecl
28#elif defined(__linux__)
31# define PEAK_CALLCONV __attribute__((cdecl))
36# error Platform is not supported yet!
49#if !defined(PEAK_NO_WARN_DEPRECATED)
50# if defined(__cplusplus) && __cplusplus >= 201402L || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)
51# define PEAK_DEPRECATED_ATTR [[ deprecated ]]
52# define PEAK_DEPRECATED_ATTR_MSG(X) [[ deprecated(X) ]]
53# define PEAK_DEPRECATED(X) X PEAK_DEPRECATED_ATTR
54# define PEAK_DEPRECATED_MSG(X, Y) X [[ deprecated(Y) ]]
55# elif defined(__GNUC__)
56# define PEAK_DEPRECATED_ATTR __attribute__(( deprecated ))
57# define PEAK_DEPRECATED_ATTR_MSG(X) __attribute__(( deprecated(X) ))
58# define PEAK_DEPRECATED(X) X PEAK_DEPRECATED_ATTR
59# define PEAK_DEPRECATED_MSG(X, Y) X __attribute__(( deprecated(Y) ))
61# define PEAK_DEPRECATED_ATTR
62# define PEAK_DEPRECATED_ATTR_MSG(X)
63# define PEAK_DEPRECATED(X) X
64# define PEAK_DEPRECATED_MSG(X, Y) X
67# define PEAK_DEPRECATED_ATTR
68# define PEAK_DEPRECATED_ATTR_MSG(X)
69# define PEAK_DEPRECATED(X) X
70# define PEAK_DEPRECATED_MSG(X, Y) X
78struct peak_inference_result;
79struct peak_message_queue;
82struct peak_imagewriter;
85#define PEAK_VERSION_CODE(major,minor,subminor,patch) (((major) << 24) + ((minor) << 16) + ((subminor) << 8) + (patch))
86#define PEAK_API_STATUS PEAK_EXPORT peak_status PEAK_CALLCONV
87#define PEAK_API_STATUS_DEPRECATED(X) PEAK_EXPORT PEAK_DEPRECATED_ATTR_MSG(X) peak_status PEAK_CALLCONV
88#define PEAK_API_ACCESS_STATUS PEAK_EXPORT peak_access_status PEAK_CALLCONV
89#define PEAK_API_BOOL PEAK_EXPORT peak_bool PEAK_CALLCONV
90#define PEAK_API_CAMERA_ID PEAK_EXPORT peak_camera_id PEAK_CALLCONV
865#define PEAK_INVALID_HANDLE NULL
879#define PEAK_INFINITE 0xffffffff
1053#define PEAK_IDENTITY_MATRIX { 1.0, 0.0, 0.0, \
1169#define PEAK_SUCCESS(status) ((((status) & 0xf000) == 0x0000) ? PEAK_TRUE : PEAK_FALSE)
1182#define PEAK_WARNING(status) ((((status) & 0xf000) == 0x4000) ? PEAK_TRUE : PEAK_FALSE)
1195#define PEAK_ERROR(status) ((((status) & 0xf000) == 0x8000) ? PEAK_TRUE : PEAK_FALSE)
1271#define PEAK_IS_WRITEABLE(accessStatus) ((((accessStatus) & 0x2000) == 0x2000) ? PEAK_TRUE : PEAK_FALSE)
1287#define PEAK_IS_READABLE(accessStatus) ((((accessStatus) & 0x1000) == 0x1000) ? PEAK_TRUE : PEAK_FALSE)
1302#define PEAK_IS_SUPPORTED(accessStatus) (((accessStatus) != PEAK_ACCESS_NOT_SUPPORTED) ? PEAK_TRUE : PEAK_FALSE)
1326 PEAK_DEPRECATED_MSG(peak_interface_technology_INVALID,
"Use PEAK_INTERFACE_TECHNOLOGY_INVALID instead") = 0x0,
1327 PEAK_DEPRECATED_MSG(peak_interface_technology_GEV,
"Use PEAK_INTERFACE_TECHNOLOGY_GEV instead") = 0x1,
1328 PEAK_DEPRECATED_MSG(peak_interface_technology_U3V,
"Use PEAK_INTERFACE_TECHNOLOGY_U3V instead") = 0x2,
1329 PEAK_DEPRECATED_MSG(peak_interface_technology_UEYE,
"Use PEAK_INTERFACE_TECHNOLOGY_UEYE instead") = 0x3,
1390 uint32_t* patchVersion);
1435 size_t* lastErrorMessageSize);
1519#define PEAK_INVALID_CAMERA_ID UINT64_C(0)
1521#pragma pack(push, 1)
1565 uint8_t reserved[444];
1593 uint8_t reserved[64];
1803#pragma pack(push, 1)
2047 size_t* userDefinedNameSize);
2084#pragma pack(push, 1)
2108#pragma pack (push, 1)
2123 uint8_t reserved[4];
2173#pragma pack (push, 1)
2199 uint8_t reservedCamera[64];
2207 uint8_t reserved[64];
2466#pragma pack(push, 1)
2501 uint8_t reserved[256];
3355 int64_t* maxTimeout, int64_t* incTimeout);
3596#pragma pack(push, 1)
3641 uint8_t reserved[64];
3719#pragma pack(push, 1)
3777 uint8_t reserved[256];
4173 size_t* parameterSetCount);
4439 double* incFrameRate_fps);
4537 double* maxExposureTime_us,
double* incExposureTime_us);
4807 double* incPixelClock_MHz);
4934 PEAK_DEPRECATED_MSG(PEAK_IO_CHANNEL_TRIGGER_INPUT,
"Use PEAK_IO_CHANNEL_LINE_0 instead") = 0x2101,
4943 PEAK_DEPRECATED_MSG(PEAK_IO_CHANNEL_FLASH_OUTPUT,
"Use PEAK_IO_CHANNEL_LINE_1 instead") = 0x2201,
4952 PEAK_DEPRECATED_MSG(PEAK_IO_CHANNEL_GPIO_1,
"Use PEAK_IO_CHANNEL_LINE_2 instead") = 0x6301,
4961 PEAK_DEPRECATED_MSG(PEAK_IO_CHANNEL_GPIO_2,
"Use PEAK_IO_CHANNEL_LINE_3 instead") = 0x6302,
5132PEAK_API_STATUS_DEPRECATED(
"Use peak_IOChannel_GetListForDirection instead")
5575 double* minNoiseFilterDuration_us,
double* maxNoiseFilterDuration_us,
double* incNoiseFilterDuration_us);
5601 double noiseFilterDuration_us);
5625 double* noiseFilterDuration_us);
5688#define PEAK_TRIGGER_MODE_HARDWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_TRIGGER_INPUT }
5703#define PEAK_TRIGGER_MODE_SOFTWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_SOFTWARE }
5908PEAK_API_STATUS_DEPRECATED(
"Use peak_Trigger_Mode_Config_Get instead")
6040 size_t* triggerEdgeCount);
6145 double* maxTriggerDelay_us,
double* incTriggerDelay_us);
6250 uint32_t* maxTriggerDivider, uint32_t* incTriggerDivider);
6354 uint32_t* maxTriggerBurst, uint32_t* incTriggerBurst);
6472#define PEAK_FLASH_MODE_EXPOSURE_ACTIVE { PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6481#define PEAK_FLASH_MODE_ACQUISITION_ACTIVE { PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6490#define PEAK_FLASH_MODE_GLOBAL_START_WINDOW { PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6649PEAK_API_STATUS_DEPRECATED(
"Use peak_Flash_Mode_Config_Get instead")
6731 double* maxFlashStartDelay_us,
double* incFlashStartDelay_us);
6835 double* maxFlashEndDelay_us,
double* incFlashEndDelay_us);
6940 double* maxFlashDuration_us,
double* incFlashDuration_us);
7036 uint32_t* incFocus);
7153 size_t* pixelFormatCount);
7352 double* minGain,
double* maxGain,
double* incGain);
7705 double* maxMatrixElementValue,
double* incMatrixElementValue);
7965 uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
8066 uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
8067 uint32_t* incAutoBrightnessTargetTolerance);
8091 uint32_t autoBrightnessTargetTolerance);
8113 uint32_t* autoBrightnessTargetTolerance);
8169 double* minAutoBrightnessTargetPercentile,
double* maxAutoBrightnessTargetPercentile,
8170 double* incAutoBrightnessTargetPercentile);
8194 double autoBrightnessTargetPercentile);
8216 double* autoBrightnessTargetPercentile);
9256 size_t* binningFactorXCount);
9299 size_t* binningFactorYCount);
9608 size_t* decimationFactorXCount);
9653 size_t* decimationFactorYCount);
9928 double* maxScalingFactorX,
double* incScalingFactorX);
9953 double* maxScalingFactorY,
double* incScalingFactorY);
10489 const char* featureName);
10546 double* minFloatValue,
double* maxFloatValue,
double* incFloatValue);
10595 double* floatList,
size_t* floatCount);
10630 double floatValue);
10659 double* floatValue);
10679 const char* integerFeatureName);
10717 const char* integerFeatureName, int64_t* minIntegerValue, int64_t* maxIntegerValue, int64_t* incIntegerValue);
10768 const char* integerFeatureName, int64_t* integerList,
size_t* integerCount);
10803 int64_t integerValue);
10832 int64_t* integerValue);
10928 const char* stringValue);
10977 char* stringValue,
size_t* stringValueSize);
11008 const char* commandFeatureName);
11045 const char* commandFeatureName, uint32_t timeout_ms);
11115 size_t* enumerationEntryCount);
11191 peak_gfa_module module,
const char* enumerationFeatureName,
const char* enumerationEntrySymbolicValue);
11227 peak_gfa_module module,
const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
11301 const char* enumerationFeatureName,
const char* enumerationEntrySymbolicValue);
11336 const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
11400 const uint8_t* registerValue,
size_t registerValueSize);
11444 uint8_t* registerValue,
size_t* registerValueSize);
11478 const uint8_t* data,
size_t dataSize);
11617 double* maxGain,
double* incGain);
12021 peak_camera_handle hCam, uint32_t* minColorTemperature, uint32_t* maxColorTemperature, uint32_t* incColorTemperature);
12111 uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
12174 uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
12175 uint32_t* incAutoBrightnessTargetTolerance);
12197 uint32_t autoBrightnessTargetTolerance);
12217 uint32_t* autoBrightnessTargetTolerance);
12241 double* minAutoBrightnessTargetPercentile,
double* maxAutoBrightnessTargetPercentile,
12242 double* incAutoBrightnessTargetPercentile);
12264 double autoBrightnessTargetPercentile);
12284 double* autoBrightnessTargetPercentile);
13127 uint32_t* skipFramesMin, uint32_t* skipFramesMax, uint32_t* skipFramesInc);
13222 peak_size* incAutoWhiteBalanceROISize);
13366 uint32_t* skipFramesMin, uint32_t* skipFramesMax, uint32_t* skipFramesInc);
13391#pragma pack(push, 1)
13459 size_t autoFocusROICount);
13495 size_t* autoFocusROICount);
13820 uint8_t* maxHysteresis, uint8_t* incHysteresis);
13945 size_t* hotpixelCount);
13969 size_t hotpixelCount);
14297 uint32_t* minFactor, uint32_t* maxFactor, uint32_t* incFactor);
14360#define PEAK_ROTATION_ANGLE_0 (0)
14366#define PEAK_ROTATION_ANGLE_180 (180)
14372#define PEAK_ROTATION_ANGLE_CLOCKWISE_90 (-90)
14378#define PEAK_ROTATION_ANGLE_CLOCKWISE_270 (-270)
14384#define PEAK_ROTATION_ANGLE_COUNTERCLOCKWISE_90 (90)
14390#define PEAK_ROTATION_ANGLE_COUNTERCLOCKWISE_270 (270)
14810 uint64_t encodedFrames;
14813 uint64_t droppedFrames;
14818 uint8_t reserved[256];
15332 uint32_t numInferencesSuccessful;
15335 uint32_t numInferencesFailed;
15338 char reserved[256];
15339} peak_inference_statistics;
15408 uint32_t* maxThreshold, uint32_t* incThreshold);
16368 size_t messageQueueMaxSize);
16388 size_t* messageQueueMaxSize);
16506 uint64_t* hostTimestamp_ns);
17665}
peak_imagefile_format, PEAK_DEPRECATED_MSG(papientitiy_imagefile_format,
"use peak_imagefile_format");
17775 size_t* binningFactorXCount);
17809 size_t* binningFactorYCount);
17892 size_t* decimationFactorXCount);
17928 size_t* decimationFactorYCount);
18199 size_t* testPatternCount);
18607#define PEAK_LINKSPEED_ETH_10M 1250000
18613#define PEAK_LINKSPEED_ETH_100M 12500000
18619#define PEAK_LINKSPEED_USB2_HIGH_SPEED 60000000
18625#define PEAK_LINKSPEED_ETH_1G 125000000
18631#define PEAK_LINKSPEED_ETH_5G 625000000
18637#define PEAK_LINKSPEED_ETH_10G 1250000000
18643#define PEAK_LINKSPEED_USB3_SUPER_SPEED 500000000
18722 int64_t* maxThroughputLimit_Bps, int64_t* incThroughputLimit_Bps);
peak_status peak_Acquisition_GetInfo(peak_camera_handle hCam, peak_acquisition_info *acquisitionInfo)
Query the acquisition info.
peak_bool peak_Acquisition_IsStarted(peak_camera_handle hCam)
Check whether the acquisition is currently started or not.
peak_status peak_Acquisition_Stop(peak_camera_handle hCam)
Stops an acquisition.
peak_status peak_Acquisition_WaitForFrame(peak_camera_handle hCam, uint32_t timeout_ms, peak_frame_handle *hFrame)
Wait for an acquired frame.
peak_status peak_Acquisition_Start(peak_camera_handle hCam, uint32_t numberOfFrames)
Start an acquisition.
peak_status peak_AutoBrightness_TargetPercentile_Set(peak_camera_handle hCam, double autoBrightnessTargetPercentile)
Set the auto brightness target percentile value.
peak_status peak_AutoBrightness_TargetTolerance_GetRange(peak_camera_handle hCam, uint32_t *minAutoBrightnessTargetTolerance, uint32_t *maxAutoBrightnessTargetTolerance, uint32_t *incAutoBrightnessTargetTolerance)
Get the current range of valid auto brightness target tolerance values.
peak_status peak_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
Get the auto brightness target value.
peak_status peak_AutoBrightness_Gain_Mode_GetList(peak_camera_handle hCam, peak_auto_feature_mode *modeList, size_t *modeListSize)
Get the list of currently selectable auto brightness gain control modes.
peak_status peak_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoBrightnessROISize, peak_size *maxAutoBrightnessROISize, peak_size *incAutoBrightnessROISize)
Get the current range of valid auto brightness ROI sizes.
peak_status peak_AutoBrightness_Exposure_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
Set the auto exposure control mode.
peak_access_status peak_AutoBrightness_ROI_GetAccessStatus(peak_camera_handle hCam)
Query the auto brightness access status.
peak_access_status peak_AutoBrightness_Exposure_GetAccessStatus(peak_camera_handle hCam)
Query the auto exposure control access status.
peak_access_status peak_AutoBrightness_TargetPercentile_GetAccessStatus(peak_camera_handle hCam)
Query the auto brightness access status.
peak_access_status peak_AutoBrightness_Gain_GetAccessStatus(peak_camera_handle hCam)
Query the auto gain control access status.
peak_status peak_AutoBrightness_TargetPercentile_Get(peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
Get the auto brightness target percentile value.
peak_access_status peak_AutoBrightness_GetAccessStatus(peak_camera_handle hCam)
Query the auto brightness access status.
peak_status peak_AutoBrightness_TargetTolerance_Set(peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
Set the auto brightness target tolerance value.
peak_status peak_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the auto gain control mode.
peak_access_status peak_AutoBrightness_TargetTolerance_GetAccessStatus(peak_camera_handle hCam)
Query the auto brightness access status.
peak_status peak_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI)
Set the auto brightness ROI.
peak_status peak_AutoBrightness_TargetPercentile_GetRange(peak_camera_handle hCam, double *minAutoBrightnessTargetPercentile, double *maxAutoBrightnessTargetPercentile, double *incAutoBrightnessTargetPercentile)
Get the current range of valid auto brightness target percentile values.
peak_status peak_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the auto gain control mode.
peak_status peak_AutoBrightness_TargetTolerance_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
Get the auto brightness target tolerance value.
peak_status peak_AutoBrightness_Exposure_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
Get the auto exposure control mode.
peak_status peak_AutoBrightness_Exposure_Mode_GetList(peak_camera_handle hCam, peak_auto_feature_mode *modeList, size_t *modeListSize)
Get the list of currently selectable auto brightness exposure control modes.
peak_status peak_AutoBrightness_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
Get the auto brightness ROI mode.
peak_status peak_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi *autoBrightnessROI)
Get the auto brightness ROI.
peak_status peak_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget)
Set the auto brightness target value.
peak_status peak_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t *minAutoBrightnessTarget, uint32_t *maxAutoBrightnessTarget, uint32_t *incAutoBrightnessTarget)
Get the current range of valid auto brightness target values.
peak_status peak_AutoBrightness_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
Set the auto brightness ROI mode.
peak_access_status peak_AutoBrightness_Target_GetAccessStatus(peak_camera_handle hCam)
Query the auto brightness access status.
peak_status peak_AutoBrightness_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoBrightnessROIOffset, peak_position *maxAutoBrightnessROIOffset, peak_position *incAutoBrightnessROIOffset)
Get the current range of valid auto brightness ROI offsets.
peak_status peak_AutoWhiteBalance_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
Get the auto white balance ROI mode.
peak_access_status peak_AutoWhiteBalance_ROI_GetAccessStatus(peak_camera_handle hCam)
Query the auto white balance ROI access status.
peak_status peak_AutoWhiteBalance_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoWhiteBalanceROIOffset, peak_position *maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
Get the current range of valid auto white balance ROI offsets.
peak_access_status peak_AutoWhiteBalance_GetAccessStatus(peak_camera_handle hCam)
Query the auto white balance access status.
peak_status peak_AutoWhiteBalance_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
Set the auto white balance ROI mode.
peak_status peak_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
Set the auto white balance control mode.
peak_status peak_AutoWhiteBalance_Mode_GetList(peak_camera_handle hCam, peak_auto_feature_mode *modeList, size_t *modeListSize)
Get the list of currently selectable auto white balance control modes.
peak_status peak_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
Get the auto white balance ROI.
peak_status peak_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
Set the auto white balance ROI.
peak_status peak_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
Get the auto white balance control mode.
peak_status peak_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoWhiteBalanceROISize, peak_size *maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
Get the current range of valid auto white balance ROI sizes.
peak_access_status peak_Bandwidth_ThroughputCalculated_GetAccessStatus(peak_camera_handle hCam)
Query the throughput calculated access status.
peak_access_status peak_Bandwidth_LinkSpeed_GetAccessStatus(peak_camera_handle hCam)
Query the link speed access status.
peak_status peak_Bandwidth_ThroughputLimit_Get(peak_camera_handle hCam, int64_t *throughputLimit_Bps)
Get the throughput limit.
peak_status peak_Bandwidth_ThroughputFrameRateLimit_Get(peak_camera_handle hCam, double *throughputFrameRateLimit_fps)
Get the throughput frame rate limit.
peak_status peak_Bandwidth_ThroughputLimit_Set(peak_camera_handle hCam, int64_t throughputLimit_Bps)
Set the throughput limit.
peak_status peak_Bandwidth_LinkSpeed_Get(peak_camera_handle hCam, int64_t *linkSpeed_Bps)
Get the link speed.
peak_access_status peak_Bandwidth_ThroughputLimit_GetAccessStatus(peak_camera_handle hCam)
Query the throughput limit access status.
peak_status peak_Bandwidth_ThroughputLimit_GetRange(peak_camera_handle hCam, int64_t *minThroughputLimit_Bps, int64_t *maxThroughputLimit_Bps, int64_t *incThroughputLimit_Bps)
Get the current range of valid throughput limit values.
peak_status peak_Bandwidth_ThroughputCalculated_Get(peak_camera_handle hCam, int64_t *throughputCalculated_Bps)
Get the throughput calculated.
peak_access_status peak_Bandwidth_ThroughputFrameRateLimit_GetAccessStatus(peak_camera_handle hCam)
Query the throughput frame rate limit access status.
peak_status peak_BinningManual_FactorY_GetList(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *binningFactorYList, size_t *binningFactorYCount)
Get the list of currently selectable factors for the binning in y direction.
peak_access_status peak_BinningManual_GetAccessStatus(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine)
Query the binning manual access status.
peak_status peak_BinningManual_Get(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *binningFactorX, uint32_t *binningFactorY)
Get the binning factors.
peak_status peak_BinningManual_Set(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t binningFactorX, uint32_t binningFactorY)
Set the binning factors.
peak_status peak_BinningManual_FactorX_GetList(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *binningFactorXList, size_t *binningFactorXCount)
Get the list of currently selectable factors for the binning in x direction.
peak_status peak_Binning_Get(peak_camera_handle hCam, uint32_t *binningFactorX, uint32_t *binningFactorY)
Get the binning factors.
peak_status peak_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t *binningFactorXList, size_t *binningFactorXCount)
Get the list of currently selectable factors for the binning in x direction.
peak_status peak_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t *binningFactorYList, size_t *binningFactorYCount)
Get the list of currently selectable factors for the binning in y direction.
peak_status peak_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
Set the binning factors.
peak_access_status peak_Binning_GetAccessStatus(peak_camera_handle hCam)
Query the binning access status.
peak_access_status peak_BlackLevel_Auto_GetAccessStatus(peak_camera_handle hCam)
Query black level auto access status.
peak_status peak_BlackLevel_Offset_GetRange(peak_camera_handle hCam, double *min, double *max, double *inc)
Get the range for the black level offset.
peak_bool peak_BlackLevel_Auto_IsEnabled(peak_camera_handle hCam)
Get the black level auto enable state.
peak_status peak_BlackLevel_Offset_Get(peak_camera_handle hCam, double *offset)
Get the current black level offset.
peak_access_status peak_BlackLevel_Offset_GetAccessStatus(peak_camera_handle hCam)
Query black level offset access status.
peak_status peak_BlackLevel_Offset_Set(peak_camera_handle hCam, double offset)
Set the black level offset.
peak_status peak_BlackLevel_Auto_Enable(peak_camera_handle hCam, peak_bool enable)
Set the black level auto enable state.
peak_status peak_Acquisition_BufferHandling_Mode_Get(peak_camera_handle hCam, peak_buffer_handling_mode *mode)
Get the buffer handling mode.
peak_status peak_Acquisition_BufferHandling_Mode_GetList(peak_camera_handle hCam, peak_buffer_handling_mode *bufferHandlingModeList, size_t *bufferHandlingModesCount)
Get the list of currently usable buffer handling modes.
peak_access_status peak_Acquisition_BufferHandling_Mode_GetAccessStatus(peak_camera_handle hCam)
Query the buffer handling mode access status.
peak_status peak_Acquisition_BufferHandling_Mode_Set(peak_camera_handle hCam, peak_buffer_handling_mode mode)
Set the buffer handling mode.
peak_buffer_handling_mode
peak buffer handling modes
Definition ids_peak_comfort_c.h:2790
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST_SINGLE_BUFFER
Oldest First Single Buffer Mode.
Definition ids_peak_comfort_c.h:2836
@ PEAK_BUFFER_HANDLING_MODE_NEWEST_ONLY
Newest Only Mode.
Definition ids_peak_comfort_c.h:2818
@ PEAK_BUFFER_HANDLING_MODE_INVALID
Invalid buffer handling mode.
Definition ids_peak_comfort_c.h:2795
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST_DEPEND_ON_CAMERA_FIFO
Oldest First Depend On Camera FIFO Mode.
Definition ids_peak_comfort_c.h:2850
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST
Oldest First Mode.
Definition ids_peak_comfort_c.h:2809
peak_camera_memory_area
peak Camera Memory Area
Definition ids_peak_comfort_c.h:10143
peak_status peak_CameraMemory_Area_Data_Read(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, uint8_t *data, size_t dataSize)
Read from the specified camera memory area.
peak_status peak_CameraMemory_Area_GetList(peak_camera_handle hCam, peak_camera_memory_area *cameraMemoryAreaList, size_t *cameraMemoryAreaCount)
Get the list of currently usable camera memory areas.
peak_status peak_CameraMemory_Area_Size_Get(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, size_t *cameraMemoryAreaSize)
Get the size of a camera memory area.
peak_access_status peak_CameraMemory_Area_GetAccessStatus(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea)
Query the camera memory area access status.
peak_status peak_CameraMemory_Area_Data_Write(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, const uint8_t *data, size_t dataSize)
Write to a camera memory area.
peak_status peak_CameraMemory_Area_Data_Clear(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea)
Clear a camera memory area.
@ PEAK_CAMERA_MEMORY_AREA_USER_DATA_2
Cameras User Data 2 memory.
Definition ids_peak_comfort_c.h:10160
@ PEAK_CAMERA_MEMORY_AREA_INVALID
Invalid memory area.
Definition ids_peak_comfort_c.h:10148
@ PEAK_CAMERA_MEMORY_AREA_USER_DATA_1
Cameras User Data 1 memory.
Definition ids_peak_comfort_c.h:10154
peak_access_status peak_CameraSettings_DiskFile_GetAccessStatus(peak_camera_handle hCam)
Query the disk file settings access status.
peak_status peak_CameraSettings_ParameterSet_Store(peak_camera_handle hCam, peak_parameter_set parameterSet)
Store the current camera configuration in a user-definable parameter set.
peak_parameter_set
peak Parameter set
Definition ids_peak_comfort_c.h:4059
peak_status peak_CameraSettings_ParameterSet_GetList(peak_camera_handle hCam, peak_parameter_set *parameterSetList, size_t *parameterSetCount)
Get the list of currently usable parameter sets.
peak_status peak_CameraSettings_ParameterSet_Startup_Get(peak_camera_handle hCam, peak_parameter_set *parameterSet)
Get the startup parameter set.
peak_status peak_CameraSettings_DiskFile_Store(peak_camera_handle hCam, const char *file)
Store the current camera configuration to a disk file.
peak_status peak_CameraSettings_DiskFile_Apply(peak_camera_handle hCam, const char *file)
Apply the camera configuration from the specified disk file.
peak_access_status peak_CameraSettings_ParameterSet_GetAccessStatus(peak_camera_handle hCam, peak_parameter_set parameterSet)
Query the parameter set access status.
peak_access_status peak_CameraSettings_ParameterSet_Startup_GetAccessStatus(peak_camera_handle hCam)
Query the startup parameter set access status.
peak_status peak_CameraSettings_ParameterSet_Apply(peak_camera_handle hCam, peak_parameter_set parameterSet)
Apply the specified parameter set.
peak_status peak_CameraSettings_ParameterSet_Startup_Set(peak_camera_handle hCam, peak_parameter_set parameterSet)
Set the startup parameter set.
@ PEAK_PARAMETER_SET_LONG_EXPOSURE
Long exposure set.
Definition ids_peak_comfort_c.h:4082
@ PEAK_PARAMETER_SET_USER_1
User set 1.
Definition ids_peak_comfort_c.h:4089
@ PEAK_PARAMETER_SET_INVALID
Invalid parameter set.
Definition ids_peak_comfort_c.h:4064
@ PEAK_PARAMETER_SET_LINESCAN
Linescan set.
Definition ids_peak_comfort_c.h:4076
@ PEAK_PARAMETER_SET_USER_2
User set 2.
Definition ids_peak_comfort_c.h:4096
@ PEAK_PARAMETER_SET_DEFAULT
Default set.
Definition ids_peak_comfort_c.h:4070
uint64_t peak_camera_id
peak Camera ID
Definition ids_peak_comfort_c.h:1511
peak_status peak_CameraList_Update(size_t *cameraCount)
Update the camera list.
struct peak_camera * peak_camera_handle
peak Camera handle
Definition ids_peak_comfort_c.h:1496
peak_camera_id peak_Camera_ID_FromSerialNumber(const char *serialNumber)
Query the camera id by the serial number.
peak_bool peak_Camera_IsConnected(peak_camera_handle hCam)
Get the connected status of the camera.
peak_status peak_Camera_Open(peak_camera_id cameraID, peak_camera_handle *hCam)
Open the camera by the Camera id.
peak_camera_id peak_Camera_ID_FromUserDefinedName(const char *userDefinedName)
Query the camera id by the user defined name.
peak_status peak_Camera_Reboot(peak_camera_handle hCam)
Reboot the camera.
peak_status peak_Camera_UserDefinedName_Get(peak_camera_handle hCam, char *userDefinedName, size_t *userDefinedNameSize)
Get the user defined name.
peak_status peak_Camera_GetDescriptor(peak_camera_id cameraID, peak_camera_descriptor *cameraDescriptor)
Query the camera descriptor.
peak_status peak_Camera_UserDefinedName_Set(peak_camera_handle hCam, const char *userDefinedName)
Set the user defined name.
peak_status peak_Camera_ResetToDefaultSettings(peak_camera_handle hCam)
Reset the camera configuration.
peak_status peak_CameraList_Get(peak_camera_descriptor *cameraList, size_t *cameraCount)
Query the current camera list.
peak_status peak_Camera_Close(peak_camera_handle hCam)
Close the camera.
peak_access_status peak_Camera_GetAccessStatus(peak_camera_id cameraID)
Query the camera access status.
peak_camera_type
peak Camera types
Definition ids_peak_comfort_c.h:1464
peak_status peak_Camera_OpenFirstAvailable(peak_camera_handle *hCam)
Open the first available camera.
peak_camera_id peak_Camera_ID_FromHandle(peak_camera_handle hCam)
Query the camera id by the camera handle.
peak_camera_id peak_Camera_ID_FromMAC(peak_mac_address macAddress)
Query the camera id by the mac address.
@ PEAK_CAMERA_TYPE_UEYE_USB
uEye USB camera
Definition ids_peak_comfort_c.h:1472
@ PEAK_CAMERA_TYPE_UEYE_PLUS_GEV
uEye+ GigE Vision camera
Definition ids_peak_comfort_c.h:1481
@ PEAK_CAMERA_TYPE_UEYE_PLUS_U3V
uEye+ USB3 Vision camera
Definition ids_peak_comfort_c.h:1478
@ PEAK_CAMERA_TYPE_INVALID
Invalid camera type.
Definition ids_peak_comfort_c.h:1469
@ PEAK_CAMERA_TYPE_UEYE_ETH
uEye Eth camera
Definition ids_peak_comfort_c.h:1475
peak_bool peak_Chunks_Type_IsEnabled(peak_camera_handle hCam, peak_chunks_type type)
Indicates whether a specific chunk type is enabled or disabled.
peak_access_status peak_Chunks_Type_GetAccessStatus(peak_camera_handle hCam, peak_chunks_type type)
Query the chunk type's access status.
peak_ptp_status
Enumeration representing the status of PTP (Precision Time Protocol).
Definition ids_peak_comfort_c.h:19694
peak_status peak_Chunks_Exposure_Get(peak_camera_handle hCam, peak_chunks_exposure *data)
Retrieves the exposure information from chunk data.
peak_status peak_Chunks_Enable(peak_camera_handle hCam, peak_bool enabled)
Control whether the chunk transmission is enabled or disabled.
peak_status peak_Chunks_PTPStatus_Get(peak_camera_handle hCam, peak_chunks_ptp_status *data)
Retrieves the Precision Time Protocol (PTP) status information from chunk data.
peak_status peak_Chunks_Timestamp_Get(peak_camera_handle hCam, peak_chunks_timestamp *data)
Retrieves the timestamp information from chunk data.
peak_status peak_Chunks_ExposureTrigger_Get(peak_camera_handle hCam, peak_chunks_exposure_trigger *data)
Retrieves the exposure trigger timestamp information from chunk data.
peak_status peak_Chunks_Type_Supported_GetList(peak_camera_handle hCam, peak_chunks_type *chunksTypesSupported, size_t *chunksTypesSize)
Get the list of supported chunk types.
peak_status peak_Chunks_Type_Enable(peak_camera_handle hCam, peak_chunks_type type, peak_bool enabled)
Control whether a specific chunk type is enabled or disabled.
peak_access_status peak_Chunks_GetAccessStatus(peak_camera_handle hCam)
Query the chunks access status.
peak_status peak_Chunks_Update(peak_camera_handle hCam, peak_frame_handle hFrame)
Update the chunk data from the frame.
peak_status peak_Chunks_Sequencer_Get(peak_camera_handle hCam, peak_chunks_sequencer *data)
Retrieves the sequencer information from chunk data.
peak_status peak_Chunks_AutoUpdate_Enable(peak_camera_handle hCam, peak_bool enabled)
Control whether the chunks auto update is enabled or disabled.
peak_bool peak_Chunks_AutoUpdate_IsEnabled(peak_camera_handle hCam)
Indicates whether the chunks auto update is enabled or disabled.
peak_chunks_type
Enumeration for chunk types.
Definition ids_peak_comfort_c.h:19263
peak_bool peak_Chunks_IsEnabled(peak_camera_handle hCam)
Indicates whether chunks are enabled or disabled.
peak_auto_feature_status
Enumeration representing the status of an auto feature.
Definition ids_peak_comfort_c.h:19642
peak_status peak_Chunks_Gain_Get(peak_camera_handle hCam, peak_chunks_gain *data)
Retrieves the gain information from chunk data, including analog master gain and digital gains for re...
peak_status peak_Chunks_LineStatus_Get(peak_camera_handle hCam, peak_chunks_line_status *data)
Retrieves the status information of all lines from chunk data.
peak_status peak_Chunks_AutoFeature_Get(peak_camera_handle hCam, peak_chunks_autofeature *data)
Retrieves the auto-feature information from chunk data.
peak_status peak_Chunks_FrameInfo_Get(peak_camera_handle hCam, peak_chunks_frame_info *data)
Retrieves the frame information from chunk data, including pixel format and region of interest (ROI).
peak_status peak_Chunks_UsableROI_Get(peak_camera_handle hCam, peak_chunks_usable_roi *data)
Retrieves the usable region of interest (ROI) information from chunk data.
@ PEAK_PTP_STATUS_LISTENING
Definition ids_peak_comfort_c.h:19708
@ PEAK_PTP_STATUS_INITIALIZING
Definition ids_peak_comfort_c.h:19699
@ PEAK_PTP_STATUS_FAULTY
Definition ids_peak_comfort_c.h:19702
@ PEAK_PTP_STATUS_UNCALIBRATED
Definition ids_peak_comfort_c.h:19720
@ PEAK_PTP_STATUS_SLAVE
Definition ids_peak_comfort_c.h:19723
@ PEAK_PTP_STATUS_PASSIVE
Definition ids_peak_comfort_c.h:19717
@ PEAK_PTP_STATUS_DISABLED
Definition ids_peak_comfort_c.h:19705
@ PEAK_PTP_STATUS_INVALID
Definition ids_peak_comfort_c.h:19696
@ PEAK_PTP_STATUS_PRE_MASTER
Definition ids_peak_comfort_c.h:19711
@ PEAK_PTP_STATUS_MASTER
Definition ids_peak_comfort_c.h:19714
@ PEAK_CHUNKS_TYPE_FRAME_INFO
Definition ids_peak_comfort_c.h:19271
@ PEAK_CHUNKS_TYPE_PTP_STATUS
Definition ids_peak_comfort_c.h:19298
@ PEAK_CHUNKS_TYPE_INVALID
Invalid chunk type.
Definition ids_peak_comfort_c.h:19268
@ PEAK_CHUNKS_TYPE_LINE_STATUS
Definition ids_peak_comfort_c.h:19292
@ PEAK_CHUNKS_TYPE_GAIN
Definition ids_peak_comfort_c.h:19277
@ PEAK_CHUNKS_TYPE_USABLE_ROI
Definition ids_peak_comfort_c.h:19289
@ PEAK_CHUNKS_TYPE_TIMESTAMP
Definition ids_peak_comfort_c.h:19283
@ PEAK_CHUNKS_TYPE_AUTO_FEATURE_STATUS
Definition ids_peak_comfort_c.h:19295
@ PEAK_CHUNKS_TYPE_EXPOSURE
Definition ids_peak_comfort_c.h:19274
@ PEAK_CHUNKS_TYPE_EXPOSURE_TRIGGER
Definition ids_peak_comfort_c.h:19286
@ PEAK_CHUNKS_TYPE_SEQUENCER
Definition ids_peak_comfort_c.h:19280
@ PEAK_AUTO_FEATURE_STATUS_INVALID
Definition ids_peak_comfort_c.h:19644
@ PEAK_AUTO_FEATURE_STATUS_DONE
Definition ids_peak_comfort_c.h:19650
@ PEAK_AUTO_FEATURE_STATUS_OFF
Definition ids_peak_comfort_c.h:19647
@ PEAK_AUTO_FEATURE_STATUS_STUCK
Definition ids_peak_comfort_c.h:19656
@ PEAK_AUTO_FEATURE_STATUS_ACTIVE
Definition ids_peak_comfort_c.h:19653
peak_status peak_ColorCorrection_Mode_Get(peak_camera_handle hCam, peak_color_correction_mode *colorCorrectionMode)
Get the color correction mode.
peak_access_status peak_ColorCorrection_Matrix_GetAccessStatus(peak_camera_handle hCam)
Query the color correction matrix access status.
peak_status peak_ColorCorrection_Matrix_GetRange(peak_camera_handle hCam, double *minMatrixElementValue, double *maxMatrixElementValue, double *incMatrixElementValue)
Get the current range of valid color correction matrix element values.
peak_status peak_ColorCorrection_Mode_Set(peak_camera_handle hCam, peak_color_correction_mode colorCorrectionMode)
Set the color correction mode.
peak_bool peak_ColorCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the color correction.
peak_access_status peak_ColorCorrection_GetAccessStatus(peak_camera_handle hCam)
Query the color correction access status.
peak_status peak_ColorCorrection_Mode_GetList(peak_camera_handle hCam, peak_color_correction_mode *colorCorrectionModeList, size_t *colorCorrectionModeCount)
Get the list of currently selectable color correction modes.
peak_status peak_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
Sets the color correction matrix for the current selected color correction.
peak_status peak_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the color correction.
peak_color_correction_mode
peak Color correction mode
Definition ids_peak_comfort_c.h:7511
peak_status peak_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
Get the color correction matrix.
@ PEAK_COLOR_CORRECTION_MODE_HQ
HQ.
Definition ids_peak_comfort_c.h:7522
@ PEAK_COLOR_CORRECTION_MODE_INVALID
Invalid color correction.
Definition ids_peak_comfort_c.h:7516
@ PEAK_COLOR_CORRECTION_MODE_USER_1
User 1.
Definition ids_peak_comfort_c.h:7531
peak_access_status peak_DecimationManual_GetAccessStatus(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine)
Query the decimation manual access status.
peak_status peak_DecimationManual_FactorY_GetList(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorYList, size_t *decimationFactorYCount)
Get the list of currently selectable factors for the decimation in y direction.
peak_status peak_DecimationManual_FactorX_GetList(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorXList, size_t *decimationFactorXCount)
Get the list of currently selectable factors for the decimation in x direction.
peak_status peak_DecimationManual_Get(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
Get the decimation factors.
peak_status peak_DecimationManual_Set(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t decimationFactorX, uint32_t decimationFactorY)
Set the decimation factors.
peak_status peak_Decimation_Get(peak_camera_handle hCam, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
Get the decimation factors.
peak_access_status peak_Decimation_GetAccessStatus(peak_camera_handle hCam)
Query the decimation access status.
peak_status peak_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t *decimationFactorXList, size_t *decimationFactorXCount)
Get the list of currently selectable factors for the decimation in x direction.
peak_status peak_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY)
Set the decimation factors.
peak_status peak_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t *decimationFactorYList, size_t *decimationFactorYCount)
Get the list of currently selectable factors for the decimation in y direction.
peak_access_status peak_EthernetConfig_PersistentIP_GetAccessStatus(peak_camera_id cameraID)
Query the persistent ip access status.
peak_bool peak_EthernetConfig_DHCP_IsEnabled(peak_camera_id cameraID)
Get the enabled status of dhcp.
peak_ethernet_status
peak Ethernet status
Definition ids_peak_comfort_c.h:2135
peak_status peak_EthernetConfig_GetInfo(peak_camera_id cameraID, peak_ethernet_info *ethernetInfo)
Query the ethernet information.
peak_status peak_EthernetConfig_DHCP_Enable(peak_camera_id cameraID, peak_bool enabled)
Enable/Disable dhcp.
peak_access_status peak_EthernetConfig_DHCP_GetAccessStatus(peak_camera_id cameraID)
Query the dhcp access status.
peak_status peak_EthernetConfig_PersistentIP_Get(peak_camera_id cameraID, peak_ip_config *persistentIP)
Get the persistent ip.
peak_status peak_EthernetConfig_PersistentIP_Set(peak_camera_id cameraID, peak_ip_config persistentIP)
Set the persistent ip.
peak_access_status peak_EthernetConfig_GetAccessStatus(peak_camera_id cameraID)
Query the ethernet configuration access status.
@ PEAK_ETHERNET_STATUS_SUBNET_MISMATCH
The camera persistent IP is not in the hosts subnet.
Definition ids_peak_comfort_c.h:2160
@ PEAK_ETHERNET_STATUS_INVALID
Invalid ethernet status.
Definition ids_peak_comfort_c.h:2140
@ PEAK_ETHERNET_STATUS_NOK
The cameras ethernet status is not ok.
Definition ids_peak_comfort_c.h:2152
@ PEAK_ETHERNET_STATUS_OK
The cameras ethernet status is ok.
Definition ids_peak_comfort_c.h:2146
@ PEAK_ETHERNET_STATUS_INAPPLICABLE_IP
The camera IP is not applicable.
Definition ids_peak_comfort_c.h:2169
peak_status peak_ExposureTime_GetRange(peak_camera_handle hCam, double *minExposureTime_us, double *maxExposureTime_us, double *incExposureTime_us)
Get the current range of valid exposure time values.
peak_status peak_ExposureTime_Set(peak_camera_handle hCam, double exposureTime_us)
Set the exposure time.
peak_access_status peak_ExposureTime_GetAccessStatus(peak_camera_handle hCam)
Query the exposure time access status.
peak_status peak_ExposureTime_Get(peak_camera_handle hCam, double *exposureTime_us)
Get the exposure time.
peak_firmware_update_status
Status of a firmware update step.
Definition ids_peak_comfort_c.h:15847
peak_status peak_FirmwareUpdate_Execute(peak_camera_id cameraID, const char *gufFileName)
Upload the firmware provided by the guf file to the given camera.
peak_status peak_FirmwareUpdate_CompatibleCameraList_Get(const char *gufFileName, peak_camera_descriptor *cameraList, size_t *cameraCount)
Get a list of cameras that can be updated using the provided .guf-File.
peak_firmware_update_step
Steps of the firmware update procedure.
Definition ids_peak_comfort_c.h:15823
@ PEAK_FIRMWARE_UPDATE_STATUS_FAILED
The update (step) has failed.
Definition ids_peak_comfort_c.h:15855
@ PEAK_FIRMWARE_UPDATE_STATUS_FINSIHED
The update (step) has successfully finished.
Definition ids_peak_comfort_c.h:15853
@ PEAK_FIRMWARE_UPDATE_STATUS_PROGRESS
The update step has made progress.
Definition ids_peak_comfort_c.h:15851
@ PEAK_FIRMWARE_UPDATE_STATUS_STARTED
The update (step) has been started.
Definition ids_peak_comfort_c.h:15849
@ PEAK_FIRMWARE_UPDATE_STEP_TOTAL
Step representing the whole update process.
Definition ids_peak_comfort_c.h:15825
@ PEAK_FIRMWARE_UPDATE_STEP_WRITEFEATURE
The firmware update is modifying camera properties.
Definition ids_peak_comfort_c.h:15831
@ PEAK_FIRMWARE_UPDATE_STEP_UPLOADFILE
The firmware file is uploaded to the camera.
Definition ids_peak_comfort_c.h:15837
@ PEAK_FIRMWARE_UPDATE_STEP_RESETDEVICE
The firmware update resets the device and waits for it to reconnect.
Definition ids_peak_comfort_c.h:15839
@ PEAK_FIRMWARE_UPDATE_STEP_ASSERTFEATURE
The firmware update is validating the cameras state.
Definition ids_peak_comfort_c.h:15835
@ PEAK_FIRMWARE_UPDATE_STEP_CHECKPRECONDITIONS
The firmware update is checking for compatability with the camera.
Definition ids_peak_comfort_c.h:15827
@ PEAK_FIRMWARE_UPDATE_STEP_EXECUTEFEATURE
The firmware update is running tasks on the camera.
Definition ids_peak_comfort_c.h:15833
@ PEAK_FIRMWARE_UPDATE_STEP_ACQUIREUPDATEDATA
The firmware update is loading the firmware files to be uploaded.
Definition ids_peak_comfort_c.h:15829
peak_status peak_Flash_EndDelay_Set(peak_camera_handle hCam, double flashEndDelay_us)
Set the flash end delay.
peak_status peak_Flash_EndDelay_Get(peak_camera_handle hCam, double *flashEndDelay_us)
Get the flash end delay.
peak_access_status peak_Flash_Duration_GetAccessStatus(peak_camera_handle hCam)
Query the flash duration property access status.
peak_status peak_Flash_StartDelay_Get(peak_camera_handle hCam, double *flashStartDelay_us)
Get the flash start delay.
peak_status peak_Flash_Duration_GetRange(peak_camera_handle hCam, double *minFlashDuration_us, double *maxFlashDuration_us, double *incFlashDuration_us)
Get the current range of valid flash duration values.
peak_status peak_Flash_EndDelay_GetRange(peak_camera_handle hCam, double *minFlashEndDelay_us, double *maxFlashEndDelay_us, double *incFlashEndDelay_us)
Get the current range of valid flash end delay values.
peak_status peak_Flash_Duration_Set(peak_camera_handle hCam, double flashDuration_us)
Set the flash duration.
peak_access_status peak_Flash_StartDelay_GetAccessStatus(peak_camera_handle hCam)
Query the flash start delay property access status.
peak_access_status peak_Flash_EndDelay_GetAccessStatus(peak_camera_handle hCam)
Query the flash end delay property access status.
peak_status peak_Flash_Duration_Get(peak_camera_handle hCam, double *flashDuration_us)
Get the flash duration.
peak_status peak_Flash_StartDelay_Set(peak_camera_handle hCam, double flashStartDelay_us)
Set the flash start delay.
peak_status peak_Flash_StartDelay_GetRange(peak_camera_handle hCam, double *minFlashStartDelay_us, double *maxFlashStartDelay_us, double *incFlashStartDelay_us)
Get the current range of valid flash start delay values.
peak_access_status peak_Flash_Mode_GetAccessStatus(peak_camera_handle hCam, peak_flash_mode flashMode)
Query the flash mode access status.
peak_status peak_Flash_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the flash.
peak_status peak_Flash_Mode_Config_Get(peak_camera_handle hCam, peak_flash_mode *flashMode)
Get the flash mode.
peak_status peak_Flash_Mode_Set(peak_camera_handle hCam, peak_flash_mode flashMode)
Set the flash mode.
peak_access_status peak_Flash_GetAccessStatus(peak_camera_handle hCam)
Query the flash feature access status.
peak_flash_reference
Selects the internal signal that will be the source to start the flash active signal.
Definition ids_peak_comfort_c.h:6406
peak_bool peak_Flash_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the flash.
@ PEAK_FLASH_REFERENCE_LINE_1_SIGNAL
Line 1 signal.
Definition ids_peak_comfort_c.h:6417
@ PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW
Global start window.
Definition ids_peak_comfort_c.h:6429
@ PEAK_FLASH_REFERENCE_INVALID
Invalid flash reference.
Definition ids_peak_comfort_c.h:6411
@ PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE
Acquisition active.
Definition ids_peak_comfort_c.h:6435
@ PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE
Exposure active.
Definition ids_peak_comfort_c.h:6423
peak_status peak_Focus_GetRange(peak_camera_handle hCam, uint32_t *minFocus, uint32_t *maxFocus, uint32_t *incFocus)
Get the current range of valid focus values.
peak_access_status peak_Focus_GetAccessStatus(peak_camera_handle hCam)
Query the focus access status.
peak_status peak_Focus_Set(peak_camera_handle hCam, uint32_t focus)
Set the focus value.
peak_status peak_Focus_Get(peak_camera_handle hCam, uint32_t *focus)
Get the focus value.
peak_status peak_Frame_ID_Get(peak_frame_handle hFrame, uint64_t *frameID)
Query the frame id of a frame.
peak_status peak_Frame_Timestamp_Get(peak_frame_handle hFrame, uint64_t *timestamp_ns)
Query the timestamp of a frame.
peak_status peak_Frame_BytesWritten_Get(peak_frame_handle hFrame, size_t *bytesWritten)
Query the bytes written to the buffer of a frame.
peak_status peak_Frame_ROI_Get(peak_frame_handle hFrame, peak_roi *roi)
Query the size parameters of a frame.
peak_frame_type
peak Frame type
Definition ids_peak_comfort_c.h:3697
peak_status peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t *processingTime_ms)
Query the processing time of a frame.
peak_bool peak_Frame_HasChunks(peak_frame_handle hFrame)
Check whether the frame has chunk data.
peak_status peak_Frame_Type_Get(peak_frame_handle hFrame, peak_frame_type *frameType)
Query the type of a frame.
peak_bool peak_Frame_IsComplete(peak_frame_handle hFrame)
Check whether the frame is complete.
peak_status peak_Frame_GetInfo(peak_frame_handle hFrame, peak_frame_info *frameInfo)
Query the frame info.
peak_status peak_Frame_Buffer_Get(peak_frame_handle hFrame, peak_buffer *buffer)
Query the buffer of a frame.
peak_status peak_Frame_PixelFormat_Get(peak_frame_handle hFrame, peak_pixel_format *pixelFormat)
Query the pixel format of a frame.
peak_status peak_Frame_BytesExpected_Get(peak_frame_handle hFrame, size_t *bytesExpected)
Query the bytes expected for a complete image.
@ PEAK_FRAME_TYPE_IMAGE
Image data.
Definition ids_peak_comfort_c.h:3709
@ PEAK_FRAME_TYPE_INVALID
Invalid frame type.
Definition ids_peak_comfort_c.h:3702
peak_status peak_Frame_Save(peak_frame_handle hFrame, const char *fileName)
Write the frame as image to the file system.
peak_status peak_Frame_Release(peak_camera_handle hCam, peak_frame_handle hFrame)
Release a frame.
struct peak_frame * peak_frame_handle
peak Frame handle
Definition ids_peak_comfort_c.h:2457
peak_status peak_FrameRate_Get(peak_camera_handle hCam, double *frameRate_fps)
Get the frame rate.
peak_status peak_FrameRate_Set(peak_camera_handle hCam, double frameRate_fps)
Set the frame rate.
peak_status peak_FrameRate_GetRange(peak_camera_handle hCam, double *minFrameRate_fps, double *maxFrameRate_fps, double *incFrameRate_fps)
Get the current range of valid frame rate values.
peak_access_status peak_FrameRate_GetAccessStatus(peak_camera_handle hCam)
Query the frame rate access status.
peak_status peak_Gain_Get(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double *gain)
Get the gain value for the specified gain type and gain channel.
peak_access_status peak_Gain_GetAccessStatus(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel)
Query the gain access status for the specified gain type and gain channel.
peak_gain_type
peak Gain type
Definition ids_peak_comfort_c.h:7205
peak_gain_channel
peak Gain channel
Definition ids_peak_comfort_c.h:7230
peak_status peak_Gain_GetChannelList(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel *gainChannelList, size_t *gainChannelCount)
Get the list of available gain channels for the given gain type.
peak_status peak_Gain_GetRange(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double *minGain, double *maxGain, double *incGain)
Get the current range of valid gain values for the specified gain type and gain channel.
peak_status peak_Gain_Set(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double gain)
Set the gain for the specified gain type and gain channel.
@ PEAK_GAIN_TYPE_DIGITAL
Digital gain is used.
Definition ids_peak_comfort_c.h:7216
@ PEAK_GAIN_TYPE_ANALOG
Analog gain is used.
Definition ids_peak_comfort_c.h:7213
@ PEAK_GAIN_TYPE_INVALID
Invalid gain type.
Definition ids_peak_comfort_c.h:7210
@ PEAK_GAIN_TYPE_COMBINED
Combined gain is used.
Definition ids_peak_comfort_c.h:7219
@ PEAK_GAIN_CHANNEL_INVALID
Invalid gain channel.
Definition ids_peak_comfort_c.h:7235
@ PEAK_GAIN_CHANNEL_MASTER
Master channel.
Definition ids_peak_comfort_c.h:7247
@ PEAK_GAIN_CHANNEL_BLUE
Blue channel.
Definition ids_peak_comfort_c.h:7244
@ PEAK_GAIN_CHANNEL_RED
Red channel.
Definition ids_peak_comfort_c.h:7238
@ PEAK_GAIN_CHANNEL_GREEN
Green channel.
Definition ids_peak_comfort_c.h:7241
peak_access_status peak_Gamma_GetAccessStatus(peak_camera_handle hCam)
Query the gamma access status.
peak_status peak_Gamma_Get(peak_camera_handle hCam, double *gamma)
Get the gamma value.
peak_status peak_Gamma_GetRange(peak_camera_handle hCam, double *minGamma, double *maxGamma, double *incGamma)
Get the current range of valid gamma values.
peak_status peak_Gamma_Set(peak_camera_handle hCam, double gamma)
Set the gamma value.
peak_auto_feature_roi_mode
peak Auto feature ROI mode
Definition ids_peak_comfort_c.h:7857
peak_auto_feature_brightness_algorithm
peak Auto feature brightness algorithm
Definition ids_peak_comfort_c.h:7829
peak_auto_feature_mode
peak Auto feature mode
Definition ids_peak_comfort_c.h:7793
@ PEAK_AUTO_FEATURE_ROI_MODE_MANUAL
Auto feature ROI mode Manual.
Definition ids_peak_comfort_c.h:7880
@ PEAK_AUTO_FEATURE_ROI_MODE_INVALID
Invalid auto feature ROI mode.
Definition ids_peak_comfort_c.h:7862
@ PEAK_AUTO_FEATURE_ROI_MODE_FULL_IMAGE
Auto feature ROI mode Full Image.
Definition ids_peak_comfort_c.h:7871
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_INVALID
Invalid auto feature brightness algorithm.
Definition ids_peak_comfort_c.h:7834
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEAN
brightness algorithm mean
Definition ids_peak_comfort_c.h:7846
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEDIAN
default brightness algorithm
Definition ids_peak_comfort_c.h:7840
@ PEAK_AUTO_FEATURE_MODE_CONTINUOUS
Auto feature mode Continuous.
Definition ids_peak_comfort_c.h:7818
@ PEAK_AUTO_FEATURE_MODE_OFF
Auto feature Off.
Definition ids_peak_comfort_c.h:7806
@ PEAK_AUTO_FEATURE_MODE_ONCE
Auto feature mode Once.
Definition ids_peak_comfort_c.h:7812
@ PEAK_AUTO_FEATURE_MODE_INVALID
Invalid auto feature mode.
Definition ids_peak_comfort_c.h:7798
peak_status peak_GFA_Boolean_Set(peak_camera_handle hCam, peak_gfa_module module, const char *booleanFeatureName, peak_bool booleanValue)
Set the boolean feature with the given name.
peak_status peak_GFA_Boolean_Get(peak_camera_handle hCam, peak_gfa_module module, const char *booleanFeatureName, peak_bool *booleanValue)
Get the boolean feature with the given name.
peak_status peak_GFA_Command_WaitForDone(peak_camera_handle hCam, peak_gfa_module module, const char *commandFeatureName, uint32_t timeout_ms)
Wait for the execution of the command feature with the given name to be done.
peak_status peak_GFA_Command_Execute(peak_camera_handle hCam, peak_gfa_module module, const char *commandFeatureName)
Execute the command feature with the given name.
peak_status peak_GFA_Data_Write(peak_camera_handle hCam, peak_gfa_module module, uint64_t address, const uint8_t *data, size_t dataSize)
Write data to the specified register address.
peak_status peak_GFA_Data_Read(peak_camera_handle hCam, peak_gfa_module module, uint64_t address, uint8_t *data, size_t dataSize)
Read data from the specified register address.
peak_access_status peak_GFA_EnumerationEntry_GetAccessStatusBySymbolicValue(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const char *enumerationEntrySymbolicValue)
Query the access status of the enumeration entry by its symbolic value.
peak_access_status peak_GFA_EnumerationEntry_GetAccessStatusByIntegerValue(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, int64_t enumerationEntryIntegerValue)
Query the access status of the enumeration entry by its integer value.
peak_access_status peak_GFA_EnumerationEntry_GetAccessStatus(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const peak_gfa_enumeration_entry *enumerationEntry)
Query the access status of the enumeration entry.
peak_status peak_GFA_Enumeration_GetList(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, peak_gfa_enumeration_entry *enumerationEntryList, size_t *enumerationEntryCount)
Get the list of currently selectable enumeration entries.
peak_status peak_GFA_Enumeration_SetBySymbolicValue(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const char *enumerationEntrySymbolicValue)
Set the enumeration feature with the given name by the entries symbolic value.
peak_status peak_GFA_Enumeration_SetByIntegerValue(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, int64_t enumerationEntryIntegerValue)
Set the enumeration feature with the given name by the entries integer value.
peak_status peak_GFA_Enumeration_Set(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const peak_gfa_enumeration_entry *enumerationEntry)
Set the enumeration feature with the given name.
peak_status peak_GFA_Enumeration_Get(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, peak_gfa_enumeration_entry *enumerationEntry)
Get the enumeration feature with the given name.
peak_status peak_GFA_Float_GetList(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double *floatList, size_t *floatCount)
Get the list of currently selectable values for the float feature with the given name.
peak_status peak_GFA_Float_GetRange(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double *minFloatValue, double *maxFloatValue, double *incFloatValue)
Get the current range of valid values for the float feature with the given name.
peak_status peak_GFA_Float_Set(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double floatValue)
Set the float feature with the given name.
peak_status peak_GFA_Float_Get(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double *floatValue)
Get the float feature with the given name.
peak_bool peak_GFA_Float_HasRange(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName)
Check whether the valid values for the float feature with the given name are organized as a range.
peak_status peak_GFA_Integer_GetRange(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t *minIntegerValue, int64_t *maxIntegerValue, int64_t *incIntegerValue)
Get the current range of valid values for the integer feature with the given name.
peak_status peak_GFA_Integer_GetList(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t *integerList, size_t *integerCount)
Get the list of currently selectable values for the integer feature with the given name.
peak_bool peak_GFA_Integer_HasRange(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName)
Check whether the valid values for the integer feature with the given name are organized as a range.
peak_status peak_GFA_Integer_Set(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t integerValue)
Set the integer feature with the given name.
peak_status peak_GFA_Integer_Get(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t *integerValue)
Get the integer feature with the given name.
peak_status peak_GFA_Register_Set(peak_camera_handle hCam, peak_gfa_module module, const char *registerFeatureName, const uint8_t *registerValue, size_t registerValueSize)
Set the register feature with the given name.
peak_status peak_GFA_Register_Get(peak_camera_handle hCam, peak_gfa_module module, const char *registerFeatureName, uint8_t *registerValue, size_t *registerValueSize)
Get the register feature with the given name.
peak_status peak_GFA_String_Set(peak_camera_handle hCam, peak_gfa_module module, const char *stringFeatureName, const char *stringValue)
Set the string feature with the given name.
peak_status peak_GFA_String_Get(peak_camera_handle hCam, peak_gfa_module module, const char *stringFeatureName, char *stringValue, size_t *stringValueSize)
Get the string feature with the given name.
peak_access_status peak_GFA_Feature_GetAccessStatus(peak_camera_handle hCam, peak_gfa_module module, const char *featureName)
Query the access status of the feature with the given name.
peak_gfa_module
peak GFA modules
Definition ids_peak_comfort_c.h:10431
peak_bool peak_GFA_IsWriteAccessEnabled(peak_camera_handle hCam)
Get the enabled status of the GFA write access.
peak_status peak_GFA_EnableWriteAccess(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the GFA write access.
@ PEAK_GFA_MODULE_SYSTEM
The GFA module for the access of the GenICam GenTL System module.
Definition ids_peak_comfort_c.h:10439
@ PEAK_GFA_MODULE_INVALID
Invalid GFA module.
Definition ids_peak_comfort_c.h:10436
@ PEAK_GFA_MODULE_REMOTE_DEVICE
The GFA module for the access of the GenICam Remote Device module.
Definition ids_peak_comfort_c.h:10448
@ PEAK_GFA_MODULE_INTERFACE
The GFA module for the access of the GenICam GenTL Interface module.
Definition ids_peak_comfort_c.h:10442
@ PEAK_GFA_MODULE_DATA_STREAM
The GFA module for the access of the GenICam GenTL Data Stream module.
Definition ids_peak_comfort_c.h:10451
@ PEAK_GFA_MODULE_LOCAL_DEVICE
The GFA module for the access of the GenICam GenTL Local Device module.
Definition ids_peak_comfort_c.h:10445
peak_status peak_IPL_Histogram_Channel_GetCount(peak_histogram_handle hHistogram, size_t *numChannels)
Get the number of channels in the histogram.
peak_status peak_IPL_Histogram_Channel_GetBinArray(peak_histogram_handle hHistogram, size_t channel, uint64_t *binArray, size_t *binArraySize)
Get the bin array for a channel in the histogram.
struct peak_histogram * peak_histogram_handle
The handle type for a histogram.
Definition ids_peak_comfort_c.h:14457
peak_status peak_IPL_Histogram_Release(peak_histogram_handle hHistogram)
Releases the histogram after use.
peak_status peak_IPL_Histogram_ProcessFrame(peak_frame_handle hFrame, peak_histogram_handle *hHistogram)
Calculates the histogram for the given peak_frame_handle.
peak_status peak_IPL_Histogram_Channel_GetInfo(peak_histogram_handle hHistogram, size_t channel, peak_histogram_channel_info *channelInfo)
Get the channel info for a channel in the histogram.
peak_status peak_IPL_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget)
Set the host auto brightness target value.
peak_status peak_IPL_AutoBrightness_Algorithm_Set(peak_camera_handle hCam, peak_auto_feature_brightness_algorithm algorithm)
Set the host auto brightness control algorithm.
peak_status peak_IPL_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t *minAutoBrightnessTarget, uint32_t *maxAutoBrightnessTarget, uint32_t *incAutoBrightnessTarget)
Get the current range of valid host auto brightness target values.
peak_status peak_IPL_AutoBrightness_TargetPercentile_Set(peak_camera_handle hCam, double autoBrightnessTargetPercentile)
Set the host auto brightness target percentile value.
peak_status peak_IPL_AutoBrightness_TargetTolerance_GetRange(peak_camera_handle hCam, uint32_t *minAutoBrightnessTargetTolerance, uint32_t *maxAutoBrightnessTargetTolerance, uint32_t *incAutoBrightnessTargetTolerance)
Get the current range of valid host auto brightness target tolerance values.
peak_status peak_IPL_AutoBrightness_AverageLast_Get(peak_camera_handle hCam, uint32_t *lastAverage)
Get the last calculated brightness average value.
peak_status peak_IPL_AutoBrightness_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoBrightnessROIOffset, peak_position *maxAutoBrightnessROIOffset, peak_position *incAutoBrightnessROIOffset)
Get the current range of valid host auto brightness ROI offsets.
peak_status peak_IPL_AutoBrightness_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
Get the host auto brightness ROI mode.
peak_status peak_IPL_AutoBrightness_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames)
Set the skip frames for the auto brightness controller.
peak_status peak_IPL_AutoBrightness_TargetTolerance_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
Get the host auto brightness target tolerance value.
peak_status peak_IPL_AutoBrightness_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
Set the host auto brightness ROI mode.
peak_status peak_IPL_AutoBrightness_TargetTolerance_Set(peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
Set the host auto brightness target tolerance value.
peak_status peak_IPL_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi *autoBrightnessROI)
Get the host auto brightness ROI.
peak_status peak_IPL_AutoBrightness_TargetPercentile_Get(peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
Get the host auto brightness target percentile value.
peak_status peak_IPL_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
Get the host auto brightness target value.
peak_status peak_IPL_AutoBrightness_TargetPercentile_GetRange(peak_camera_handle hCam, double *minAutoBrightnessTargetPercentile, double *maxAutoBrightnessTargetPercentile, double *incAutoBrightnessTargetPercentile)
Get the current range of valid host auto brightness target percentile values.
peak_status peak_IPL_AutoBrightness_SkipFrames_GetRange(peak_camera_handle hCam, uint32_t *skipFramesMin, uint32_t *skipFramesMax, uint32_t *skipFramesInc)
Get the skip frames range for the auto brightness controller.
peak_status peak_IPL_AutoBrightness_Algorithm_Get(peak_camera_handle hCam, peak_auto_feature_brightness_algorithm *algorithm)
Get the host auto brightness control algorithm.
peak_status peak_IPL_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI)
Set the host auto brightness ROI.
peak_status peak_IPL_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoBrightnessROISize, peak_size *maxAutoBrightnessROISize, peak_size *incAutoBrightnessROISize)
Get the current range of valid host auto brightness ROI sizes.
peak_status peak_IPL_AutoBrightness_SkipFrames_Get(peak_camera_handle hCam, uint32_t *skipFrames)
Get the skip frames for the auto brightness controller.
peak_status peak_IPL_AutoBrightness_Exposure_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
Get the host auto exposure control mode.
peak_status peak_IPL_AutoBrightness_Exposure_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
Set the host auto exposure control mode.
peak_status peak_IPL_AutoBrightness_ExposureLimit_Set(peak_camera_handle hCam, peak_double_limit exposureLimit)
Set the host auto exposure limit.
peak_status peak_IPL_AutoBrightness_ExposureLimit_Get(peak_camera_handle hCam, peak_double_limit *exposureLimit)
Get the host auto exposure limit.
peak_status peak_IPL_AutoFocus_Hysteresis_GetRange(peak_camera_handle hCam, uint8_t *minHysteresis, uint8_t *maxHysteresis, uint8_t *incHysteresis)
Get the current range of valid auto focus hysteresis values.
peak_status peak_IPL_AutoFocus_SharpnessAlgorithm_Get(peak_camera_handle hCam, peak_sharpness_algorithm *sharpnessAlgorithm)
Get the focus sharpness algorithm.
peak_status peak_IPL_AutoFocus_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoFocusMode)
Get the host auto focus control mode.
peak_status peak_IPL_AutoFocus_SharpnessAlgorithm_Set(peak_camera_handle hCam, peak_sharpness_algorithm sharpnessAlgorithm)
Set the host auto focus sharpness algorithm.
peak_access_status peak_IPL_AutoFocus_GetAccessStatus(peak_camera_handle hCam)
Query the auto focus access status.
peak_status peak_IPL_AutoFocus_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoFocusMode)
Set the host auto focus control mode.
peak_status peak_IPL_AutoFocus_Hysteresis_Set(peak_camera_handle hCam, uint8_t hysteresis)
Set the host auto focus hysteresis.
peak_status peak_IPL_AutoFocus_Hysteresis_Get(peak_camera_handle hCam, uint8_t *hysteresis)
Get the host auto focus hysteresis.
peak_status peak_IPL_AutoFocus_ROI_Set(peak_camera_handle hCam, const peak_focus_roi *autoFocusROIList, size_t autoFocusROICount)
Set the list of host auto focus regions of interest.
peak_focus_roi_weight
The peak focus ROI weight classes.
Definition ids_peak_comfort_c.h:13373
peak_status peak_IPL_AutoFocus_SearchAlgorithm_Get(peak_camera_handle hCam, peak_auto_focus_search_algorithm *searchAlgorithm)
Get the host auto focus search algorithm.
peak_status peak_IPL_AutoFocus_Range_Set(peak_camera_handle hCam, uint32_t rangeBegin, uint32_t rangeEnd)
Set the host auto focus range.
peak_status peak_IPL_AutoFocus_ROI_Get(peak_camera_handle hCam, peak_focus_roi *autoFocusROIList, size_t *autoFocusROICount)
Get the list of host auto focus regions of interest.
peak_auto_focus_search_algorithm
The peak focus search algorithm.
Definition ids_peak_comfort_c.h:13541
peak_sharpness_algorithm
The peak sharpness measurement algorithm.
Definition ids_peak_comfort_c.h:13628
peak_status peak_IPL_AutoFocus_Range_Get(peak_camera_handle hCam, uint32_t *rangeBegin, uint32_t *rangeEnd)
Get the host auto focus range.
peak_status peak_IPL_AutoFocus_SearchAlgorithm_Set(peak_camera_handle hCam, peak_auto_focus_search_algorithm searchAlgorithm)
Set the host auto focus search algorithm.
@ PEAK_FOCUS_ROI_WEIGHT_STRONG
Focus ROI weight strong.
Definition ids_peak_comfort_c.h:13387
@ PEAK_FOCUS_ROI_WEIGHT_MEDIUM
Focus ROI weight medium.
Definition ids_peak_comfort_c.h:13384
@ PEAK_FOCUS_ROI_WEIGHT_INVALID
Invalid focus ROI weight.
Definition ids_peak_comfort_c.h:13378
@ PEAK_FOCUS_ROI_WEIGHT_WEAK
Focus ROI weight weak.
Definition ids_peak_comfort_c.h:13381
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_GOLDEN_RATIO
Search algorithm Golden Ratio.
Definition ids_peak_comfort_c.h:13552
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_HILL_CLIMBING
Search algorithm Hill Climbing.
Definition ids_peak_comfort_c.h:13559
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_GLOBAL_SEARCH
Search algorithm Full Scan.
Definition ids_peak_comfort_c.h:13571
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_INVALID
Invalid search algorithm type.
Definition ids_peak_comfort_c.h:13546
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_FULL_SCAN
Search algorithm Full Scan.
Definition ids_peak_comfort_c.h:13565
@ PEAK_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE
Sharpness algorithm Histogram Variance.
Definition ids_peak_comfort_c.h:13657
@ PEAK_SHARPNESS_ALGORITHM_TENENGRAD
Sharpness algorithm Tenengrad.
Definition ids_peak_comfort_c.h:13639
@ PEAK_SHARPNESS_ALGORITHM_SOBEL
Sharpness algorithm Sobel.
Definition ids_peak_comfort_c.h:13645
@ PEAK_SHARPNESS_ALGORITHM_INVALID
Invalid sharpness algorithm type.
Definition ids_peak_comfort_c.h:13633
@ PEAK_SHARPNESS_ALGORITHM_MEAN_SCORE
Sharpness algorithm Mean Score.
Definition ids_peak_comfort_c.h:13651
peak_status peak_IPL_AutoBrightness_GainAnalog_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainAnalogLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain analog limit.
peak_status peak_IPL_AutoBrightness_GainAnalog_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainAnalogLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain analog limit.
peak_status peak_IPL_AutoBrightness_GainAnalogLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain analog limit range.
peak_status peak_IPL_AutoBrightness_GainLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain limit.
peak_status peak_IPL_AutoBrightness_GainLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain limit range.
peak_status peak_IPL_AutoBrightness_GainLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain limit.
peak_status peak_IPL_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainCombinedLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host gain combined limit.
peak_status peak_IPL_AutoBrightness_GainCombined_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host combined gain control mode.
peak_status peak_IPL_AutoBrightness_GainCombined_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the combined gain control mode.
peak_status peak_IPL_AutoBrightness_GainCombinedLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain combined limit.
peak_status peak_IPL_AutoBrightness_GainCombinedLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain combined limit range.
peak_status peak_IPL_AutoBrightness_GainDigitalLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain digital limit.
peak_status peak_IPL_AutoBrightness_GainDigitalLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain digital limit.
peak_status peak_IPL_AutoBrightness_GainDigital_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainDigitalLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain digital limit range.
peak_status peak_IPL_AutoBrightness_GainDigital_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainHost_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host gain control mode.
peak_status peak_IPL_AutoBrightness_GainHostLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the auto host gain limit range.
peak_status peak_IPL_AutoBrightness_GainHost_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host gain control mode.
peak_status peak_IPL_AutoBrightness_GainHostLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain limit.
peak_status peak_IPL_AutoBrightness_GainHostLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the auto host gain limit.
peak_status peak_IPL_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
Get the host auto white balance ROI.
peak_status peak_IPL_AutoWhiteBalance_SkipFrames_GetRange(peak_camera_handle hCam, uint32_t *skipFramesMin, uint32_t *skipFramesMax, uint32_t *skipFramesInc)
Get the skip frames range for the auto white balance controller.
peak_status peak_IPL_AutoWhiteBalance_SkipFrames_Get(peak_camera_handle hCam, uint32_t *skipFrames)
Get the skip frames for the auto white balance controller.
peak_status peak_IPL_AutoWhiteBalance_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames)
Set the skip frames for the auto white balance controller.
peak_status peak_IPL_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoWhiteBalanceROISize, peak_size *maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
Get the current range of valid host auto white balance ROI sizes.
peak_status peak_IPL_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
Get the host auto white balance control mode.
peak_status peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoWhiteBalanceROIOffset, peak_position *maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
Get the current range of valid host auto white balance ROI offsets.
peak_status peak_IPL_AutoWhiteBalance_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
Get the host auto white balance ROI mode.
peak_status peak_IPL_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
Set the host auto white balance ROI.
peak_status peak_IPL_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
Set the host auto white balance control mode.
peak_status peak_IPL_AutoWhiteBalance_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
Set the host auto white balance ROI mode.
peak_status peak_IPL_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t *binningFactorYList, size_t *binningFactorYCount)
Get the list of currently selectable factors for the host binning in y direction.
peak_status peak_IPL_Binning_Get(peak_camera_handle hCam, uint32_t *binningFactorX, uint32_t *binningFactorY)
Get the host binning factors.
peak_status peak_IPL_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
Set the host binning factors.
peak_status peak_IPL_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t *binningFactorXList, size_t *binningFactorXCount)
Get the list of currently selectable factors for the host binning in x direction.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorTemperature_GetRange(peak_camera_handle hCam, uint32_t *minColorTemperature, uint32_t *maxColorTemperature, uint32_t *incColorTemperature)
Returns the allowed temperature range for the current combination of color space and algorithm.
peak_bool peak_IPL_ColorCorrection_ChromaticAdaption_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the chromatic adaption.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorTemperature_Set(peak_camera_handle hCam, uint32_t colorTemperature)
Set the used color temperature used for chromatic adaption.
peak_chromatic_adaption_algorithm
Enumeration that defines the available chromatic adaption algorithms.
Definition ids_peak_comfort_c.h:11832
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorTemperature_Get(peak_camera_handle hCam, uint32_t *colorTemperature)
Get the current color temperature.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_Algorithm_Set(peak_camera_handle hCam, peak_chromatic_adaption_algorithm algorithm)
Set the algorithm used for chromatic adaption.
peak_chromatic_adaption_color_space
Enumeration that defines the available color spaces.
Definition ids_peak_comfort_c.h:11858
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorSpace_Get(peak_camera_handle hCam, peak_chromatic_adaption_color_space *colorSpace)
Get the target color space.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_Algorithm_Get(peak_camera_handle hCam, peak_chromatic_adaption_algorithm *algorithm)
Get the current algorithm used for chromatic adaption.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_Enable(peak_camera_handle hCam, peak_bool enable)
Enable/Disable the host chromatic adaption.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorSpace_Set(peak_camera_handle hCam, peak_chromatic_adaption_color_space colorSpace)
Set the target color space.
@ PEAK_CHROMATIC_ADAPTION_ALGORITHM_INVALID
Invalid chromatic adaption algorithm.
Definition ids_peak_comfort_c.h:11837
@ PEAK_CHROMATIC_ADAPTION_ALGORITHM_LEGACY
Definition ids_peak_comfort_c.h:11840
@ PEAK_CHROMATIC_ADAPTION_ALGORITHM_BRADFORD
Definition ids_peak_comfort_c.h:11843
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_ECI_RGB_D50
ECI-RGB: standard illuminant D50 (5000 K), gamma 1.8.
Definition ids_peak_comfort_c.h:11875
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_SRGB_D50
sRGB (standard RGB): standard illuminant D50 (5000 K), gamma 2.2.
Definition ids_peak_comfort_c.h:11866
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_ADOBE_RGB_D65
Adobe RGB: standard illuminant D65 (6500 K), gamma 2.2.
Definition ids_peak_comfort_c.h:11878
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_CIE_RGB_E
CIE-RGB: standard illuminant E (equal energy distribution), gamma 2.2.
Definition ids_peak_comfort_c.h:11872
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_SRGB_D65
sRGB (standard RGB): standard illuminant D65 (6500 K), gamma 2.2.
Definition ids_peak_comfort_c.h:11869
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_INVALID
Invalid color space.
Definition ids_peak_comfort_c.h:11863
peak_bool peak_IPL_ColorCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the host color correction.
peak_status peak_IPL_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
Get the host color correction matrix.
peak_status peak_IPL_ColorCorrection_Saturation_Get(peak_camera_handle hCam, double *saturation)
Get the saturation value.
peak_status peak_IPL_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
Sets the host color correction matrix.
peak_status peak_IPL_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the host color correction.
peak_status peak_IPL_ColorCorrection_Saturation_GetRange(peak_camera_handle hCam, double *minSaturation, double *maxSaturation, double *incSaturation)
Get the current range of valid saturation values.
peak_status peak_IPL_ColorCorrection_Saturation_Set(peak_camera_handle hCam, double saturation)
Sets the saturation value.
peak_status peak_IPL_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t *decimationFactorXList, size_t *decimationFactorXCount)
Get the list of currently selectable factors for the host decimation in x direction.
peak_status peak_IPL_Decimation_Get(peak_camera_handle hCam, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
Get the decimation factors.
peak_status peak_IPL_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY)
Set the host decimation factors.
peak_status peak_IPL_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t *decimationFactorYList, size_t *decimationFactorYCount)
Get the list of currently selectable factors for the host decimation in y direction.
peak_status peak_IPL_DigitalBlack_Set(peak_camera_handle hCam, double digitalBlack)
Set the host digital black value.
peak_status peak_IPL_DigitalBlack_Get(peak_camera_handle hCam, double *digitalBlack)
Get the host digital black value.
peak_status peak_IPL_DigitalBlack_GetRange(peak_camera_handle hCam, double *minDigitalBlack, double *maxDigitalBlack)
Get the current range of valid host digital black values.
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_Set(peak_camera_handle hCam, uint32_t factor)
Set the 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_bool peak_IPL_EdgeEnhancement_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the edge enhancement feature.
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.
peak_status peak_IPL_EdgeEnhancement_Enable(peak_camera_handle hCam, peak_bool enable)
Enable/Disable the host edge enhancement.
peak_status peak_IPL_ReadImage(peak_camera_handle hCam, const char *path, peak_frame_handle *hFrame)
Reads an image file from the disk and returns the peak_frame_handle for it.
peak_status peak_IPL_ProcessFrame(peak_camera_handle hCam, peak_frame_handle hFrame, peak_frame_handle *hResultFrame)
Process a frame with the host image processing pipeline and store the result in a new frame.
peak_status peak_IPL_ProcessFrameInplace(peak_camera_handle hCam, peak_frame_handle hFrame)
Process a frame with the host image processing pipeline and replace the original frame.
peak_status peak_IPL_Gain_GetRange(peak_camera_handle hCam, peak_gain_channel gainChannel, double *minGain, double *maxGain, double *incGain)
Get the current range of valid host gain values for the specified gain channel.
peak_status peak_IPL_Gain_Set(peak_camera_handle hCam, peak_gain_channel gainChannel, double gain)
Set the host gain for the specified gain channel.
peak_status peak_IPL_Gain_Get(peak_camera_handle hCam, peak_gain_channel gainChannel, double *gain)
Get the host gain value for the specified gain channel.
peak_status peak_IPL_Gamma_GetRange(peak_camera_handle hCam, double *minGamma, double *maxGamma, double *incGamma)
Get the current range of valid host gamma values.
peak_status peak_IPL_Gamma_Set(peak_camera_handle hCam, double gamma)
Set the host gamma value.
peak_status peak_IPL_Gamma_Get(peak_camera_handle hCam, double *gamma)
Get the host gamma value.
peak_status peak_IPL_HotpixelCorrection_Sensitivity_Set(peak_camera_handle hCam, peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity)
Set the host hotpixel correction sensitivity level.
peak_status peak_IPL_HotpixelCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the host hotpixel correction.
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.
peak_hotpixel_correction_sensitivity
peak hotpixel correction sensitivity level
Definition ids_peak_comfort_c.h:13830
peak_status peak_IPL_HotpixelCorrection_Sensitivity_Get(peak_camera_handle hCam, peak_hotpixel_correction_sensitivity *hotpixelCorrectionSensitivity)
Get the host hotpixel correction sensitivity level.
peak_bool peak_IPL_HotpixelCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the host hotpixel correction.
peak_status peak_IPL_HotpixelCorrection_ResetList(peak_camera_handle hCam)
Reset the list of host hotpixel positions.
peak_status peak_IPL_HotpixelCorrection_SetList(peak_camera_handle hCam, const peak_position *hotpixelList, size_t hotpixelCount)
Set the list of host hotpixel positions.
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_1
hotpixel correction sensitivity level 1
Definition ids_peak_comfort_c.h:13842
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_4
hotpixel correction sensitivity level 4
Definition ids_peak_comfort_c.h:13854
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_INVALID
Invalid hotpixel correction sensitivity level.
Definition ids_peak_comfort_c.h:13835
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_3
hotpixel correction sensitivity level 3
Definition ids_peak_comfort_c.h:13851
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_2
hotpixel correction sensitivity level 2
Definition ids_peak_comfort_c.h:13845
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_5
hotpixel correction sensitivity level 5
Definition ids_peak_comfort_c.h:13860
peak_status peak_IPL_LUT_ValueList_Set(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_channel channel, uint32_t *values, size_t size)
Sets all LUT values for a given selector and channel.
peak_status peak_IPL_LUT_Value_Set(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_channel channel, uint32_t index, uint32_t value)
Sets a single LUT value for a given selector and channel at an offset.
peak_lut_channel
Enumeration for specifying which channel/channels should be modified when configuring the LUT.
Definition ids_peak_comfort_c.h:19011
peak_status peak_IPL_LUT_Preset_Set(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_preset preset)
Applies the given preset to the specified LUT.
peak_bool peak_IPL_LUT_IsEnabled(peak_camera_handle hCam)
Query whether LUT processing is enabled. If enabled, the LUT will be applied to the subsequent image.
peak_status peak_IPL_LUT_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/disable whether the LUT should be applied to the subsequent image.
peak_status peak_IPL_LUT_Value_Get(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_channel channel, uint32_t index, uint32_t *value)
Reads a single LUT value for a given selector and channel at an offset.
peak_lut_preset
Enumeration for available LUT presets that can be applied.
Definition ids_peak_comfort_c.h:19031
peak_status peak_IPL_LUT_ValueList_Get(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_channel channel, uint32_t *values, size_t *size)
Reads all LUT values for a given selector and channel.
peak_lut_selector
Enumeration for specifying which LUT should be used for LUT configuration.
Definition ids_peak_comfort_c.h:18993
@ PEAK_LUT_CHANNEL_GREEN
Definition ids_peak_comfort_c.h:19016
@ PEAK_LUT_CHANNEL_BLUE
Definition ids_peak_comfort_c.h:19019
@ PEAK_LUT_CHANNEL_ALL
Definition ids_peak_comfort_c.h:19022
@ PEAK_LUT_CHANNEL_RED
Definition ids_peak_comfort_c.h:19013
@ PEAK_LUT_PRESET_ONLY_RED
Definition ids_peak_comfort_c.h:19069
@ PEAK_LUT_PRESET_INVERSE
Definition ids_peak_comfort_c.h:19042
@ PEAK_LUT_PRESET_JET
Definition ids_peak_comfort_c.h:19049
@ PEAK_LUT_PRESET_DIGITAL_GAIN2
Definition ids_peak_comfort_c.h:19086
@ PEAK_LUT_PRESET_RAINBOW
Definition ids_peak_comfort_c.h:19063
@ PEAK_LUT_PRESET_ONLY_GREEN
Definition ids_peak_comfort_c.h:19075
@ PEAK_LUT_PRESET_BINARIZE
Definition ids_peak_comfort_c.h:19097
@ PEAK_LUT_PRESET_IDENTITY
Definition ids_peak_comfort_c.h:19036
@ PEAK_LUT_PRESET_ONLY_BLUE
Definition ids_peak_comfort_c.h:19081
@ PEAK_LUT_PRESET_DIGITAL_BLACK_25_PERCENT
Definition ids_peak_comfort_c.h:19091
@ PEAK_LUT_PRESET_HOT
Definition ids_peak_comfort_c.h:19056
@ PEAK_LUT_12BIT
Definition ids_peak_comfort_c.h:19001
@ PEAK_LUT_10BIT
Definition ids_peak_comfort_c.h:18998
@ PEAK_LUT_8BIT
Definition ids_peak_comfort_c.h:18995
peak_bool peak_IPL_Mirror_UpDown_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the up-down host mirroring.
peak_status peak_IPL_Mirror_LeftRight_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the left-right host mirroring.
peak_bool peak_IPL_Mirror_LeftRight_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the left-right host mirroring.
peak_status peak_IPL_Mirror_UpDown_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the up-down host mirroring.
peak_status peak_IPL_Rotation_Angle_Get(peak_camera_handle hCam, int32_t *rotationAngle)
Reads the rotation angle.
peak_status peak_IPL_Rotation_Angle_Set(peak_camera_handle hCam, int32_t rotationAngle)
Sets the rotation in the image processing pipeline.
peak_status peak_I2C_RegisterAddress_Length_Get(peak_i2c_handle hI2C, peak_i2c_register_address_length *length)
Get the i2c register address length.
peak_status peak_I2C_OperationStatus_Get(peak_i2c_handle hI2C, peak_i2c_operation_status *operationStatus)
Get the i2c operation status.
peak_status peak_I2C_AckPolling_Timeout_Set(peak_i2c_handle hI2C, uint32_t timeout_ms)
Set the i2c ack polling timeout in milliseconds.
peak_status peak_I2C_RegisterAddress_Endianness_Set(peak_i2c_handle hI2C, peak_endianness endianness)
Set the i2c register address endianness.
peak_status peak_I2C_DeviceAddress_GetRange(peak_i2c_handle hI2C, uint32_t *minAddress, uint32_t *maxAddress)
Get the current range of valid i2c device addresses.
peak_status peak_I2C_AckPolling_Timeout_GetRange(peak_i2c_handle hI2C, uint32_t *minTimeout_ms, uint32_t *maxTimeout_ms, uint32_t *incTimeout_ms)
Get the current range of valid i2c ack polling timeouts in milliseconds.
peak_status peak_I2C_RegisterAddress_Endianness_Get(peak_i2c_handle hI2C, peak_endianness *endianness)
Get the i2c register endianness.
peak_status peak_I2C_Mode_Set(peak_i2c_handle hI2C, peak_i2c_mode mode)
Set the i2c mode.
peak_status peak_I2C_AckPolling_Timeout_Get(peak_i2c_handle hI2C, uint32_t *timeout_ms)
Get the i2c ack polling timeout in milliseconds.
peak_status peak_I2C_Data_Read(peak_i2c_handle hI2C, size_t maxDataSize, uint8_t *data, size_t *dataSize)
Read from a i2c device register.
peak_status peak_I2C_Mode_Get(peak_i2c_handle hI2C, peak_i2c_mode *mode)
Get the i2c mode.
peak_status peak_I2C_Mode_GetList(peak_i2c_handle hI2C, peak_i2c_mode *modeList, size_t *modeListSize)
Get the list of currently selectable i2c modes.
peak_status peak_I2C_DeviceAddress_Get(peak_i2c_handle hI2C, uint32_t *address)
Get the i2c device address.
peak_status peak_I2C_Data_MaxSize_Get(peak_i2c_handle hI2C, size_t *maxDataSize)
Get the max data size to read or to write from i2c device register.
peak_status peak_I2C_AckPolling_Enable(peak_i2c_handle hI2C, peak_bool enabled)
Enable/Disable the i2c ack polling.
peak_i2c_operation_status
peak i2c operation status
Definition ids_peak_comfort_c.h:17510
peak_status peak_I2C_RegisterAddress_Get(peak_i2c_handle hI2C, uint32_t *address)
Get the i2c register address.
peak_status peak_I2C_Data_Write(peak_i2c_handle hI2C, const uint8_t *data, size_t dataSize)
Write to a i2c device register.
peak_i2c_register_address_length
peak i2c register address length
Definition ids_peak_comfort_c.h:17056
struct peak_i2c * peak_i2c_handle
peak i2c handle The value for an invalid i2c handle is PEAK_INVALID_HANDLE.
Definition ids_peak_comfort_c.h:16791
peak_bool peak_I2C_AckPolling_IsEnabled(peak_i2c_handle hI2C)
Get the enabled status of the i2c ack polling.
peak_status peak_I2C_Destroy(peak_i2c_handle hI2C)
Destroys a i2c handle.
peak_status peak_I2C_Create(peak_camera_handle hCam, peak_i2c_handle *hI2C)
Creates a new i2c instance.
peak_status peak_I2C_RegisterAddress_Length_Set(peak_i2c_handle hI2C, peak_i2c_register_address_length length)
Set the i2c register address length.
peak_status peak_I2C_RegisterAddress_Length_GetList(peak_i2c_handle hI2C, peak_i2c_register_address_length *i2cLengthList, size_t *i2cLengthCount)
Get list of supported i2c register address lengths.
peak_i2c_mode
peak i2c modes
Definition ids_peak_comfort_c.h:16864
peak_access_status peak_I2C_AckPolling_Timeout_GetAccessStatus(peak_i2c_handle hI2C)
Query the i2c ack polling timeout access status.
peak_status peak_I2C_RegisterAddress_Set(peak_i2c_handle hI2C, uint32_t address)
Set the i2c register address.
peak_status peak_I2C_DeviceAddress_Set(peak_i2c_handle hI2C, uint32_t address)
Set the i2c device address.
peak_access_status peak_I2C_GetAccessStatus(peak_i2c_handle hI2C)
Query the i2c access status.
@ PEAK_I2C_OPERATION_STATUS_INVALID_DEVICE_ADDRESS
The device address is not allowed.
Definition ids_peak_comfort_c.h:17527
@ PEAK_I2C_OPERATION_STATUS_ERROR
An error occured while reading or writing.
Definition ids_peak_comfort_c.h:17521
@ PEAK_I2C_OPERATION_STATUS_INVALID
Invalid operation status.
Definition ids_peak_comfort_c.h:17515
@ PEAK_I2C_OPERATION_STATUS_READY
I2C communication is ready or the last write/read was successful.
Definition ids_peak_comfort_c.h:17518
@ PEAK_I2C_OPERATION_STATUS_TIMEOUT_ERROR
The Receiver did not acknowledge within the given time. See peak_I2C_AckPolling_Timeout_Set.
Definition ids_peak_comfort_c.h:17524
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_0BIT
0 bit register length. Register address will not be used
Definition ids_peak_comfort_c.h:17063
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_24BIT
24 bit register length
Definition ids_peak_comfort_c.h:17069
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_INVALID
Invalid register address length.
Definition ids_peak_comfort_c.h:17061
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_16BIT
16 bit register length
Definition ids_peak_comfort_c.h:17067
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_8BIT
8 bit register length
Definition ids_peak_comfort_c.h:17065
@ PEAK_I2C_MODE_INVALID
Invalid i2c mode.
Definition ids_peak_comfort_c.h:16869
@ PEAK_I2C_MODE_STANDARD
I2C fast mode with 100 kHz clock frequency.
Definition ids_peak_comfort_c.h:16871
@ PEAK_I2C_MODE_FAST
I2C fast mode with 400 kHz clock frequency.
Definition ids_peak_comfort_c.h:16873
@ PEAK_I2C_MODE_FAST_PLUS
I2C fast mode with 1000 kHz clock frequency.
Definition ids_peak_comfort_c.h:16875
struct peak_imagewriter * peak_imagewriter_handle
peak ImageWriter handle The value for an invalid ImageWriter handle is PEAK_INVALID_HANDLE.
Definition ids_peak_comfort_c.h:17558
peak_status peak_IPL_ImageWriter_Compression_Set(peak_imagewriter_handle hImageWriter, uint32_t compression)
Sets a compression for the ImageWriter instance.
peak_status peak_IPL_ImageWriter_Destroy(peak_imagewriter_handle hImageWriter)
Destroys an ImageWriter instance.
peak_status peak_IPL_ImageWriter_Compression_Get(peak_imagewriter_handle hImageWriter, uint32_t *compression)
Reads the currently set compression ratio from the ImageWriter instance.
peak_status peak_IPL_ImageWriter_Save(peak_imagewriter_handle hImageWriter, peak_frame_handle hFrame, const char *fileName)
Save the given frame.
peak_status peak_IPL_ImageWriter_Create(peak_imagewriter_handle *hImageWriter)
Creates a new ImageWriter instance.
peak_status peak_IPL_ImageWriter_Format_Set(peak_imagewriter_handle hImageWriter, peak_imagefile_format imageFormat)
Sets an image file format for the ImageWriter instance.
peak_imagefile_format
ImageWriter image file formats.
Definition ids_peak_comfort_c.h:17623
peak_status peak_IPL_ImageWriter_Format_Get(peak_imagewriter_handle hImageWriter, peak_imagefile_format *imageFormat)
Reads the currently set image file format from the ImageWriter instance.
@ PEAK_IMAGEFILE_FORMAT_JPEG
Image file format JPEG.
Definition ids_peak_comfort_c.h:17642
@ PEAK_IMAGEFILE_FORMAT_PNG
Image file format PNG.
Definition ids_peak_comfort_c.h:17635
@ PEAK_IMAGEFILE_FORMAT_RAW
Image file format RAW.
Definition ids_peak_comfort_c.h:17663
@ PEAK_IMAGEFILE_FORMAT_BMP
Image file format BMP.
Definition ids_peak_comfort_c.h:17656
@ PEAK_IMAGEFILE_FORMAT_INVALID
Invalid image file format.
Definition ids_peak_comfort_c.h:17628
@ PEAK_IMAGEFILE_FORMAT_TIFF
Image file format TIFF.
Definition ids_peak_comfort_c.h:17649
peak_status peak_Inference_Statistics_Get(peak_inference_handle hInference, peak_inference_statistics *statistics)
Gets the inference statistics.
peak_status peak_Inference_CNN_Open(const char *path, peak_inference_handle *hInference)
Loads a cnn file from the file system and returns a handle to the inference instance.
peak_inference_preprocessing_mode
peak inference preprocessing modes.
Definition ids_peak_comfort_c.h:15022
struct peak_inference * peak_inference_handle
The handle to identify an inference instance.
Definition ids_peak_comfort_c.h:14989
struct peak_inference_result * peak_inference_result_handle
The handle to identify an inference result.
Definition ids_peak_comfort_c.h:14995
peak_status peak_Inference_Result_Get(peak_inference_result_handle hInferenceHandle, peak_inference_result_data *result)
Get the result from a previous inference call.
peak_status peak_Inference_Statistics_Reset(peak_inference_handle hInference)
Resets the inference statistics.
peak_status peak_Inference_CNN_Info_Get(peak_inference_handle hInference, peak_inference_info *info)
Gets detailed info about the loaded CNN.
peak_status peak_Inference_CNN_ProcessFrame(peak_inference_handle hInference, peak_frame_handle hFrame, peak_inference_result_handle *hInferenceHandle)
Runs an image through a cnn and returns the inference result. This call is blocking and returns once ...
peak_status peak_Inference_ConfidenceThreshold_GetRange(peak_inference_handle hInference, uint32_t *minThreshold, uint32_t *maxThreshold, uint32_t *incThreshold)
Gets the allowed range for setting the confidence threshold.
peak_status peak_Inference_Result_Classification_GetList(peak_inference_result_handle hInferenceHandle, peak_inference_result_classification *resultList, size_t *resultCount)
Get the result entries from a given classification inference result handle.
peak_status peak_Inference_CNN_Close(peak_inference_handle hInference)
Unloads a cnn instance.
peak_inference_type
peak inference types
Definition ids_peak_comfort_c.h:15004
peak_status peak_Inference_ConfidenceThreshold_Set(peak_inference_handle hInference, uint32_t threshold)
Sets the confidence threshold for the inference. Lower thresholds include more results.
peak_status peak_Inference_Result_Detection_GetList(peak_inference_result_handle hInferenceHandle, peak_inference_result_detection *resultList, size_t *resultCount)
Get the result entries from a given detection inference result handle.
peak_status peak_Inference_Result_Release(peak_inference_result_handle hInferenceHandle)
Releases a inference result that was previously received from peak_Inference_CNN_ProcessFrame.
peak_status peak_Inference_ConfidenceThreshold_Get(peak_inference_handle hInference, uint32_t *threshold)
Gets the confidence threshold of the inference.
@ PEAK_INFERENCE_PREPROCESSING_MODE_CAFFE
Caffe preprocessing mode.
Definition ids_peak_comfort_c.h:15030
@ PEAK_INFERENCE_PREPROCESSING_MODE_TENSORFLOW
Tensorflow preprocessing mode.
Definition ids_peak_comfort_c.h:15033
@ PEAK_INFERENCE_PREPROCESSING_MODE_INVALID
Invalid inference preprocessing mode.
Definition ids_peak_comfort_c.h:15027
@ PEAK_INFERENCE_TYPE_CLASSIFICATION
CNN classification model.
Definition ids_peak_comfort_c.h:15015
@ PEAK_INFERENCE_TYPE_DETECTION
CNN detection model.
Definition ids_peak_comfort_c.h:15012
@ PEAK_INFERENCE_TYPE_INVALID
Invalid inference type.
Definition ids_peak_comfort_c.h:15009
peak_status peak_IOChannel_Direction_Get(peak_camera_handle hCam, peak_io_channel ioChannel, peak_io_direction *direction)
Get the io channel direction.
peak_bool peak_IOChannel_NoiseFilter_IsEnabled(peak_camera_handle hCam, peak_io_channel ioChannel)
Get the enabled status of the io channel noise filter property.
peak_io_channel
peak IO channel
Definition ids_peak_comfort_c.h:4908
peak_status peak_IOChannel_NoiseFilter_Enable(peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
Enable/Disable the io channel noise filter property.
peak_access_status peak_IOChannel_Inverter_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel inverter property access status.
peak_access_status peak_IOChannel_NoiseFilter_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel noise filter property access status.
peak_access_status peak_IOChannel_Type_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel type property access status.
peak_status peak_IOChannel_Inverter_Enable(peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
Enable/Disable the io channel inverter property.
peak_status peak_IOChannel_NoiseFilter_Duration_GetRange(peak_camera_handle hCam, peak_io_channel ioChannel, double *minNoiseFilterDuration_us, double *maxNoiseFilterDuration_us, double *incNoiseFilterDuration_us)
Get the current range of valid io channel noise filter duration values.
peak_io_direction
peak IO channel direction
Definition ids_peak_comfort_c.h:5067
peak_status peak_IOChannel_NoiseFilter_Duration_Get(peak_camera_handle hCam, peak_io_channel ioChannel, double *noiseFilterDuration_us)
Get the io channel noise filter duration.
peak_status peak_IOChannel_Level_SetHigh(peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool high)
Set the io channel level.
peak_access_status peak_IOChannel_Level_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel level property access status.
peak_bool peak_IOChannel_Inverter_IsEnabled(peak_camera_handle hCam, peak_io_channel ioChannel)
Get the enabled status of the io channel inverter property.
peak_status peak_IOChannel_NoiseFilter_Duration_Set(peak_camera_handle hCam, peak_io_channel ioChannel, double noiseFilterDuration_us)
Set the io channel noise filter duration.
peak_bool peak_IOChannel_Level_IsHigh(peak_camera_handle hCam, peak_io_channel ioChannel)
Get the level of the io channel.
peak_status peak_IOChannel_Type_Get(peak_camera_handle hCam, peak_io_channel ioChannel, peak_io_type *type)
Get the io channel type.
peak_io_type
peak IO channel type
Definition ids_peak_comfort_c.h:5242
peak_status peak_IOChannel_GetListForDirection(peak_camera_handle hCam, peak_io_direction direction, peak_io_channel *ioChannelList, size_t *ioChannelCount)
Get the list of supported io channels for the given direction.
peak_access_status peak_IOChannel_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel access status.
peak_access_status peak_IOChannel_Direction_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel direction property access status.
@ PEAK_IO_CHANNEL_LINE_5
Line 5.
Definition ids_peak_comfort_c.h:5003
@ PEAK_IO_CHANNEL_LINE_2
Line 2.
Definition ids_peak_comfort_c.h:4982
@ PEAK_IO_CHANNEL_LINE_1
Line 1.
Definition ids_peak_comfort_c.h:4975
@ PEAK_IO_CHANNEL_INVALID
Invalid io channel.
Definition ids_peak_comfort_c.h:4913
@ PEAK_IO_CHANNEL_LINE_6
Line 6.
Definition ids_peak_comfort_c.h:5010
@ PEAK_IO_CHANNEL_LINE_4
Line 4.
Definition ids_peak_comfort_c.h:4996
@ PEAK_IO_CHANNEL_SOFTWARE
Software.
Definition ids_peak_comfort_c.h:4925
@ PEAK_IO_CHANNEL_LINE_7
Line 7.
Definition ids_peak_comfort_c.h:5017
@ PEAK_IO_CHANNEL_NONE
None.
Definition ids_peak_comfort_c.h:4919
@ PEAK_IO_CHANNEL_LINE_0
Line 0.
Definition ids_peak_comfort_c.h:4968
@ PEAK_IO_CHANNEL_LINE_3
Line 3.
Definition ids_peak_comfort_c.h:4989
@ PEAK_IO_DIRECTION_ANY
Input or Output.
Definition ids_peak_comfort_c.h:5090
@ PEAK_IO_DIRECTION_OUTPUT
Output.
Definition ids_peak_comfort_c.h:5084
@ PEAK_IO_DIRECTION_UNKNOWN
Unknown io direction.
Definition ids_peak_comfort_c.h:5072
@ PEAK_IO_DIRECTION_INPUT
Input.
Definition ids_peak_comfort_c.h:5078
@ PEAK_IO_TYPE_INVALID
Invalid io type.
Definition ids_peak_comfort_c.h:5247
@ PEAK_IO_TYPE_UNKNOWN
Unknown io type.
Definition ids_peak_comfort_c.h:5253
@ PEAK_IO_TYPE_OPTO_COUPLED
Invalid io type.
Definition ids_peak_comfort_c.h:5266
@ PEAK_IO_TYPE_TRI_STATE
Invalid io type.
Definition ids_peak_comfort_c.h:5259
@ PEAK_IO_TYPE_LVTTL
Invalid io type.
Definition ids_peak_comfort_c.h:5272
peak_access_status peak_IPO_GetAccessStatus(peak_interface_technology interfaceTech)
Query the IPO access status.
peak_status peak_IPO_Enable(peak_interface_technology interfaceTech, peak_bool enabled)
Control whether the IPO thread is enabled or disabled.
peak_bool peak_IPO_IsEnabled(peak_interface_technology interfaceTech)
Indicates whether the IPO performance thread is enabled or disabled for the specified specified inter...
peak_status peak_LED_Target_GetList(peak_camera_handle hCam, peak_led_target *targetList, size_t *targetCount)
Get the list of currently usable LED targets.
peak_status peak_LED_Get(peak_camera_handle hCam, peak_led_target target, peak_led_mode *mode)
Get the LED mode for the specified LED target.
peak_led_target
peak LED target
Definition ids_peak_comfort_c.h:18207
peak_led_mode
peak LED mode
Definition ids_peak_comfort_c.h:18229
peak_access_status peak_LED_GetAccessStatus(peak_camera_handle hCam)
Query LED access status.
peak_status peak_LED_Set(peak_camera_handle hCam, peak_led_target target, peak_led_mode mode)
Set LED mode for the specified LED target.
peak_status peak_LED_Mode_GetList(peak_camera_handle hCam, peak_led_target target, peak_led_mode *modeList, size_t *ledModeCount)
Get the list of currently usable LED modes of the specified LED target.
@ PEAK_LED_TARGET_STATUS
The camera status LED target.
Definition ids_peak_comfort_c.h:18217
@ PEAK_LED_TARGET_INVALID
Invalid LED target.
Definition ids_peak_comfort_c.h:18213
@ PEAK_LED_TARGET_NETWORK
The camera network LED target.
Definition ids_peak_comfort_c.h:18215
@ PEAK_LED_MODE_INVALID
Invalid LED mode.
Definition ids_peak_comfort_c.h:18234
@ PEAK_LED_MODE_CAMERA_STATUS
Turns status LED to show camera status.
Definition ids_peak_comfort_c.h:18245
@ PEAK_LED_MODE_BLINK_FAST
Turns LED to fast flashing.
Definition ids_peak_comfort_c.h:18240
@ PEAK_LED_MODE_BLINK_SLOW
Turns LED to slow flashing.
Definition ids_peak_comfort_c.h:18238
@ PEAK_LED_MODE_OFF
Turns off LED.
Definition ids_peak_comfort_c.h:18236
@ PEAK_LED_MODE_NETWORK_STATUS
Turns network LED to show network status.
Definition ids_peak_comfort_c.h:18250
peak_status peak_Library_Init()
Init the IDS peak comfortC library.
peak_status peak_Library_Exit()
Exit the IDS peak comfortC library.
peak_status peak_Library_GetLastError(peak_status *lastErrorCode, char *lastErrorMessage, size_t *lastErrorMessageSize)
Query the last error.
peak_bool peak_Library_InterfaceTechnology_IsSupported(peak_interface_technology interfaceTech)
Query the supported interface technologies.
peak_status peak_Library_GetVersion(uint32_t *majorVersion, uint32_t *minorVersion, uint32_t *subminorVersion, uint32_t *patchVersion)
Query the library version.
peak_status peak_Acquisition_LossHandling_ResendRequestTimeout_GetRange(peak_camera_handle hCam, int64_t *minTimeout, int64_t *maxTimeout, int64_t *incTimeout)
Get the current range of valid loss handling resend request timeout values.
peak_status peak_Acquisition_LossHandling_ResendRequestTimeout_Set(peak_camera_handle hCam, int64_t timeout)
Set the loss handling resend request timeout.
peak_loss_handling_mode
peak Loss handling modes
Definition ids_peak_comfort_c.h:2970
peak_status peak_Acquisition_LossHandling_Extent_GetRange(peak_camera_handle hCam, int64_t *minExtent, int64_t *maxExtent, int64_t *incExtent)
Get the extent range of valid extent values.
peak_status peak_Acquisition_LossHandling_ResendRequestTimeout_Get(peak_camera_handle hCam, int64_t *timeout)
Get the loss handling resend request timeout.
peak_access_status peak_Acquisition_LossHandling_Mode_GetAccessStatus(peak_camera_handle hCam)
Query the loss handling mode access status.
peak_access_status peak_Acquisition_LossHandling_Extent_GetAccessStatus(peak_camera_handle hCam)
Query the loss handling extent access status.
peak_status peak_Acquisition_LossHandling_Extent_Get(peak_camera_handle hCam, int64_t *extent)
Get the loss handling extent.
peak_status peak_Acquisition_LossHandling_Extent_Set(peak_camera_handle hCam, int64_t extent)
Set the loss handling extent.
peak_status peak_Acquisition_LossHandling_Mode_Get(peak_camera_handle hCam, peak_loss_handling_mode *mode)
Get the loss handling mode.
peak_status peak_Acquisition_LossHandling_Mode_Set(peak_camera_handle hCam, peak_loss_handling_mode mode)
Set the loss handling mode.
peak_access_status peak_Acquisition_LossHandling_FrameAbortTimeout_GetAccessStatus(peak_camera_handle hCam)
Query the loss handling frame abort timeout access status.
peak_status peak_Acquisition_LossHandling_FrameAbortTimeout_GetRange(peak_camera_handle hCam, int64_t *minTimeout, int64_t *maxTimeout, int64_t *incTimeout)
Get the frame abort timeout range of valid values.
peak_status peak_Acquisition_LossHandling_FrameAbortTimeout_Get(peak_camera_handle hCam, int64_t *timeout)
Get the loss handling frame abort timeout.
peak_status peak_Acquisition_LossHandling_Mode_GetList(peak_camera_handle hCam, peak_loss_handling_mode *lossHandlingModeList, size_t *lossHandlingModesCount)
Get the list of currently usable loss handling modes.
peak_access_status peak_Acquisition_LossHandling_ResendRequestTimeout_GetAccessStatus(peak_camera_handle hCam)
Query the loss handling resend request timeout access status.
peak_status peak_Acquisition_LossHandling_FrameAbortTimeout_Set(peak_camera_handle hCam, int64_t timeout)
Set the loss handling frame abort timeout.
@ PEAK_LOSS_HANDLING_MODE_OFF
Loss handling mode off.
Definition ids_peak_comfort_c.h:2981
@ PEAK_LOSS_HANDLING_MODE_LIMITED
Loss handling mode limited.
Definition ids_peak_comfort_c.h:2989
@ PEAK_LOSS_HANDLING_MODE_INVALID
Invalid loss handling mode.
Definition ids_peak_comfort_c.h:2975
@ PEAK_LOSS_HANDLING_MODE_UNLIMITED
Loss handling mode unlimited.
Definition ids_peak_comfort_c.h:2996
peak_status peak_Acquisition_Buffer_Revoke(peak_camera_handle hCam, uint8_t *memoryAddress)
Revoke an image buffer.
peak_status peak_Acquisition_Buffer_GetRequiredCount(peak_camera_handle hCam, size_t *requiredBufferCount)
Query the required image buffer count.
peak_status peak_Acquisition_Buffer_Announce(peak_camera_handle hCam, uint8_t *memoryAddress, size_t memorySize, void *userContext)
Announce an image buffer.
peak_status peak_Acquisition_Buffer_RevokeAll(peak_camera_handle hCam)
Revoke all image buffers.
peak_status peak_Acquisition_Buffer_GetRequiredSize(peak_camera_handle hCam, size_t *requiredBufferSize)
Query the required image buffer size.
peak_status peak_Message_Data_DeviceFound_Get(peak_message_handle hMessage, peak_message_data_device_found *message)
Get the message data for camera manager device found data types.
peak_status peak_Message_Data_DeviceReconnected_Get(peak_message_handle hMessage, peak_message_data_device_reconnected *message)
Get the message data for camera manager device reconnected data types.
peak_status peak_Message_Data_FirmwareUpdate_Get(peak_message_handle hMessage, peak_message_data_firmware_update *message)
Get the message data for firmware update data types.
peak_status peak_Message_Data_RemoteDevice_Get(peak_message_handle hMessage, peak_message_data_remote_device *message)
Get the message data for remote device types.
peak_status peak_Message_Data_DeviceLost_Get(peak_message_handle hMessage, peak_message_data_device_lost *message)
Get the message data for camera manager device lost data types.
peak_status peak_Message_Data_AutoFocusData_Get(peak_message_handle hMessage, peak_message_data_autofocus *message)
Get the message data for auto focus data types.
peak_message_data_type
peak message data types valid message data types
Definition ids_peak_comfort_c.h:15611
peak_status peak_Message_Data_RemoteDeviceDropped_Get(peak_message_handle hMessage, peak_message_data_remote_device_dropped *message)
Get the message data for remote device dropped types.
peak_status peak_Message_Data_Type_Get(peak_message_handle hMessage, peak_message_data_type *messageType)
Get the message data type.
peak_status peak_Message_Data_RemoteDeviceError_Get(peak_message_handle hMessage, peak_message_data_remote_device_error *message)
Get the message data for remote device error types.
peak_status peak_Message_Data_DeviceDisconnected_Get(peak_message_handle hMessage, peak_message_data_device_disconnected *message)
Get the message data for camera manager device disconnected data types.
peak_status peak_Message_Data_RemoteDeviceFrame_Get(peak_message_handle hMessage, peak_message_data_remote_device_frame *message)
Get the message data for remote device frame types.
peak_status peak_Message_Data_RemoteDeviceTemperature_Get(peak_message_handle hMessage, peak_message_data_remote_device_temperature *message)
Get the message data for remote device temperature types.
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_ERROR
Remote device error message data type.
Definition ids_peak_comfort_c.h:15622
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE
Remote device message data type.
Definition ids_peak_comfort_c.h:15619
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED
Remote device dropped message data type.
Definition ids_peak_comfort_c.h:15625
@ PEAK_MESSAGE_DATA_TYPE_NO_DATA
No data message data type.
Definition ids_peak_comfort_c.h:15616
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME
Remote device frame message data type.
Definition ids_peak_comfort_c.h:15628
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_LOST
Camera manager device lost message data type.
Definition ids_peak_comfort_c.h:15640
@ PEAK_MESSAGE_DATA_TYPE_FIRMWARE_UPDATE
Firmware update message data type.
Definition ids_peak_comfort_c.h:15649
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE
Remote device temperature message data type.
Definition ids_peak_comfort_c.h:15631
@ PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA
Autofeature auto focus data message data type.
Definition ids_peak_comfort_c.h:15634
@ PEAK_MESSAGE_DATA_TYPE_INVALID
Invalid message data type.
Definition ids_peak_comfort_c.h:15613
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_DISCONNECTED
Camera manager device disconnected message data type.
Definition ids_peak_comfort_c.h:15646
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_RECONNECTED
Camera manager device reconnected message data type.
Definition ids_peak_comfort_c.h:15643
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_FOUND
Camera manager device found message data type.
Definition ids_peak_comfort_c.h:15637
peak_status peak_Message_Type_Get(peak_message_handle hMessage, peak_message_type *messageType)
Get the message type.
peak_status peak_Message_GetInfo(peak_message_handle hMessage, peak_message_info *messageInfo)
Get the info for a message.
peak_status peak_Message_ID_Get(peak_message_handle hMessage, uint64_t *messageID)
Get the message id.
peak_status peak_Message_HostTimestamp_Get(peak_message_handle hMessage, uint64_t *hostTimestamp_ns)
Get the host timestamp for a message.
peak_status peak_Message_CameraHandle_Get(peak_message_handle hMessage, peak_camera_handle *hCam)
Get the camera handle for a message.
struct peak_message * peak_message_handle
peak queue handle The value for an invalid queue handle is PEAK_INVALID_HANDLE.
Definition ids_peak_comfort_c.h:15954
peak_status peak_Message_Release(peak_message_handle hMessage)
Release a message.
peak_bool peak_MessageQueue_IsStarted(peak_message_queue_handle hMessageQueue)
Checks if the queue is started.
peak_status peak_MessageQueue_WaitForMessage(peak_message_queue_handle hMessageQueue, uint32_t timeout_ms, peak_message_handle *hMessage)
Wait for a new message.
peak_status peak_MessageQueue_DisableMessage(peak_message_queue_handle hMessageQueue, peak_camera_handle hCam, peak_message_type messageType)
Disable a message type for a message queue.
peak_status peak_MessageQueue_Create(peak_message_queue_handle *hMessageQueue)
Creates a new message queue.
peak_status peak_MessageQueue_MaxQueueSize_Set(peak_message_queue_handle hMessageQueue, size_t messageQueueMaxSize)
Sets the maximum queue sizeIf the queue size is reached and new message are about to be enqueued they...
peak_status peak_MessageQueue_EnabledMessages_GetList(peak_message_queue_handle hMessageQueue, peak_message_type *messageTypesArray, size_t *messageTypesArraySize)
Query the current message types enabled for the queue.
peak_status peak_MessageQueue_Statistics_Get(peak_message_queue_handle hMessageQueue, peak_message_queue_statistics_info *messageQueueInfo)
Get the queue statistic info.
struct peak_message_queue * peak_message_queue_handle
peak queue handle The value for an invalid queue handle is PEAK_INVALID_HANDLE.
Definition ids_peak_comfort_c.h:15947
peak_status peak_MessageQueue_Statistics_Reset(peak_message_queue_handle hMessageQueue)
Reset the queue statistic info.
peak_status peak_MessageQueue_EnableMessageList(peak_message_queue_handle hMessageQueue, peak_camera_handle hCam, const peak_message_type *messageTypesArray, size_t messageTypesArraySize)
Enable a list of message types at once.
peak_status peak_MessageQueue_GetMode(peak_message_queue_handle hMessageQueue, peak_message_queue_mode *queueMode)
Get the queue mode.
peak_status peak_MessageQueue_Start(peak_message_queue_handle hMessageQueue)
Start the queue.
peak_status peak_MessageQueue_EnableMessage(peak_message_queue_handle hMessageQueue, peak_camera_handle hCam, peak_message_type messageType)
Enable a message type for a message queue.
peak_status peak_MessageQueue_MaxQueueSize_Get(peak_message_queue_handle hMessageQueue, size_t *messageQueueMaxSize)
Gets the maximum queue size.
peak_message_queue_mode
peak queue mode Changes the behavior of the queue
Definition ids_peak_comfort_c.h:15433
peak_status peak_MessageQueue_Destroy(peak_message_queue_handle hMessageQueue)
Destroy a message queue.
peak_status peak_MessageQueue_SetMode(peak_message_queue_handle hMessageQueue, peak_message_queue_mode queueMode)
Set the queue mode.
peak_status peak_MessageQueue_DisableMessageList(peak_message_queue_handle hMessageQueue, peak_camera_handle hCam, const peak_message_type *messageTypesArray, size_t messageTypesArraySize)
Disable a list of message types at once.
peak_status peak_MessageQueue_Flush(peak_message_queue_handle hMessageQueue)
Flushes the queue.
peak_bool peak_MessageQueue_IsMessageSupported(peak_message_queue_handle hMessageQueue, peak_camera_handle hCam, peak_message_type messageType)
Checks if the message type is supported by the queue.
peak_status peak_MessageQueue_Stop(peak_message_queue_handle hMessageQueue)
Stop the queue.
@ PEAK_QUEUE_MODE_NEWEST_ONLY
Newest messages returned only (event order)
Definition ids_peak_comfort_c.h:15441
@ PEAK_QUEUE_MODE_INVALID
Invalid queue mode.
Definition ids_peak_comfort_c.h:15435
@ PEAK_QUEUE_MODE_OLDEST_FIRST
Oldest messages returned first (chronological order)
Definition ids_peak_comfort_c.h:15438
peak_message_type
The peak message types.
Definition ids_peak_comfort_c.h:15453
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_TEMPERATURE
Remote device temperature message type. It will be generated when the temperature deviates by more th...
Definition ids_peak_comfort_c.h:15521
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_ERROR
Remote device error message type. This will be generated when an error is detected.
Definition ids_peak_comfort_c.h:15467
@ PEAK_MESSAGE_TYPE_AUTO_BRIGHTNESS_EXPOSURE_ONCE_FINISHED
Autofeature auto brightness exposure once finished message type. It will be generated when the host a...
Definition ids_peak_comfort_c.h:15588
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_PTP_MASTER_SYNC_LOST
Remote device missed ptp master sync lost message type. It will be generated when ptp master sync is ...
Definition ids_peak_comfort_c.h:15515
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_EVENT_DROPPED
Remote device event dropped message type. Will be generated when one or more events are lost.
Definition ids_peak_comfort_c.h:15473
@ PEAK_MESSAGE_TYPE_AUTO_FOCUS_NEW_DATA
Autofeature auto focus new data message type. It will be generated by host auto focus for each Focus ...
Definition ids_peak_comfort_c.h:15567
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_TEST
Remote device test message type. It will be generated by calling the TestEventGenerate command node....
Definition ids_peak_comfort_c.h:15527
@ PEAK_MESSAGE_TYPE_AUTO_FOCUS_ONCE_FINISHED
Autofeature auto focus once finished message type. It will be generated when the host auto focus fini...
Definition ids_peak_comfort_c.h:15559
@ PEAK_MESSAGE_TYPE_DEVICE_DISCONNECTED
Camera manager device disconnected message type.
Definition ids_peak_comfort_c.h:15551
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_EXPOSURE_START
Remote device exposure start message type. The camera started the exposure of a frame (or line in Lin...
Definition ids_peak_comfort_c.h:15479
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_MISSED_TRIGGER_EXPOSURE
Remote device missed trigger exposure message type. The camera missed a trigger to start the exposure...
Definition ids_peak_comfort_c.h:15503
@ PEAK_MESSAGE_TYPE_DEVICE_RECONNECTED
Camera manager device reconnected message type.
Definition ids_peak_comfort_c.h:15546
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_CRITICAL_ERROR
Remote device critical error message type. This will be generated when a critical error is detected.
Definition ids_peak_comfort_c.h:15461
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_FRAME_START
Remote device frame start message type. The camera started the capture of a frame....
Definition ids_peak_comfort_c.h:15491
@ PEAK_MESSAGE_TYPE_AUTO_BRIGHTNESS_ONCE_FINISHED
Autofeature auto brightness once finished message type. It will be generated when the host auto brigh...
Definition ids_peak_comfort_c.h:15595
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_EXPOSURE_END
Remote device exposure end message type. The camera completed the exposure of a frame (or line in Lin...
Definition ids_peak_comfort_c.h:15485
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_FRAME_DROPPED
Remote device frame dropped message type. Will be generated when one or more frames are lost.
Definition ids_peak_comfort_c.h:15497
@ PEAK_MESSAGE_TYPE_DEVICE_FOUND
Camera manager device found message type. Will be generated when a device was found....
Definition ids_peak_comfort_c.h:15534
@ PEAK_MESSAGE_TYPE_REMOTE_DEVICE_MISSED_TRIGGER_LINE
Remote device missed trigger line message type. The camera missed a trigger to start the capture of a...
Definition ids_peak_comfort_c.h:15509
@ PEAK_MESSAGE_TYPE_DEVICE_LOST
Camera manager device lost message type. Will be generated when a device was lost....
Definition ids_peak_comfort_c.h:15541
@ PEAK_MESSAGE_TYPE_FIRMWARE_UPDATE
Firmware update message type. It will be generated when a firmware update reports a status change....
Definition ids_peak_comfort_c.h:15602
@ PEAK_MESSAGE_TYPE_AUTO_BRIGHTNESS_GAIN_ONCE_FINISHED
Autofeature auto brightness gain once finished message type. It will be generated when the host auto ...
Definition ids_peak_comfort_c.h:15581
@ PEAK_MESSAGE_TYPE_INVALID
Invalid message type.
Definition ids_peak_comfort_c.h:15455
@ PEAK_MESSAGE_TYPE_AUTO_WHITEBALANCE_ONCE_FINISHED
Autofeature auto whitebalance once finished message type. It will be generated when the host auto whi...
Definition ids_peak_comfort_c.h:15574
peak_status peak_Mirror_UpDown_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the up-down mirroring.
peak_access_status peak_Mirror_LeftRight_GetAccessStatus(peak_camera_handle hCam)
Query the left-right mirroring access status.
peak_access_status peak_Mirror_UpDown_GetAccessStatus(peak_camera_handle hCam)
Query the up-down mirroring access status.
peak_bool peak_Mirror_LeftRight_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the left-right mirroring.
peak_status peak_Mirror_LeftRight_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the left-right mirroring.
peak_bool peak_Mirror_UpDown_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the up-down mirroring.
uint8_t peak_bool
peak Boolean type
Definition ids_peak_comfort_c.h:888
peak_access_status peak_PixelClock_GetAccessStatus(peak_camera_handle hCam)
Query the pixel clock access status.
peak_bool peak_PixelClock_HasRange(peak_camera_handle hCam)
Check whether the valid values for the pixel clock feature are organized as a range.
peak_status peak_PixelClock_Get(peak_camera_handle hCam, double *pixelClock_MHz)
Get the pixel clock.
peak_status peak_PixelClock_GetRange(peak_camera_handle hCam, double *minPixelClock_MHz, double *maxPixelClock_MHz, double *incPixelClock_MHz)
Get the current range of valid pixel clock values.
peak_status peak_PixelClock_GetList(peak_camera_handle hCam, double *pixelClockList, size_t *pixelClockCount)
Get the list of currently selectable pixel clock values.
peak_status peak_PixelClock_Set(peak_camera_handle hCam, double pixelClock_MHz)
Set the pixel clock.
peak_access_status peak_Reconnect_GetAccessStatus(peak_interface_technology interfaceTech)
Query the reconnect access status.
peak_bool peak_Reconnect_IsEnabled(peak_interface_technology interfaceTech)
Indicates whether the reconnect is active or inactive for the specified specified interface technolog...
peak_status peak_Reconnect_Enable(peak_interface_technology interfaceTech, peak_bool enabled)
Control whether the reconnect is enabled or disabled.
peak_access_status peak_ROI_Offset_GetAccessStatus(peak_camera_handle hCam)
Query the ROI offset access status.
peak_status peak_ROI_Get(peak_camera_handle hCam, peak_roi *roi)
Get the ROI.
peak_status peak_ROI_Offset_Get(peak_camera_handle hCam, peak_position *position)
Get the ROI offset.
peak_status peak_ROI_Size_Get(peak_camera_handle hCam, peak_size *size)
Get the ROI size.
peak_status peak_ROI_Offset_Set(peak_camera_handle hCam, peak_position position)
Set the ROI offset.
peak_status peak_ROI_Size_Set(peak_camera_handle hCam, peak_size size)
Set the ROI size.
peak_status peak_ROI_Set(peak_camera_handle hCam, peak_roi roi)
Set the ROI.
peak_status peak_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minROIOffset, peak_position *maxROIOffset, peak_position *incROIOffset)
Get the current range of valid ROI offsets.
peak_status peak_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minROISize, peak_size *maxROISize, peak_size *incROISize)
Get the current range of valid ROI sizes.
peak_access_status peak_ROI_GetAccessStatus(peak_camera_handle hCam)
Query the ROI access status.
peak_access_status peak_ROI_Size_GetAccessStatus(peak_camera_handle hCam)
Query the ROI size access status.
peak_status peak_Scaling_FactorY_GetRange(peak_camera_handle hCam, double *minScalingFactorY, double *maxScalingFactorY, double *incScalingFactorY)
Get the current range of valid scaling factor y values.
peak_status peak_Scaling_FactorX_GetRange(peak_camera_handle hCam, double *minScalingFactorX, double *maxScalingFactorX, double *incScalingFactorX)
Get the current range of valid scaling factor x values.
peak_status peak_Scaling_Get(peak_camera_handle hCam, double *scalingFactorX, double *scalingFactorY)
Get the scaling factors.
peak_status peak_Scaling_Set(peak_camera_handle hCam, double scalingFactorX, double scalingFactorY)
Set the scaling factors.
peak_access_status peak_Scaling_GetAccessStatus(peak_camera_handle hCam)
Query the scaling access status.
peak_status peak_IPL_Sharpness_GetList(peak_sharpness_algorithm sharpnessAlgorithm, peak_pixel_format *pixelFormatList, size_t *pixelFormatSize)
Query the current supported pixel formats for the given algorithm.
peak_status peak_IPL_Sharpness_Measure(peak_frame_handle hFrame, peak_roi roi, peak_sharpness_algorithm sharpnessAlgorithm, double *calculatedValue)
Measures the sharpness in the image.
peak_status peak_ShutterMode_Get(peak_camera_handle hCam, peak_shutter_mode *shutterMode)
Get the shutter mode.
peak_access_status peak_ShutterMode_GetAccessStatus(peak_camera_handle hCam)
Query the shutter mode access status.
peak_shutter_mode
Definition ids_peak_comfort_c.h:4616
peak_status peak_ShutterMode_Set(peak_camera_handle hCam, peak_shutter_mode shutterMode)
Set the shutter mode.
peak_status peak_ShutterMode_GetList(peak_camera_handle hCam, peak_shutter_mode *shutterModeList, size_t *shutterModeCount)
Get the list of currently available shutter modes.
@ PEAK_SHUTTER_MODE_GLOBAL
Global Shutter.
Definition ids_peak_comfort_c.h:4635
@ PEAK_SHUTTER_MODE_GLOBAL_RESET
Global Reset.
Definition ids_peak_comfort_c.h:4644
@ PEAK_SHUTTER_MODE_UNKNOWN
Unknown shutter mode.
Definition ids_peak_comfort_c.h:4621
@ PEAK_SHUTTER_MODE_ROLLING
Rolling Shutter.
Definition ids_peak_comfort_c.h:4628
peak_status
peak Status codes
Definition ids_peak_comfort_c.h:1064
peak_access_status
peak Access status codes
Definition ids_peak_comfort_c.h:1206
@ PEAK_STATUS_SUCCESS
Success.
Definition ids_peak_comfort_c.h:1066
@ PEAK_STATUS_BUFFER_TOO_SMALL
The buffer is too small to take the complete data.
Definition ids_peak_comfort_c.h:1127
@ PEAK_STATUS_NOT_INITIALIZED
The library is not initialized.
Definition ids_peak_comfort_c.h:1103
@ PEAK_STATUS_VALUE_ADJUSTED
The set value was auto-adjusted.
Definition ids_peak_comfort_c.h:1076
@ PEAK_STATUS_NOT_IMPLEMENTED
The function is not implemented.
Definition ids_peak_comfort_c.h:1106
@ PEAK_STATUS_ERROR
Unspecified error.
Definition ids_peak_comfort_c.h:1097
@ PEAK_STATUS_OUT_OF_MEMORY
The system could not provide enough memory.
Definition ids_peak_comfort_c.h:1148
@ PEAK_STATUS_BUSY
Device or resource is busy.
Definition ids_peak_comfort_c.h:1145
@ PEAK_STATUS_TIMEOUT
A timeout occurred.
Definition ids_peak_comfort_c.h:1133
@ PEAK_STATUS_WARNING_OPERATION
A operation failed.
Definition ids_peak_comfort_c.h:1090
@ PEAK_STATUS_INVALID_CONFIGURATION
The current configuration of an addressed module does not allow the requested operation to be execute...
Definition ids_peak_comfort_c.h:1130
@ PEAK_STATUS_NOT_SUPPORTED
Indicates that the requested functionality is not supported.
Definition ids_peak_comfort_c.h:1154
@ PEAK_STATUS_NO_DATA
The specified or requested data is not present.
Definition ids_peak_comfort_c.h:1139
@ PEAK_STATUS_CAMERA_NOT_FOUND
There is no such camera.
Definition ids_peak_comfort_c.h:1112
@ PEAK_STATUS_INVALID_HANDLE
The handle is invalid.
Definition ids_peak_comfort_c.h:1118
@ PEAK_STATUS_IO
An I/O error occurred.
Definition ids_peak_comfort_c.h:1151
@ PEAK_STATUS_INVALID_PARAMETER
One or more parameters are invalid.
Definition ids_peak_comfort_c.h:1121
@ PEAK_STATUS_WARNING
Unspecified warning.
Definition ids_peak_comfort_c.h:1069
@ PEAK_STATUS_OUT_OF_RANGE
The value or configuration is out of the valid range.
Definition ids_peak_comfort_c.h:1124
@ PEAK_STATUS_WARNING_OVERFLOW
A value was dropped.
Definition ids_peak_comfort_c.h:1083
@ PEAK_STATUS_INVALID_PEAK_INSTALLATION
The peak installation is corrupted.
Definition ids_peak_comfort_c.h:1142
@ PEAK_STATUS_ABORTED
The operation was aborted.
Definition ids_peak_comfort_c.h:1136
@ PEAK_STATUS_ACCESS_DENIED
The access to the requested feature was denied due to the current system status.
Definition ids_peak_comfort_c.h:1109
@ PEAK_STATUS_CAMERA_NOT_AVAILABLE
The specified camera is not available.
Definition ids_peak_comfort_c.h:1115
@ PEAK_ACCESS_GFA_LOCK
No access.
Definition ids_peak_comfort_c.h:1235
@ PEAK_ACCESS_INVALID
Invalid access status code.
Definition ids_peak_comfort_c.h:1214
@ PEAK_ACCESS_WRITEONLY
Write only access.
Definition ids_peak_comfort_c.h:1247
@ PEAK_ACCESS_NOT_SUPPORTED
Not supported.
Definition ids_peak_comfort_c.h:1222
@ PEAK_ACCESS_READONLY
Read only access.
Definition ids_peak_comfort_c.h:1241
@ PEAK_ACCESS_NONE
No access.
Definition ids_peak_comfort_c.h:1228
@ PEAK_ACCESS_READWRITE
Read write access.
Definition ids_peak_comfort_c.h:1253
peak_status peak_TestPattern_Set(peak_camera_handle hCam, peak_test_pattern pattern)
Set the test pattern.
peak_status peak_TestPattern_GetList(peak_camera_handle hCam, peak_test_pattern *testPatternList, size_t *testPatternCount)
Get the list of currently usable test pattern.
peak_access_status peak_TestPattern_GetAccessStatus(peak_camera_handle hCam)
Query the test pattern access status.
peak_test_pattern
peak test pattern
Definition ids_peak_comfort_c.h:18038
peak_status peak_TestPattern_Get(peak_camera_handle hCam, peak_test_pattern *pattern)
Get the test pattern.
@ PEAK_TEST_PATTERN_COLORBAR
Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan,...
Definition ids_peak_comfort_c.h:18052
@ PEAK_TEST_PATTERN_GREYHORIZONTALRAMP
GreyHorizontalRamp: Image is filled horizontally with an image that goes from the darkest possible va...
Definition ids_peak_comfort_c.h:18072
@ PEAK_TEST_PATTERN_GREYDIAGONALRAMPMOVING
GreyDiagonalRampMoving: Moving diagonal ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:18070
@ PEAK_TEST_PATTERN_FPGAGRAYSCALE
Grayscale generated by FPGA.
Definition ids_peak_comfort_c.h:18062
@ PEAK_TEST_PATTERN_INVALID
Invalid test pattern.
Definition ids_peak_comfort_c.h:18043
@ PEAK_TEST_PATTERN_GREYWEDGEMOVINGSENSOR
GreyWedgeMovingSensor: Moving grey wedges generated by the image sensor.
Definition ids_peak_comfort_c.h:18076
@ PEAK_TEST_PATTERN_FPGACOLORSTRIPE
ColorStripe generated by FPGA.
Definition ids_peak_comfort_c.h:18058
@ PEAK_TEST_PATTERN_FPGAFRAMECOUNT
Framecount generated by FPGA.
Definition ids_peak_comfort_c.h:18060
@ PEAK_TEST_PATTERN_WHITE
White: Image is filled with the brightest possible image.
Definition ids_peak_comfort_c.h:18086
@ PEAK_TEST_PATTERN_FPGAVERTICALGRAYSCALE
VerticalGrayscale generated by FPGA.
Definition ids_peak_comfort_c.h:18064
@ PEAK_TEST_PATTERN_GREYWEDGESENSOR
GreyWedgeSensor: Grey wedges generated by the image sensor.
Definition ids_peak_comfort_c.h:18078
@ PEAK_TEST_PATTERN_GREYVERTICALRAMP
GreyVerticalRamp: Vertical ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:18074
@ PEAK_TEST_PATTERN_CHESSPATTERN
Chessboard pattern.
Definition ids_peak_comfort_c.h:18050
@ PEAK_TEST_PATTERN_FPGACHESSBOARD
Chessboard generated by FPGA.
Definition ids_peak_comfort_c.h:18056
@ PEAK_TEST_PATTERN_OFF
Image is coming from the sensor.
Definition ids_peak_comfort_c.h:18046
@ PEAK_TEST_PATTERN_BLACK
Image is filled with the darkest possible image.
Definition ids_peak_comfort_c.h:18048
@ PEAK_TEST_PATTERN_RAMPINGPATTERN
RampingPattern: Diagonal color pattern.
Definition ids_peak_comfort_c.h:18080
@ PEAK_TEST_PATTERN_FPGAWHITE
White generated by FPGA.
Definition ids_peak_comfort_c.h:18066
@ PEAK_TEST_PATTERN_SEQUENCEPATTERN2
SequencePattern2: SequencePattern2.
Definition ids_peak_comfort_c.h:18084
@ PEAK_TEST_PATTERN_FPGABLACK
Black generated by FPGA.
Definition ids_peak_comfort_c.h:18054
@ PEAK_TEST_PATTERN_SEQUENCEPATTERN1
SequencePattern1: SequencePattern1.
Definition ids_peak_comfort_c.h:18082
@ PEAK_TEST_PATTERN_GREYDIAGONALRAMP
GreyDiagonalRamp: Diagonal ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:18068
peak_status peak_Trigger_Burst_Set(peak_camera_handle hCam, uint32_t triggerBurst)
Set the trigger burst.
peak_status peak_Trigger_Burst_Get(peak_camera_handle hCam, uint32_t *triggerBurst)
Get the trigger burst.
peak_access_status peak_Trigger_Burst_GetAccessStatus(peak_camera_handle hCam)
Query the trigger burst property access status.
peak_status peak_Trigger_Burst_GetRange(peak_camera_handle hCam, uint32_t *minTriggerBurst, uint32_t *maxTriggerBurst, uint32_t *incTriggerBurst)
Get the current range of valid trigger burst values.
peak_status peak_Trigger_Delay_Get(peak_camera_handle hCam, double *triggerDelay_us)
Get the trigger delay.
peak_access_status peak_Trigger_Delay_GetAccessStatus(peak_camera_handle hCam)
Query the trigger delay property access status.
peak_status peak_Trigger_Delay_GetRange(peak_camera_handle hCam, double *minTriggerDelay_us, double *maxTriggerDelay_us, double *incTriggerDelay_us)
Get the current range of valid trigger delay values.
peak_status peak_Trigger_Delay_Set(peak_camera_handle hCam, double triggerDelay_us)
Set the trigger delay.
peak_status peak_Trigger_Divider_Set(peak_camera_handle hCam, uint32_t triggerDivider)
Set the trigger divider.
peak_status peak_Trigger_Divider_Get(peak_camera_handle hCam, uint32_t *triggerDivider)
Get the trigger divider.
peak_access_status peak_Trigger_Divider_GetAccessStatus(peak_camera_handle hCam)
Query the trigger divider property access status.
peak_status peak_Trigger_Divider_GetRange(peak_camera_handle hCam, uint32_t *minTriggerDivider, uint32_t *maxTriggerDivider, uint32_t *incTriggerDivider)
Get the current range of valid trigger divider values.
peak_access_status peak_Trigger_Edge_GetAccessStatus(peak_camera_handle hCam)
Query the trigger edge property access status.
peak_trigger_edge
peak Trigger edge
Definition ids_peak_comfort_c.h:5942
peak_status peak_Trigger_Edge_GetList(peak_camera_handle hCam, peak_trigger_edge *triggerEdgeList, size_t *triggerEdgeCount)
Get the list of currently selectable trigger edges.
peak_status peak_Trigger_Edge_Set(peak_camera_handle hCam, peak_trigger_edge triggerEdge)
Set the trigger edge.
peak_status peak_Trigger_Edge_Get(peak_camera_handle hCam, peak_trigger_edge *triggerEdge)
Get the trigger edge.
@ PEAK_TRIGGER_EDGE_FALLING
Falling edge.
Definition ids_peak_comfort_c.h:5959
@ PEAK_TRIGGER_EDGE_ANY
Any edge.
Definition ids_peak_comfort_c.h:5965
@ PEAK_TRIGGER_EDGE_INVALID
Invalid trigger edge.
Definition ids_peak_comfort_c.h:5947
@ PEAK_TRIGGER_EDGE_RISING
Rising edge.
Definition ids_peak_comfort_c.h:5953
peak_status peak_Trigger_Mode_Set(peak_camera_handle hCam, peak_trigger_mode triggerMode)
Set the trigger mode.
peak_status peak_Trigger_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the trigger.
peak_status peak_Trigger_Execute(peak_camera_handle hCam)
Execute the trigger.
peak_status peak_Trigger_Mode_Config_Get(peak_camera_handle hCam, peak_trigger_mode *triggerMode)
Get the trigger mode.
peak_bool peak_Trigger_IsExecutable(peak_camera_handle hCam)
Check whether the trigger is executable or not.
peak_access_status peak_Trigger_GetAccessStatus(peak_camera_handle hCam)
Query the trigger feature access status.
peak_access_status peak_Trigger_Mode_GetAccessStatus(peak_camera_handle hCam, peak_trigger_mode triggerMode)
Query the trigger mode access status.
peak_trigger_target
peak Trigger target
Definition ids_peak_comfort_c.h:5634
peak_bool peak_Trigger_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the trigger.
@ PEAK_TRIGGER_TARGET_INVALID
Invalid trigger target.
Definition ids_peak_comfort_c.h:5639
@ PEAK_TRIGGER_TARGET_LEVEL_CONTROLLED_EXPOSURE
Level controlled exposure.
Definition ids_peak_comfort_c.h:5651
@ PEAK_TRIGGER_TARGET_FRAME_START
Frame start.
Definition ids_peak_comfort_c.h:5645
struct peak_video * peak_video_handle
peak Video handle
Definition ids_peak_comfort_c.h:14596
peak_video_encoder
peak Encoder types
Definition ids_peak_comfort_c.h:14605
peak_video_encoder_option
peak container options
Definition ids_peak_comfort_c.h:14867
peak_status peak_VideoWriter_Encoder_Option_Get(peak_video_handle hVideo, peak_video_encoder_option encoderOption, void *value, size_t count, size_t *outCount)
Get encoder options.
peak_status peak_VideoWriter_GetInfo(peak_video_handle hVideo, peak_video_info *videoInfo)
Get information from the video stream.
peak_video_container_option
peak container options
Definition ids_peak_comfort_c.h:14845
peak_status peak_VideoWriter_Close(peak_video_handle hVideo)
Closes a video file.
peak_status peak_VideoWriter_Container_Option_Get(peak_video_handle hVideo, peak_video_container_option containerOption, void *value, size_t count, size_t *outCount)
Get container options.
peak_status peak_VideoWriter_Container_GetEncoderList(peak_video_container container, peak_video_encoder *encoderList, size_t *encoderCount)
Get the list of currently usable encoders.
peak_status peak_VideoWriter_Encoder_GetContainerList(peak_video_encoder encoder, peak_video_container *containerList, size_t *containerCount)
Get the list of currently usable containers.
peak_status peak_VideoWriter_Encoder_Option_Set(peak_video_handle hVideo, peak_video_encoder_option encoderOption, const void *value, size_t count)
Set additional encoder options.
peak_status peak_VideoWriter_Open(peak_video_handle *hVideo, const char *fileName, peak_video_container container, peak_video_encoder encoder)
Opens a video file with the given file name.
peak_video_container
peak Container types
Definition ids_peak_comfort_c.h:14624
peak_status peak_VideoWriter_WaitUntilQueueEmpty(peak_video_handle hVideo, int32_t timeout_ms)
Wait until queue is empty.
peak_status peak_VideoWriter_AddFrame(peak_video_handle hVideo, peak_frame_handle hFrame)
Writes a image frame into the video file.
peak_status peak_VideoWriter_Container_Option_Set(peak_video_handle hVideo, peak_video_container_option containerOption, const void *value, size_t count)
Set additional container options.
@ PEAK_VIDEO_ENCODER_INVALID
Invalid encoder.
Definition ids_peak_comfort_c.h:14610
@ PEAK_VIDEO_ENCODER_MJPEG
Motion JPEG.
Definition ids_peak_comfort_c.h:14613
@ PEAK_VIDEO_ENCODER_OPTION_INVALID
Invalid encoder option.
Definition ids_peak_comfort_c.h:14872
@ PEAK_VIDEO_ENCODER_OPTION_QUALITY
Quality encoder option.
Definition ids_peak_comfort_c.h:14878
@ PEAK_VIDEO_CONTAINER_OPTION_FRAMERATE
Frame rate container option.
Definition ids_peak_comfort_c.h:14856
@ PEAK_VIDEO_CONTAINER_OPTION_INVALID
Invalid container option.
Definition ids_peak_comfort_c.h:14850
@ PEAK_VIDEO_CONTAINER_AVI
Audio Video Interleave.
Definition ids_peak_comfort_c.h:14632
@ PEAK_VIDEO_CONTAINER_INVALID
Invalid container.
Definition ids_peak_comfort_c.h:14629
peak_endianness
endianness order
Definition ids_peak_comfort_c.h:17155
@ PEAK_ENDIANNESS_INVALID
Invalid endianness.
Definition ids_peak_comfort_c.h:17160
@ PEAK_ENDIANNESS_BIG_ENDIAN
big-endian (BE)
Definition ids_peak_comfort_c.h:17166
@ PEAK_ENDIANNESS_LITTLE_ENDIAN
little-endian (LE)
Definition ids_peak_comfort_c.h:17172
peak_interface_technology
peak interface technology
Definition ids_peak_comfort_c.h:1310
@ PEAK_INTERFACE_TECHNOLOGY_UEYE
uEye interface technology
Definition ids_peak_comfort_c.h:1324
@ PEAK_INTERFACE_TECHNOLOGY_GEV
GigE vision interface technology.
Definition ids_peak_comfort_c.h:1318
@ PEAK_INTERFACE_TECHNOLOGY_INVALID
Invalid interface technology type.
Definition ids_peak_comfort_c.h:1315
@ PEAK_INTERFACE_TECHNOLOGY_U3V
USB3 vision interface technology.
Definition ids_peak_comfort_c.h:1321
peak Acquisition info
Definition ids_peak_comfort_c.h:2468
double fps
Measured framerate.
Definition ids_peak_comfort_c.h:2499
uint32_t numIncomplete
Number of incomplete frame transmissions.
Definition ids_peak_comfort_c.h:2491
uint32_t numUnderrun
Number of buffer underruns.
Definition ids_peak_comfort_c.h:2475
uint32_t numDropped
Number of dropped frames.
Definition ids_peak_comfort_c.h:2483
peak Buffer descriptor
Definition ids_peak_comfort_c.h:916
size_t memorySize
The size of allocated buffer memory.
Definition ids_peak_comfort_c.h:921
uint8_t * memoryAddress
The memory address at which the buffer starts.
Definition ids_peak_comfort_c.h:918
void * userContext
User context pointer.
Definition ids_peak_comfort_c.h:930
peak Camera descriptor
Definition ids_peak_comfort_c.h:1532
char serialNumber[64]
The cameras serial number.
Definition ids_peak_comfort_c.h:1549
char userDefinedName[64]
The cameras user defined name.
Definition ids_peak_comfort_c.h:1560
peak_interface_technology interfaceTechnology
The interface technology.
Definition ids_peak_comfort_c.h:1563
peak_camera_id cameraID
The camera id.
Definition ids_peak_comfort_c.h:1534
char modelName[64]
The cameras model name.
Definition ids_peak_comfort_c.h:1543
peak_camera_type cameraType
The camera type.
Definition ids_peak_comfort_c.h:1537
Structure representing the status of an auto feature.
Definition ids_peak_comfort_c.h:19664
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19669
peak_auto_feature_status status
Definition ids_peak_comfort_c.h:19666
Structure representing the status of multiple auto features.
Definition ids_peak_comfort_c.h:19677
peak_chunks_autofeature_status autoBrightnessStatus
Definition ids_peak_comfort_c.h:19679
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19685
peak_chunks_autofeature_status autoWhiteBalanceStatus
Definition ids_peak_comfort_c.h:19682
Structure representing exposure trigger timestamp information.
Definition ids_peak_comfort_c.h:19602
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19607
int64_t timestamp
Definition ids_peak_comfort_c.h:19604
Structure representing exposure information.
Definition ids_peak_comfort_c.h:19537
double exposureTime_us
Definition ids_peak_comfort_c.h:19539
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19542
Structure representing frame information.
Definition ids_peak_comfort_c.h:19521
peak_pixel_format pixelFormat
Definition ids_peak_comfort_c.h:19523
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19529
peak_roi roi
Definition ids_peak_comfort_c.h:19526
Structure representing gain information.
Definition ids_peak_comfort_c.h:19551
double digitalBlueGain
Definition ids_peak_comfort_c.h:19565
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19568
double digitalMasterGain
Definition ids_peak_comfort_c.h:19556
double digitalGreenGain
Definition ids_peak_comfort_c.h:19562
double analogMasterGain
Definition ids_peak_comfort_c.h:19553
double digitalRedGain
Definition ids_peak_comfort_c.h:19559
Structure representing line status information.
Definition ids_peak_comfort_c.h:19628
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19633
uint32_t lineStatusAll
Definition ids_peak_comfort_c.h:19630
Structure representing the PTP status.
Definition ids_peak_comfort_c.h:19731
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19736
peak_ptp_status ptpStatus
Definition ids_peak_comfort_c.h:19733
Structure representing sequencer status.
Definition ids_peak_comfort_c.h:19576
int64_t sequencerSetActive
Definition ids_peak_comfort_c.h:19578
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19581
Structure representing timestamp information.
Definition ids_peak_comfort_c.h:19589
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19594
int64_t timestamp
Definition ids_peak_comfort_c.h:19591
Structure representing usable ROI (Region of Interest).
Definition ids_peak_comfort_c.h:19615
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19620
peak_roi roi
Definition ids_peak_comfort_c.h:19617
peak Double Limit
Definition ids_peak_comfort_c.h:12475
double max
Maximum.
Definition ids_peak_comfort_c.h:12479
double min
Minimum.
Definition ids_peak_comfort_c.h:12477
peak Ethernet info
Definition ids_peak_comfort_c.h:2183
peak_mac_address cameraMAC
The mac address of the camera.
Definition ids_peak_comfort_c.h:2185
peak_mac_address hostMAC
The mac address of the host.
Definition ids_peak_comfort_c.h:2205
peak_ip_config cameraPersistentIP
The current persistent ip address of the camera.
Definition ids_peak_comfort_c.h:2194
peak_bool cameraDHCPEnabled
The current DHCP enabled status of the camera.
Definition ids_peak_comfort_c.h:2191
peak_ethernet_status cameraEthernetStatus
The current ethernet status of the camera.
Definition ids_peak_comfort_c.h:2197
peak_ip_config hostIP
The current subnet mask of the host.
Definition ids_peak_comfort_c.h:2202
peak_ip_config cameraIP
The current ip address of the camera.
Definition ids_peak_comfort_c.h:2188
peak Flash mode
Definition ids_peak_comfort_c.h:6450
peak_flash_reference flashReference
Flash reference.
Definition ids_peak_comfort_c.h:6455
peak_io_channel ioChannel
IO channel.
Definition ids_peak_comfort_c.h:6461
The peak focus ROI (2D) with weight.
Definition ids_peak_comfort_c.h:13398
peak_roi roi
The peak ROI (2D)
Definition ids_peak_comfort_c.h:13400
peak_focus_roi_weight weight
The ROI weight.
Definition ids_peak_comfort_c.h:13403
peak Frame info
Definition ids_peak_comfort_c.h:3721
uint64_t frameID
The frame id.
Definition ids_peak_comfort_c.h:3735
uint32_t processingTime_ms
The host side processing time.
Definition ids_peak_comfort_c.h:3775
peak_bool isComplete
'Complete' flag
Definition ids_peak_comfort_c.h:3753
peak_frame_type type
The type and format of the contents of the frame.
Definition ids_peak_comfort_c.h:3723
peak_pixel_format pixelFormat
The pixel format.
Definition ids_peak_comfort_c.h:3747
size_t bytesWritten
The number of bytes actually written to the buffer.
Definition ids_peak_comfort_c.h:3769
uint64_t timestamp_ns
The timestamp in nanoseconds.
Definition ids_peak_comfort_c.h:3741
peak_roi roi
The ROI of the frame.
Definition ids_peak_comfort_c.h:3744
peak_buffer buffer
The memory buffer that stores the frame contents.
Definition ids_peak_comfort_c.h:3726
size_t bytesExpected
The number of bytes expected for a complete image.
Definition ids_peak_comfort_c.h:3760
peak GFA enumeration entry
Definition ids_peak_comfort_c.h:11057
char symbolicValue[64]
The symbolic value of the enumeration entry as a zero-terminated string.
Definition ids_peak_comfort_c.h:11059
int64_t integerValue
The integer value of the enumeration entry.
Definition ids_peak_comfort_c.h:11062
peak histogram channel info
Definition ids_peak_comfort_c.h:14438
uint64_t pixelSum
The sum of all pixel values of the channel.
Definition ids_peak_comfort_c.h:14440
uint8_t reserved[64]
Reserved for future use.
Definition ids_peak_comfort_c.h:14450
size_t binSize
The maximum size of the bin for the channel. For a 8-Bit format this is 255, for a 10-Bit format 1023...
Definition ids_peak_comfort_c.h:14447
uint64_t pixelCount
The count of all pixels for the channel.
Definition ids_peak_comfort_c.h:14443
The peak information struct for CNN details.
Definition ids_peak_comfort_c.h:15121
peak_inference_type inferenceType
Inference type.
Definition ids_peak_comfort_c.h:15138
size_t inputHeight
Input height of the CNN.
Definition ids_peak_comfort_c.h:15144
size_t inputWidth
Input width of the CNN.
Definition ids_peak_comfort_c.h:15141
size_t numberOfClasses
Number of classes of the CNN.
Definition ids_peak_comfort_c.h:15153
char projectName[256]
Project name of the CNN.
Definition ids_peak_comfort_c.h:15132
uint64_t creationTime_s
Creation time (in Seconds) of the CNN.
Definition ids_peak_comfort_c.h:15129
char lighthouseID[256]
Lighthouse ID.
Definition ids_peak_comfort_c.h:15126
peak_version fileVersion
File version of the CNN.
Definition ids_peak_comfort_c.h:15123
peak_inference_preprocessing_mode preprocessingMode
Preprocessing mode used for the CNN.
Definition ids_peak_comfort_c.h:15150
peak_pixel_format inputPixelFormat
Input pixel format.
Definition ids_peak_comfort_c.h:15147
uint8_t reserved[256]
Reserved.
Definition ids_peak_comfort_c.h:15156
char networkName[256]
Network name of the CNN.
Definition ids_peak_comfort_c.h:15135
The inference classification result.
Definition ids_peak_comfort_c.h:15061
peak_inference_type type
inference CNN model
Definition ids_peak_comfort_c.h:15063
float score
Inference score.
Definition ids_peak_comfort_c.h:15066
char label[256]
Label of detected class.
Definition ids_peak_comfort_c.h:15069
The peak inference result.
Definition ids_peak_comfort_c.h:15078
uint32_t inference_time_us
Frame inference time (microseconds)
Definition ids_peak_comfort_c.h:15089
peak_frame_handle frameHandle
Handle to the frame.
Definition ids_peak_comfort_c.h:15083
uint32_t preprocessing_time_us
Frame preprocessing time (microseconds)
Definition ids_peak_comfort_c.h:15086
peak_inference_type type
Type of inference.
Definition ids_peak_comfort_c.h:15080
char reserved[256]
Reserved.
Definition ids_peak_comfort_c.h:15092
The inference detection result.
Definition ids_peak_comfort_c.h:15041
peak_roi rect
ROI of the detected class.
Definition ids_peak_comfort_c.h:15052
peak_inference_type type
inference CNN model
Definition ids_peak_comfort_c.h:15043
float score
Inference score.
Definition ids_peak_comfort_c.h:15046
char label[256]
Label of detected class.
Definition ids_peak_comfort_c.h:15049
peak IP configuration
Definition ids_peak_comfort_c.h:2116
peak_ip_address address
The ip address.
Definition ids_peak_comfort_c.h:2118
peak_ip_address subnetMask
The subnet mask.
Definition ids_peak_comfort_c.h:2121
peak message data for auto focus data messages.
Definition ids_peak_comfort_c.h:15746
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15754
int32_t focusValue
Focus value.
Definition ids_peak_comfort_c.h:15748
int32_t sharpnessValue
Sharpness value for the focus value.
Definition ids_peak_comfort_c.h:15751
peak message data for camera manager device disconnected messages.
Definition ids_peak_comfort_c.h:15810
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15812
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15815
peak message data for camera manager device found messages.
Definition ids_peak_comfort_c.h:15763
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15765
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15768
peak message data for camera manager device lost messages.
Definition ids_peak_comfort_c.h:15778
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15780
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15783
peak message data for camera manager device reconnected messages.
Definition ids_peak_comfort_c.h:15793
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15795
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15800
Message data containing information about the current state of a firmware update.
Definition ids_peak_comfort_c.h:15863
char serialNumber[64]
Serial number of the camera that is currently being updated.
Definition ids_peak_comfort_c.h:15871
char description[256]
Description of the referred step or an error description if stepStatus is PEAK_FIRMWARE_UPDATE_STATUS...
Definition ids_peak_comfort_c.h:15886
peak_firmware_update_step step
Firmware update step that the message refers to.
Definition ids_peak_comfort_c.h:15874
char reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15889
double stepProgressPercentage
The progress of the referred step in percent [0,100]. Only valid if stepStatus is PEAK_FIRMWARE_UPDAT...
Definition ids_peak_comfort_c.h:15882
peak_camera_id cameraId
ID of the camera that the firmware update has been started with.
Definition ids_peak_comfort_c.h:15868
peak_firmware_update_status stepStatus
Status of the referred update step
Definition ids_peak_comfort_c.h:15877
peak message data for remote device dropped messages.
Definition ids_peak_comfort_c.h:15692
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15700
int64_t count
Number of dropped frames.
Definition ids_peak_comfort_c.h:15697
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15694
peak message data for remote device error messages.
Definition ids_peak_comfort_c.h:15674
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15682
int64_t error_type
The error type.
Definition ids_peak_comfort_c.h:15679
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15676
peak message data for remote device frame messages.
Definition ids_peak_comfort_c.h:15710
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15718
int64_t frameId
The Frame ID.
Definition ids_peak_comfort_c.h:15715
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15712
peak message data for remote device temperature messages.
Definition ids_peak_comfort_c.h:15728
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15736
double temperature
The temperature in °C.
Definition ids_peak_comfort_c.h:15733
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15730
peak message data for remote device messages.
Definition ids_peak_comfort_c.h:15659
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15664
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15661
peak message info struct
Definition ids_peak_comfort_c.h:15922
uint64_t messageID
internal message ID
Definition ids_peak_comfort_c.h:15930
peak_camera_handle hCam
camera handle for device events or PEAK_INVALID_HANDLE for system messages
Definition ids_peak_comfort_c.h:15927
peak_message_type type
type of the message
Definition ids_peak_comfort_c.h:15924
uint8_t reserved[256]
Reserved for future use.
Definition ids_peak_comfort_c.h:15939
uint64_t hostMessageTimestamp_ns
message enqueue timestamp in nanoseconds. For further infos see peak_Message_HostTimestamp_Get.
Definition ids_peak_comfort_c.h:15933
peak_message_data_type dataType
message data type (if any). See peak_Message_Data_Type_Get for a description of each type.
Definition ids_peak_comfort_c.h:15936
peak queue info struct
Definition ids_peak_comfort_c.h:15897
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15914
uint64_t numInQueue
Number of messages currently in the message queue.
Definition ids_peak_comfort_c.h:15908
uint64_t numDelivered
Counter of messages delivered by the message queue.
Definition ids_peak_comfort_c.h:15902
uint64_t numDropped
Counter of messages dropped by the message queue.
Definition ids_peak_comfort_c.h:15905
uint64_t numMaxQueueSize
Maximum number of concurrent messages in the message queue.
Definition ids_peak_comfort_c.h:15911
uint64_t numQueued
Counter of messages which were queued in the message queue.
Definition ids_peak_comfort_c.h:15899
peak Position (2D)
Definition ids_peak_comfort_c.h:965
uint32_t y
Y-Position.
Definition ids_peak_comfort_c.h:970
uint32_t x
X-Position.
Definition ids_peak_comfort_c.h:967
The peak ROI (2D)
Definition ids_peak_comfort_c.h:981
peak_size size
ROI size.
Definition ids_peak_comfort_c.h:986
peak_position offset
ROI offset.
Definition ids_peak_comfort_c.h:983
peak Size (2D)
Definition ids_peak_comfort_c.h:945
uint32_t width
Width.
Definition ids_peak_comfort_c.h:947
uint32_t height
Height.
Definition ids_peak_comfort_c.h:950
peak Trigger mode
Definition ids_peak_comfort_c.h:5666
peak_io_channel ioChannel
The iO channel.
Definition ids_peak_comfort_c.h:5677
peak_trigger_target triggerTarget
The trigger target.
Definition ids_peak_comfort_c.h:5671
The peak version info.
Definition ids_peak_comfort_c.h:15101
uint32_t subMinor
Subminor version.
Definition ids_peak_comfort_c.h:15109
uint32_t patch
Patch level.
Definition ids_peak_comfort_c.h:15112
uint32_t minor
Minor version.
Definition ids_peak_comfort_c.h:15106
uint32_t major
Major version.
Definition ids_peak_comfort_c.h:15103
video info structure
Definition ids_peak_comfort_c.h:14808
peak IPv4 address
Definition ids_peak_comfort_c.h:2098
uint8_t parts[4]
The IP address in little-endian byte array representation.
Definition ids_peak_comfort_c.h:2103
uint32_t addr
The IP address in little-endian word representation.
Definition ids_peak_comfort_c.h:2100
peak MAC-48 address
Definition ids_peak_comfort_c.h:1817
uint32_t low_part
Lower 4 bytes of the MAC address.
Definition ids_peak_comfort_c.h:1828
uint8_t octets[6]
The octets, i.e. the MAC address in byte array representation.
Definition ids_peak_comfort_c.h:1819
uint16_t high_part
Upper 2 bytes of the MAC address.
Definition ids_peak_comfort_c.h:1825
The peak 3x3 Matrix.
Definition ids_peak_comfort_c.h:1008
double element_00
Element 00.
Definition ids_peak_comfort_c.h:1013
double element_21
Element 21.
Definition ids_peak_comfort_c.h:1034
double element_12
Element 12.
Definition ids_peak_comfort_c.h:1028
double element_20
Element 20.
Definition ids_peak_comfort_c.h:1031
double elementArray[3][3]
The matrix elements in 2-dimensional array format.
Definition ids_peak_comfort_c.h:1042
double element_02
Element 02.
Definition ids_peak_comfort_c.h:1019
double element_11
Element 11.
Definition ids_peak_comfort_c.h:1025
double element_22
Element 22.
Definition ids_peak_comfort_c.h:1037
double element_01
Element 01.
Definition ids_peak_comfort_c.h:1016
double element_10
Element 10.
Definition ids_peak_comfort_c.h:1022