IDS peak comfortC v1.12.0
Loading...
Searching...
No Matches
ids_peak_comfort_c.h
Go to the documentation of this file.
1
8
9#ifndef PEAK_COMFORT_C_H
10#define PEAK_COMFORT_C_H
11
12/* Function declaration modifiers */
13#if defined(_WIN32)
14# ifndef PEAK_NO_DECLSPEC_STATEMENTS
15# ifdef PEAK_EXPORTING
16# define PEAK_EXPORT __declspec(dllexport)
17# else
18# define PEAK_EXPORT __declspec(dllimport)
19# endif
20# else
21# define PEAK_EXPORT
22# endif
23# if defined(_M_IX86) || defined(__i386__)
24# define PEAK_CALLCONV __cdecl
25# else
26# define PEAK_CALLCONV
27# endif
28#elif defined(__linux__)
29# define PEAK_EXPORT
30# if defined(__i386__)
31# define PEAK_CALLCONV __attribute__((cdecl))
32# else
33# define PEAK_CALLCONV
34# endif
35#else
36# error Platform is not supported yet!
37#endif
38
39#ifdef __cplusplus
40# include <cstddef>
41# include <cstdint>
42
43extern "C" {
44#else
45# include <stddef.h>
46# include <stdint.h>
47#endif
48
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) ))
60# else
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
65# endif
66#else
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
71#endif
72
73/* helper entities */
74struct peak_camera;
75struct peak_frame;
76struct peak_video;
77struct peak_inference;
78struct peak_inference_result;
79struct peak_message_queue;
80struct peak_message;
81struct peak_i2c;
82struct peak_imagewriter;
83struct peak_histogram;
84
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
91
96
103
110
117
122
129
133
138
143
150
157
164
169
176
183
192
199
206
211
216
221
226
231
238
245
252
259
266
273
282
291
299
306
314
322
330
337
344
351
358
363
373
383
393
403
413
423
430
443
457
467
478
485
495
502
509
516
523
530
537
544
551
558
563
573
583
592
602
613
623
633
643
653
663
673
683
693
703
713
720
730
739
748
758
769
776
783
790
794
798
804
810
818
828
836#define PEAK_INVALID_HANDLE NULL
837
850#define PEAK_INFINITE 0xffffffff
851
859typedef uint8_t peak_bool;
860
868#define PEAK_TRUE 1
869
877#define PEAK_FALSE 0
878
879#pragma pack(push, 1)
886typedef struct
887{
890
893
902
904#pragma pack(pop)
905
906#pragma pack(push, 1)
915typedef struct
916{
918 uint32_t width;
919
921 uint32_t height;
922
923} peak_size;
924#pragma pack(pop)
925
926#pragma pack(push, 1)
935typedef struct
936{
938 uint32_t x;
939
941 uint32_t y;
942
944#pragma pack(pop)
945
946#pragma pack(push, 1)
951typedef struct
952{
955
958
959} peak_roi;
960#pragma pack(pop)
961
962#pragma pack(push, 1)
978typedef union
979{
981 struct
982 {
985
988
991
994
997
1000
1003
1006
1009
1010 } elements;
1011
1013 double elementArray[3][3];
1014
1015} peak_matrix;
1016#pragma pack(pop)
1017
1024#define PEAK_IDENTITY_MATRIX { 1.0, 0.0, 0.0, \
1025 0.0, 1.0, 0.0, \
1026 0.0, 0.0, 1.0 }
1027
1125
1137#define PEAK_SUCCESS(status) ((((status) & 0xf000) == 0x0000) ? PEAK_TRUE : PEAK_FALSE)
1138
1150#define PEAK_WARNING(status) ((((status) & 0xf000) == 0x4000) ? PEAK_TRUE : PEAK_FALSE)
1151
1163#define PEAK_ERROR(status) ((((status) & 0xf000) == 0x8000) ? PEAK_TRUE : PEAK_FALSE)
1164
1224
1239#define PEAK_IS_WRITEABLE(accessStatus) ((((accessStatus) & 0x2000) == 0x2000) ? PEAK_TRUE : PEAK_FALSE)
1240
1255#define PEAK_IS_READABLE(accessStatus) ((((accessStatus) & 0x1000) == 0x1000) ? PEAK_TRUE : PEAK_FALSE)
1256
1270#define PEAK_IS_SUPPORTED(accessStatus) (((accessStatus) != PEAK_ACCESS_NOT_SUPPORTED) ? PEAK_TRUE : PEAK_FALSE)
1271
1277typedef enum
1278{
1284
1287
1290
1293
1294 PEAK_DEPRECATED_MSG(peak_interface_technology_INVALID, "Use PEAK_INTERFACE_TECHNOLOGY_INVALID instead") = 0x0,
1295 PEAK_DEPRECATED_MSG(peak_interface_technology_GEV, "Use PEAK_INTERFACE_TECHNOLOGY_GEV instead") = 0x1,
1296 PEAK_DEPRECATED_MSG(peak_interface_technology_U3V, "Use PEAK_INTERFACE_TECHNOLOGY_U3V instead") = 0x2,
1297 PEAK_DEPRECATED_MSG(peak_interface_technology_UEYE, "Use PEAK_INTERFACE_TECHNOLOGY_UEYE instead") = 0x3,
1299
1300
1317PEAK_API_STATUS peak_Library_Init();
1318
1336PEAK_API_STATUS peak_Library_Exit();
1337
1357PEAK_API_STATUS peak_Library_GetVersion(uint32_t* majorVersion, uint32_t* minorVersion, uint32_t* subminorVersion,
1358 uint32_t* patchVersion);
1359
1402PEAK_API_STATUS peak_Library_GetLastError(peak_status* lastErrorCode, char* lastErrorMessage,
1403 size_t* lastErrorMessageSize);
1404
1424
1452
1464typedef struct peak_camera* peak_camera_handle;
1465
1479typedef uint64_t peak_camera_id;
1480
1487#define PEAK_INVALID_CAMERA_ID UINT64_C(0)
1488
1489#pragma pack(push, 1)
1499typedef struct
1500{
1503
1506
1511 char modelName[64];
1512
1518
1529
1532
1533 uint8_t reserved[444];
1534
1536
1537#pragma pack(pop)
1538
1564
1587PEAK_API_STATUS peak_Reconnect_Enable(peak_interface_technology interfaceTech, peak_bool enabled);
1588
1606
1638PEAK_API_ACCESS_STATUS peak_Reconnect_GetAccessStatus(peak_interface_technology interfaceTech);
1639
1661PEAK_API_STATUS peak_CameraList_Update(size_t* cameraCount);
1662
1696PEAK_API_STATUS peak_CameraList_Get(peak_camera_descriptor* cameraList, size_t* cameraCount);
1697
1720
1743PEAK_API_CAMERA_ID peak_Camera_ID_FromSerialNumber(const char* serialNumber);
1744
1769PEAK_API_CAMERA_ID peak_Camera_ID_FromUserDefinedName(const char* userDefinedName);
1770
1771#pragma pack(push, 1)
1784typedef union
1785{
1787 uint8_t octets[6];
1788
1790 struct
1791 {
1793 uint16_t high_part;
1794
1796 uint32_t low_part;
1797
1798 } parts;
1799
1801#pragma pack(pop)
1802
1824PEAK_API_CAMERA_ID peak_Camera_ID_FromMAC(peak_mac_address macAddress);
1825
1848PEAK_API_ACCESS_STATUS peak_Camera_GetAccessStatus(peak_camera_id cameraID);
1849
1867PEAK_API_STATUS peak_Camera_GetDescriptor(peak_camera_id cameraID, peak_camera_descriptor* cameraDescriptor);
1868
1889PEAK_API_STATUS peak_Camera_Open(peak_camera_id cameraID, peak_camera_handle* hCam);
1890
1911
1930
1948
1979PEAK_API_STATUS peak_Camera_UserDefinedName_Set(peak_camera_handle hCam, const char* userDefinedName);
1980
2014PEAK_API_STATUS peak_Camera_UserDefinedName_Get(peak_camera_handle hCam, char* userDefinedName,
2015 size_t* userDefinedNameSize);
2016
2033
2051
2052#pragma pack(push, 1)
2065typedef union
2066{
2068 uint32_t addr;
2069
2071 uint8_t parts[4];
2072
2074#pragma pack (pop)
2075
2076#pragma pack (push, 1)
2083typedef struct
2084{
2087
2090
2091 uint8_t reserved[4];
2092
2094#pragma pack (pop)
2095
2140
2141#pragma pack (push, 1)
2178#pragma pack (pop)
2179
2213
2233PEAK_API_STATUS peak_EthernetConfig_GetInfo(peak_camera_id cameraID, peak_ethernet_info* ethernetInfo);
2234
2266
2301
2318
2353
2382
2404
2425typedef struct peak_frame* peak_frame_handle;
2426
2434#pragma pack(push, 1)
2435typedef struct
2436{
2443 uint32_t numUnderrun;
2444
2451 uint32_t numDropped;
2452
2460
2467 double fps;
2468
2469 uint8_t reserved[256];
2470
2472#pragma pack(pop)
2473
2519PEAK_API_STATUS peak_Acquisition_Start(peak_camera_handle hCam, uint32_t numberOfFrames);
2520
2546
2565
2602PEAK_API_STATUS peak_Acquisition_WaitForFrame(peak_camera_handle hCam, uint32_t timeout_ms, peak_frame_handle* hFrame);
2603
2624
2643PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredSize(peak_camera_handle hCam, size_t* requiredBufferSize);
2644
2662PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredCount(peak_camera_handle hCam, size_t* requiredBufferCount);
2663
2700PEAK_API_STATUS peak_Acquisition_Buffer_Announce(peak_camera_handle hCam, uint8_t* memoryAddress, size_t memorySize,
2701 void* userContext);
2702
2727PEAK_API_STATUS peak_Acquisition_Buffer_Revoke(peak_camera_handle hCam, uint8_t* memoryAddress);
2728
2751
2820
2848
2884PEAK_API_STATUS peak_Acquisition_BufferHandling_Mode_GetList(peak_camera_handle hCam, peak_buffer_handling_mode* bufferHandlingModeList, size_t* bufferHandlingModesCount);
2885
2909
2931
2967
2995
3031PEAK_API_STATUS peak_Acquisition_LossHandling_Mode_GetList(peak_camera_handle hCam, peak_loss_handling_mode* lossHandlingModeList, size_t* lossHandlingModesCount);
3032
3054
3076
3104
3127PEAK_API_STATUS peak_Acquisition_LossHandling_Extent_GetRange(peak_camera_handle hCam, int64_t* minExtent, int64_t* maxExtent, int64_t* incExtent);
3128
3150
3174
3202
3224PEAK_API_STATUS peak_Acquisition_LossHandling_FrameAbortTimeout_GetRange(peak_camera_handle hCam, int64_t* minTimeout, int64_t* maxTimeout, int64_t* incTimeout);
3225
3247
3269
3297
3323 int64_t* maxTimeout, int64_t* incTimeout);
3324
3348
3370
3377typedef enum
3378{
3384
3387
3390
3393
3396
3399
3402
3405
3408
3411
3414
3417
3420
3423
3426
3429
3432
3435
3438
3441
3444
3447
3450
3453
3456
3459
3462
3465
3468
3471
3474
3477
3480
3483
3486
3489
3492
3495
3498
3501
3507
3513
3519
3525
3531
3537
3543
3549
3555
3561
3563
3564#pragma pack(push, 1)
3571typedef struct
3572{
3578
3584
3589 uint32_t numChannels;
3590
3596
3602
3608
3609 uint8_t reserved[64];
3610
3612#pragma pack(pop)
3613
3632PEAK_API_STATUS peak_PixelFormat_GetInfo(peak_pixel_format pixelFormat, peak_pixel_format_info* pixelFormatInfo);
3633
3657
3664typedef enum
3665{
3671
3678
3680
3687#pragma pack(push, 1)
3688typedef struct
3689{
3692
3695
3703 uint64_t frameID;
3704
3710
3713
3716
3722
3729
3738
3744
3745 uint8_t reserved[256];
3746
3748#pragma pack(pop)
3749
3767PEAK_API_STATUS peak_Frame_GetInfo(peak_frame_handle hFrame, peak_frame_info* frameInfo);
3768
3786PEAK_API_STATUS peak_Frame_Type_Get(peak_frame_handle hFrame, peak_frame_type* frameType);
3787
3805PEAK_API_STATUS peak_Frame_Buffer_Get(peak_frame_handle hFrame, peak_buffer* buffer);
3806
3824PEAK_API_STATUS peak_Frame_ID_Get(peak_frame_handle hFrame, uint64_t* frameID);
3825
3843PEAK_API_STATUS peak_Frame_Timestamp_Get(peak_frame_handle hFrame, uint64_t* timestamp_ns);
3844
3862PEAK_API_STATUS peak_Frame_ROI_Get(peak_frame_handle hFrame, peak_roi* roi);
3863
3882
3900
3918PEAK_API_STATUS peak_Frame_BytesExpected_Get(peak_frame_handle hFrame, size_t* bytesExpected);
3919
3937PEAK_API_STATUS peak_Frame_BytesWritten_Get(peak_frame_handle hFrame, size_t* bytesWritten);
3938
3956PEAK_API_STATUS peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t* processingTime_ms);
3957
3983PEAK_API_STATUS peak_Frame_Save(peak_frame_handle hFrame, const char* fileName);
3984
4041
4072 peak_parameter_set parameterSet);
4073
4115 size_t* parameterSetCount);
4116
4143
4168
4196
4224
4246
4275
4300PEAK_API_STATUS peak_CameraSettings_DiskFile_Store(peak_camera_handle hCam, const char* file);
4301
4326PEAK_API_STATUS peak_CameraSettings_DiskFile_Apply(peak_camera_handle hCam, const char* file);
4327
4355
4380PEAK_API_STATUS peak_FrameRate_GetRange(peak_camera_handle hCam, double* minFrameRate_fps, double* maxFrameRate_fps,
4381 double* incFrameRate_fps);
4382
4403PEAK_API_STATUS peak_FrameRate_Set(peak_camera_handle hCam, double frameRate_fps);
4404
4424PEAK_API_STATUS peak_FrameRate_Get(peak_camera_handle hCam, double* frameRate_fps);
4425
4453
4478PEAK_API_STATUS peak_ExposureTime_GetRange(peak_camera_handle hCam, double* minExposureTime_us,
4479 double* maxExposureTime_us, double* incExposureTime_us);
4480
4501PEAK_API_STATUS peak_ExposureTime_Set(peak_camera_handle hCam, double exposureTime_us);
4502
4522PEAK_API_STATUS peak_ExposureTime_Get(peak_camera_handle hCam, double* exposureTime_us);
4523
4551
4568
4596PEAK_API_STATUS peak_PixelClock_GetRange(peak_camera_handle hCam, double* minPixelClock_MHz, double* maxPixelClock_MHz,
4597 double* incPixelClock_MHz);
4598
4641PEAK_API_STATUS peak_PixelClock_GetList(peak_camera_handle hCam, double* pixelClockList, size_t* pixelClockCount);
4642
4665PEAK_API_STATUS peak_PixelClock_Set(peak_camera_handle hCam, double pixelClock_MHz);
4666
4686PEAK_API_STATUS peak_PixelClock_Get(peak_camera_handle hCam, double* pixelClock_MHz);
4687
4697typedef enum
4698{
4704
4710
4716
4724 PEAK_DEPRECATED_MSG(PEAK_IO_CHANNEL_TRIGGER_INPUT, "Use PEAK_IO_CHANNEL_LINE_0 instead") = 0x2101,
4725
4733 PEAK_DEPRECATED_MSG(PEAK_IO_CHANNEL_FLASH_OUTPUT, "Use PEAK_IO_CHANNEL_LINE_1 instead") = 0x2201,
4734
4742 PEAK_DEPRECATED_MSG(PEAK_IO_CHANNEL_GPIO_1, "Use PEAK_IO_CHANNEL_LINE_2 instead") = 0x6301,
4743
4751 PEAK_DEPRECATED_MSG(PEAK_IO_CHANNEL_GPIO_2, "Use PEAK_IO_CHANNEL_LINE_3 instead") = 0x6302,
4752
4759
4766
4773
4780
4787
4794
4801
4808
4810
4842
4883
4922PEAK_API_STATUS_DEPRECATED("Use peak_IOChannel_GetListForDirection instead")
4923 peak_IOChannel_GetList(peak_camera_handle hCam, peak_io_channel* ioChannelList, size_t* ioChannelCount);
4924
4962 peak_io_direction direction, peak_io_channel* ioChannelList, size_t* ioChannelCount);
4963
4995
5018
5065
5096
5119
5150
5168
5190
5222
5244
5262
5295
5317 peak_bool enabled);
5318
5336
5365 double* minNoiseFilterDuration_us, double* maxNoiseFilterDuration_us, double* incNoiseFilterDuration_us);
5366
5391 double noiseFilterDuration_us);
5392
5415 double* noiseFilterDuration_us);
5416
5444
5470
5478#define PEAK_TRIGGER_MODE_HARDWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_TRIGGER_INPUT }
5479
5493#define PEAK_TRIGGER_MODE_SOFTWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_SOFTWARE }
5494
5522
5544PEAK_API_STATUS peak_Trigger_Enable(peak_camera_handle hCam, peak_bool enabled);
5545
5562
5581
5607
5640
5672
5698PEAK_API_STATUS_DEPRECATED("Use peak_Trigger_Mode_Config_Get instead")
5699peak_Trigger_Mode_Get(peak_camera_handle hCam, peak_trigger_mode* triggerMode);
5700
5722
5758
5788
5830 size_t* triggerEdgeCount);
5831
5855
5877
5907
5934PEAK_API_STATUS peak_Trigger_Delay_GetRange(peak_camera_handle hCam, double* minTriggerDelay_us,
5935 double* maxTriggerDelay_us, double* incTriggerDelay_us);
5936
5959PEAK_API_STATUS peak_Trigger_Delay_Set(peak_camera_handle hCam, double triggerDelay_us);
5960
5981PEAK_API_STATUS peak_Trigger_Delay_Get(peak_camera_handle hCam, double* triggerDelay_us);
5982
6012
6039PEAK_API_STATUS peak_Trigger_Divider_GetRange(peak_camera_handle hCam, uint32_t* minTriggerDivider,
6040 uint32_t* maxTriggerDivider, uint32_t* incTriggerDivider);
6041
6063PEAK_API_STATUS peak_Trigger_Divider_Set(peak_camera_handle hCam, uint32_t triggerDivider);
6064
6085PEAK_API_STATUS peak_Trigger_Divider_Get(peak_camera_handle hCam, uint32_t* triggerDivider);
6086
6116
6143PEAK_API_STATUS peak_Trigger_Burst_GetRange(peak_camera_handle hCam, uint32_t* minTriggerBurst,
6144 uint32_t* maxTriggerBurst, uint32_t* incTriggerBurst);
6145
6167PEAK_API_STATUS peak_Trigger_Burst_Set(peak_camera_handle hCam, uint32_t triggerBurst);
6168
6189PEAK_API_STATUS peak_Trigger_Burst_Get(peak_camera_handle hCam, uint32_t* triggerBurst);
6190
6228
6254
6262#define PEAK_FLASH_MODE_EXPOSURE_ACTIVE { PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6263
6271#define PEAK_FLASH_MODE_ACQUISITION_ACTIVE { PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6272
6280#define PEAK_FLASH_MODE_GLOBAL_START_WINDOW { PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6281
6309
6330PEAK_API_STATUS peak_Flash_Enable(peak_camera_handle hCam, peak_bool enabled);
6331
6348
6380
6413
6439PEAK_API_STATUS_DEPRECATED("Use peak_Flash_Mode_Config_Get instead")
6440 peak_Flash_Mode_Get(peak_camera_handle hCam, peak_flash_mode* flashMode);
6441
6463
6493
6520PEAK_API_STATUS peak_Flash_StartDelay_GetRange(peak_camera_handle hCam, double* minFlashStartDelay_us,
6521 double* maxFlashStartDelay_us, double* incFlashStartDelay_us);
6522
6544PEAK_API_STATUS peak_Flash_StartDelay_Set(peak_camera_handle hCam, double flashStartDelay_us);
6545
6566PEAK_API_STATUS peak_Flash_StartDelay_Get(peak_camera_handle hCam, double* flashStartDelay_us);
6567
6597
6624PEAK_API_STATUS peak_Flash_EndDelay_GetRange(peak_camera_handle hCam, double* minFlashEndDelay_us,
6625 double* maxFlashEndDelay_us, double* incFlashEndDelay_us);
6626
6649PEAK_API_STATUS peak_Flash_EndDelay_Set(peak_camera_handle hCam, double flashEndDelay_us);
6650
6671PEAK_API_STATUS peak_Flash_EndDelay_Get(peak_camera_handle hCam, double* flashEndDelay_us);
6672
6702
6729PEAK_API_STATUS peak_Flash_Duration_GetRange(peak_camera_handle hCam, double* minFlashDuration_us,
6730 double* maxFlashDuration_us, double* incFlashDuration_us);
6731
6752PEAK_API_STATUS peak_Flash_Duration_Set(peak_camera_handle hCam, double flashDuration_us);
6753
6774PEAK_API_STATUS peak_Flash_Duration_Get(peak_camera_handle hCam, double* flashDuration_us);
6775
6802
6825PEAK_API_STATUS peak_Focus_GetRange(peak_camera_handle hCam, uint32_t* minFocus, uint32_t* maxFocus,
6826 uint32_t* incFocus);
6827
6851PEAK_API_STATUS peak_Focus_Set(peak_camera_handle hCam, uint32_t focus);
6852
6872PEAK_API_STATUS peak_Focus_Get(peak_camera_handle hCam, uint32_t* focus);
6873
6901
6943 size_t* pixelFormatCount);
6944
6966
6987
6994typedef enum
6995{
7001
7004
7007
7010
7012
7040
7072 peak_gain_channel gainChannel);
7073
7110 peak_gain_channel* gainChannelList, size_t* gainChannelCount);
7111
7141PEAK_API_STATUS peak_Gain_GetRange(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
7142 double* minGain, double* maxGain, double* incGain);
7143
7169PEAK_API_STATUS peak_Gain_Set(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
7170 double gain);
7171
7196PEAK_API_STATUS peak_Gain_Get(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
7197 double* gain);
7198
7225
7248PEAK_API_STATUS peak_Gamma_GetRange(peak_camera_handle hCam, double* minGamma, double* maxGamma, double* incGamma);
7249
7270PEAK_API_STATUS peak_Gamma_Set(peak_camera_handle hCam, double gamma);
7271
7291PEAK_API_STATUS peak_Gamma_Get(peak_camera_handle hCam, double* gamma);
7292
7324
7352
7397 peak_color_correction_mode* colorCorrectionModeList, size_t* colorCorrectionModeCount);
7398
7423
7443
7471
7494PEAK_API_STATUS peak_ColorCorrection_Matrix_GetRange(peak_camera_handle hCam, double* minMatrixElementValue,
7495 double* maxMatrixElementValue, double* incMatrixElementValue);
7496
7517PEAK_API_STATUS peak_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix);
7518
7538PEAK_API_STATUS peak_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix* colorCorrectionMatrix);
7539
7558
7575
7611
7639
7673
7701
7731
7754PEAK_API_STATUS peak_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t* minAutoBrightnessTarget,
7755 uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
7756
7757
7758
7779PEAK_API_STATUS peak_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget);
7780
7800PEAK_API_STATUS peak_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t* autoBrightnessTarget);
7801
7831
7856 uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
7857 uint32_t* incAutoBrightnessTargetTolerance);
7858
7881 uint32_t autoBrightnessTargetTolerance);
7882
7903 uint32_t* autoBrightnessTargetTolerance);
7904
7934
7959 double* minAutoBrightnessTargetPercentile, double* maxAutoBrightnessTargetPercentile,
7960 double* incAutoBrightnessTargetPercentile);
7961
7984 double autoBrightnessTargetPercentile);
7985
8006 double* autoBrightnessTargetPercentile);
8007
8037
8059 peak_auto_feature_roi_mode autoBrightnessROIMode);
8060
8081 peak_auto_feature_roi_mode* autoBrightnessROIMode);
8082
8110 peak_position* minAutoBrightnessROIOffset, peak_position* maxAutoBrightnessROIOffset,
8111 peak_position* incAutoBrightnessROIOffset);
8112
8139PEAK_API_STATUS peak_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minAutoBrightnessROISize,
8140 peak_size* maxAutoBrightnessROISize, peak_size* incAutoBrightnessROISize);
8141
8169PEAK_API_STATUS peak_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI);
8170
8190PEAK_API_STATUS peak_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi* autoBrightnessROI);
8191
8221
8259 peak_auto_feature_mode* modeList, size_t* modeListSize);
8260
8282
8303
8333
8371 peak_auto_feature_mode* modeList, size_t* modeListSize);
8372
8394
8415
8443
8471
8493 peak_auto_feature_roi_mode autoWhiteBalanceROIMode);
8494
8515 peak_auto_feature_roi_mode* autoWhiteBalanceROIMode);
8516
8546 peak_position* minAutoWhiteBalanceROIOffset, peak_position* maxAutoWhiteBalanceROIOffset,
8547 peak_position* incAutoWhiteBalanceROIOffset);
8548
8577PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minAutoWhiteBalanceROISize,
8578 peak_size* maxAutoWhiteBalanceROISize, peak_size* incAutoWhiteBalanceROISize);
8579
8607PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI);
8608
8628PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi* autoWhiteBalanceROI);
8629
8651
8672
8709 peak_auto_feature_mode* modeList, size_t* modeListSize);
8710
8737
8764 peak_position* maxROIOffset, peak_position* incROIOffset);
8765
8792
8814
8835
8861PEAK_API_STATUS peak_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minROISize, peak_size* maxROISize,
8862 peak_size* incROISize);
8863
8890
8912
8933
8955PEAK_API_STATUS peak_ROI_Set(peak_camera_handle hCam, peak_roi roi);
8956
8976PEAK_API_STATUS peak_ROI_Get(peak_camera_handle hCam, peak_roi* roi);
8977
9004
9045PEAK_API_STATUS peak_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t* binningFactorXList,
9046 size_t* binningFactorXCount);
9047
9088PEAK_API_STATUS peak_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t* binningFactorYList,
9089 size_t* binningFactorYCount);
9090
9118PEAK_API_STATUS peak_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY);
9119
9140PEAK_API_STATUS peak_Binning_Get(peak_camera_handle hCam, uint32_t* binningFactorX, uint32_t* binningFactorY);
9141
9160
9185 peak_subsampling_engine subsamplingEngine);
9186
9229 peak_subsampling_engine subsamplingEngine, uint32_t* binningFactorXList, size_t* binningFactorXCount);
9230
9273 peak_subsampling_engine subsamplingEngine, uint32_t* binningFactorYList, size_t* binningFactorYCount);
9274
9301 peak_subsampling_engine subsamplingEngine, uint32_t binningFactorX, uint32_t binningFactorY);
9302
9325 peak_subsampling_engine subsamplingEngine, uint32_t *binningFactorX, uint32_t *binningFactorY);
9326
9354
9397PEAK_API_STATUS peak_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t* decimationFactorXList,
9398 size_t* decimationFactorXCount);
9399
9442PEAK_API_STATUS peak_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t* decimationFactorYList,
9443 size_t* decimationFactorYCount);
9444
9469PEAK_API_STATUS peak_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY);
9470
9491PEAK_API_STATUS peak_Decimation_Get(peak_camera_handle hCam, uint32_t* decimationFactorX, uint32_t* decimationFactorY);
9492
9521 peak_subsampling_engine subsamplingEngine);
9522
9567 peak_subsampling_engine subsamplingEngine, uint32_t* decimationFactorXList, size_t* decimationFactorXCount);
9568
9613 peak_subsampling_engine subsamplingEngine, uint32_t* decimationFactorYList, size_t* decimationFactorYCount);
9614
9641 peak_subsampling_engine subsamplingEngine, uint32_t decimationFactorX, uint32_t decimationFactorY);
9642
9665 peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorX, uint32_t *decimationFactorY);
9666
9694
9717PEAK_API_STATUS peak_Scaling_FactorX_GetRange(peak_camera_handle hCam, double* minScalingFactorX,
9718 double* maxScalingFactorX, double* incScalingFactorX);
9719
9742PEAK_API_STATUS peak_Scaling_FactorY_GetRange(peak_camera_handle hCam, double* minScalingFactorY,
9743 double* maxScalingFactorY, double* incScalingFactorY);
9744
9772PEAK_API_STATUS peak_Scaling_Set(peak_camera_handle hCam, double scalingFactorX, double scalingFactorY);
9773
9794PEAK_API_STATUS peak_Scaling_Get(peak_camera_handle hCam, double* scalingFactorX, double* scalingFactorY);
9795
9823
9843
9860
9888
9908
9925
9953
9984 peak_camera_memory_area cameraMemoryArea);
9985
10028 peak_camera_memory_area* cameraMemoryAreaList, size_t* cameraMemoryAreaCount);
10029
10055 peak_camera_memory_area cameraMemoryArea, size_t* cameraMemoryAreaSize);
10056
10080 peak_camera_memory_area cameraMemoryArea);
10081
10116 peak_camera_memory_area cameraMemoryArea, const uint8_t* data, size_t dataSize);
10117
10150 peak_camera_memory_area cameraMemoryArea, uint8_t* data, size_t dataSize);
10151
10191
10210
10244
10279 const char* featureName);
10280
10298PEAK_API_BOOL peak_GFA_Float_HasRange(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName);
10299
10335PEAK_API_STATUS peak_GFA_Float_GetRange(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
10336 double* minFloatValue, double* maxFloatValue, double* incFloatValue);
10337
10384PEAK_API_STATUS peak_GFA_Float_GetList(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
10385 double* floatList, size_t* floatCount);
10386
10419PEAK_API_STATUS peak_GFA_Float_Set(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
10420 double floatValue);
10421
10448PEAK_API_STATUS peak_GFA_Float_Get(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
10449 double* floatValue);
10450
10469 const char* integerFeatureName);
10470
10507 const char* integerFeatureName, int64_t* minIntegerValue, int64_t* maxIntegerValue, int64_t* incIntegerValue);
10508
10558 const char* integerFeatureName, int64_t* integerList, size_t* integerCount);
10559
10592PEAK_API_STATUS peak_GFA_Integer_Set(peak_camera_handle hCam, peak_gfa_module module, const char* integerFeatureName,
10593 int64_t integerValue);
10594
10621PEAK_API_STATUS peak_GFA_Integer_Get(peak_camera_handle hCam, peak_gfa_module module, const char* integerFeatureName,
10622 int64_t* integerValue);
10623
10655PEAK_API_STATUS peak_GFA_Boolean_Set(peak_camera_handle hCam, peak_gfa_module module, const char* booleanFeatureName,
10656 peak_bool booleanValue);
10657
10684PEAK_API_STATUS peak_GFA_Boolean_Get(peak_camera_handle hCam, peak_gfa_module module, const char* booleanFeatureName,
10685 peak_bool* booleanValue);
10686
10717PEAK_API_STATUS peak_GFA_String_Set(peak_camera_handle hCam, peak_gfa_module module, const char* stringFeatureName,
10718 const char* stringValue);
10719
10766PEAK_API_STATUS peak_GFA_String_Get(peak_camera_handle hCam, peak_gfa_module module, const char* stringFeatureName,
10767 char* stringValue, size_t* stringValueSize);
10768
10798 const char* commandFeatureName);
10799
10835 const char* commandFeatureName, uint32_t timeout_ms);
10836
10846 typedef struct
10847{
10850
10853
10855
10904 const char* enumerationFeatureName, peak_gfa_enumeration_entry* enumerationEntryList,
10905 size_t* enumerationEntryCount);
10906
10944 const char* enumerationFeatureName, const peak_gfa_enumeration_entry* enumerationEntry);
10945
10981 peak_gfa_module module, const char* enumerationFeatureName, const char* enumerationEntrySymbolicValue);
10982
11017 peak_gfa_module module, const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
11018
11055 const char* enumerationFeatureName, const peak_gfa_enumeration_entry* enumerationEntry);
11056
11091 const char* enumerationFeatureName, const char* enumerationEntrySymbolicValue);
11092
11126 const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
11127
11155 const char* enumerationFeatureName, peak_gfa_enumeration_entry* enumerationEntry);
11156
11189PEAK_API_STATUS peak_GFA_Register_Set(peak_camera_handle hCam, peak_gfa_module module, const char* registerFeatureName,
11190 const uint8_t* registerValue, size_t registerValueSize);
11191
11233PEAK_API_STATUS peak_GFA_Register_Get(peak_camera_handle hCam, peak_gfa_module module, const char* registerFeatureName,
11234 uint8_t* registerValue, size_t* registerValueSize);
11235
11267PEAK_API_STATUS peak_GFA_Data_Write(peak_camera_handle hCam, peak_gfa_module module, uint64_t address,
11268 const uint8_t* data, size_t dataSize);
11269
11296PEAK_API_STATUS peak_GFA_Data_Read(peak_camera_handle hCam, peak_gfa_module module, uint64_t address, uint8_t* data,
11297 size_t dataSize);
11298
11338 peak_pixel_format* outputPixelFormatList, size_t* outputPixelFormatCount);
11339
11366
11385
11406PEAK_API_STATUS peak_IPL_Gain_GetRange(peak_camera_handle hCam, peak_gain_channel gainChannel, double* minGain,
11407 double* maxGain, double* incGain);
11408
11430PEAK_API_STATUS peak_IPL_Gain_Set(peak_camera_handle hCam, peak_gain_channel gainChannel, double gain);
11431
11452PEAK_API_STATUS peak_IPL_Gain_Get(peak_camera_handle hCam, peak_gain_channel gainChannel, double* gain);
11453
11473PEAK_API_STATUS peak_IPL_Gamma_GetRange(peak_camera_handle hCam, double* minGamma, double* maxGamma, double* incGamma);
11474
11493PEAK_API_STATUS peak_IPL_Gamma_Set(peak_camera_handle hCam, double gamma);
11494
11512PEAK_API_STATUS peak_IPL_Gamma_Get(peak_camera_handle hCam, double* gamma);
11513
11530PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix);
11531
11549PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix* colorCorrectionMatrix);
11550
11568PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Get(peak_camera_handle hCam, double* saturation);
11569
11588PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Set(peak_camera_handle hCam, double saturation);
11589
11610PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_GetRange(peak_camera_handle hCam, double* minSaturation, double* maxSaturation, double* incSaturation);
11611
11629
11646
11667PEAK_API_STATUS peak_IPL_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t* minAutoBrightnessTarget,
11668 uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
11669
11688PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget);
11689
11707PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t* autoBrightnessTarget);
11708
11731 uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
11732 uint32_t* incAutoBrightnessTargetTolerance);
11733
11754 uint32_t autoBrightnessTargetTolerance);
11755
11774 uint32_t* autoBrightnessTargetTolerance);
11775
11798 double* minAutoBrightnessTargetPercentile, double* maxAutoBrightnessTargetPercentile,
11799 double* incAutoBrightnessTargetPercentile);
11800
11821 double autoBrightnessTargetPercentile);
11822
11841 double* autoBrightnessTargetPercentile);
11842
11862 peak_auto_feature_roi_mode autoBrightnessROIMode);
11863
11882 peak_auto_feature_roi_mode* autoBrightnessROIMode);
11883
11908 peak_position* minAutoBrightnessROIOffset, peak_position* maxAutoBrightnessROIOffset,
11909 peak_position* incAutoBrightnessROIOffset);
11910
11935 peak_size* minAutoBrightnessROISize, peak_size* maxAutoBrightnessROISize, peak_size* incAutoBrightnessROISize);
11936
11963PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI);
11964
11982PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi* autoBrightnessROI);
11983
12003 peak_auto_feature_mode autoExposureMode);
12004
12023 peak_auto_feature_mode* autoExposureMode);
12024
12031typedef struct
12032{
12034 double min;
12036 double max;
12037}
12039
12056
12073
12094
12113
12134
12153
12174
12193
12213
12232
12253
12272
12292
12311
12329PEAK_API_STATUS peak_IPL_AutoBrightness_AverageLast_Get(peak_camera_handle hCam, uint32_t* lastAverage);
12330
12354
12371
12391
12415
12432
12451
12475
12492
12511
12535
12552
12571
12595
12612
12631
12646PEAK_API_STATUS peak_IPL_AutoBrightness_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames);
12647
12663PEAK_API_STATUS peak_IPL_AutoBrightness_SkipFrames_Get(peak_camera_handle hCam, uint32_t* skipFrames);
12664
12684 uint32_t* skipFramesMin, uint32_t* skipFramesMax, uint32_t* skipFramesInc);
12685
12705 peak_auto_feature_roi_mode autoWhiteBalanceROIMode);
12706
12725 peak_auto_feature_roi_mode* autoWhiteBalanceROIMode);
12726
12751 peak_position* minAutoWhiteBalanceROIOffset, peak_position* maxAutoWhiteBalanceROIOffset,
12752 peak_position* incAutoWhiteBalanceROIOffset);
12753
12778 peak_size* minAutoWhiteBalanceROISize, peak_size* maxAutoWhiteBalanceROISize,
12779 peak_size* incAutoWhiteBalanceROISize);
12780
12809PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI);
12810
12828PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi* autoWhiteBalanceROI);
12829
12849
12868 peak_auto_feature_mode* autoWhiteBalanceMode);
12869
12870
12885PEAK_API_STATUS peak_IPL_AutoWhiteBalance_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames);
12886
12902PEAK_API_STATUS peak_IPL_AutoWhiteBalance_SkipFrames_Get(peak_camera_handle hCam, uint32_t* skipFrames);
12903
12923 uint32_t* skipFramesMin, uint32_t* skipFramesMax, uint32_t* skipFramesInc);
12924
12947
12948#pragma pack(push, 1)
12949
12954typedef struct
12955{
12958
12961
12963#pragma pack(pop)
12964
12992
13015PEAK_API_STATUS peak_IPL_AutoFocus_ROI_Set(peak_camera_handle hCam, const peak_focus_roi* autoFocusROIList,
13016 size_t autoFocusROICount);
13017
13051PEAK_API_STATUS peak_IPL_AutoFocus_ROI_Get(peak_camera_handle hCam, peak_focus_roi* autoFocusROIList,
13052 size_t* autoFocusROICount);
13053
13073
13092
13131
13156 peak_auto_focus_search_algorithm searchAlgorithm);
13157
13178 peak_auto_focus_search_algorithm* searchAlgorithm);
13179
13217
13242 peak_sharpness_algorithm sharpnessAlgorithm);
13243
13264 peak_sharpness_algorithm* sharpnessAlgorithm);
13265
13287PEAK_API_STATUS peak_IPL_AutoFocus_Range_Set(peak_camera_handle hCam, uint32_t rangeBegin, uint32_t rangeEnd);
13288
13309PEAK_API_STATUS peak_IPL_AutoFocus_Range_Get(peak_camera_handle hCam, uint32_t* rangeBegin, uint32_t* rangeEnd);
13310
13331PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Set(peak_camera_handle hCam, uint8_t hysteresis);
13332
13352PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Get(peak_camera_handle hCam, uint8_t* hysteresis);
13353
13376PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_GetRange(peak_camera_handle hCam, uint8_t* minHysteresis,
13377 uint8_t* maxHysteresis, uint8_t* incHysteresis);
13378
13420
13443 peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity);
13444
13463 peak_hotpixel_correction_sensitivity* hotpixelCorrectionSensitivity);
13464
13502 size_t* hotpixelCount);
13503
13526 size_t hotpixelCount);
13527
13548
13567
13584
13603
13620
13639
13656
13683 peak_frame_handle* hResultFrame);
13684
13714
13734PEAK_API_STATUS peak_IPL_ReadImage(
13735 peak_camera_handle hCam, const char* path, peak_frame_handle* hFrame);
13736
13755
13772
13773
13792PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_Set(peak_camera_handle hCam, uint32_t factor);
13793
13811PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_Get(peak_camera_handle hCam, uint32_t* factor);
13812
13830PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_GetDefault(peak_camera_handle hCam, uint32_t* defaultFactor);
13831
13852 uint32_t* minFactor, uint32_t* maxFactor, uint32_t* incFactor);
13853
13877 peak_sharpness_algorithm sharpnessAlgorithm, double* calculatedValue);
13878
13907PEAK_API_STATUS peak_IPL_Sharpness_GetList(peak_sharpness_algorithm sharpnessAlgorithm, peak_pixel_format* pixelFormatList, size_t* pixelFormatSize);
13908
13909
13914#define PEAK_ROTATION_ANGLE_0 (0)
13915
13920#define PEAK_ROTATION_ANGLE_180 (180)
13921
13926#define PEAK_ROTATION_ANGLE_CLOCKWISE_90 (-90)
13927
13932#define PEAK_ROTATION_ANGLE_CLOCKWISE_270 (-270)
13933
13938#define PEAK_ROTATION_ANGLE_COUNTERCLOCKWISE_90 (90)
13939
13944#define PEAK_ROTATION_ANGLE_COUNTERCLOCKWISE_270 (270)
13945
13964PEAK_API_STATUS peak_IPL_Rotation_Angle_Set(peak_camera_handle hCam, int32_t rotationAngle);
13965
13983PEAK_API_STATUS peak_IPL_Rotation_Angle_Get(peak_camera_handle hCam, int32_t* rotationAngle);
13984
13991typedef struct
13992{
13994 uint64_t pixelSum;
13995
13997 uint64_t pixelCount;
13998
14001 size_t binSize;
14002
14004 uint8_t reserved[64];
14006
14011typedef struct peak_histogram* peak_histogram_handle;
14012
14035 peak_histogram_handle* hHistogram);
14036
14054
14075PEAK_API_STATUS peak_IPL_Histogram_Channel_GetCount(peak_histogram_handle hHistogram, size_t* numChannels);
14076
14098PEAK_API_STATUS peak_IPL_Histogram_Channel_GetInfo(peak_histogram_handle hHistogram, size_t channel, peak_histogram_channel_info* channelInfo);
14099
14136PEAK_API_STATUS peak_IPL_Histogram_Channel_GetBinArray(peak_histogram_handle hHistogram, size_t channel, uint64_t* binArray, size_t* binArraySize);
14137
14149typedef struct peak_video* peak_video_handle;
14150
14157typedef enum
14158{
14164
14167
14169
14176typedef enum
14177{
14183
14186
14188
14206PEAK_API_STATUS peak_VideoWriter_Open(peak_video_handle* hVideo, const char* fileName,
14207 peak_video_container container, peak_video_encoder encoder);
14208
14225
14243
14275 peak_video_encoder* encoderList, size_t* encoderCount);
14276
14317 peak_pixel_format* pixelFormatList, size_t* pixelFormatCount);
14318
14350 peak_video_container* containerList, size_t* containerCount);
14351
14359typedef struct
14360{
14361 /* \brief Overall encoded frames */
14362 uint64_t encodedFrames;
14363
14364 /* \brief Overall dropped frames */
14365 uint64_t droppedFrames;
14366
14367 /* \brief Current file size in bytes */
14368 uint64_t fileSize;
14369
14370 uint8_t reserved[256];
14372
14389
14411
14433
14453 peak_video_container_option containerOption, const void* value, size_t count);
14454
14475 peak_video_container_option containerOption, void* value, size_t count, size_t* outCount);
14476
14496 peak_video_encoder_option encoderOption, const void* value, size_t count);
14497
14518 peak_video_encoder_option encoderOption, void* value, size_t count, size_t* outCount);
14519
14535PEAK_API_STATUS peak_VideoWriter_WaitUntilQueueEmpty(peak_video_handle hVideo, int32_t timeout_ms);
14536
14541typedef struct peak_inference* peak_inference_handle;
14542
14547typedef struct peak_inference_result* peak_inference_result_handle;
14548
14569
14587
14592typedef struct
14593{
14596
14598 float score;
14599
14601 char label[256];
14602
14605
14607
14612typedef struct
14613{
14616
14618 float score;
14619
14621 char label[256];
14622
14624
14629typedef struct
14630{
14633
14636
14639
14642
14644 char reserved[256];
14645
14647
14652typedef struct
14653{
14655 uint32_t major;
14656
14658 uint32_t minor;
14659
14661 uint32_t subMinor;
14662
14664 uint32_t patch;
14665} peak_version;
14666
14667
14672typedef struct
14673{
14676
14678 char lighthouseID[256];
14679
14682
14684 char projectName[256];
14685
14687 char networkName[256];
14688
14691
14694
14697
14700
14703
14706
14708 uint8_t reserved[256];
14710
14726PEAK_API_STATUS peak_Inference_CNN_Open(const char* path, peak_inference_handle* hInference);
14727
14742
14762 peak_inference_result_handle* hInferenceHandle);
14763
14780
14798
14815
14846 peak_inference_result_classification* resultList, size_t* resultCount);
14847
14878 peak_inference_result_detection* resultList, size_t* resultCount);
14879
14880typedef struct
14881{
14883 uint32_t numInferencesSuccessful;
14884
14886 uint32_t numInferencesFailed;
14887
14889 char reserved[256];
14890} peak_inference_statistics;
14891
14907PEAK_API_STATUS peak_Inference_Statistics_Get(peak_inference_handle hInference, peak_inference_statistics* statistics);
14908
14923
14939PEAK_API_STATUS peak_Inference_ConfidenceThreshold_Get(peak_inference_handle hInference, uint32_t* threshold);
14940
14958PEAK_API_STATUS peak_Inference_ConfidenceThreshold_GetRange(peak_inference_handle hInference, uint32_t* minThreshold,
14959 uint32_t* maxThreshold, uint32_t* incThreshold);
14960
14976PEAK_API_STATUS peak_Inference_ConfidenceThreshold_Set(peak_inference_handle hInference, uint32_t threshold);
14977
14995
15003typedef enum
15004{
15007
15013
15019
15025
15031
15037
15043
15049
15055
15061
15067
15073
15079
15086
15093
15098
15103
15111
15119
15126
15133
15140
15147
15155
15202
15209typedef struct
15210{
15213
15215 uint8_t reserved[32];
15217
15224typedef struct
15225{
15228
15230 int64_t error_type;
15231
15233 uint8_t reserved[32];
15235
15242typedef struct
15243{
15246
15248 int64_t count;
15249
15251 uint8_t reserved[32];
15253
15260typedef struct
15261{
15264
15266 int64_t frameId;
15267
15269 uint8_t reserved[32];
15271
15278typedef struct
15279{
15282
15285
15287 uint8_t reserved[32];
15289
15296typedef struct
15297{
15299 int32_t focusValue;
15300
15303
15305 uint8_t reserved[32];
15307
15321
15336
15343typedef struct
15344{
15347
15348 peak_reconnect_information reconnectInformation;
15349
15351 uint8_t reserved[32];
15353
15368
15392
15408
15442
15447typedef struct
15448{
15450 uint64_t numQueued;
15451
15454
15456 uint64_t numDropped;
15457
15459 uint64_t numInQueue;
15460
15463
15465 uint8_t reserved[32];
15467
15472typedef struct
15473{
15476
15479
15481 uint64_t messageID;
15482
15485
15488
15490 uint8_t reserved[256];
15492
15498typedef struct peak_message_queue* peak_message_queue_handle;
15499
15505typedef struct peak_message* peak_message_handle;
15506
15521
15538
15564 peak_camera_handle hCam, peak_message_type messageType);
15590 peak_camera_handle hCam, peak_message_type messageType);
15591
15618 peak_camera_handle hCam, const peak_message_type* messageTypesArray, size_t messageTypesArraySize);
15619
15646 peak_camera_handle hCam, const peak_message_type* messageTypesArray, size_t messageTypesArraySize);
15647
15682 peak_message_type* messageTypesArray, size_t* messageTypesArraySize);
15683
15707 peak_message_queue_mode queueMode);
15708
15728 peak_message_queue_mode* queueMode);
15729
15747
15768
15783
15815 uint32_t timeout_ms, peak_message_handle* hMessage);
15816
15834
15855 peak_camera_handle hCam, peak_message_type messageType);
15856
15875 peak_message_queue_statistics_info* messageQueueInfo);
15876
15893
15919 size_t messageQueueMaxSize);
15920
15939 size_t* messageQueueMaxSize);
15940
15957
15976 peak_message_info* messageInfo);
15977
15996 peak_message_type* messageType);
15997
16017 peak_camera_handle* hCam);
16018
16036PEAK_API_STATUS peak_Message_ID_Get(peak_message_handle hMessage, uint64_t* messageID);
16037
16057 uint64_t* hostTimestamp_ns);
16058
16092 peak_message_data_type* messageType);
16093
16122
16144
16166
16188
16210
16232
16254
16276
16296
16316
16336
16342typedef struct peak_i2c* peak_i2c_handle;
16343
16360
16377PEAK_API_STATUS peak_I2C_Destroy(peak_i2c_handle hI2C);
16378
16406PEAK_API_ACCESS_STATUS peak_I2C_GetAccessStatus(peak_i2c_handle hI2C);
16407
16428
16470PEAK_API_STATUS peak_I2C_Mode_GetList(peak_i2c_handle hI2C, peak_i2c_mode* modeList, size_t* modeListSize);
16471
16496
16519
16549PEAK_API_STATUS peak_I2C_DeviceAddress_GetRange(peak_i2c_handle hI2C, uint32_t* minAddress, uint32_t* maxAddress);
16550
16575PEAK_API_STATUS peak_I2C_DeviceAddress_Set(peak_i2c_handle hI2C, uint32_t address);
16576
16598PEAK_API_STATUS peak_I2C_DeviceAddress_Get(peak_i2c_handle hI2C, uint32_t* address);
16599
16622
16654 peak_i2c_register_address_length* i2cLengthList, size_t* i2cLengthCount);
16655
16676
16699
16725
16748
16771
16799PEAK_API_STATUS peak_I2C_RegisterAddress_Set(peak_i2c_handle hI2C, uint32_t address);
16800
16822PEAK_API_STATUS peak_I2C_RegisterAddress_Get(peak_i2c_handle hI2C, uint32_t* address);
16823
16850
16867
16896
16923PEAK_API_STATUS peak_I2C_AckPolling_Timeout_GetRange(peak_i2c_handle hI2C, uint32_t* minTimeout_ms, uint32_t* maxTimeout_ms, uint32_t* incTimeout_ms);
16924
16947PEAK_API_STATUS peak_I2C_AckPolling_Timeout_Set(peak_i2c_handle hI2C, uint32_t timeout_ms);
16948
16970PEAK_API_STATUS peak_I2C_AckPolling_Timeout_Get(peak_i2c_handle hI2C, uint32_t* timeout_ms);
16971
17005PEAK_API_STATUS peak_I2C_Data_Write(peak_i2c_handle hI2C, const uint8_t* data, size_t dataSize);
17006
17029PEAK_API_STATUS peak_I2C_Data_Read(peak_i2c_handle hI2C, size_t maxDataSize, uint8_t* data, size_t* dataSize);
17030
17052PEAK_API_STATUS peak_I2C_Data_MaxSize_Get(peak_i2c_handle hI2C, size_t* maxDataSize);
17053
17080
17102
17103
17109typedef struct peak_imagewriter* peak_imagewriter_handle;
17110
17125
17143
17162PEAK_API_STATUS peak_IPL_ImageWriter_Save(peak_imagewriter_handle hImageWriter, peak_frame_handle hFrame, const char* fileName);
17163
17171typedef enum
17172{
17178
17185
17192
17199
17206
17213
17214} peak_imagefile_format, PEAK_DEPRECATED_MSG(papientitiy_imagefile_format, "use peak_imagefile_format");
17215
17234
17253
17271PEAK_API_STATUS peak_IPL_ImageWriter_Compression_Set(peak_imagewriter_handle hImageWriter, uint32_t compression);
17272
17290PEAK_API_STATUS peak_IPL_ImageWriter_Compression_Get(peak_imagewriter_handle hImageWriter, uint32_t* compression);
17291
17323PEAK_API_STATUS peak_IPL_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t* binningFactorXList,
17324 size_t* binningFactorXCount);
17325
17357PEAK_API_STATUS peak_IPL_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t* binningFactorYList,
17358 size_t* binningFactorYCount);
17359
17385PEAK_API_STATUS peak_IPL_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY);
17386
17405PEAK_API_STATUS peak_IPL_Binning_Get(peak_camera_handle hCam, uint32_t* binningFactorX, uint32_t* binningFactorY);
17406
17440PEAK_API_STATUS peak_IPL_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t* decimationFactorXList,
17441 size_t* decimationFactorXCount);
17442
17476PEAK_API_STATUS peak_IPL_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t* decimationFactorYList,
17477 size_t* decimationFactorYCount);
17478
17501PEAK_API_STATUS peak_IPL_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY);
17502
17521PEAK_API_STATUS peak_IPL_Decimation_Get(peak_camera_handle hCam, uint32_t* decimationFactorX, uint32_t* decimationFactorY);
17522
17551PEAK_API_STATUS peak_FirmwareUpdate_CompatibleCameraList_Get(const char* gufFileName, peak_camera_descriptor* cameraList, size_t* cameraCount);
17552
17579PEAK_API_STATUS peak_FirmwareUpdate_Execute(peak_camera_id cameraID, const char* gufFileName);
17580
17637
17665
17689
17711
17748 size_t* testPatternCount);
17749
17768
17801
17829
17865PEAK_API_STATUS peak_LED_Target_GetList(peak_camera_handle hCam, peak_led_target* targetList, size_t* targetCount);
17866
17903PEAK_API_STATUS peak_LED_Mode_GetList(peak_camera_handle hCam, peak_led_target target, peak_led_mode* modeList, size_t* ledModeCount);
17904
17931
17954
17982
18006
18023
18051
18075PEAK_API_STATUS peak_BlackLevel_Offset_Set(peak_camera_handle hCam, double offset);
18076
18097PEAK_API_STATUS peak_BlackLevel_Offset_Get(peak_camera_handle hCam, double* offset);
18098
18122PEAK_API_STATUS peak_BlackLevel_Offset_GetRange(peak_camera_handle hCam, double* min, double* max, double* inc);
18123
18151
18156#define PEAK_LINKSPEED_ETH_10M 1250000
18157
18162#define PEAK_LINKSPEED_ETH_100M 12500000
18163
18168#define PEAK_LINKSPEED_USB2_HIGH_SPEED 60000000
18169
18174#define PEAK_LINKSPEED_ETH_1G 125000000
18175
18180#define PEAK_LINKSPEED_ETH_5G 625000000
18181
18186#define PEAK_LINKSPEED_ETH_10G 1250000000
18187
18192#define PEAK_LINKSPEED_USB3_SUPER_SPEED 500000000
18193
18216PEAK_API_STATUS peak_Bandwidth_LinkSpeed_Get(peak_camera_handle hCam, int64_t* linkSpeed_Bps);
18217
18245
18270PEAK_API_STATUS peak_Bandwidth_ThroughputLimit_GetRange(peak_camera_handle hCam, int64_t* minThroughputLimit_Bps,
18271 int64_t* maxThroughputLimit_Bps, int64_t* incThroughputLimit_Bps);
18272
18295PEAK_API_STATUS peak_Bandwidth_ThroughputLimit_Set(peak_camera_handle hCam, int64_t throughputLimit_Bps);
18296
18316PEAK_API_STATUS peak_Bandwidth_ThroughputLimit_Get(peak_camera_handle hCam, int64_t* throughputLimit_Bps);
18317
18345
18365PEAK_API_STATUS peak_Bandwidth_ThroughputFrameRateLimit_Get(peak_camera_handle hCam, double* throughputFrameRateLimit_fps);
18366
18394
18415PEAK_API_STATUS peak_Bandwidth_ThroughputCalculated_Get(peak_camera_handle hCam, int64_t* throughputCalculated_Bps);
18416
18438PEAK_API_ACCESS_STATUS peak_IPO_GetAccessStatus(peak_interface_technology interfaceTech);
18439
18454
18469PEAK_API_STATUS peak_IPO_Enable(peak_interface_technology interfaceTech, peak_bool enabled);
18470
18491PEAK_API_STATUS peak_IPL_DigitalBlack_GetRange(peak_camera_handle hCam, double* minDigitalBlack, double* maxDigitalBlack);
18492
18513PEAK_API_STATUS peak_IPL_DigitalBlack_Set(peak_camera_handle hCam, double digitalBlack);
18514
18534PEAK_API_STATUS peak_IPL_DigitalBlack_Get(peak_camera_handle hCam, double* digitalBlack);
18535
18542typedef enum {
18545
18548
18552
18553
18573
18647
18663PEAK_API_STATUS peak_IPL_LUT_Enable(peak_camera_handle hCam, peak_bool enabled);
18664
18676
18695
18717PEAK_API_STATUS peak_IPL_LUT_Value_Set(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_channel channel, uint32_t index, uint32_t value);
18718
18742PEAK_API_STATUS peak_IPL_LUT_Value_Get(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_channel channel, uint32_t index, uint32_t* value);
18743
18767PEAK_API_STATUS peak_IPL_LUT_ValueList_Set(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_channel channel, uint32_t* values, size_t size);
18768
18802PEAK_API_STATUS peak_IPL_LUT_ValueList_Get(peak_camera_handle hCam, peak_lut_selector selector, peak_lut_channel channel, uint32_t* values, size_t* size);
18803
18804
18805#ifdef __cplusplus
18806} // extern "C"
18807#endif // __cplusplus
18808
18809#endif // PEAK_COMFORT_C_H
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:2758
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST_SINGLE_BUFFER
Oldest First Single Buffer Mode.
Definition ids_peak_comfort_c.h:2804
@ PEAK_BUFFER_HANDLING_MODE_NEWEST_ONLY
Newest Only Mode.
Definition ids_peak_comfort_c.h:2786
@ PEAK_BUFFER_HANDLING_MODE_INVALID
Invalid buffer handling mode.
Definition ids_peak_comfort_c.h:2763
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST_DEPEND_ON_CAMERA_FIFO
Oldest First Depend On Camera FIFO Mode.
Definition ids_peak_comfort_c.h:2818
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST
Oldest First Mode.
Definition ids_peak_comfort_c.h:2777
peak_camera_memory_area
peak Camera Memory Area
Definition ids_peak_comfort_c.h:9933
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:9950
@ PEAK_CAMERA_MEMORY_AREA_INVALID
Invalid memory area.
Definition ids_peak_comfort_c.h:9938
@ PEAK_CAMERA_MEMORY_AREA_USER_DATA_1
Cameras User Data 1 memory.
Definition ids_peak_comfort_c.h:9944
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:4001
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:4024
@ PEAK_PARAMETER_SET_USER_1
User set 1.
Definition ids_peak_comfort_c.h:4031
@ PEAK_PARAMETER_SET_INVALID
Invalid parameter set.
Definition ids_peak_comfort_c.h:4006
@ PEAK_PARAMETER_SET_LINESCAN
Linescan set.
Definition ids_peak_comfort_c.h:4018
@ PEAK_PARAMETER_SET_USER_2
User set 2.
Definition ids_peak_comfort_c.h:4038
@ PEAK_PARAMETER_SET_DEFAULT
Default set.
Definition ids_peak_comfort_c.h:4012
uint64_t peak_camera_id
peak Camera ID
Definition ids_peak_comfort_c.h:1479
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:1464
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:1432
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:1440
@ PEAK_CAMERA_TYPE_UEYE_PLUS_GEV
uEye+ GigE Vision camera
Definition ids_peak_comfort_c.h:1449
@ PEAK_CAMERA_TYPE_UEYE_PLUS_U3V
uEye+ USB3 Vision camera
Definition ids_peak_comfort_c.h:1446
@ PEAK_CAMERA_TYPE_INVALID
Invalid camera type.
Definition ids_peak_comfort_c.h:1437
@ PEAK_CAMERA_TYPE_UEYE_ETH
uEye Eth camera
Definition ids_peak_comfort_c.h:1443
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:7301
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:7312
@ PEAK_COLOR_CORRECTION_MODE_INVALID
Invalid color correction.
Definition ids_peak_comfort_c.h:7306
@ PEAK_COLOR_CORRECTION_MODE_USER_1
User 1.
Definition ids_peak_comfort_c.h:7321
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:2103
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:2128
@ PEAK_ETHERNET_STATUS_INVALID
Invalid ethernet status.
Definition ids_peak_comfort_c.h:2108
@ PEAK_ETHERNET_STATUS_NOK
The cameras ethernet status is not ok.
Definition ids_peak_comfort_c.h:2120
@ PEAK_ETHERNET_STATUS_OK
The cameras ethernet status is ok.
Definition ids_peak_comfort_c.h:2114
@ PEAK_ETHERNET_STATUS_INAPPLICABLE_IP
The camera IP is not applicable.
Definition ids_peak_comfort_c.h:2137
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:15398
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:15374
@ PEAK_FIRMWARE_UPDATE_STATUS_FAILED
The update (step) has failed.
Definition ids_peak_comfort_c.h:15406
@ PEAK_FIRMWARE_UPDATE_STATUS_FINSIHED
The update (step) has successfully finished.
Definition ids_peak_comfort_c.h:15404
@ PEAK_FIRMWARE_UPDATE_STATUS_PROGRESS
The update step has made progress.
Definition ids_peak_comfort_c.h:15402
@ PEAK_FIRMWARE_UPDATE_STATUS_STARTED
The update (step) has been started.
Definition ids_peak_comfort_c.h:15400
@ PEAK_FIRMWARE_UPDATE_STEP_TOTAL
Step representing the whole update process.
Definition ids_peak_comfort_c.h:15376
@ PEAK_FIRMWARE_UPDATE_STEP_WRITEFEATURE
The firmware update is modifying camera properties.
Definition ids_peak_comfort_c.h:15382
@ PEAK_FIRMWARE_UPDATE_STEP_UPLOADFILE
The firmware file is uploaded to the camera.
Definition ids_peak_comfort_c.h:15388
@ PEAK_FIRMWARE_UPDATE_STEP_RESETDEVICE
The firmware update resets the device and waits for it to reconnect.
Definition ids_peak_comfort_c.h:15390
@ PEAK_FIRMWARE_UPDATE_STEP_ASSERTFEATURE
The firmware update is validating the cameras state.
Definition ids_peak_comfort_c.h:15386
@ PEAK_FIRMWARE_UPDATE_STEP_CHECKPRECONDITIONS
The firmware update is checking for compatability with the camera.
Definition ids_peak_comfort_c.h:15378
@ PEAK_FIRMWARE_UPDATE_STEP_EXECUTEFEATURE
The firmware update is running tasks on the camera.
Definition ids_peak_comfort_c.h:15384
@ PEAK_FIRMWARE_UPDATE_STEP_ACQUIREUPDATEDATA
The firmware update is loading the firmware files to be uploaded.
Definition ids_peak_comfort_c.h:15380
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:6196
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:6207
@ PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW
Global start window.
Definition ids_peak_comfort_c.h:6219
@ PEAK_FLASH_REFERENCE_INVALID
Invalid flash reference.
Definition ids_peak_comfort_c.h:6201
@ PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE
Acquisition active.
Definition ids_peak_comfort_c.h:6225
@ PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE
Exposure active.
Definition ids_peak_comfort_c.h:6213
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:3665
peak_status peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t *processingTime_ms)
Query the processing time of a frame.
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:3677
@ PEAK_FRAME_TYPE_INVALID
Invalid frame type.
Definition ids_peak_comfort_c.h:3670
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:2425
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:6995
peak_gain_channel
peak Gain channel
Definition ids_peak_comfort_c.h:7020
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:7006
@ PEAK_GAIN_TYPE_ANALOG
Analog gain is used.
Definition ids_peak_comfort_c.h:7003
@ PEAK_GAIN_TYPE_INVALID
Invalid gain type.
Definition ids_peak_comfort_c.h:7000
@ PEAK_GAIN_TYPE_COMBINED
Combined gain is used.
Definition ids_peak_comfort_c.h:7009
@ PEAK_GAIN_CHANNEL_INVALID
Invalid gain channel.
Definition ids_peak_comfort_c.h:7025
@ PEAK_GAIN_CHANNEL_MASTER
Master channel.
Definition ids_peak_comfort_c.h:7037
@ PEAK_GAIN_CHANNEL_BLUE
Blue channel.
Definition ids_peak_comfort_c.h:7034
@ PEAK_GAIN_CHANNEL_RED
Red channel.
Definition ids_peak_comfort_c.h:7028
@ PEAK_GAIN_CHANNEL_GREEN
Green channel.
Definition ids_peak_comfort_c.h:7031
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:7647
peak_auto_feature_brightness_algorithm
peak Auto feature brightness algorithm
Definition ids_peak_comfort_c.h:7619
peak_auto_feature_mode
peak Auto feature mode
Definition ids_peak_comfort_c.h:7583
@ PEAK_AUTO_FEATURE_ROI_MODE_MANUAL
Auto feature ROI mode Manual.
Definition ids_peak_comfort_c.h:7670
@ PEAK_AUTO_FEATURE_ROI_MODE_INVALID
Invalid auto feature ROI mode.
Definition ids_peak_comfort_c.h:7652
@ PEAK_AUTO_FEATURE_ROI_MODE_FULL_IMAGE
Auto feature ROI mode Full Image.
Definition ids_peak_comfort_c.h:7661
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_INVALID
Invalid auto feature brightness algorithm.
Definition ids_peak_comfort_c.h:7624
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEAN
brightness algorithm mean
Definition ids_peak_comfort_c.h:7636
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEDIAN
default brightness algorithm
Definition ids_peak_comfort_c.h:7630
@ PEAK_AUTO_FEATURE_MODE_CONTINUOUS
Auto feature mode Continuous.
Definition ids_peak_comfort_c.h:7608
@ PEAK_AUTO_FEATURE_MODE_OFF
Auto feature Off.
Definition ids_peak_comfort_c.h:7596
@ PEAK_AUTO_FEATURE_MODE_ONCE
Auto feature mode Once.
Definition ids_peak_comfort_c.h:7602
@ PEAK_AUTO_FEATURE_MODE_INVALID
Invalid auto feature mode.
Definition ids_peak_comfort_c.h:7588
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:10221
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:10229
@ PEAK_GFA_MODULE_INVALID
Invalid GFA module.
Definition ids_peak_comfort_c.h:10226
@ PEAK_GFA_MODULE_REMOTE_DEVICE
The GFA module for the access of the GenICam Remote Device module.
Definition ids_peak_comfort_c.h:10238
@ PEAK_GFA_MODULE_INTERFACE
The GFA module for the access of the GenICam GenTL Interface module.
Definition ids_peak_comfort_c.h:10232
@ PEAK_GFA_MODULE_DATA_STREAM
The GFA module for the access of the GenICam GenTL Data Stream module.
Definition ids_peak_comfort_c.h:10241
@ PEAK_GFA_MODULE_LOCAL_DEVICE
The GFA module for the access of the GenICam GenTL Local Device module.
Definition ids_peak_comfort_c.h:10235
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:14011
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:12930
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:13098
peak_sharpness_algorithm
The peak sharpness measurement algorithm.
Definition ids_peak_comfort_c.h:13185
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:12944
@ PEAK_FOCUS_ROI_WEIGHT_MEDIUM
Focus ROI weight medium.
Definition ids_peak_comfort_c.h:12941
@ PEAK_FOCUS_ROI_WEIGHT_INVALID
Invalid focus ROI weight.
Definition ids_peak_comfort_c.h:12935
@ PEAK_FOCUS_ROI_WEIGHT_WEAK
Focus ROI weight weak.
Definition ids_peak_comfort_c.h:12938
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_GOLDEN_RATIO
Search algorithm Golden Ratio.
Definition ids_peak_comfort_c.h:13109
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_HILL_CLIMBING
Search algorithm Hill Climbing.
Definition ids_peak_comfort_c.h:13116
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_GLOBAL_SEARCH
Search algorithm Full Scan.
Definition ids_peak_comfort_c.h:13128
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_INVALID
Invalid search algorithm type.
Definition ids_peak_comfort_c.h:13103
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_FULL_SCAN
Search algorithm Full Scan.
Definition ids_peak_comfort_c.h:13122
@ PEAK_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE
Sharpness algorithm Histogram Variance.
Definition ids_peak_comfort_c.h:13214
@ PEAK_SHARPNESS_ALGORITHM_TENENGRAD
Sharpness algorithm Tenengrad.
Definition ids_peak_comfort_c.h:13196
@ PEAK_SHARPNESS_ALGORITHM_SOBEL
Sharpness algorithm Sobel.
Definition ids_peak_comfort_c.h:13202
@ PEAK_SHARPNESS_ALGORITHM_INVALID
Invalid sharpness algorithm type.
Definition ids_peak_comfort_c.h:13190
@ PEAK_SHARPNESS_ALGORITHM_MEAN_SCORE
Sharpness algorithm Mean Score.
Definition ids_peak_comfort_c.h:13208
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_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 cost 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:13387
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:13399
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_4
hotpixel correction sensitivity level 4
Definition ids_peak_comfort_c.h:13411
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_INVALID
Invalid hotpixel correction sensitivity level.
Definition ids_peak_comfort_c.h:13392
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_3
hotpixel correction sensitivity level 3
Definition ids_peak_comfort_c.h:13408
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_2
hotpixel correction sensitivity level 2
Definition ids_peak_comfort_c.h:13402
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_5
hotpixel correction sensitivity level 5
Definition ids_peak_comfort_c.h:13417
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:18560
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:18579
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:18542
@ PEAK_LUT_CHANNEL_GREEN
Definition ids_peak_comfort_c.h:18565
@ PEAK_LUT_CHANNEL_BLUE
Definition ids_peak_comfort_c.h:18568
@ PEAK_LUT_CHANNEL_ALL
Definition ids_peak_comfort_c.h:18571
@ PEAK_LUT_CHANNEL_RED
Definition ids_peak_comfort_c.h:18562
@ PEAK_LUT_PRESET_ONLY_RED
Definition ids_peak_comfort_c.h:18617
@ PEAK_LUT_PRESET_INVERSE
Definition ids_peak_comfort_c.h:18590
@ PEAK_LUT_PRESET_JET
Definition ids_peak_comfort_c.h:18597
@ PEAK_LUT_PRESET_DIGITAL_GAIN2
Definition ids_peak_comfort_c.h:18634
@ PEAK_LUT_PRESET_RAINBOW
Definition ids_peak_comfort_c.h:18611
@ PEAK_LUT_PRESET_ONLY_GREEN
Definition ids_peak_comfort_c.h:18623
@ PEAK_LUT_PRESET_BINARIZE
Definition ids_peak_comfort_c.h:18645
@ PEAK_LUT_PRESET_IDENTITY
Definition ids_peak_comfort_c.h:18584
@ PEAK_LUT_PRESET_ONLY_BLUE
Definition ids_peak_comfort_c.h:18629
@ PEAK_LUT_PRESET_DIGITAL_BLACK_25_PERCENT
Definition ids_peak_comfort_c.h:18639
@ PEAK_LUT_PRESET_HOT
Definition ids_peak_comfort_c.h:18604
@ PEAK_LUT_12BIT
Definition ids_peak_comfort_c.h:18550
@ PEAK_LUT_10BIT
Definition ids_peak_comfort_c.h:18547
@ PEAK_LUT_8BIT
Definition ids_peak_comfort_c.h:18544
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_PixelFormat_Get(peak_camera_handle hCam, peak_pixel_format *pixelFormat)
Get the output pixel format of the host processing.
peak_status peak_IPL_PixelFormat_Set(peak_camera_handle hCam, peak_pixel_format pixelFormat)
Set the output pixel format for host processing.
peak_status peak_IPL_PixelFormat_GetList(peak_camera_handle hCam, peak_pixel_format inputPixelFormat, peak_pixel_format *outputPixelFormatList, size_t *outputPixelFormatCount)
Get a list of supported output pixel formats for a specific input pixelformat.
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:17061
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:16607
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:16342
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:16415
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:17078
@ PEAK_I2C_OPERATION_STATUS_ERROR
An error occured while reading or writing.
Definition ids_peak_comfort_c.h:17072
@ PEAK_I2C_OPERATION_STATUS_INVALID
Invalid operation status.
Definition ids_peak_comfort_c.h:17066
@ PEAK_I2C_OPERATION_STATUS_READY
I2C communication is ready or the last write/read was successful.
Definition ids_peak_comfort_c.h:17069
@ 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:17075
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_0BIT
0 bit register length. Register address will not be used
Definition ids_peak_comfort_c.h:16614
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_24BIT
24 bit register length
Definition ids_peak_comfort_c.h:16620
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_INVALID
Invalid register address length.
Definition ids_peak_comfort_c.h:16612
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_16BIT
16 bit register length
Definition ids_peak_comfort_c.h:16618
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_8BIT
8 bit register length
Definition ids_peak_comfort_c.h:16616
@ PEAK_I2C_MODE_INVALID
Invalid i2c mode.
Definition ids_peak_comfort_c.h:16420
@ PEAK_I2C_MODE_STANDARD
I2C fast mode with 100 kHz clock frequency.
Definition ids_peak_comfort_c.h:16422
@ PEAK_I2C_MODE_FAST
I2C fast mode with 400 kHz clock frequency.
Definition ids_peak_comfort_c.h:16424
@ PEAK_I2C_MODE_FAST_PLUS
I2C fast mode with 1000 kHz clock frequency.
Definition ids_peak_comfort_c.h:16426
peak_subsampling_engine
peak subsampling engine
Definition ids_peak_comfort_c.h:9147
@ PEAK_SUBSAMPLING_ENGINE_INVALID
invalid subsampling engine
Definition ids_peak_comfort_c.h:9152
@ PEAK_SUBSAMPLING_ENGINE_FPGA
subsampling engine fpga.
Definition ids_peak_comfort_c.h:9154
@ PEAK_SUBSAMPLING_ENGINE_UEYE
subsampling engine ueye.
Definition ids_peak_comfort_c.h:9158
@ PEAK_SUBSAMPLING_ENGINE_SENSOR
subsampling engine sensor.
Definition ids_peak_comfort_c.h:9156
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:17109
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:17172
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:17191
@ PEAK_IMAGEFILE_FORMAT_PNG
Image file format PNG.
Definition ids_peak_comfort_c.h:17184
@ PEAK_IMAGEFILE_FORMAT_RAW
Image file format RAW.
Definition ids_peak_comfort_c.h:17212
@ PEAK_IMAGEFILE_FORMAT_BMP
Image file format BMP.
Definition ids_peak_comfort_c.h:17205
@ PEAK_IMAGEFILE_FORMAT_INVALID
Invalid image file format.
Definition ids_peak_comfort_c.h:17177
@ PEAK_IMAGEFILE_FORMAT_TIFF
Image file format TIFF.
Definition ids_peak_comfort_c.h:17198
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:14574
struct peak_inference * peak_inference_handle
The handle to identify an inference instance.
Definition ids_peak_comfort_c.h:14541
struct peak_inference_result * peak_inference_result_handle
The handle to identify an inference result.
Definition ids_peak_comfort_c.h:14547
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:14556
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:14582
@ PEAK_INFERENCE_PREPROCESSING_MODE_TENSORFLOW
Tensorflow preprocessing mode.
Definition ids_peak_comfort_c.h:14585
@ PEAK_INFERENCE_PREPROCESSING_MODE_INVALID
Invalid inference preprocessing mode.
Definition ids_peak_comfort_c.h:14579
@ PEAK_INFERENCE_TYPE_CLASSIFICATION
CNN classification model.
Definition ids_peak_comfort_c.h:14567
@ PEAK_INFERENCE_TYPE_DETECTION
CNN detection model.
Definition ids_peak_comfort_c.h:14564
@ PEAK_INFERENCE_TYPE_INVALID
Invalid inference type.
Definition ids_peak_comfort_c.h:14561
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:4698
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:4857
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:5032
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:4793
@ PEAK_IO_CHANNEL_LINE_2
Line 2.
Definition ids_peak_comfort_c.h:4772
@ PEAK_IO_CHANNEL_LINE_1
Line 1.
Definition ids_peak_comfort_c.h:4765
@ PEAK_IO_CHANNEL_INVALID
Invalid io channel.
Definition ids_peak_comfort_c.h:4703
@ PEAK_IO_CHANNEL_LINE_6
Line 6.
Definition ids_peak_comfort_c.h:4800
@ PEAK_IO_CHANNEL_LINE_4
Line 4.
Definition ids_peak_comfort_c.h:4786
@ PEAK_IO_CHANNEL_SOFTWARE
Software.
Definition ids_peak_comfort_c.h:4715
@ PEAK_IO_CHANNEL_LINE_7
Line 7.
Definition ids_peak_comfort_c.h:4807
@ PEAK_IO_CHANNEL_NONE
None.
Definition ids_peak_comfort_c.h:4709
@ PEAK_IO_CHANNEL_LINE_0
Line 0.
Definition ids_peak_comfort_c.h:4758
@ PEAK_IO_CHANNEL_LINE_3
Line 3.
Definition ids_peak_comfort_c.h:4779
@ PEAK_IO_DIRECTION_ANY
Input or Output.
Definition ids_peak_comfort_c.h:4880
@ PEAK_IO_DIRECTION_OUTPUT
Output.
Definition ids_peak_comfort_c.h:4874
@ PEAK_IO_DIRECTION_UNKNOWN
Unknown io direction.
Definition ids_peak_comfort_c.h:4862
@ PEAK_IO_DIRECTION_INPUT
Input.
Definition ids_peak_comfort_c.h:4868
@ PEAK_IO_TYPE_INVALID
Invalid io type.
Definition ids_peak_comfort_c.h:5037
@ PEAK_IO_TYPE_UNKNOWN
Unknown io type.
Definition ids_peak_comfort_c.h:5043
@ PEAK_IO_TYPE_OPTO_COUPLED
Invalid io type.
Definition ids_peak_comfort_c.h:5056
@ PEAK_IO_TYPE_TRI_STATE
Invalid io type.
Definition ids_peak_comfort_c.h:5049
@ PEAK_IO_TYPE_LVTTL
Invalid io type.
Definition ids_peak_comfort_c.h:5062
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:17756
peak_led_mode
peak LED mode
Definition ids_peak_comfort_c.h:17778
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:17766
@ PEAK_LED_TARGET_INVALID
Invalid LED target.
Definition ids_peak_comfort_c.h:17762
@ PEAK_LED_TARGET_NETWORK
The camera network LED target.
Definition ids_peak_comfort_c.h:17764
@ PEAK_LED_MODE_INVALID
Invalid LED mode.
Definition ids_peak_comfort_c.h:17783
@ PEAK_LED_MODE_CAMERA_STATUS
Turns status LED to show camera status.
Definition ids_peak_comfort_c.h:17794
@ PEAK_LED_MODE_BLINK_FAST
Turns LED to fast flashing.
Definition ids_peak_comfort_c.h:17789
@ PEAK_LED_MODE_BLINK_SLOW
Turns LED to slow flashing.
Definition ids_peak_comfort_c.h:17787
@ PEAK_LED_MODE_OFF
Turns off LED.
Definition ids_peak_comfort_c.h:17785
@ PEAK_LED_MODE_NETWORK_STATUS
Turns network LED to show network status.
Definition ids_peak_comfort_c.h:17799
peak_status peak_Library_Init()
Init the peak comfortC library.
peak_status peak_Library_Exit()
Exit the 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:2938
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:2949
@ PEAK_LOSS_HANDLING_MODE_LIMITED
Loss handling mode limited.
Definition ids_peak_comfort_c.h:2957
@ PEAK_LOSS_HANDLING_MODE_INVALID
Invalid loss handling mode.
Definition ids_peak_comfort_c.h:2943
@ PEAK_LOSS_HANDLING_MODE_UNLIMITED
Loss handling mode unlimited.
Definition ids_peak_comfort_c.h:2964
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:15162
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:15173
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE
Remote device message data type.
Definition ids_peak_comfort_c.h:15170
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED
Remote device dropped message data type.
Definition ids_peak_comfort_c.h:15176
@ PEAK_MESSAGE_DATA_TYPE_NO_DATA
No data message data type.
Definition ids_peak_comfort_c.h:15167
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME
Remote device frame message data type.
Definition ids_peak_comfort_c.h:15179
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_LOST
Camera manager device lost message data type.
Definition ids_peak_comfort_c.h:15191
@ PEAK_MESSAGE_DATA_TYPE_FIRMWARE_UPDATE
Firmware update message data type.
Definition ids_peak_comfort_c.h:15200
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE
Remote device temperature message data type.
Definition ids_peak_comfort_c.h:15182
@ PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA
Autofeature auto focus data message data type.
Definition ids_peak_comfort_c.h:15185
@ PEAK_MESSAGE_DATA_TYPE_INVALID
Invalid message data type.
Definition ids_peak_comfort_c.h:15164
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_DISCONNECTED
Camera manager device disconnected message data type.
Definition ids_peak_comfort_c.h:15197
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_RECONNECTED
Camera manager device reconnected message data type.
Definition ids_peak_comfort_c.h:15194
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_FOUND
Camera manager device found message data type.
Definition ids_peak_comfort_c.h:15188
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:15505
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:15498
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 behaviour of the queue
Definition ids_peak_comfort_c.h:14984
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:14992
@ PEAK_QUEUE_MODE_INVALID
Invalid queue mode.
Definition ids_peak_comfort_c.h:14986
@ PEAK_QUEUE_MODE_OLDEST_FIRST
Oldest messages returned first (chronological order)
Definition ids_peak_comfort_c.h:14989
peak_message_type
The peak message types.
Definition ids_peak_comfort_c.h:15004
@ 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:15072
@ 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:15018
@ 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:15139
@ 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:15066
@ 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:15024
@ 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:15118
@ 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:15078
@ 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:15110
@ PEAK_MESSAGE_TYPE_DEVICE_DISCONNECTED
Camera manager device disconnected message type.
Definition ids_peak_comfort_c.h:15102
@ 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:15030
@ 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:15054
@ PEAK_MESSAGE_TYPE_DEVICE_RECONNECTED
Camera manager device reconnected message type.
Definition ids_peak_comfort_c.h:15097
@ 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:15012
@ 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:15042
@ 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:15146
@ 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:15036
@ 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:15048
@ 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:15085
@ 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:15060
@ 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:15092
@ 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:15153
@ 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:15132
@ PEAK_MESSAGE_TYPE_INVALID
Invalid message type.
Definition ids_peak_comfort_c.h:15006
@ 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:15125
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:859
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_status peak_PixelFormat_Get(peak_camera_handle hCam, peak_pixel_format *pixelFormat)
Get the pixel format.
peak_status peak_VideoWriter_Encoder_GetPixelFormatList(peak_video_encoder encoder, peak_pixel_format *pixelFormatList, size_t *pixelFormatCount)
Get the list of currently selectable pixel formats.
peak_status peak_PixelFormat_GetInfo(peak_pixel_format pixelFormat, peak_pixel_format_info *pixelFormatInfo)
Query the pixel format info.
peak_status peak_PixelFormat_GetList(peak_camera_handle hCam, peak_pixel_format *pixelFormatList, size_t *pixelFormatCount)
Get the list of currently selectable pixel formats.
peak_access_status peak_PixelFormat_GetAccessStatus(peak_camera_handle hCam)
Query the pixel format access status.
peak_pixel_format
peak Pixel format
Definition ids_peak_comfort_c.h:3378
peak_status peak_PixelFormat_Set(peak_camera_handle hCam, peak_pixel_format pixelFormat)
Set the pixel format.
@ PEAK_PIXEL_FORMAT_RGBA12
RGBa12.
Definition ids_peak_comfort_c.h:3455
@ PEAK_PIXEL_FORMAT_BAYER_BG12G24_IDS
BayerBG12 grouped 24.
Definition ids_peak_comfort_c.h:3548
@ PEAK_PIXEL_FORMAT_BAYER_BG10G40_IDS
BayerBG grouped 40.
Definition ids_peak_comfort_c.h:3524
@ PEAK_PIXEL_FORMAT_MONO8
Mono8.
Definition ids_peak_comfort_c.h:3422
@ PEAK_PIXEL_FORMAT_BGR8
BGR8.
Definition ids_peak_comfort_c.h:3440
@ PEAK_PIXEL_FORMAT_BAYER_RG12G24_IDS
BayerRG12 grouped 24.
Definition ids_peak_comfort_c.h:3536
@ PEAK_PIXEL_FORMAT_BAYER_GB8
BayerGB8.
Definition ids_peak_comfort_c.h:3404
@ PEAK_PIXEL_FORMAT_BAYER_GR10
BayerGR10.
Definition ids_peak_comfort_c.h:3389
@ PEAK_PIXEL_FORMAT_INVALID
Invalid pixel format.
Definition ids_peak_comfort_c.h:3383
@ PEAK_PIXEL_FORMAT_MONO12P
Mono12 packed.
Definition ids_peak_comfort_c.h:3494
@ PEAK_PIXEL_FORMAT_BGR12
BGR12.
Definition ids_peak_comfort_c.h:3446
@ PEAK_PIXEL_FORMAT_BGRA10
BGRa10.
Definition ids_peak_comfort_c.h:3461
@ PEAK_PIXEL_FORMAT_BAYER_RG10P
BayerRG10 packed.
Definition ids_peak_comfort_c.h:3473
@ PEAK_PIXEL_FORMAT_BAYER_BG10P
BayerBG10 packed.
Definition ids_peak_comfort_c.h:3485
@ PEAK_PIXEL_FORMAT_MONO12G24_IDS
Mono12 grouped 24.
Definition ids_peak_comfort_c.h:3560
@ PEAK_PIXEL_FORMAT_RGBA10
RGBa10.
Definition ids_peak_comfort_c.h:3452
@ PEAK_PIXEL_FORMAT_BAYER_GB10G40_IDS
BayerGB10 grouped 40.
Definition ids_peak_comfort_c.h:3518
@ PEAK_PIXEL_FORMAT_RGB12
RGB12.
Definition ids_peak_comfort_c.h:3437
@ PEAK_PIXEL_FORMAT_BAYER_RG10G40_IDS
BayerRG10 grouped 40.
Definition ids_peak_comfort_c.h:3512
@ PEAK_PIXEL_FORMAT_BAYER_BG12
BayerBG12.
Definition ids_peak_comfort_c.h:3419
@ PEAK_PIXEL_FORMAT_BAYER_GB12P
BayerGB12 packed.
Definition ids_peak_comfort_c.h:3482
@ PEAK_PIXEL_FORMAT_BAYER_GR12
BayerGR12.
Definition ids_peak_comfort_c.h:3392
@ PEAK_PIXEL_FORMAT_MONO10
Mono10.
Definition ids_peak_comfort_c.h:3425
@ PEAK_PIXEL_FORMAT_BAYER_GB10
BayerGB10.
Definition ids_peak_comfort_c.h:3407
@ PEAK_PIXEL_FORMAT_RGBA8
RGBa8.
Definition ids_peak_comfort_c.h:3449
@ PEAK_PIXEL_FORMAT_BAYER_GB10P
BayerGB10 packed.
Definition ids_peak_comfort_c.h:3479
@ PEAK_PIXEL_FORMAT_BGRA12
BGRa12.
Definition ids_peak_comfort_c.h:3464
@ PEAK_PIXEL_FORMAT_BAYER_RG10
BayerRG10.
Definition ids_peak_comfort_c.h:3398
@ PEAK_PIXEL_FORMAT_BAYER_RG8
BayerRG8.
Definition ids_peak_comfort_c.h:3395
@ PEAK_PIXEL_FORMAT_BAYER_BG8
BayerBG8.
Definition ids_peak_comfort_c.h:3413
@ PEAK_PIXEL_FORMAT_MONO10G40_IDS
Mono10 grouped 40.
Definition ids_peak_comfort_c.h:3554
@ PEAK_PIXEL_FORMAT_BAYER_GR10P
BayerGR10 packed.
Definition ids_peak_comfort_c.h:3467
@ PEAK_PIXEL_FORMAT_MONO12
Mono12.
Definition ids_peak_comfort_c.h:3428
@ PEAK_PIXEL_FORMAT_BAYER_GR12G24_IDS
BayerGR12 grouped 24.
Definition ids_peak_comfort_c.h:3530
@ PEAK_PIXEL_FORMAT_RGB10P32
RGB10 packed 32.
Definition ids_peak_comfort_c.h:3497
@ PEAK_PIXEL_FORMAT_BGR10P32
BGR10 packed 32.
Definition ids_peak_comfort_c.h:3500
@ PEAK_PIXEL_FORMAT_BGRA8
BGRa8.
Definition ids_peak_comfort_c.h:3458
@ PEAK_PIXEL_FORMAT_BAYER_GB12
BayerGB12.
Definition ids_peak_comfort_c.h:3410
@ PEAK_PIXEL_FORMAT_BAYER_GR8
BayerGR8.
Definition ids_peak_comfort_c.h:3386
@ PEAK_PIXEL_FORMAT_RGB10
RGB10.
Definition ids_peak_comfort_c.h:3434
@ PEAK_PIXEL_FORMAT_BAYER_GR12P
BayerGR12 packed.
Definition ids_peak_comfort_c.h:3470
@ PEAK_PIXEL_FORMAT_BGR10
BGR10.
Definition ids_peak_comfort_c.h:3443
@ PEAK_PIXEL_FORMAT_BAYER_GB12G24_IDS
BayerGB12 grouped 24.
Definition ids_peak_comfort_c.h:3542
@ PEAK_PIXEL_FORMAT_BAYER_BG12P
BayerBG12 packed.
Definition ids_peak_comfort_c.h:3488
@ PEAK_PIXEL_FORMAT_RGB8
RGB8.
Definition ids_peak_comfort_c.h:3431
@ PEAK_PIXEL_FORMAT_BAYER_BG10
BayerBG10.
Definition ids_peak_comfort_c.h:3416
@ PEAK_PIXEL_FORMAT_BAYER_RG12P
BayerRG12 packed.
Definition ids_peak_comfort_c.h:3476
@ PEAK_PIXEL_FORMAT_BAYER_GR10G40_IDS
BayerGR10 grouped 40.
Definition ids_peak_comfort_c.h:3506
@ PEAK_PIXEL_FORMAT_BAYER_RG12
BayerRG12.
Definition ids_peak_comfort_c.h:3401
@ PEAK_PIXEL_FORMAT_MONO10P
Mono10 packed.
Definition ids_peak_comfort_c.h:3491
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 Status codes
Definition ids_peak_comfort_c.h:1035
peak_access_status
peak Access status codes
Definition ids_peak_comfort_c.h:1174
@ PEAK_STATUS_SUCCESS
Success.
Definition ids_peak_comfort_c.h:1037
@ PEAK_STATUS_BUFFER_TOO_SMALL
The buffer is too small to take the complete data.
Definition ids_peak_comfort_c.h:1098
@ PEAK_STATUS_NOT_INITIALIZED
The library is not initialized.
Definition ids_peak_comfort_c.h:1074
@ PEAK_STATUS_VALUE_ADJUSTED
The set value was auto-adjusted.
Definition ids_peak_comfort_c.h:1047
@ PEAK_STATUS_NOT_IMPLEMENTED
The function is not implemented.
Definition ids_peak_comfort_c.h:1077
@ PEAK_STATUS_ERROR
Unspecified error.
Definition ids_peak_comfort_c.h:1068
@ PEAK_STATUS_OUT_OF_MEMORY
The system could not provide enough memory.
Definition ids_peak_comfort_c.h:1119
@ PEAK_STATUS_BUSY
Device or resource is busy.
Definition ids_peak_comfort_c.h:1116
@ PEAK_STATUS_TIMEOUT
A timeout occurred.
Definition ids_peak_comfort_c.h:1104
@ PEAK_STATUS_WARNING_OPERATION
A operation failed.
Definition ids_peak_comfort_c.h:1061
@ 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:1101
@ PEAK_STATUS_NO_DATA
The specified or requested data is not present.
Definition ids_peak_comfort_c.h:1110
@ PEAK_STATUS_CAMERA_NOT_FOUND
There is no such camera.
Definition ids_peak_comfort_c.h:1083
@ PEAK_STATUS_INVALID_HANDLE
The handle is invalid.
Definition ids_peak_comfort_c.h:1089
@ PEAK_STATUS_IO
Communication with the camera failed.
Definition ids_peak_comfort_c.h:1122
@ PEAK_STATUS_INVALID_PARAMETER
One or more parameters are invalid.
Definition ids_peak_comfort_c.h:1092
@ PEAK_STATUS_WARNING
Unspecified warning.
Definition ids_peak_comfort_c.h:1040
@ PEAK_STATUS_OUT_OF_RANGE
The value or configuration is out of the valid range.
Definition ids_peak_comfort_c.h:1095
@ PEAK_STATUS_WARNING_OVERFLOW
A value was dropped.
Definition ids_peak_comfort_c.h:1054
@ PEAK_STATUS_INVALID_PEAK_INSTALLATION
The peak installation is corrupted.
Definition ids_peak_comfort_c.h:1113
@ PEAK_STATUS_ABORTED
The operation was aborted.
Definition ids_peak_comfort_c.h:1107
@ PEAK_STATUS_ACCESS_DENIED
The access to the requested feature was denied due to the current system status.
Definition ids_peak_comfort_c.h:1080
@ PEAK_STATUS_CAMERA_NOT_AVAILABLE
The specified camera is not available.
Definition ids_peak_comfort_c.h:1086
@ PEAK_ACCESS_GFA_LOCK
No access.
Definition ids_peak_comfort_c.h:1203
@ PEAK_ACCESS_INVALID
Invalid access status code.
Definition ids_peak_comfort_c.h:1182
@ PEAK_ACCESS_WRITEONLY
Write only access.
Definition ids_peak_comfort_c.h:1215
@ PEAK_ACCESS_NOT_SUPPORTED
Not supported.
Definition ids_peak_comfort_c.h:1190
@ PEAK_ACCESS_READONLY
Read only access.
Definition ids_peak_comfort_c.h:1209
@ PEAK_ACCESS_NONE
No access.
Definition ids_peak_comfort_c.h:1196
@ PEAK_ACCESS_READWRITE
Read write access.
Definition ids_peak_comfort_c.h:1221
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:17587
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:17601
@ 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:17621
@ PEAK_TEST_PATTERN_GREYDIAGONALRAMPMOVING
GreyDiagonalRampMoving: Moving diagonal ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:17619
@ PEAK_TEST_PATTERN_FPGAGRAYSCALE
Grayscale generated by FPGA.
Definition ids_peak_comfort_c.h:17611
@ PEAK_TEST_PATTERN_INVALID
Invalid test pattern.
Definition ids_peak_comfort_c.h:17592
@ PEAK_TEST_PATTERN_GREYWEDGEMOVINGSENSOR
GreyWedgeMovingSensor: Moving grey wedges generated by the image sensor.
Definition ids_peak_comfort_c.h:17625
@ PEAK_TEST_PATTERN_FPGACOLORSTRIPE
ColorStripe generated by FPGA.
Definition ids_peak_comfort_c.h:17607
@ PEAK_TEST_PATTERN_FPGAFRAMECOUNT
Framecount generated by FPGA.
Definition ids_peak_comfort_c.h:17609
@ PEAK_TEST_PATTERN_WHITE
White: Image is filled with the brightest possible image.
Definition ids_peak_comfort_c.h:17635
@ PEAK_TEST_PATTERN_FPGAVERTICALGRAYSCALE
VerticalGrayscale generated by FPGA.
Definition ids_peak_comfort_c.h:17613
@ PEAK_TEST_PATTERN_GREYWEDGESENSOR
GreyWedgeSensor: Grey wedges generated by the image sensor.
Definition ids_peak_comfort_c.h:17627
@ PEAK_TEST_PATTERN_GREYVERTICALRAMP
GreyVerticalRamp: Vertical ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:17623
@ PEAK_TEST_PATTERN_CHESSPATTERN
Chessboard pattern.
Definition ids_peak_comfort_c.h:17599
@ PEAK_TEST_PATTERN_FPGACHESSBOARD
Chessboard generated by FPGA.
Definition ids_peak_comfort_c.h:17605
@ PEAK_TEST_PATTERN_OFF
Image is coming from the sensor.
Definition ids_peak_comfort_c.h:17595
@ PEAK_TEST_PATTERN_BLACK
Image is filled with the darkest possible image.
Definition ids_peak_comfort_c.h:17597
@ PEAK_TEST_PATTERN_RAMPINGPATTERN
RampingPattern: Diagonal color pattern.
Definition ids_peak_comfort_c.h:17629
@ PEAK_TEST_PATTERN_FPGAWHITE
White generated by FPGA.
Definition ids_peak_comfort_c.h:17615
@ PEAK_TEST_PATTERN_SEQUENCEPATTERN2
SequencePattern2: SequencePattern2.
Definition ids_peak_comfort_c.h:17633
@ PEAK_TEST_PATTERN_FPGABLACK
Black generated by FPGA.
Definition ids_peak_comfort_c.h:17603
@ PEAK_TEST_PATTERN_SEQUENCEPATTERN1
SequencePattern1: SequencePattern1.
Definition ids_peak_comfort_c.h:17631
@ PEAK_TEST_PATTERN_GREYDIAGONALRAMP
GreyDiagonalRamp: Diagonal ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:17617
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:5732
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:5749
@ PEAK_TRIGGER_EDGE_ANY
Any edge.
Definition ids_peak_comfort_c.h:5755
@ PEAK_TRIGGER_EDGE_INVALID
Invalid trigger edge.
Definition ids_peak_comfort_c.h:5737
@ PEAK_TRIGGER_EDGE_RISING
Rising edge.
Definition ids_peak_comfort_c.h:5743
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:5424
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:5429
@ PEAK_TRIGGER_TARGET_LEVEL_CONTROLLED_EXPOSURE
Level controlled exposure.
Definition ids_peak_comfort_c.h:5441
@ PEAK_TRIGGER_TARGET_FRAME_START
Frame start.
Definition ids_peak_comfort_c.h:5435
struct peak_video * peak_video_handle
peak Video handle
Definition ids_peak_comfort_c.h:14149
peak_video_encoder
peak Encoder types
Definition ids_peak_comfort_c.h:14158
peak_video_encoder_option
peak container options
Definition ids_peak_comfort_c.h:14419
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:14397
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:14177
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:14163
@ PEAK_VIDEO_ENCODER_MJPEG
Motion JPEG.
Definition ids_peak_comfort_c.h:14166
@ PEAK_VIDEO_ENCODER_OPTION_INVALID
Invalid encoder option.
Definition ids_peak_comfort_c.h:14424
@ PEAK_VIDEO_ENCODER_OPTION_QUALITY
Quality encoder option.
Definition ids_peak_comfort_c.h:14430
@ PEAK_VIDEO_CONTAINER_OPTION_FRAMERATE
Frame rate container option.
Definition ids_peak_comfort_c.h:14408
@ PEAK_VIDEO_CONTAINER_OPTION_INVALID
Invalid container option.
Definition ids_peak_comfort_c.h:14402
@ PEAK_VIDEO_CONTAINER_AVI
Audio Video Interleave.
Definition ids_peak_comfort_c.h:14185
@ PEAK_VIDEO_CONTAINER_INVALID
Invalid container.
Definition ids_peak_comfort_c.h:14182
peak_endianness
endianness order
Definition ids_peak_comfort_c.h:16706
@ PEAK_ENDIANNESS_INVALID
Invalid endianness.
Definition ids_peak_comfort_c.h:16711
@ PEAK_ENDIANNESS_BIG_ENDIAN
big-endian (BE)
Definition ids_peak_comfort_c.h:16717
@ PEAK_ENDIANNESS_LITTLE_ENDIAN
little-endian (LE)
Definition ids_peak_comfort_c.h:16723
peak_interface_technology
peak interface technology
Definition ids_peak_comfort_c.h:1278
@ PEAK_INTERFACE_TECHNOLOGY_UEYE
uEye interface technology
Definition ids_peak_comfort_c.h:1292
@ PEAK_INTERFACE_TECHNOLOGY_GEV
GigE vision interface technology.
Definition ids_peak_comfort_c.h:1286
@ PEAK_INTERFACE_TECHNOLOGY_INVALID
Invalid interface technology type.
Definition ids_peak_comfort_c.h:1283
@ PEAK_INTERFACE_TECHNOLOGY_U3V
USB3 vision interface technology.
Definition ids_peak_comfort_c.h:1289
peak Acquisition info
Definition ids_peak_comfort_c.h:2436
double fps
Measured framerate.
Definition ids_peak_comfort_c.h:2467
uint32_t numIncomplete
Number of incomplete frame transmissions.
Definition ids_peak_comfort_c.h:2459
uint32_t numUnderrun
Number of buffer underruns.
Definition ids_peak_comfort_c.h:2443
uint32_t numDropped
Number of dropped frames.
Definition ids_peak_comfort_c.h:2451
peak Buffer descriptor
Definition ids_peak_comfort_c.h:887
size_t memorySize
The size of allocated buffer memory.
Definition ids_peak_comfort_c.h:892
uint8_t * memoryAddress
The memory address at which the buffer starts.
Definition ids_peak_comfort_c.h:889
void * userContext
User context pointer.
Definition ids_peak_comfort_c.h:901
peak Camera descriptor
Definition ids_peak_comfort_c.h:1500
char serialNumber[64]
The cameras serial number.
Definition ids_peak_comfort_c.h:1517
char userDefinedName[64]
The cameras user defined name.
Definition ids_peak_comfort_c.h:1528
peak_interface_technology interfaceTechnology
The interface technology.
Definition ids_peak_comfort_c.h:1531
peak_camera_id cameraID
The camera id.
Definition ids_peak_comfort_c.h:1502
char modelName[64]
The cameras model name.
Definition ids_peak_comfort_c.h:1511
peak_camera_type cameraType
The camera type.
Definition ids_peak_comfort_c.h:1505
peak Double Limit
Definition ids_peak_comfort_c.h:12032
double max
Maximum.
Definition ids_peak_comfort_c.h:12036
double min
Minimum.
Definition ids_peak_comfort_c.h:12034
peak Ethernet info
Definition ids_peak_comfort_c.h:2151
peak_mac_address cameraMAC
The mac address of the camera.
Definition ids_peak_comfort_c.h:2153
peak_mac_address hostMAC
The mac address of the host.
Definition ids_peak_comfort_c.h:2173
peak_ip_config cameraPersistentIP
The current persistent ip address of the camera.
Definition ids_peak_comfort_c.h:2162
peak_bool cameraDHCPEnabled
The current DHCP enabled status of the camera.
Definition ids_peak_comfort_c.h:2159
peak_ethernet_status cameraEthernetStatus
The current ethernet status of the camera.
Definition ids_peak_comfort_c.h:2165
peak_ip_config hostIP
The current subnet mask of the host.
Definition ids_peak_comfort_c.h:2170
peak_ip_config cameraIP
The current ip address of the camera.
Definition ids_peak_comfort_c.h:2156
peak Flash mode
Definition ids_peak_comfort_c.h:6240
peak_flash_reference flashReference
Flash reference.
Definition ids_peak_comfort_c.h:6245
peak_io_channel ioChannel
IO channel.
Definition ids_peak_comfort_c.h:6251
The peak focus ROI (2D) with weight.
Definition ids_peak_comfort_c.h:12955
peak_roi roi
The peak ROI (2D)
Definition ids_peak_comfort_c.h:12957
peak_focus_roi_weight weight
The ROI weight.
Definition ids_peak_comfort_c.h:12960
peak Frame info
Definition ids_peak_comfort_c.h:3689
uint64_t frameID
The frame id.
Definition ids_peak_comfort_c.h:3703
uint32_t processingTime_ms
The host side processing time.
Definition ids_peak_comfort_c.h:3743
peak_bool isComplete
'Complete' flag
Definition ids_peak_comfort_c.h:3721
peak_frame_type type
The type and format of the contents of the frame.
Definition ids_peak_comfort_c.h:3691
peak_pixel_format pixelFormat
The pixel format.
Definition ids_peak_comfort_c.h:3715
size_t bytesWritten
The number of bytes actually written to the buffer.
Definition ids_peak_comfort_c.h:3737
uint64_t timestamp_ns
The timestamp in nanoseconds.
Definition ids_peak_comfort_c.h:3709
peak_roi roi
The ROI of the frame.
Definition ids_peak_comfort_c.h:3712
peak_buffer buffer
The memory buffer that stores the frame contents.
Definition ids_peak_comfort_c.h:3694
size_t bytesExpected
The number of bytes expected for a complete image.
Definition ids_peak_comfort_c.h:3728
peak GFA enumeration entry
Definition ids_peak_comfort_c.h:10847
char symbolicValue[64]
The symbolic value of the enumeration entry as a zero-terminated string.
Definition ids_peak_comfort_c.h:10849
int64_t integerValue
The integer value of the enumeration entry.
Definition ids_peak_comfort_c.h:10852
peak histogram channel info
Definition ids_peak_comfort_c.h:13992
uint64_t pixelSum
The sum of all pixel values of the channel.
Definition ids_peak_comfort_c.h:13994
uint8_t reserved[64]
Reserved for future use.
Definition ids_peak_comfort_c.h:14004
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:14001
uint64_t pixelCount
The count of all pixels for the channel.
Definition ids_peak_comfort_c.h:13997
The peak information struct for CNN details.
Definition ids_peak_comfort_c.h:14673
peak_inference_type inferenceType
Inference type.
Definition ids_peak_comfort_c.h:14690
size_t inputHeight
Input height of the CNN.
Definition ids_peak_comfort_c.h:14696
size_t inputWidth
Input width of the CNN.
Definition ids_peak_comfort_c.h:14693
size_t numberOfClasses
Number of classes of the CNN.
Definition ids_peak_comfort_c.h:14705
char projectName[256]
Project name of the CNN.
Definition ids_peak_comfort_c.h:14684
uint64_t creationTime_s
Creation time (in Seconds) of the CNN.
Definition ids_peak_comfort_c.h:14681
char lighthouseID[256]
Lighthouse ID.
Definition ids_peak_comfort_c.h:14678
peak_version fileVersion
File version of the CNN.
Definition ids_peak_comfort_c.h:14675
peak_inference_preprocessing_mode preprocessingMode
Preprocessing mode used for the CNN.
Definition ids_peak_comfort_c.h:14702
peak_pixel_format inputPixelFormat
Input pixel format.
Definition ids_peak_comfort_c.h:14699
uint8_t reserved[256]
Reserved.
Definition ids_peak_comfort_c.h:14708
char networkName[256]
Network name of the CNN.
Definition ids_peak_comfort_c.h:14687
The inference classification result.
Definition ids_peak_comfort_c.h:14613
peak_inference_type type
inference CNN model
Definition ids_peak_comfort_c.h:14615
float score
Inference score.
Definition ids_peak_comfort_c.h:14618
char label[256]
Label of detected class.
Definition ids_peak_comfort_c.h:14621
The peak inference result.
Definition ids_peak_comfort_c.h:14630
uint32_t inference_time_us
Frame inference time (microseconds)
Definition ids_peak_comfort_c.h:14641
peak_frame_handle frameHandle
Handle to the frame.
Definition ids_peak_comfort_c.h:14635
uint32_t preprocessing_time_us
Frame preprocessing time (microseconds)
Definition ids_peak_comfort_c.h:14638
peak_inference_type type
Type of inference.
Definition ids_peak_comfort_c.h:14632
char reserved[256]
Reserved.
Definition ids_peak_comfort_c.h:14644
The inference detection result.
Definition ids_peak_comfort_c.h:14593
peak_roi rect
ROI of the detected class.
Definition ids_peak_comfort_c.h:14604
peak_inference_type type
inference CNN model
Definition ids_peak_comfort_c.h:14595
float score
Inference score.
Definition ids_peak_comfort_c.h:14598
char label[256]
Label of detected class.
Definition ids_peak_comfort_c.h:14601
peak IP configuration
Definition ids_peak_comfort_c.h:2084
peak_ip_address address
The ip address.
Definition ids_peak_comfort_c.h:2086
peak_ip_address subnetMask
The subnet mask.
Definition ids_peak_comfort_c.h:2089
peak message data for auto focus data messages.
Definition ids_peak_comfort_c.h:15297
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15305
int32_t focusValue
Focus value.
Definition ids_peak_comfort_c.h:15299
int32_t sharpnessValue
Sharpness value for the focus value.
Definition ids_peak_comfort_c.h:15302
peak message data for camera manager device disconnected messages.
Definition ids_peak_comfort_c.h:15361
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15363
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15366
peak message data for camera manager device found messages.
Definition ids_peak_comfort_c.h:15314
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15316
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15319
peak message data for camera manager device lost messages.
Definition ids_peak_comfort_c.h:15329
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15331
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15334
peak message data for camera manager device reconnected messages.
Definition ids_peak_comfort_c.h:15344
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15346
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15351
Message data containing information about the current state of a firmware update.
Definition ids_peak_comfort_c.h:15414
char serialNumber[64]
Serial number of the camera that is currently being updated.
Definition ids_peak_comfort_c.h:15422
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:15437
peak_firmware_update_step step
Firmware update step that the message refers to.
Definition ids_peak_comfort_c.h:15425
char reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15440
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:15433
peak_camera_id cameraId
ID of the camera that the firmware update has been started with.
Definition ids_peak_comfort_c.h:15419
peak_firmware_update_status stepStatus
Status of the referred update step
Definition ids_peak_comfort_c.h:15428
peak message data for remote device dropped messages.
Definition ids_peak_comfort_c.h:15243
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15251
int64_t count
Number of dropped frames.
Definition ids_peak_comfort_c.h:15248
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15245
peak message data for remote device error messages.
Definition ids_peak_comfort_c.h:15225
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15233
int64_t error_type
The error type.
Definition ids_peak_comfort_c.h:15230
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15227
peak message data for remote device frame messages.
Definition ids_peak_comfort_c.h:15261
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15269
int64_t frameId
The Frame ID.
Definition ids_peak_comfort_c.h:15266
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15263
peak message data for remote device temperature messages.
Definition ids_peak_comfort_c.h:15279
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15287
double temperature
The temperature in °C.
Definition ids_peak_comfort_c.h:15284
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15281
peak message data for remote device messages.
Definition ids_peak_comfort_c.h:15210
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15215
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15212
peak message info struct
Definition ids_peak_comfort_c.h:15473
uint64_t messageID
internal message ID
Definition ids_peak_comfort_c.h:15481
peak_camera_handle hCam
camera handle for device events or PEAK_INVALID_HANDLE for system messages
Definition ids_peak_comfort_c.h:15478
peak_message_type type
type of the message
Definition ids_peak_comfort_c.h:15475
uint8_t reserved[256]
Reserved for future use.
Definition ids_peak_comfort_c.h:15490
uint64_t hostMessageTimestamp_ns
message enqueue timestamp in nanoseconds. For further infos see peak_Message_HostTimestamp_Get.
Definition ids_peak_comfort_c.h:15484
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:15487
peak queue info struct
Definition ids_peak_comfort_c.h:15448
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15465
uint64_t numInQueue
Number of messages currently in the message queue.
Definition ids_peak_comfort_c.h:15459
uint64_t numDelivered
Counter of messages delivered by the message queue.
Definition ids_peak_comfort_c.h:15453
uint64_t numDropped
Counter of messages dropped by the message queue.
Definition ids_peak_comfort_c.h:15456
uint64_t numMaxQueueSize
Maximum number of concurrent messages in the message queue.
Definition ids_peak_comfort_c.h:15462
uint64_t numQueued
Counter of messages which were queued in the message queue.
Definition ids_peak_comfort_c.h:15450
peak Pixel format info
Definition ids_peak_comfort_c.h:3572
uint32_t numSignificantBitsPerChannel
Significant bits per channel.
Definition ids_peak_comfort_c.h:3601
uint32_t numBitsPerPixel
Bits per pixel.
Definition ids_peak_comfort_c.h:3577
uint32_t numSignificantBitsPerPixel
Significant bits per pixel.
Definition ids_peak_comfort_c.h:3583
uint32_t numChannels
Number of channels.
Definition ids_peak_comfort_c.h:3589
uint32_t maxValuePerChannel
Maximum value per channel.
Definition ids_peak_comfort_c.h:3607
uint32_t numBitsPerChannel
Bits per channel.
Definition ids_peak_comfort_c.h:3595
peak Position (2D)
Definition ids_peak_comfort_c.h:936
uint32_t y
Y-Position.
Definition ids_peak_comfort_c.h:941
uint32_t x
X-Position.
Definition ids_peak_comfort_c.h:938
peak information whether reconnect is successful, the acquisition is running and the configuration is...
Definition ids_peak_comfort_c.h:1545
peak_bool isReconnectSuccessful
Reconnect successful status True if the reconnected was successful.
Definition ids_peak_comfort_c.h:1549
peak_bool isAcquisitionRunning
device acquisition restarted status True if the acquisition could be restarted
Definition ids_peak_comfort_c.h:1554
peak_bool isConfigurationRestored
device configuration restored status True if the configuration could be restored
Definition ids_peak_comfort_c.h:1559
The peak ROI (2D)
Definition ids_peak_comfort_c.h:952
peak_size size
ROI size.
Definition ids_peak_comfort_c.h:957
peak_position offset
ROI offset.
Definition ids_peak_comfort_c.h:954
peak Size (2D)
Definition ids_peak_comfort_c.h:916
uint32_t width
Width.
Definition ids_peak_comfort_c.h:918
uint32_t height
Height.
Definition ids_peak_comfort_c.h:921
peak Trigger mode
Definition ids_peak_comfort_c.h:5456
peak_io_channel ioChannel
The iO channel.
Definition ids_peak_comfort_c.h:5467
peak_trigger_target triggerTarget
The trigger target.
Definition ids_peak_comfort_c.h:5461
The peak version info.
Definition ids_peak_comfort_c.h:14653
uint32_t subMinor
Subminor version.
Definition ids_peak_comfort_c.h:14661
uint32_t patch
Patch level.
Definition ids_peak_comfort_c.h:14664
uint32_t minor
Minor version.
Definition ids_peak_comfort_c.h:14658
uint32_t major
Major version.
Definition ids_peak_comfort_c.h:14655
video info structure
Definition ids_peak_comfort_c.h:14360
peak IPv4 address
Definition ids_peak_comfort_c.h:2066
uint8_t parts[4]
The IP address in little-endian byte array representation.
Definition ids_peak_comfort_c.h:2071
uint32_t addr
The IP address in little-endian word representation.
Definition ids_peak_comfort_c.h:2068
peak MAC-48 address
Definition ids_peak_comfort_c.h:1785
uint32_t low_part
Lower 4 bytes of the MAC address.
Definition ids_peak_comfort_c.h:1796
uint8_t octets[6]
The octets, i.e. the MAC address in byte array representation.
Definition ids_peak_comfort_c.h:1787
uint16_t high_part
Upper 2 bytes of the MAC address.
Definition ids_peak_comfort_c.h:1793
The peak 3x3 Matrix.
Definition ids_peak_comfort_c.h:979
double element_00
Element 00.
Definition ids_peak_comfort_c.h:984
double element_21
Element 21.
Definition ids_peak_comfort_c.h:1005
double element_12
Element 12.
Definition ids_peak_comfort_c.h:999
double element_20
Element 20.
Definition ids_peak_comfort_c.h:1002
double elementArray[3][3]
The matrix elements in 2-dimensional array format.
Definition ids_peak_comfort_c.h:1013
double element_02
Element 02.
Definition ids_peak_comfort_c.h:990
double element_11
Element 11.
Definition ids_peak_comfort_c.h:996
double element_22
Element 22.
Definition ids_peak_comfort_c.h:1008
double element_01
Element 01.
Definition ids_peak_comfort_c.h:987
double element_10
Element 10.
Definition ids_peak_comfort_c.h:993