IDS peak comfortC v1.16.0
Loading...
Searching...
No Matches
ids_peak_comfort_c.h
Go to the documentation of this file.
1
7
8#ifndef PEAK_COMFORT_C_H
9#define PEAK_COMFORT_C_H
10
11/* Function declaration modifiers */
12#if defined(_WIN32)
13# ifndef PEAK_NO_DECLSPEC_STATEMENTS
14# ifdef PEAK_EXPORTING
15# define PEAK_EXPORT __declspec(dllexport)
16# else
17# define PEAK_EXPORT __declspec(dllimport)
18# endif
19# else
20# define PEAK_EXPORT
21# endif
22# if defined(_M_IX86) || defined(__i386__)
23# define PEAK_CALLCONV __cdecl
24# else
25# define PEAK_CALLCONV
26# endif
27#elif defined(__linux__)
28# define PEAK_EXPORT
29# if defined(__i386__)
30# define PEAK_CALLCONV __attribute__((cdecl))
31# else
32# define PEAK_CALLCONV
33# endif
34#else
35# error Platform is not supported yet!
36#endif
37
38#ifdef __cplusplus
39# include <cstddef>
40# include <cstdint>
41
42extern "C" {
43#else
44# include <stddef.h>
45# include <stdint.h>
46#endif
47
48#if !defined(PEAK_NO_WARN_DEPRECATED)
49# if defined(__cplusplus) && __cplusplus >= 201402L || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)
50# define PEAK_DEPRECATED_ATTR [[ deprecated ]]
51# define PEAK_DEPRECATED_ATTR_MSG(X) [[ deprecated(X) ]]
52# define PEAK_DEPRECATED(X) X PEAK_DEPRECATED_ATTR
53# define PEAK_DEPRECATED_MSG(X, Y) X [[ deprecated(Y) ]]
54# elif defined(__GNUC__)
55# define PEAK_DEPRECATED_ATTR __attribute__(( deprecated ))
56# define PEAK_DEPRECATED_ATTR_MSG(X) __attribute__(( deprecated(X) ))
57# define PEAK_DEPRECATED(X) X PEAK_DEPRECATED_ATTR
58# define PEAK_DEPRECATED_MSG(X, Y) X __attribute__(( deprecated(Y) ))
59# else
60# define PEAK_DEPRECATED_ATTR
61# define PEAK_DEPRECATED_ATTR_MSG(X)
62# define PEAK_DEPRECATED(X) X
63# define PEAK_DEPRECATED_MSG(X, Y) X
64# endif
65# if defined(__cplusplus) && __cplusplus >= 201703L || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L) \
66 || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
67# define PEAK_DEPRECATED_ENUM_ATTR [[deprecated]]
68# define PEAK_DEPRECATED_ENUM_MSG(X, Y) X [[ deprecated(Y) ]]
69# elif defined(__GNUC__)
70# define PEAK_DEPRECATED_ENUM_ATTR __attribute__((deprecated))
71# define PEAK_DEPRECATED_ENUM_MSG(X, Y) X __attribute__(( deprecated(Y) ))
72# else
73# define PEAK_DEPRECATED_ENUM_ATTR
74# define PEAK_DEPRECATED_ENUM_MSG(X, Y) X
75# endif
76#else
77# define PEAK_DEPRECATED_ATTR
78# define PEAK_DEPRECATED_ENUM_ATTR
79# define PEAK_DEPRECATED_ENUM_MSG(X, Y) X
80# define PEAK_DEPRECATED_ATTR_MSG(X)
81# define PEAK_DEPRECATED(X) X
82# define PEAK_DEPRECATED_MSG(X, Y) X
83#endif
84
85/* helper entities */
86struct peak_camera;
87struct peak_frame;
88struct peak_video;
89struct peak_inference;
90struct peak_inference_result;
91struct peak_message_queue;
92struct peak_message;
93struct peak_i2c;
94struct peak_imagewriter;
95struct peak_histogram;
96
97#define PEAK_VERSION_CODE(major,minor,subminor,patch) (((major) << 24) + ((minor) << 16) + ((subminor) << 8) + (patch))
98#define PEAK_API_STATUS PEAK_EXPORT peak_status PEAK_CALLCONV
99#define PEAK_API_STATUS_DEPRECATED(X) PEAK_EXPORT PEAK_DEPRECATED_ATTR_MSG(X) peak_status PEAK_CALLCONV
100#define PEAK_API_ACCESS_STATUS PEAK_EXPORT peak_access_status PEAK_CALLCONV
101#define PEAK_API_BOOL PEAK_EXPORT peak_bool PEAK_CALLCONV
102#define PEAK_API_CAMERA_ID PEAK_EXPORT peak_camera_id PEAK_CALLCONV
103
108
115
122
129
134
141
145
150
155
162
169
176
181
188
195
204
211
218
223
228
233
238
243
250
257
264
271
277
284
291
300
309
317
324
332
340
348
355
362
369
376
381
391
401
411
421
431
441
448
461
475
485
496
503
513
520
527
534
541
548
555
562
569
576
581
591
601
610
620
631
641
660
670
680
690
700
710
720
730
740
750
757
767
776
785
795
806
813
820
827
831
835
841
847
855
865
869
877#define PEAK_INVALID_HANDLE NULL
878
891#define PEAK_INFINITE 0xffffffff
892
900typedef uint8_t peak_bool;
901
909#define PEAK_TRUE 1
910
918#define PEAK_FALSE 0
919
920#pragma pack(push, 1)
927typedef struct
928{
931
934
943
945#pragma pack(pop)
946
947#pragma pack(push, 1)
956typedef struct
957{
959 uint32_t width;
960
962 uint32_t height;
963
964} peak_size;
965#pragma pack(pop)
966
967#pragma pack(push, 1)
976typedef struct
977{
979 uint32_t x;
980
982 uint32_t y;
983
985#pragma pack(pop)
986
987#pragma pack(push, 1)
992typedef struct
993{
996
999
1000} peak_roi;
1001#pragma pack(pop)
1002
1003#pragma pack(push, 1)
1019typedef union
1020{
1022 struct
1023 {
1026
1029
1032
1035
1038
1041
1044
1047
1050
1051 } elements;
1052
1054 double elementArray[3][3];
1055
1056} peak_matrix;
1057#pragma pack(pop)
1058
1065#define PEAK_IDENTITY_MATRIX { 1.0, 0.0, 0.0, \
1066 0.0, 1.0, 0.0, \
1067 0.0, 0.0, 1.0 }
1068
1169
1181#define PEAK_SUCCESS(status) ((((status) & 0xf000) == 0x0000) ? PEAK_TRUE : PEAK_FALSE)
1182
1194#define PEAK_WARNING(status) ((((status) & 0xf000) == 0x4000) ? PEAK_TRUE : PEAK_FALSE)
1195
1207#define PEAK_ERROR(status) ((((status) & 0xf000) == 0x8000) ? PEAK_TRUE : PEAK_FALSE)
1208
1268
1283#define PEAK_IS_WRITEABLE(accessStatus) ((((accessStatus) & 0x2000) == 0x2000) ? PEAK_TRUE : PEAK_FALSE)
1284
1299#define PEAK_IS_READABLE(accessStatus) ((((accessStatus) & 0x1000) == 0x1000) ? PEAK_TRUE : PEAK_FALSE)
1300
1314#define PEAK_IS_SUPPORTED(accessStatus) (((accessStatus) != PEAK_ACCESS_NOT_SUPPORTED) ? PEAK_TRUE : PEAK_FALSE)
1315
1321typedef enum
1322{
1328
1331
1334
1337
1338 PEAK_DEPRECATED_ENUM_MSG(peak_interface_technology_INVALID, "Use PEAK_INTERFACE_TECHNOLOGY_INVALID instead") = 0x0,
1339 PEAK_DEPRECATED_ENUM_MSG(peak_interface_technology_GEV, "Use PEAK_INTERFACE_TECHNOLOGY_GEV instead") = 0x1,
1340 PEAK_DEPRECATED_ENUM_MSG(peak_interface_technology_U3V, "Use PEAK_INTERFACE_TECHNOLOGY_U3V instead") = 0x2,
1341 PEAK_DEPRECATED_ENUM_MSG(peak_interface_technology_UEYE, "Use PEAK_INTERFACE_TECHNOLOGY_UEYE instead") = 0x3,
1343
1344
1361PEAK_API_STATUS peak_Library_Init();
1362
1380PEAK_API_STATUS peak_Library_Exit();
1381
1401PEAK_API_STATUS peak_Library_GetVersion(uint32_t* majorVersion, uint32_t* minorVersion, uint32_t* patchVersion,
1402 uint32_t* legacyVersion);
1403
1446PEAK_API_STATUS peak_Library_GetLastError(peak_status* lastErrorCode, char* lastErrorMessage,
1447 size_t* lastErrorMessageSize);
1448
1468
1496
1508typedef struct peak_camera* peak_camera_handle;
1509
1523typedef uint64_t peak_camera_id;
1524
1531#define PEAK_INVALID_CAMERA_ID UINT64_C(0)
1532
1533#pragma pack(push, 1)
1543typedef struct
1544{
1547
1550
1555 char modelName[64];
1556
1562
1573
1576
1577 uint8_t reserved[444];
1578
1580
1581#pragma pack(pop)
1582
1608
1631PEAK_API_STATUS peak_Reconnect_Enable(peak_interface_technology interfaceTech, peak_bool enabled);
1632
1650
1682PEAK_API_ACCESS_STATUS peak_Reconnect_GetAccessStatus(peak_interface_technology interfaceTech);
1683
1705PEAK_API_STATUS peak_CameraList_Update(size_t* cameraCount);
1706
1740PEAK_API_STATUS peak_CameraList_Get(peak_camera_descriptor* cameraList, size_t* cameraCount);
1741
1764
1787PEAK_API_CAMERA_ID peak_Camera_ID_FromSerialNumber(const char* serialNumber);
1788
1813PEAK_API_CAMERA_ID peak_Camera_ID_FromUserDefinedName(const char* userDefinedName);
1814
1815#pragma pack(push, 1)
1828typedef union
1829{
1831 uint8_t octets[6];
1832
1834 struct
1835 {
1837 uint16_t high_part;
1838
1840 uint32_t low_part;
1841
1842 } parts;
1843
1845#pragma pack(pop)
1846
1868PEAK_API_CAMERA_ID peak_Camera_ID_FromMAC(peak_mac_address macAddress);
1869
1892PEAK_API_ACCESS_STATUS peak_Camera_GetAccessStatus(peak_camera_id cameraID);
1893
1911PEAK_API_STATUS peak_Camera_GetDescriptor(peak_camera_id cameraID, peak_camera_descriptor* cameraDescriptor);
1912
1933PEAK_API_STATUS peak_Camera_Open(peak_camera_id cameraID, peak_camera_handle* hCam);
1934
1955
1974
1992
2023PEAK_API_STATUS peak_Camera_UserDefinedName_Set(peak_camera_handle hCam, const char* userDefinedName);
2024
2058PEAK_API_STATUS peak_Camera_UserDefinedName_Get(peak_camera_handle hCam, char* userDefinedName,
2059 size_t* userDefinedNameSize);
2060
2077
2095
2096#pragma pack(push, 1)
2109typedef union
2110{
2112 uint32_t addr;
2113
2115 uint8_t parts[4];
2116
2118#pragma pack (pop)
2119
2120#pragma pack (push, 1)
2127typedef struct
2128{
2131
2134
2135 uint8_t reserved[4];
2136
2138#pragma pack (pop)
2139
2184
2185#pragma pack (push, 1)
2222#pragma pack (pop)
2223
2257
2277PEAK_API_STATUS peak_EthernetConfig_GetInfo(peak_camera_id cameraID, peak_ethernet_info* ethernetInfo);
2278
2310
2345
2362
2397
2426
2448
2469typedef struct peak_frame* peak_frame_handle;
2470
2478#pragma pack(push, 1)
2479typedef struct
2480{
2487 uint32_t numUnderrun;
2488
2495 uint32_t numDropped;
2496
2504
2511 double fps;
2512
2513 uint8_t reserved[256];
2514
2516#pragma pack(pop)
2517
2563PEAK_API_STATUS peak_Acquisition_Start(peak_camera_handle hCam, uint32_t numberOfFrames);
2564
2590
2609
2646PEAK_API_STATUS peak_Acquisition_WaitForFrame(peak_camera_handle hCam, uint32_t timeout_ms, peak_frame_handle* hFrame);
2647
2668
2687PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredSize(peak_camera_handle hCam, size_t* requiredBufferSize);
2688
2706PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredCount(peak_camera_handle hCam, size_t* requiredBufferCount);
2707
2744PEAK_API_STATUS peak_Acquisition_Buffer_Announce(peak_camera_handle hCam, uint8_t* memoryAddress, size_t memorySize,
2745 void* userContext);
2746
2771PEAK_API_STATUS peak_Acquisition_Buffer_Revoke(peak_camera_handle hCam, uint8_t* memoryAddress);
2772
2795
2864
2892
2928PEAK_API_STATUS peak_Acquisition_BufferHandling_Mode_GetList(peak_camera_handle hCam, peak_buffer_handling_mode* bufferHandlingModeList, size_t* bufferHandlingModesCount);
2929
2953
2975
3011
3039
3075PEAK_API_STATUS peak_Acquisition_LossHandling_Mode_GetList(peak_camera_handle hCam, peak_loss_handling_mode* lossHandlingModeList, size_t* lossHandlingModesCount);
3076
3098
3120
3148
3171PEAK_API_STATUS peak_Acquisition_LossHandling_Extent_GetRange(peak_camera_handle hCam, int64_t* minExtent, int64_t* maxExtent, int64_t* incExtent);
3172
3194
3218
3246
3268PEAK_API_STATUS peak_Acquisition_LossHandling_FrameAbortTimeout_GetRange(peak_camera_handle hCam, int64_t* minTimeout, int64_t* maxTimeout, int64_t* incTimeout);
3269
3291
3313
3341
3367 int64_t* maxTimeout, int64_t* incTimeout);
3368
3392
3414
3421typedef enum
3422{
3428
3431
3434
3437
3440
3443
3446
3449
3452
3455
3458
3461
3464
3467
3470
3473
3476
3479
3482
3485
3488
3491
3494
3497
3500
3503
3506
3509
3512
3515
3518
3521
3524
3527
3530
3533
3536
3539
3542
3545
3548
3554
3560
3566
3572
3578
3584
3590
3596
3602
3608
3610
3611#pragma pack(push, 1)
3618typedef struct
3619{
3625
3631
3636 uint32_t numChannels;
3637
3643
3649
3655
3656 uint8_t reserved[64];
3657
3659#pragma pack(pop)
3660
3679PEAK_API_STATUS peak_PixelFormat_GetInfo(peak_pixel_format pixelFormat, peak_pixel_format_info* pixelFormatInfo);
3680
3704
3711typedef enum
3712{
3718
3725
3727
3734#pragma pack(push, 1)
3735typedef struct
3736{
3739
3742
3750 uint64_t frameID;
3751
3757
3760
3763
3769
3776
3785
3791
3792 uint8_t reserved[256];
3793
3795#pragma pack(pop)
3796
3814PEAK_API_STATUS peak_Frame_GetInfo(peak_frame_handle hFrame, peak_frame_info* frameInfo);
3815
3833PEAK_API_STATUS peak_Frame_Type_Get(peak_frame_handle hFrame, peak_frame_type* frameType);
3834
3852PEAK_API_STATUS peak_Frame_Buffer_Get(peak_frame_handle hFrame, peak_buffer* buffer);
3853
3871PEAK_API_STATUS peak_Frame_ID_Get(peak_frame_handle hFrame, uint64_t* frameID);
3872
3890PEAK_API_STATUS peak_Frame_Timestamp_Get(peak_frame_handle hFrame, uint64_t* timestamp_ns);
3891
3909PEAK_API_STATUS peak_Frame_ROI_Get(peak_frame_handle hFrame, peak_roi* roi);
3910
3929
3947
3965PEAK_API_STATUS peak_Frame_BytesExpected_Get(peak_frame_handle hFrame, size_t* bytesExpected);
3966
3984PEAK_API_STATUS peak_Frame_BytesWritten_Get(peak_frame_handle hFrame, size_t* bytesWritten);
3985
4003PEAK_API_STATUS peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t* processingTime_ms);
4004
4041PEAK_API_STATUS peak_Frame_Save(peak_frame_handle hFrame, const char* fileName);
4042
4057
4114
4145 peak_parameter_set parameterSet);
4146
4188 size_t* parameterSetCount);
4189
4216
4241
4269
4297
4319
4348
4373PEAK_API_STATUS peak_CameraSettings_DiskFile_Store(peak_camera_handle hCam, const char* file);
4374
4399PEAK_API_STATUS peak_CameraSettings_DiskFile_Apply(peak_camera_handle hCam, const char* file);
4400
4428
4453PEAK_API_STATUS peak_FrameRate_GetRange(peak_camera_handle hCam, double* minFrameRate_fps, double* maxFrameRate_fps,
4454 double* incFrameRate_fps);
4455
4476PEAK_API_STATUS peak_FrameRate_Set(peak_camera_handle hCam, double frameRate_fps);
4477
4497PEAK_API_STATUS peak_FrameRate_Get(peak_camera_handle hCam, double* frameRate_fps);
4498
4526
4551PEAK_API_STATUS peak_ExposureTime_GetRange(peak_camera_handle hCam, double* minExposureTime_us,
4552 double* maxExposureTime_us, double* incExposureTime_us);
4553
4574PEAK_API_STATUS peak_ExposureTime_Set(peak_camera_handle hCam, double exposureTime_us);
4575
4595PEAK_API_STATUS peak_ExposureTime_Get(peak_camera_handle hCam, double* exposureTime_us);
4596
4623
4662
4704PEAK_API_STATUS peak_ShutterMode_GetList(peak_camera_handle hCam, peak_shutter_mode* shutterModeList, size_t* shutterModeCount);
4705
4727
4748
4776
4793
4821PEAK_API_STATUS peak_PixelClock_GetRange(peak_camera_handle hCam, double* minPixelClock_MHz, double* maxPixelClock_MHz,
4822 double* incPixelClock_MHz);
4823
4866PEAK_API_STATUS peak_PixelClock_GetList(peak_camera_handle hCam, double* pixelClockList, size_t* pixelClockCount);
4867
4890PEAK_API_STATUS peak_PixelClock_Set(peak_camera_handle hCam, double pixelClock_MHz);
4891
4911PEAK_API_STATUS peak_PixelClock_Get(peak_camera_handle hCam, double* pixelClock_MHz);
4912
4922typedef enum
4923{
4929
4935
4941
4949 PEAK_DEPRECATED_ENUM_MSG(PEAK_IO_CHANNEL_TRIGGER_INPUT, "Use PEAK_IO_CHANNEL_LINE_0 instead") = 0x2101,
4950
4958 PEAK_DEPRECATED_ENUM_MSG(PEAK_IO_CHANNEL_FLASH_OUTPUT, "Use PEAK_IO_CHANNEL_LINE_1 instead") = 0x2201,
4959
4967 PEAK_DEPRECATED_ENUM_MSG(PEAK_IO_CHANNEL_GPIO_1, "Use PEAK_IO_CHANNEL_LINE_2 instead") = 0x6301,
4968
4976 PEAK_DEPRECATED_ENUM_MSG(PEAK_IO_CHANNEL_GPIO_2, "Use PEAK_IO_CHANNEL_LINE_3 instead") = 0x6302,
4977
4984
4991
4998
5005
5012
5019
5026
5033
5035
5067
5108
5147PEAK_API_STATUS_DEPRECATED("Use peak_IOChannel_GetListForDirection instead")
5148 peak_IOChannel_GetList(peak_camera_handle hCam, peak_io_channel* ioChannelList, size_t* ioChannelCount);
5149
5187 peak_io_direction direction, peak_io_channel* ioChannelList, size_t* ioChannelCount);
5188
5220
5243
5290
5321
5344
5375
5393
5415
5447
5469
5487
5520
5542 peak_bool enabled);
5543
5561
5590 double* minNoiseFilterDuration_us, double* maxNoiseFilterDuration_us, double* incNoiseFilterDuration_us);
5591
5616 double noiseFilterDuration_us);
5617
5640 double* noiseFilterDuration_us);
5641
5669
5695
5703#define PEAK_TRIGGER_MODE_HARDWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_TRIGGER_INPUT }
5704
5718#define PEAK_TRIGGER_MODE_SOFTWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_SOFTWARE }
5719
5747
5769PEAK_API_STATUS peak_Trigger_Enable(peak_camera_handle hCam, peak_bool enabled);
5770
5787
5806
5832
5865
5897
5923PEAK_API_STATUS_DEPRECATED("Use peak_Trigger_Mode_Config_Get instead")
5924peak_Trigger_Mode_Get(peak_camera_handle hCam, peak_trigger_mode* triggerMode);
5925
5947
5983
6013
6055 size_t* triggerEdgeCount);
6056
6080
6102
6132
6159PEAK_API_STATUS peak_Trigger_Delay_GetRange(peak_camera_handle hCam, double* minTriggerDelay_us,
6160 double* maxTriggerDelay_us, double* incTriggerDelay_us);
6161
6184PEAK_API_STATUS peak_Trigger_Delay_Set(peak_camera_handle hCam, double triggerDelay_us);
6185
6206PEAK_API_STATUS peak_Trigger_Delay_Get(peak_camera_handle hCam, double* triggerDelay_us);
6207
6237
6264PEAK_API_STATUS peak_Trigger_Divider_GetRange(peak_camera_handle hCam, uint32_t* minTriggerDivider,
6265 uint32_t* maxTriggerDivider, uint32_t* incTriggerDivider);
6266
6288PEAK_API_STATUS peak_Trigger_Divider_Set(peak_camera_handle hCam, uint32_t triggerDivider);
6289
6310PEAK_API_STATUS peak_Trigger_Divider_Get(peak_camera_handle hCam, uint32_t* triggerDivider);
6311
6341
6368PEAK_API_STATUS peak_Trigger_Burst_GetRange(peak_camera_handle hCam, uint32_t* minTriggerBurst,
6369 uint32_t* maxTriggerBurst, uint32_t* incTriggerBurst);
6370
6392PEAK_API_STATUS peak_Trigger_Burst_Set(peak_camera_handle hCam, uint32_t triggerBurst);
6393
6414PEAK_API_STATUS peak_Trigger_Burst_Get(peak_camera_handle hCam, uint32_t* triggerBurst);
6415
6453
6479
6487#define PEAK_FLASH_MODE_EXPOSURE_ACTIVE { PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6488
6496#define PEAK_FLASH_MODE_ACQUISITION_ACTIVE { PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6497
6505#define PEAK_FLASH_MODE_GLOBAL_START_WINDOW { PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW, PEAK_IO_CHANNEL_FLASH_OUTPUT }
6506
6534
6555PEAK_API_STATUS peak_Flash_Enable(peak_camera_handle hCam, peak_bool enabled);
6556
6573
6605
6638
6664PEAK_API_STATUS_DEPRECATED("Use peak_Flash_Mode_Config_Get instead")
6665 peak_Flash_Mode_Get(peak_camera_handle hCam, peak_flash_mode* flashMode);
6666
6688
6718
6745PEAK_API_STATUS peak_Flash_StartDelay_GetRange(peak_camera_handle hCam, double* minFlashStartDelay_us,
6746 double* maxFlashStartDelay_us, double* incFlashStartDelay_us);
6747
6769PEAK_API_STATUS peak_Flash_StartDelay_Set(peak_camera_handle hCam, double flashStartDelay_us);
6770
6791PEAK_API_STATUS peak_Flash_StartDelay_Get(peak_camera_handle hCam, double* flashStartDelay_us);
6792
6822
6849PEAK_API_STATUS peak_Flash_EndDelay_GetRange(peak_camera_handle hCam, double* minFlashEndDelay_us,
6850 double* maxFlashEndDelay_us, double* incFlashEndDelay_us);
6851
6874PEAK_API_STATUS peak_Flash_EndDelay_Set(peak_camera_handle hCam, double flashEndDelay_us);
6875
6896PEAK_API_STATUS peak_Flash_EndDelay_Get(peak_camera_handle hCam, double* flashEndDelay_us);
6897
6927
6954PEAK_API_STATUS peak_Flash_Duration_GetRange(peak_camera_handle hCam, double* minFlashDuration_us,
6955 double* maxFlashDuration_us, double* incFlashDuration_us);
6956
6977PEAK_API_STATUS peak_Flash_Duration_Set(peak_camera_handle hCam, double flashDuration_us);
6978
6999PEAK_API_STATUS peak_Flash_Duration_Get(peak_camera_handle hCam, double* flashDuration_us);
7000
7027
7050PEAK_API_STATUS peak_Focus_GetRange(peak_camera_handle hCam, uint32_t* minFocus, uint32_t* maxFocus,
7051 uint32_t* incFocus);
7052
7076PEAK_API_STATUS peak_Focus_Set(peak_camera_handle hCam, uint32_t focus);
7077
7097PEAK_API_STATUS peak_Focus_Get(peak_camera_handle hCam, uint32_t* focus);
7098
7126
7168 size_t* pixelFormatCount);
7169
7191
7212
7219typedef enum
7220{
7226
7229
7232
7235
7237
7265
7297 peak_gain_channel gainChannel);
7298
7335 peak_gain_channel* gainChannelList, size_t* gainChannelCount);
7336
7366PEAK_API_STATUS peak_Gain_GetRange(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
7367 double* minGain, double* maxGain, double* incGain);
7368
7394PEAK_API_STATUS peak_Gain_Set(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
7395 double gain);
7396
7421PEAK_API_STATUS peak_Gain_Get(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
7422 double* gain);
7423
7450
7473PEAK_API_STATUS peak_Gamma_GetRange(peak_camera_handle hCam, double* minGamma, double* maxGamma, double* incGamma);
7474
7495PEAK_API_STATUS peak_Gamma_Set(peak_camera_handle hCam, double gamma);
7496
7516PEAK_API_STATUS peak_Gamma_Get(peak_camera_handle hCam, double* gamma);
7517
7549
7577
7622 peak_color_correction_mode* colorCorrectionModeList, size_t* colorCorrectionModeCount);
7623
7648
7668
7696
7719PEAK_API_STATUS peak_ColorCorrection_Matrix_GetRange(peak_camera_handle hCam, double* minMatrixElementValue,
7720 double* maxMatrixElementValue, double* incMatrixElementValue);
7721
7742PEAK_API_STATUS peak_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix);
7743
7763PEAK_API_STATUS peak_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix* colorCorrectionMatrix);
7764
7783
7800
7836
7864
7898
7926
7956
7979PEAK_API_STATUS peak_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t* minAutoBrightnessTarget,
7980 uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
7981
7982
7983
8004PEAK_API_STATUS peak_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget);
8005
8025PEAK_API_STATUS peak_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t* autoBrightnessTarget);
8026
8056
8081 uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
8082 uint32_t* incAutoBrightnessTargetTolerance);
8083
8106 uint32_t autoBrightnessTargetTolerance);
8107
8128 uint32_t* autoBrightnessTargetTolerance);
8129
8159
8184 double* minAutoBrightnessTargetPercentile, double* maxAutoBrightnessTargetPercentile,
8185 double* incAutoBrightnessTargetPercentile);
8186
8209 double autoBrightnessTargetPercentile);
8210
8231 double* autoBrightnessTargetPercentile);
8232
8262
8284 peak_auto_feature_roi_mode autoBrightnessROIMode);
8285
8306 peak_auto_feature_roi_mode* autoBrightnessROIMode);
8307
8335 peak_position* minAutoBrightnessROIOffset, peak_position* maxAutoBrightnessROIOffset,
8336 peak_position* incAutoBrightnessROIOffset);
8337
8364PEAK_API_STATUS peak_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minAutoBrightnessROISize,
8365 peak_size* maxAutoBrightnessROISize, peak_size* incAutoBrightnessROISize);
8366
8394PEAK_API_STATUS peak_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI);
8395
8415PEAK_API_STATUS peak_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi* autoBrightnessROI);
8416
8446
8484 peak_auto_feature_mode* modeList, size_t* modeListSize);
8485
8507
8528
8558
8596 peak_auto_feature_mode* modeList, size_t* modeListSize);
8597
8619
8640
8668
8696
8718 peak_auto_feature_roi_mode autoWhiteBalanceROIMode);
8719
8740 peak_auto_feature_roi_mode* autoWhiteBalanceROIMode);
8741
8771 peak_position* minAutoWhiteBalanceROIOffset, peak_position* maxAutoWhiteBalanceROIOffset,
8772 peak_position* incAutoWhiteBalanceROIOffset);
8773
8802PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minAutoWhiteBalanceROISize,
8803 peak_size* maxAutoWhiteBalanceROISize, peak_size* incAutoWhiteBalanceROISize);
8804
8832PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI);
8833
8853PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi* autoWhiteBalanceROI);
8854
8876
8897
8934 peak_auto_feature_mode* modeList, size_t* modeListSize);
8935
8962
8989 peak_position* maxROIOffset, peak_position* incROIOffset);
8990
9017
9039
9060
9086PEAK_API_STATUS peak_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minROISize, peak_size* maxROISize,
9087 peak_size* incROISize);
9088
9115
9137
9158
9180PEAK_API_STATUS peak_ROI_Set(peak_camera_handle hCam, peak_roi roi);
9181
9201PEAK_API_STATUS peak_ROI_Get(peak_camera_handle hCam, peak_roi* roi);
9202
9229
9270PEAK_API_STATUS peak_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t* binningFactorXList,
9271 size_t* binningFactorXCount);
9272
9313PEAK_API_STATUS peak_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t* binningFactorYList,
9314 size_t* binningFactorYCount);
9315
9343PEAK_API_STATUS peak_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY);
9344
9365PEAK_API_STATUS peak_Binning_Get(peak_camera_handle hCam, uint32_t* binningFactorX, uint32_t* binningFactorY);
9366
9385
9410 peak_subsampling_engine subsamplingEngine);
9411
9454 peak_subsampling_engine subsamplingEngine, uint32_t* binningFactorXList, size_t* binningFactorXCount);
9455
9498 peak_subsampling_engine subsamplingEngine, uint32_t* binningFactorYList, size_t* binningFactorYCount);
9499
9526 peak_subsampling_engine subsamplingEngine, uint32_t binningFactorX, uint32_t binningFactorY);
9527
9550 peak_subsampling_engine subsamplingEngine, uint32_t *binningFactorX, uint32_t *binningFactorY);
9551
9579
9622PEAK_API_STATUS peak_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t* decimationFactorXList,
9623 size_t* decimationFactorXCount);
9624
9667PEAK_API_STATUS peak_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t* decimationFactorYList,
9668 size_t* decimationFactorYCount);
9669
9694PEAK_API_STATUS peak_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY);
9695
9716PEAK_API_STATUS peak_Decimation_Get(peak_camera_handle hCam, uint32_t* decimationFactorX, uint32_t* decimationFactorY);
9717
9746 peak_subsampling_engine subsamplingEngine);
9747
9792 peak_subsampling_engine subsamplingEngine, uint32_t* decimationFactorXList, size_t* decimationFactorXCount);
9793
9838 peak_subsampling_engine subsamplingEngine, uint32_t* decimationFactorYList, size_t* decimationFactorYCount);
9839
9866 peak_subsampling_engine subsamplingEngine, uint32_t decimationFactorX, uint32_t decimationFactorY);
9867
9890 peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorX, uint32_t *decimationFactorY);
9891
9919
9942PEAK_API_STATUS peak_Scaling_FactorX_GetRange(peak_camera_handle hCam, double* minScalingFactorX,
9943 double* maxScalingFactorX, double* incScalingFactorX);
9944
9967PEAK_API_STATUS peak_Scaling_FactorY_GetRange(peak_camera_handle hCam, double* minScalingFactorY,
9968 double* maxScalingFactorY, double* incScalingFactorY);
9969
9997PEAK_API_STATUS peak_Scaling_Set(peak_camera_handle hCam, double scalingFactorX, double scalingFactorY);
9998
10019PEAK_API_STATUS peak_Scaling_Get(peak_camera_handle hCam, double* scalingFactorX, double* scalingFactorY);
10020
10048
10068
10085
10113
10133
10150
10178
10209 peak_camera_memory_area cameraMemoryArea);
10210
10253 peak_camera_memory_area* cameraMemoryAreaList, size_t* cameraMemoryAreaCount);
10254
10280 peak_camera_memory_area cameraMemoryArea, size_t* cameraMemoryAreaSize);
10281
10305 peak_camera_memory_area cameraMemoryArea);
10306
10341 peak_camera_memory_area cameraMemoryArea, const uint8_t* data, size_t dataSize);
10342
10375 peak_camera_memory_area cameraMemoryArea, uint8_t* data, size_t dataSize);
10376
10416
10435
10469
10504 const char* featureName);
10505
10523PEAK_API_BOOL peak_GFA_Float_HasRange(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName);
10524
10560PEAK_API_STATUS peak_GFA_Float_GetRange(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
10561 double* minFloatValue, double* maxFloatValue, double* incFloatValue);
10562
10609PEAK_API_STATUS peak_GFA_Float_GetList(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
10610 double* floatList, size_t* floatCount);
10611
10644PEAK_API_STATUS peak_GFA_Float_Set(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
10645 double floatValue);
10646
10673PEAK_API_STATUS peak_GFA_Float_Get(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
10674 double* floatValue);
10675
10694 const char* integerFeatureName);
10695
10732 const char* integerFeatureName, int64_t* minIntegerValue, int64_t* maxIntegerValue, int64_t* incIntegerValue);
10733
10783 const char* integerFeatureName, int64_t* integerList, size_t* integerCount);
10784
10817PEAK_API_STATUS peak_GFA_Integer_Set(peak_camera_handle hCam, peak_gfa_module module, const char* integerFeatureName,
10818 int64_t integerValue);
10819
10846PEAK_API_STATUS peak_GFA_Integer_Get(peak_camera_handle hCam, peak_gfa_module module, const char* integerFeatureName,
10847 int64_t* integerValue);
10848
10880PEAK_API_STATUS peak_GFA_Boolean_Set(peak_camera_handle hCam, peak_gfa_module module, const char* booleanFeatureName,
10881 peak_bool booleanValue);
10882
10909PEAK_API_STATUS peak_GFA_Boolean_Get(peak_camera_handle hCam, peak_gfa_module module, const char* booleanFeatureName,
10910 peak_bool* booleanValue);
10911
10942PEAK_API_STATUS peak_GFA_String_Set(peak_camera_handle hCam, peak_gfa_module module, const char* stringFeatureName,
10943 const char* stringValue);
10944
10991PEAK_API_STATUS peak_GFA_String_Get(peak_camera_handle hCam, peak_gfa_module module, const char* stringFeatureName,
10992 char* stringValue, size_t* stringValueSize);
10993
11023 const char* commandFeatureName);
11024
11060 const char* commandFeatureName, uint32_t timeout_ms);
11061
11071 typedef struct
11072{
11075
11078
11080
11129 const char* enumerationFeatureName, peak_gfa_enumeration_entry* enumerationEntryList,
11130 size_t* enumerationEntryCount);
11131
11169 const char* enumerationFeatureName, const peak_gfa_enumeration_entry* enumerationEntry);
11170
11206 peak_gfa_module module, const char* enumerationFeatureName, const char* enumerationEntrySymbolicValue);
11207
11242 peak_gfa_module module, const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
11243
11280 const char* enumerationFeatureName, const peak_gfa_enumeration_entry* enumerationEntry);
11281
11316 const char* enumerationFeatureName, const char* enumerationEntrySymbolicValue);
11317
11351 const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
11352
11380 const char* enumerationFeatureName, peak_gfa_enumeration_entry* enumerationEntry);
11381
11414PEAK_API_STATUS peak_GFA_Register_Set(peak_camera_handle hCam, peak_gfa_module module, const char* registerFeatureName,
11415 const uint8_t* registerValue, size_t registerValueSize);
11416
11458PEAK_API_STATUS peak_GFA_Register_Get(peak_camera_handle hCam, peak_gfa_module module, const char* registerFeatureName,
11459 uint8_t* registerValue, size_t* registerValueSize);
11460
11492PEAK_API_STATUS peak_GFA_Data_Write(peak_camera_handle hCam, peak_gfa_module module, uint64_t address,
11493 const uint8_t* data, size_t dataSize);
11494
11521PEAK_API_STATUS peak_GFA_Data_Read(peak_camera_handle hCam, peak_gfa_module module, uint64_t address, uint8_t* data,
11522 size_t dataSize);
11523
11563 peak_pixel_format* outputPixelFormatList, size_t* outputPixelFormatCount);
11564
11591
11610
11631PEAK_API_STATUS peak_IPL_Gain_GetRange(peak_camera_handle hCam, peak_gain_channel gainChannel, double* minGain,
11632 double* maxGain, double* incGain);
11633
11655PEAK_API_STATUS peak_IPL_Gain_Set(peak_camera_handle hCam, peak_gain_channel gainChannel, double gain);
11656
11677PEAK_API_STATUS peak_IPL_Gain_Get(peak_camera_handle hCam, peak_gain_channel gainChannel, double* gain);
11678
11698PEAK_API_STATUS peak_IPL_Gamma_GetRange(peak_camera_handle hCam, double* minGamma, double* maxGamma, double* incGamma);
11699
11718PEAK_API_STATUS peak_IPL_Gamma_Set(peak_camera_handle hCam, double gamma);
11719
11737PEAK_API_STATUS peak_IPL_Gamma_Get(peak_camera_handle hCam, double* gamma);
11738
11755PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix);
11756
11774PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix* colorCorrectionMatrix);
11775
11793PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Get(peak_camera_handle hCam, double* saturation);
11794
11813PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Set(peak_camera_handle hCam, double saturation);
11814
11835PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_GetRange(peak_camera_handle hCam, double* minSaturation, double* maxSaturation, double* incSaturation);
11836
11860
11861
11895
11916
11936
11956
11976
11993 peak_camera_handle hCam, uint32_t* colorTemperature);
11994
12015 peak_camera_handle hCam, uint32_t colorTemperature);
12016
12036 peak_camera_handle hCam, uint32_t* minColorTemperature, uint32_t* maxColorTemperature, uint32_t* incColorTemperature);
12037
12053 peak_bool enable);
12054
12069
12087
12104
12125PEAK_API_STATUS peak_IPL_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t* minAutoBrightnessTarget,
12126 uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
12127
12146PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget);
12147
12165PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t* autoBrightnessTarget);
12166
12189 uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
12190 uint32_t* incAutoBrightnessTargetTolerance);
12191
12212 uint32_t autoBrightnessTargetTolerance);
12213
12232 uint32_t* autoBrightnessTargetTolerance);
12233
12256 double* minAutoBrightnessTargetPercentile, double* maxAutoBrightnessTargetPercentile,
12257 double* incAutoBrightnessTargetPercentile);
12258
12279 double autoBrightnessTargetPercentile);
12280
12299 double* autoBrightnessTargetPercentile);
12300
12320 peak_auto_feature_roi_mode autoBrightnessROIMode);
12321
12340 peak_auto_feature_roi_mode* autoBrightnessROIMode);
12341
12366 peak_position* minAutoBrightnessROIOffset, peak_position* maxAutoBrightnessROIOffset,
12367 peak_position* incAutoBrightnessROIOffset);
12368
12393 peak_size* minAutoBrightnessROISize, peak_size* maxAutoBrightnessROISize, peak_size* incAutoBrightnessROISize);
12394
12421PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI);
12422
12440PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi* autoBrightnessROI);
12441
12461 peak_auto_feature_mode autoExposureMode);
12462
12481 peak_auto_feature_mode* autoExposureMode);
12482
12489typedef struct
12490{
12492 double min;
12494 double max;
12495}
12497
12514
12533
12550
12571
12590
12611
12630
12651
12670
12690
12709
12730
12749
12769
12788
12806PEAK_API_STATUS peak_IPL_AutoBrightness_AverageLast_Get(peak_camera_handle hCam, uint32_t* lastAverage);
12807
12831
12848
12868
12892
12909
12928
12952
12969
12988
13012
13029
13048
13072
13089
13108
13123PEAK_API_STATUS peak_IPL_AutoBrightness_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames);
13124
13140PEAK_API_STATUS peak_IPL_AutoBrightness_SkipFrames_Get(peak_camera_handle hCam, uint32_t* skipFrames);
13141
13161 uint32_t* skipFramesMin, uint32_t* skipFramesMax, uint32_t* skipFramesInc);
13162
13182 peak_auto_feature_roi_mode autoWhiteBalanceROIMode);
13183
13202 peak_auto_feature_roi_mode* autoWhiteBalanceROIMode);
13203
13228 peak_position* minAutoWhiteBalanceROIOffset, peak_position* maxAutoWhiteBalanceROIOffset,
13229 peak_position* incAutoWhiteBalanceROIOffset);
13230
13255 peak_size* minAutoWhiteBalanceROISize, peak_size* maxAutoWhiteBalanceROISize,
13256 peak_size* incAutoWhiteBalanceROISize);
13257
13286PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI);
13287
13305PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi* autoWhiteBalanceROI);
13306
13326
13345 peak_auto_feature_mode* autoWhiteBalanceMode);
13346
13347
13362PEAK_API_STATUS peak_IPL_AutoWhiteBalance_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames);
13363
13379PEAK_API_STATUS peak_IPL_AutoWhiteBalance_SkipFrames_Get(peak_camera_handle hCam, uint32_t* skipFrames);
13380
13400 uint32_t* skipFramesMin, uint32_t* skipFramesMax, uint32_t* skipFramesInc);
13401
13424
13425#pragma pack(push, 1)
13426
13431typedef struct
13432{
13435
13438
13440#pragma pack(pop)
13441
13469
13492PEAK_API_STATUS peak_IPL_AutoFocus_ROI_Set(peak_camera_handle hCam, const peak_focus_roi* autoFocusROIList,
13493 size_t autoFocusROICount);
13494
13528PEAK_API_STATUS peak_IPL_AutoFocus_ROI_Get(peak_camera_handle hCam, peak_focus_roi* autoFocusROIList,
13529 size_t* autoFocusROICount);
13530
13550
13569
13608
13633 peak_auto_focus_search_algorithm searchAlgorithm);
13634
13655 peak_auto_focus_search_algorithm* searchAlgorithm);
13656
13694
13719 peak_sharpness_algorithm sharpnessAlgorithm);
13720
13741 peak_sharpness_algorithm* sharpnessAlgorithm);
13742
13764PEAK_API_STATUS peak_IPL_AutoFocus_Range_Set(peak_camera_handle hCam, uint32_t rangeBegin, uint32_t rangeEnd);
13765
13786PEAK_API_STATUS peak_IPL_AutoFocus_Range_Get(peak_camera_handle hCam, uint32_t* rangeBegin, uint32_t* rangeEnd);
13787
13808PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Set(peak_camera_handle hCam, uint8_t hysteresis);
13809
13829PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Get(peak_camera_handle hCam, uint8_t* hysteresis);
13830
13853PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_GetRange(peak_camera_handle hCam, uint8_t* minHysteresis,
13854 uint8_t* maxHysteresis, uint8_t* incHysteresis);
13855
13897
13920 peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity);
13921
13940 peak_hotpixel_correction_sensitivity* hotpixelCorrectionSensitivity);
13941
13979 size_t* hotpixelCount);
13980
14003 size_t hotpixelCount);
14004
14025
14044
14061
14080
14097
14116
14133
14161 peak_frame_handle* hResultFrame);
14162
14193
14213PEAK_API_STATUS peak_IPL_ReadImage(
14214 peak_camera_handle hCam, const char* path, peak_frame_handle* hFrame);
14215
14234
14251
14252
14271PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_Set(peak_camera_handle hCam, uint32_t factor);
14272
14290PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_Get(peak_camera_handle hCam, uint32_t* factor);
14291
14309PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_GetDefault(peak_camera_handle hCam, uint32_t* defaultFactor);
14310
14331 uint32_t* minFactor, uint32_t* maxFactor, uint32_t* incFactor);
14332
14357 peak_sharpness_algorithm sharpnessAlgorithm, double* calculatedValue);
14358
14387PEAK_API_STATUS peak_IPL_Sharpness_GetList(peak_sharpness_algorithm sharpnessAlgorithm, peak_pixel_format* pixelFormatList, size_t* pixelFormatSize);
14388
14389
14394#define PEAK_ROTATION_ANGLE_0 (0)
14395
14400#define PEAK_ROTATION_ANGLE_180 (180)
14401
14406#define PEAK_ROTATION_ANGLE_CLOCKWISE_90 (-90)
14407
14412#define PEAK_ROTATION_ANGLE_CLOCKWISE_270 (-270)
14413
14418#define PEAK_ROTATION_ANGLE_COUNTERCLOCKWISE_90 (90)
14419
14424#define PEAK_ROTATION_ANGLE_COUNTERCLOCKWISE_270 (270)
14425
14444PEAK_API_STATUS peak_IPL_Rotation_Angle_Set(peak_camera_handle hCam, int32_t rotationAngle);
14445
14463PEAK_API_STATUS peak_IPL_Rotation_Angle_Get(peak_camera_handle hCam, int32_t* rotationAngle);
14464
14471typedef struct
14472{
14474 uint64_t pixelSum;
14475
14477 uint64_t pixelCount;
14478
14481 size_t binSize;
14482
14484 uint8_t reserved[64];
14486
14491typedef struct peak_histogram* peak_histogram_handle;
14492
14516 peak_histogram_handle* hHistogram);
14517
14535
14556PEAK_API_STATUS peak_IPL_Histogram_Channel_GetCount(peak_histogram_handle hHistogram, size_t* numChannels);
14557
14579PEAK_API_STATUS peak_IPL_Histogram_Channel_GetInfo(peak_histogram_handle hHistogram, size_t channel, peak_histogram_channel_info* channelInfo);
14580
14617PEAK_API_STATUS peak_IPL_Histogram_Channel_GetBinArray(peak_histogram_handle hHistogram, size_t channel, uint64_t* binArray, size_t* binArraySize);
14618
14630typedef struct peak_video* peak_video_handle;
14631
14638typedef enum
14639{
14645
14648
14650
14657typedef enum
14658{
14664
14667
14669
14687PEAK_API_STATUS peak_VideoWriter_Open(peak_video_handle* hVideo, const char* fileName,
14688 peak_video_container container, peak_video_encoder encoder);
14689
14706
14725
14757 peak_video_encoder* encoderList, size_t* encoderCount);
14758
14799 peak_pixel_format* pixelFormatList, size_t* pixelFormatCount);
14800
14832 peak_video_container* containerList, size_t* containerCount);
14833
14841typedef struct
14842{
14843 /* \brief Overall encoded frames */
14844 uint64_t encodedFrames;
14845
14846 /* \brief Overall dropped frames */
14847 uint64_t droppedFrames;
14848
14849 /* \brief Current file size in bytes */
14850 uint64_t fileSize;
14851
14852 uint8_t reserved[256];
14854
14871
14893
14915
14935 peak_video_container_option containerOption, const void* value, size_t count);
14936
14957 peak_video_container_option containerOption, void* value, size_t count, size_t* outCount);
14958
14978 peak_video_encoder_option encoderOption, const void* value, size_t count);
14979
15000 peak_video_encoder_option encoderOption, void* value, size_t count, size_t* outCount);
15001
15017PEAK_API_STATUS peak_VideoWriter_WaitUntilQueueEmpty(peak_video_handle hVideo, int32_t timeout_ms);
15018
15023typedef struct peak_inference* peak_inference_handle;
15024
15029typedef struct peak_inference_result* peak_inference_result_handle;
15030
15051
15069
15074typedef struct
15075{
15078
15080 float score;
15081
15083 char label[256];
15084
15087
15089
15094typedef struct
15095{
15098
15100 float score;
15101
15103 char label[256];
15104
15106
15111typedef struct
15112{
15115
15118
15121
15124
15126 char reserved[256];
15127
15129
15134typedef struct
15135{
15137 uint32_t major;
15138
15140 uint32_t minor;
15141
15143 PEAK_DEPRECATED_MSG(uint32_t subMinor, "Deprecated due to SemVer 2.0 migration.");
15144
15146 uint32_t patch;
15147} peak_version;
15148
15149
15154typedef struct
15155{
15158
15160 char lighthouseID[256];
15161
15164
15166 char projectName[256];
15167
15169 char networkName[256];
15170
15173
15176
15179
15182
15185
15188
15190 uint8_t reserved[256];
15192
15208PEAK_API_STATUS peak_Inference_CNN_Open(const char* path, peak_inference_handle* hInference);
15209
15224
15245 peak_inference_result_handle* hInferenceHandle);
15246
15263
15281
15298
15329 peak_inference_result_classification* resultList, size_t* resultCount);
15330
15361 peak_inference_result_detection* resultList, size_t* resultCount);
15362
15363typedef struct
15364{
15366 uint32_t numInferencesSuccessful;
15367
15369 uint32_t numInferencesFailed;
15370
15372 char reserved[256];
15373} peak_inference_statistics;
15374
15390PEAK_API_STATUS peak_Inference_Statistics_Get(peak_inference_handle hInference, peak_inference_statistics* statistics);
15391
15406
15422PEAK_API_STATUS peak_Inference_ConfidenceThreshold_Get(peak_inference_handle hInference, uint32_t* threshold);
15423
15441PEAK_API_STATUS peak_Inference_ConfidenceThreshold_GetRange(peak_inference_handle hInference, uint32_t* minThreshold,
15442 uint32_t* maxThreshold, uint32_t* incThreshold);
15443
15459PEAK_API_STATUS peak_Inference_ConfidenceThreshold_Set(peak_inference_handle hInference, uint32_t threshold);
15460
15478
15486typedef enum
15487{
15490
15496
15502
15508
15514
15520
15526
15532
15538
15544
15550
15556
15562
15569
15576
15581
15586
15594
15602
15609
15616
15623
15630
15638
15685
15692typedef struct
15693{
15696
15698 uint8_t reserved[32];
15700
15707typedef struct
15708{
15711
15713 int64_t error_type;
15714
15716 uint8_t reserved[32];
15718
15725typedef struct
15726{
15729
15731 int64_t count;
15732
15734 uint8_t reserved[32];
15736
15743typedef struct
15744{
15747
15749 int64_t frameId;
15750
15752 uint8_t reserved[32];
15754
15761typedef struct
15762{
15765
15768
15770 uint8_t reserved[32];
15772
15779typedef struct
15780{
15782 int32_t focusValue;
15783
15786
15788 uint8_t reserved[32];
15790
15804
15819
15826typedef struct
15827{
15830
15831 peak_reconnect_information reconnectInformation;
15832
15834 uint8_t reserved[32];
15836
15851
15875
15891
15925
15930typedef struct
15931{
15933 uint64_t numQueued;
15934
15937
15939 uint64_t numDropped;
15940
15942 uint64_t numInQueue;
15943
15946
15948 uint8_t reserved[32];
15950
15955typedef struct
15956{
15959
15962
15964 uint64_t messageID;
15965
15968
15971
15973 uint8_t reserved[256];
15975
15981typedef struct peak_message_queue* peak_message_queue_handle;
15982
15988typedef struct peak_message* peak_message_handle;
15989
16004
16021
16047 peak_camera_handle hCam, peak_message_type messageType);
16073 peak_camera_handle hCam, peak_message_type messageType);
16074
16101 peak_camera_handle hCam, const peak_message_type* messageTypesArray, size_t messageTypesArraySize);
16102
16129 peak_camera_handle hCam, const peak_message_type* messageTypesArray, size_t messageTypesArraySize);
16130
16165 peak_message_type* messageTypesArray, size_t* messageTypesArraySize);
16166
16190 peak_message_queue_mode queueMode);
16191
16211 peak_message_queue_mode* queueMode);
16212
16230
16251
16266
16298 uint32_t timeout_ms, peak_message_handle* hMessage);
16299
16317
16338 peak_camera_handle hCam, peak_message_type messageType);
16339
16358 peak_message_queue_statistics_info* messageQueueInfo);
16359
16376
16402 size_t messageQueueMaxSize);
16403
16422 size_t* messageQueueMaxSize);
16423
16440
16459 peak_message_info* messageInfo);
16460
16479 peak_message_type* messageType);
16480
16500 peak_camera_handle* hCam);
16501
16519PEAK_API_STATUS peak_Message_ID_Get(peak_message_handle hMessage, uint64_t* messageID);
16520
16540 uint64_t* hostTimestamp_ns);
16541
16575 peak_message_data_type* messageType);
16576
16605
16627
16649
16671
16693
16715
16737
16759
16779
16799
16819
16825typedef struct peak_i2c* peak_i2c_handle;
16826
16843
16860PEAK_API_STATUS peak_I2C_Destroy(peak_i2c_handle hI2C);
16861
16889PEAK_API_ACCESS_STATUS peak_I2C_GetAccessStatus(peak_i2c_handle hI2C);
16890
16911
16953PEAK_API_STATUS peak_I2C_Mode_GetList(peak_i2c_handle hI2C, peak_i2c_mode* modeList, size_t* modeListSize);
16954
16979
17002
17032PEAK_API_STATUS peak_I2C_DeviceAddress_GetRange(peak_i2c_handle hI2C, uint32_t* minAddress, uint32_t* maxAddress);
17033
17058PEAK_API_STATUS peak_I2C_DeviceAddress_Set(peak_i2c_handle hI2C, uint32_t address);
17059
17081PEAK_API_STATUS peak_I2C_DeviceAddress_Get(peak_i2c_handle hI2C, uint32_t* address);
17082
17105
17137 peak_i2c_register_address_length* i2cLengthList, size_t* i2cLengthCount);
17138
17159
17182
17208
17231
17254
17282PEAK_API_STATUS peak_I2C_RegisterAddress_Set(peak_i2c_handle hI2C, uint32_t address);
17283
17305PEAK_API_STATUS peak_I2C_RegisterAddress_Get(peak_i2c_handle hI2C, uint32_t* address);
17306
17333
17350
17379
17406PEAK_API_STATUS peak_I2C_AckPolling_Timeout_GetRange(peak_i2c_handle hI2C, uint32_t* minTimeout_ms, uint32_t* maxTimeout_ms, uint32_t* incTimeout_ms);
17407
17430PEAK_API_STATUS peak_I2C_AckPolling_Timeout_Set(peak_i2c_handle hI2C, uint32_t timeout_ms);
17431
17453PEAK_API_STATUS peak_I2C_AckPolling_Timeout_Get(peak_i2c_handle hI2C, uint32_t* timeout_ms);
17454
17488PEAK_API_STATUS peak_I2C_Data_Write(peak_i2c_handle hI2C, const uint8_t* data, size_t dataSize);
17489
17512PEAK_API_STATUS peak_I2C_Data_Read(peak_i2c_handle hI2C, size_t maxDataSize, uint8_t* data, size_t* dataSize);
17513
17535PEAK_API_STATUS peak_I2C_Data_MaxSize_Get(peak_i2c_handle hI2C, size_t* maxDataSize);
17536
17563
17585
17586
17592typedef struct peak_imagewriter* peak_imagewriter_handle;
17593
17608
17626
17647PEAK_API_STATUS peak_IPL_ImageWriter_Save(peak_imagewriter_handle hImageWriter, peak_frame_handle hFrame, const char* fileName);
17648
17656typedef enum
17657{
17663
17670
17677
17684
17691
17698
17699} peak_imagefile_format, PEAK_DEPRECATED_MSG(papientitiy_imagefile_format, "use peak_imagefile_format");
17700
17719
17738
17756PEAK_API_STATUS peak_IPL_ImageWriter_Compression_Set(peak_imagewriter_handle hImageWriter, uint32_t compression);
17757
17775PEAK_API_STATUS peak_IPL_ImageWriter_Compression_Get(peak_imagewriter_handle hImageWriter, uint32_t* compression);
17776
17808PEAK_API_STATUS peak_IPL_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t* binningFactorXList,
17809 size_t* binningFactorXCount);
17810
17842PEAK_API_STATUS peak_IPL_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t* binningFactorYList,
17843 size_t* binningFactorYCount);
17844
17870PEAK_API_STATUS peak_IPL_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY);
17871
17890PEAK_API_STATUS peak_IPL_Binning_Get(peak_camera_handle hCam, uint32_t* binningFactorX, uint32_t* binningFactorY);
17891
17925PEAK_API_STATUS peak_IPL_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t* decimationFactorXList,
17926 size_t* decimationFactorXCount);
17927
17961PEAK_API_STATUS peak_IPL_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t* decimationFactorYList,
17962 size_t* decimationFactorYCount);
17963
17986PEAK_API_STATUS peak_IPL_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY);
17987
18006PEAK_API_STATUS peak_IPL_Decimation_Get(peak_camera_handle hCam, uint32_t* decimationFactorX, uint32_t* decimationFactorY);
18007
18036PEAK_API_STATUS peak_FirmwareUpdate_CompatibleCameraList_Get(const char* gufFileName, peak_camera_descriptor* cameraList, size_t* cameraCount);
18037
18064PEAK_API_STATUS peak_FirmwareUpdate_Execute(peak_camera_id cameraID, const char* gufFileName);
18065
18122
18150
18174
18196
18233 size_t* testPatternCount);
18234
18253
18286
18314
18350PEAK_API_STATUS peak_LED_Target_GetList(peak_camera_handle hCam, peak_led_target* targetList, size_t* targetCount);
18351
18388PEAK_API_STATUS peak_LED_Mode_GetList(peak_camera_handle hCam, peak_led_target target, peak_led_mode* modeList, size_t* ledModeCount);
18389
18416
18439
18467
18491
18508
18536
18560PEAK_API_STATUS peak_BlackLevel_Offset_Set(peak_camera_handle hCam, double offset);
18561
18582PEAK_API_STATUS peak_BlackLevel_Offset_Get(peak_camera_handle hCam, double* offset);
18583
18607PEAK_API_STATUS peak_BlackLevel_Offset_GetRange(peak_camera_handle hCam, double* min, double* max, double* inc);
18608
18636
18641#define PEAK_LINKSPEED_ETH_10M 1250000
18642
18647#define PEAK_LINKSPEED_ETH_100M 12500000
18648
18653#define PEAK_LINKSPEED_USB2_HIGH_SPEED 60000000
18654
18659#define PEAK_LINKSPEED_ETH_1G 125000000
18660
18665#define PEAK_LINKSPEED_ETH_5G 625000000
18666
18671#define PEAK_LINKSPEED_ETH_10G 1250000000
18672
18677#define PEAK_LINKSPEED_USB3_SUPER_SPEED 500000000
18678
18701PEAK_API_STATUS peak_Bandwidth_LinkSpeed_Get(peak_camera_handle hCam, int64_t* linkSpeed_Bps);
18702
18730
18755PEAK_API_STATUS peak_Bandwidth_ThroughputLimit_GetRange(peak_camera_handle hCam, int64_t* minThroughputLimit_Bps,
18756 int64_t* maxThroughputLimit_Bps, int64_t* incThroughputLimit_Bps);
18757
18780PEAK_API_STATUS peak_Bandwidth_ThroughputLimit_Set(peak_camera_handle hCam, int64_t throughputLimit_Bps);
18781
18801PEAK_API_STATUS peak_Bandwidth_ThroughputLimit_Get(peak_camera_handle hCam, int64_t* throughputLimit_Bps);
18802
18830
18850PEAK_API_STATUS peak_Bandwidth_ThroughputFrameRateLimit_Get(peak_camera_handle hCam, double* throughputFrameRateLimit_fps);
18851
18879
18900PEAK_API_STATUS peak_Bandwidth_ThroughputCalculated_Get(peak_camera_handle hCam, int64_t* throughputCalculated_Bps);
18901
18923PEAK_API_ACCESS_STATUS peak_IPO_GetAccessStatus(peak_interface_technology interfaceTech);
18924
18939
18954PEAK_API_STATUS peak_IPO_Enable(peak_interface_technology interfaceTech, peak_bool enabled);
18955
18976PEAK_API_STATUS peak_IPL_DigitalBlack_GetRange(peak_camera_handle hCam, double* minDigitalBlack, double* maxDigitalBlack);
18977
18998PEAK_API_STATUS peak_IPL_DigitalBlack_Set(peak_camera_handle hCam, double digitalBlack);
18999
19019PEAK_API_STATUS peak_IPL_DigitalBlack_Get(peak_camera_handle hCam, double* digitalBlack);
19020
19027typedef enum {
19030
19033
19037
19038
19058
19133
19149PEAK_API_STATUS peak_IPL_LUT_Enable(peak_camera_handle hCam, peak_bool enabled);
19150
19162
19181
19203PEAK_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);
19204
19228PEAK_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);
19229
19253PEAK_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);
19254
19288PEAK_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);
19289
19334
19357
19377PEAK_API_STATUS peak_Chunks_Enable(peak_camera_handle hCam, peak_bool enabled);
19378
19391
19412
19428
19452
19479
19500
19514
19548PEAK_API_STATUS peak_Chunks_Type_Supported_GetList(peak_camera_handle hCam, peak_chunks_type* chunksTypesSupported, size_t* chunksTypesSize);
19549
19555typedef struct {
19558
19561
19563 uint8_t reserved[64];
19565
19571typedef struct {
19574
19576 uint8_t reserved[64];
19578
19585typedef struct {
19588
19591
19594
19597
19600
19602 uint8_t reserved[64];
19604
19610typedef struct {
19613
19615 uint8_t reserved[64];
19617
19623typedef struct {
19625 int64_t timestamp;
19626
19628 uint8_t reserved[64];
19630
19636typedef struct {
19638 int64_t timestamp;
19639
19641 uint8_t reserved[64];
19643
19649typedef struct {
19652
19654 uint8_t reserved[64];
19656
19662typedef struct {
19665
19667 uint8_t reserved[64];
19669
19692
19705
19721
19759
19765typedef struct {
19768
19770 uint8_t reserved[64];
19772
19794
19816
19841
19865
19887
19909
19933
19955
19980
20002
20003#ifdef __cplusplus
20004} // extern "C"
20005#endif // __cplusplus
20006
20007#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:2802
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST_SINGLE_BUFFER
Oldest First Single Buffer Mode.
Definition ids_peak_comfort_c.h:2848
@ PEAK_BUFFER_HANDLING_MODE_NEWEST_ONLY
Newest Only Mode.
Definition ids_peak_comfort_c.h:2830
@ PEAK_BUFFER_HANDLING_MODE_INVALID
Invalid buffer handling mode.
Definition ids_peak_comfort_c.h:2807
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST_DEPEND_ON_CAMERA_FIFO
Oldest First Depend On Camera FIFO Mode.
Definition ids_peak_comfort_c.h:2862
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST
Oldest First Mode.
Definition ids_peak_comfort_c.h:2821
peak_camera_memory_area
peak Camera Memory Area
Definition ids_peak_comfort_c.h:10158
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:10175
@ PEAK_CAMERA_MEMORY_AREA_INVALID
Invalid memory area.
Definition ids_peak_comfort_c.h:10163
@ PEAK_CAMERA_MEMORY_AREA_USER_DATA_1
Cameras User Data 1 memory.
Definition ids_peak_comfort_c.h:10169
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:4074
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:4097
@ PEAK_PARAMETER_SET_USER_1
User set 1.
Definition ids_peak_comfort_c.h:4104
@ PEAK_PARAMETER_SET_INVALID
Invalid parameter set.
Definition ids_peak_comfort_c.h:4079
@ PEAK_PARAMETER_SET_LINESCAN
Linescan set.
Definition ids_peak_comfort_c.h:4091
@ PEAK_PARAMETER_SET_USER_2
User set 2.
Definition ids_peak_comfort_c.h:4111
@ PEAK_PARAMETER_SET_DEFAULT
Default set.
Definition ids_peak_comfort_c.h:4085
uint64_t peak_camera_id
peak Camera ID
Definition ids_peak_comfort_c.h:1523
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:1508
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:1476
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:1484
@ PEAK_CAMERA_TYPE_UEYE_PLUS_GEV
uEye+ GigE Vision camera
Definition ids_peak_comfort_c.h:1493
@ PEAK_CAMERA_TYPE_UEYE_PLUS_U3V
uEye+ USB3 Vision camera
Definition ids_peak_comfort_c.h:1490
@ PEAK_CAMERA_TYPE_INVALID
Invalid camera type.
Definition ids_peak_comfort_c.h:1481
@ PEAK_CAMERA_TYPE_UEYE_ETH
uEye Eth camera
Definition ids_peak_comfort_c.h:1487
peak_bool peak_Chunks_Type_IsEnabled(peak_camera_handle hCam, peak_chunks_type type)
Indicates whether a specific chunk type is enabled or disabled.
peak_access_status peak_Chunks_Type_GetAccessStatus(peak_camera_handle hCam, peak_chunks_type type)
Query the chunk type's access status.
peak_ptp_status
Enumeration representing the status of PTP (Precision Time Protocol).
Definition ids_peak_comfort_c.h:19728
peak_status peak_Chunks_Exposure_Get(peak_camera_handle hCam, peak_chunks_exposure *data)
Retrieves the exposure information from chunk data.
peak_status peak_Chunks_Enable(peak_camera_handle hCam, peak_bool enabled)
Control whether the chunk transmission is enabled or disabled.
peak_status peak_Chunks_PTPStatus_Get(peak_camera_handle hCam, peak_chunks_ptp_status *data)
Retrieves the Precision Time Protocol (PTP) status information from chunk data.
peak_status peak_Chunks_Timestamp_Get(peak_camera_handle hCam, peak_chunks_timestamp *data)
Retrieves the timestamp information from chunk data.
peak_status peak_Chunks_ExposureTrigger_Get(peak_camera_handle hCam, peak_chunks_exposure_trigger *data)
Retrieves the exposure trigger timestamp information from chunk data.
peak_status peak_Chunks_Type_Supported_GetList(peak_camera_handle hCam, peak_chunks_type *chunksTypesSupported, size_t *chunksTypesSize)
Get the list of supported chunk types.
peak_status peak_Chunks_Type_Enable(peak_camera_handle hCam, peak_chunks_type type, peak_bool enabled)
Control whether a specific chunk type is enabled or disabled.
peak_access_status peak_Chunks_GetAccessStatus(peak_camera_handle hCam)
Query the chunks access status.
peak_status peak_Chunks_Update(peak_camera_handle hCam, peak_frame_handle hFrame)
Update the chunk data from the frame.
peak_status peak_Chunks_Sequencer_Get(peak_camera_handle hCam, peak_chunks_sequencer *data)
Retrieves the sequencer information from chunk data.
peak_status peak_Chunks_AutoUpdate_Enable(peak_camera_handle hCam, peak_bool enabled)
Control whether the chunks auto update is enabled or disabled.
peak_bool peak_Chunks_AutoUpdate_IsEnabled(peak_camera_handle hCam)
Indicates whether the chunks auto update is enabled or disabled.
peak_chunks_type
Enumeration for chunk types.
Definition ids_peak_comfort_c.h:19297
peak_bool peak_Chunks_IsEnabled(peak_camera_handle hCam)
Indicates whether chunks are enabled or disabled.
peak_auto_feature_status
Enumeration representing the status of an auto feature.
Definition ids_peak_comfort_c.h:19676
peak_status peak_Chunks_Gain_Get(peak_camera_handle hCam, peak_chunks_gain *data)
Retrieves the gain information from chunk data, including analog master gain and digital gains for re...
peak_status peak_Chunks_LineStatus_Get(peak_camera_handle hCam, peak_chunks_line_status *data)
Retrieves the status information of all lines from chunk data.
peak_status peak_Chunks_AutoFeature_Get(peak_camera_handle hCam, peak_chunks_autofeature *data)
Retrieves the auto-feature information from chunk data.
peak_status peak_Chunks_FrameInfo_Get(peak_camera_handle hCam, peak_chunks_frame_info *data)
Retrieves the frame information from chunk data, including pixel format and region of interest (ROI).
peak_status peak_Chunks_UsableROI_Get(peak_camera_handle hCam, peak_chunks_usable_roi *data)
Retrieves the usable region of interest (ROI) information from chunk data.
@ PEAK_PTP_STATUS_LISTENING
Definition ids_peak_comfort_c.h:19742
@ PEAK_PTP_STATUS_INITIALIZING
Definition ids_peak_comfort_c.h:19733
@ PEAK_PTP_STATUS_FAULTY
Definition ids_peak_comfort_c.h:19736
@ PEAK_PTP_STATUS_UNCALIBRATED
Definition ids_peak_comfort_c.h:19754
@ PEAK_PTP_STATUS_SLAVE
Definition ids_peak_comfort_c.h:19757
@ PEAK_PTP_STATUS_PASSIVE
Definition ids_peak_comfort_c.h:19751
@ PEAK_PTP_STATUS_DISABLED
Definition ids_peak_comfort_c.h:19739
@ PEAK_PTP_STATUS_INVALID
Definition ids_peak_comfort_c.h:19730
@ PEAK_PTP_STATUS_PRE_MASTER
Definition ids_peak_comfort_c.h:19745
@ PEAK_PTP_STATUS_MASTER
Definition ids_peak_comfort_c.h:19748
@ PEAK_CHUNKS_TYPE_FRAME_INFO
Definition ids_peak_comfort_c.h:19305
@ PEAK_CHUNKS_TYPE_PTP_STATUS
Definition ids_peak_comfort_c.h:19332
@ PEAK_CHUNKS_TYPE_INVALID
Invalid chunk type.
Definition ids_peak_comfort_c.h:19302
@ PEAK_CHUNKS_TYPE_LINE_STATUS
Definition ids_peak_comfort_c.h:19326
@ PEAK_CHUNKS_TYPE_GAIN
Definition ids_peak_comfort_c.h:19311
@ PEAK_CHUNKS_TYPE_USABLE_ROI
Definition ids_peak_comfort_c.h:19323
@ PEAK_CHUNKS_TYPE_TIMESTAMP
Definition ids_peak_comfort_c.h:19317
@ PEAK_CHUNKS_TYPE_AUTO_FEATURE_STATUS
Definition ids_peak_comfort_c.h:19329
@ PEAK_CHUNKS_TYPE_EXPOSURE
Definition ids_peak_comfort_c.h:19308
@ PEAK_CHUNKS_TYPE_EXPOSURE_TRIGGER
Definition ids_peak_comfort_c.h:19320
@ PEAK_CHUNKS_TYPE_SEQUENCER
Definition ids_peak_comfort_c.h:19314
@ PEAK_AUTO_FEATURE_STATUS_INVALID
Definition ids_peak_comfort_c.h:19678
@ PEAK_AUTO_FEATURE_STATUS_DONE
Definition ids_peak_comfort_c.h:19684
@ PEAK_AUTO_FEATURE_STATUS_OFF
Definition ids_peak_comfort_c.h:19681
@ PEAK_AUTO_FEATURE_STATUS_STUCK
Definition ids_peak_comfort_c.h:19690
@ PEAK_AUTO_FEATURE_STATUS_ACTIVE
Definition ids_peak_comfort_c.h:19687
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:7526
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:7537
@ PEAK_COLOR_CORRECTION_MODE_INVALID
Invalid color correction.
Definition ids_peak_comfort_c.h:7531
@ PEAK_COLOR_CORRECTION_MODE_USER_1
User 1.
Definition ids_peak_comfort_c.h:7546
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:2147
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:2172
@ PEAK_ETHERNET_STATUS_INVALID
Invalid ethernet status.
Definition ids_peak_comfort_c.h:2152
@ PEAK_ETHERNET_STATUS_NOK
The cameras ethernet status is not ok.
Definition ids_peak_comfort_c.h:2164
@ PEAK_ETHERNET_STATUS_OK
The cameras ethernet status is ok.
Definition ids_peak_comfort_c.h:2158
@ PEAK_ETHERNET_STATUS_INAPPLICABLE_IP
The camera IP is not applicable.
Definition ids_peak_comfort_c.h:2181
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:15881
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:15857
@ PEAK_FIRMWARE_UPDATE_STATUS_FAILED
The update (step) has failed.
Definition ids_peak_comfort_c.h:15889
@ PEAK_FIRMWARE_UPDATE_STATUS_FINSIHED
The update (step) has successfully finished.
Definition ids_peak_comfort_c.h:15887
@ PEAK_FIRMWARE_UPDATE_STATUS_PROGRESS
The update step has made progress.
Definition ids_peak_comfort_c.h:15885
@ PEAK_FIRMWARE_UPDATE_STATUS_STARTED
The update (step) has been started.
Definition ids_peak_comfort_c.h:15883
@ PEAK_FIRMWARE_UPDATE_STEP_TOTAL
Step representing the whole update process.
Definition ids_peak_comfort_c.h:15859
@ PEAK_FIRMWARE_UPDATE_STEP_WRITEFEATURE
The firmware update is modifying camera properties.
Definition ids_peak_comfort_c.h:15865
@ PEAK_FIRMWARE_UPDATE_STEP_UPLOADFILE
The firmware file is uploaded to the camera.
Definition ids_peak_comfort_c.h:15871
@ PEAK_FIRMWARE_UPDATE_STEP_RESETDEVICE
The firmware update resets the device and waits for it to reconnect.
Definition ids_peak_comfort_c.h:15873
@ PEAK_FIRMWARE_UPDATE_STEP_ASSERTFEATURE
The firmware update is validating the cameras state.
Definition ids_peak_comfort_c.h:15869
@ PEAK_FIRMWARE_UPDATE_STEP_CHECKPRECONDITIONS
The firmware update is checking for compatability with the camera.
Definition ids_peak_comfort_c.h:15861
@ PEAK_FIRMWARE_UPDATE_STEP_EXECUTEFEATURE
The firmware update is running tasks on the camera.
Definition ids_peak_comfort_c.h:15867
@ PEAK_FIRMWARE_UPDATE_STEP_ACQUIREUPDATEDATA
The firmware update is loading the firmware files to be uploaded.
Definition ids_peak_comfort_c.h:15863
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:6421
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:6432
@ PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW
Global start window.
Definition ids_peak_comfort_c.h:6444
@ PEAK_FLASH_REFERENCE_INVALID
Invalid flash reference.
Definition ids_peak_comfort_c.h:6426
@ PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE
Acquisition active.
Definition ids_peak_comfort_c.h:6450
@ PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE
Exposure active.
Definition ids_peak_comfort_c.h:6438
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:3712
peak_status peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t *processingTime_ms)
Query the processing time of a frame.
peak_bool peak_Frame_HasChunks(peak_frame_handle hFrame)
Check whether the frame has chunk data.
peak_status peak_Frame_Type_Get(peak_frame_handle hFrame, peak_frame_type *frameType)
Query the type of a frame.
peak_bool peak_Frame_IsComplete(peak_frame_handle hFrame)
Check whether the frame is complete.
peak_status peak_Frame_GetInfo(peak_frame_handle hFrame, peak_frame_info *frameInfo)
Query the frame info.
peak_status peak_Frame_Buffer_Get(peak_frame_handle hFrame, peak_buffer *buffer)
Query the buffer of a frame.
peak_status peak_Frame_PixelFormat_Get(peak_frame_handle hFrame, peak_pixel_format *pixelFormat)
Query the pixel format of a frame.
peak_status peak_Frame_BytesExpected_Get(peak_frame_handle hFrame, size_t *bytesExpected)
Query the bytes expected for a complete image.
@ PEAK_FRAME_TYPE_IMAGE
Image data.
Definition ids_peak_comfort_c.h:3724
@ PEAK_FRAME_TYPE_INVALID
Invalid frame type.
Definition ids_peak_comfort_c.h:3717
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:2469
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:7220
peak_gain_channel
peak Gain channel
Definition ids_peak_comfort_c.h:7245
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:7231
@ PEAK_GAIN_TYPE_ANALOG
Analog gain is used.
Definition ids_peak_comfort_c.h:7228
@ PEAK_GAIN_TYPE_INVALID
Invalid gain type.
Definition ids_peak_comfort_c.h:7225
@ PEAK_GAIN_TYPE_COMBINED
Combined gain is used.
Definition ids_peak_comfort_c.h:7234
@ PEAK_GAIN_CHANNEL_INVALID
Invalid gain channel.
Definition ids_peak_comfort_c.h:7250
@ PEAK_GAIN_CHANNEL_MASTER
Master channel.
Definition ids_peak_comfort_c.h:7262
@ PEAK_GAIN_CHANNEL_BLUE
Blue channel.
Definition ids_peak_comfort_c.h:7259
@ PEAK_GAIN_CHANNEL_RED
Red channel.
Definition ids_peak_comfort_c.h:7253
@ PEAK_GAIN_CHANNEL_GREEN
Green channel.
Definition ids_peak_comfort_c.h:7256
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:7872
peak_auto_feature_brightness_algorithm
peak Auto feature brightness algorithm
Definition ids_peak_comfort_c.h:7844
peak_auto_feature_mode
peak Auto feature mode
Definition ids_peak_comfort_c.h:7808
@ PEAK_AUTO_FEATURE_ROI_MODE_MANUAL
Auto feature ROI mode Manual.
Definition ids_peak_comfort_c.h:7895
@ PEAK_AUTO_FEATURE_ROI_MODE_INVALID
Invalid auto feature ROI mode.
Definition ids_peak_comfort_c.h:7877
@ PEAK_AUTO_FEATURE_ROI_MODE_FULL_IMAGE
Auto feature ROI mode Full Image.
Definition ids_peak_comfort_c.h:7886
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_INVALID
Invalid auto feature brightness algorithm.
Definition ids_peak_comfort_c.h:7849
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEAN
brightness algorithm mean
Definition ids_peak_comfort_c.h:7861
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEDIAN
default brightness algorithm
Definition ids_peak_comfort_c.h:7855
@ PEAK_AUTO_FEATURE_MODE_CONTINUOUS
Auto feature mode Continuous.
Definition ids_peak_comfort_c.h:7833
@ PEAK_AUTO_FEATURE_MODE_OFF
Auto feature Off.
Definition ids_peak_comfort_c.h:7821
@ PEAK_AUTO_FEATURE_MODE_ONCE
Auto feature mode Once.
Definition ids_peak_comfort_c.h:7827
@ PEAK_AUTO_FEATURE_MODE_INVALID
Invalid auto feature mode.
Definition ids_peak_comfort_c.h:7813
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:10446
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:10454
@ PEAK_GFA_MODULE_INVALID
Invalid GFA module.
Definition ids_peak_comfort_c.h:10451
@ PEAK_GFA_MODULE_REMOTE_DEVICE
The GFA module for the access of the GenICam Remote Device module.
Definition ids_peak_comfort_c.h:10463
@ PEAK_GFA_MODULE_INTERFACE
The GFA module for the access of the GenICam GenTL Interface module.
Definition ids_peak_comfort_c.h:10457
@ PEAK_GFA_MODULE_DATA_STREAM
The GFA module for the access of the GenICam GenTL Data Stream module.
Definition ids_peak_comfort_c.h:10466
@ PEAK_GFA_MODULE_LOCAL_DEVICE
The GFA module for the access of the GenICam GenTL Local Device module.
Definition ids_peak_comfort_c.h:10460
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:14491
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_GetRange(peak_camera_handle hCam, peak_double_limit *exposureLimit)
Get the host auto exposure limit range.
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:13407
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:13575
peak_sharpness_algorithm
The peak sharpness measurement algorithm.
Definition ids_peak_comfort_c.h:13662
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:13421
@ PEAK_FOCUS_ROI_WEIGHT_MEDIUM
Focus ROI weight medium.
Definition ids_peak_comfort_c.h:13418
@ PEAK_FOCUS_ROI_WEIGHT_INVALID
Invalid focus ROI weight.
Definition ids_peak_comfort_c.h:13412
@ PEAK_FOCUS_ROI_WEIGHT_WEAK
Focus ROI weight weak.
Definition ids_peak_comfort_c.h:13415
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_GOLDEN_RATIO
Search algorithm Golden Ratio.
Definition ids_peak_comfort_c.h:13586
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_HILL_CLIMBING
Search algorithm Hill Climbing.
Definition ids_peak_comfort_c.h:13593
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_GLOBAL_SEARCH
Search algorithm Full Scan.
Definition ids_peak_comfort_c.h:13605
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_INVALID
Invalid search algorithm type.
Definition ids_peak_comfort_c.h:13580
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_FULL_SCAN
Search algorithm Full Scan.
Definition ids_peak_comfort_c.h:13599
@ PEAK_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE
Sharpness algorithm Histogram Variance.
Definition ids_peak_comfort_c.h:13691
@ PEAK_SHARPNESS_ALGORITHM_TENENGRAD
Sharpness algorithm Tenengrad.
Definition ids_peak_comfort_c.h:13673
@ PEAK_SHARPNESS_ALGORITHM_SOBEL
Sharpness algorithm Sobel.
Definition ids_peak_comfort_c.h:13679
@ PEAK_SHARPNESS_ALGORITHM_INVALID
Invalid sharpness algorithm type.
Definition ids_peak_comfort_c.h:13667
@ PEAK_SHARPNESS_ALGORITHM_MEAN_SCORE
Sharpness algorithm Mean Score.
Definition ids_peak_comfort_c.h:13685
peak_status peak_IPL_AutoBrightness_GainAnalog_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainAnalogLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain analog limit.
peak_status peak_IPL_AutoBrightness_GainAnalog_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainAnalogLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain analog limit.
peak_status peak_IPL_AutoBrightness_GainAnalogLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain analog limit range.
peak_status peak_IPL_AutoBrightness_GainLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain limit.
peak_status peak_IPL_AutoBrightness_GainLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain limit range.
peak_status peak_IPL_AutoBrightness_GainLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain limit.
peak_status peak_IPL_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainCombinedLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host gain combined limit.
peak_status peak_IPL_AutoBrightness_GainCombined_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host combined gain control mode.
peak_status peak_IPL_AutoBrightness_GainCombined_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the combined gain control mode.
peak_status peak_IPL_AutoBrightness_GainCombinedLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain combined limit.
peak_status peak_IPL_AutoBrightness_GainCombinedLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain combined limit range.
peak_status peak_IPL_AutoBrightness_GainDigitalLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain digital limit.
peak_status peak_IPL_AutoBrightness_GainDigitalLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain digital limit.
peak_status peak_IPL_AutoBrightness_GainDigital_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainDigitalLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain digital limit range.
peak_status peak_IPL_AutoBrightness_GainDigital_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
peak_status peak_IPL_AutoBrightness_GainHost_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host gain control mode.
peak_status peak_IPL_AutoBrightness_GainHostLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the auto host gain limit range.
peak_status peak_IPL_AutoBrightness_GainHost_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host gain control mode.
peak_status peak_IPL_AutoBrightness_GainHostLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain limit.
peak_status peak_IPL_AutoBrightness_GainHostLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the auto host gain limit.
peak_status peak_IPL_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
Get the host auto white balance ROI.
peak_status peak_IPL_AutoWhiteBalance_SkipFrames_GetRange(peak_camera_handle hCam, uint32_t *skipFramesMin, uint32_t *skipFramesMax, uint32_t *skipFramesInc)
Get the skip frames range for the auto white balance controller.
peak_status peak_IPL_AutoWhiteBalance_SkipFrames_Get(peak_camera_handle hCam, uint32_t *skipFrames)
Get the skip frames for the auto white balance controller.
peak_status peak_IPL_AutoWhiteBalance_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames)
Set the skip frames for the auto white balance controller.
peak_status peak_IPL_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoWhiteBalanceROISize, peak_size *maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
Get the current range of valid host auto white balance ROI sizes.
peak_status peak_IPL_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
Get the host auto white balance control mode.
peak_status peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoWhiteBalanceROIOffset, peak_position *maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
Get the current range of valid host auto white balance ROI offsets.
peak_status peak_IPL_AutoWhiteBalance_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
Get the host auto white balance ROI mode.
peak_status peak_IPL_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
Set the host auto white balance ROI.
peak_status peak_IPL_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
Set the host auto white balance control mode.
peak_status peak_IPL_AutoWhiteBalance_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
Set the host auto white balance ROI mode.
peak_status peak_IPL_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t *binningFactorYList, size_t *binningFactorYCount)
Get the list of currently selectable factors for the host binning in y direction.
peak_status peak_IPL_Binning_Get(peak_camera_handle hCam, uint32_t *binningFactorX, uint32_t *binningFactorY)
Get the host binning factors.
peak_status peak_IPL_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
Set the host binning factors.
peak_status peak_IPL_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t *binningFactorXList, size_t *binningFactorXCount)
Get the list of currently selectable factors for the host binning in x direction.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorTemperature_GetRange(peak_camera_handle hCam, uint32_t *minColorTemperature, uint32_t *maxColorTemperature, uint32_t *incColorTemperature)
Returns the allowed temperature range for the current combination of color space and algorithm.
peak_bool peak_IPL_ColorCorrection_ChromaticAdaption_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the chromatic adaption.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorTemperature_Set(peak_camera_handle hCam, uint32_t colorTemperature)
Set the used color temperature used for chromatic adaption.
peak_chromatic_adaption_algorithm
Enumeration that defines the available chromatic adaption algorithms.
Definition ids_peak_comfort_c.h:11847
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorTemperature_Get(peak_camera_handle hCam, uint32_t *colorTemperature)
Get the current color temperature.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_Algorithm_Set(peak_camera_handle hCam, peak_chromatic_adaption_algorithm algorithm)
Set the algorithm used for chromatic adaption.
peak_chromatic_adaption_color_space
Enumeration that defines the available color spaces.
Definition ids_peak_comfort_c.h:11873
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorSpace_Get(peak_camera_handle hCam, peak_chromatic_adaption_color_space *colorSpace)
Get the target color space.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_Algorithm_Get(peak_camera_handle hCam, peak_chromatic_adaption_algorithm *algorithm)
Get the current algorithm used for chromatic adaption.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_Enable(peak_camera_handle hCam, peak_bool enable)
Enable/Disable the host chromatic adaption.
peak_status peak_IPL_ColorCorrection_ChromaticAdaption_ColorSpace_Set(peak_camera_handle hCam, peak_chromatic_adaption_color_space colorSpace)
Set the target color space.
@ PEAK_CHROMATIC_ADAPTION_ALGORITHM_INVALID
Invalid chromatic adaption algorithm.
Definition ids_peak_comfort_c.h:11852
@ PEAK_CHROMATIC_ADAPTION_ALGORITHM_LEGACY
Definition ids_peak_comfort_c.h:11855
@ PEAK_CHROMATIC_ADAPTION_ALGORITHM_BRADFORD
Definition ids_peak_comfort_c.h:11858
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_ECI_RGB_D50
ECI-RGB: standard illuminant D50 (5000 K), gamma 1.8.
Definition ids_peak_comfort_c.h:11890
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_SRGB_D50
sRGB (standard RGB): standard illuminant D50 (5000 K), gamma 2.2.
Definition ids_peak_comfort_c.h:11881
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_ADOBE_RGB_D65
Adobe RGB: standard illuminant D65 (6500 K), gamma 2.2.
Definition ids_peak_comfort_c.h:11893
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_CIE_RGB_E
CIE-RGB: standard illuminant E (equal energy distribution), gamma 2.2.
Definition ids_peak_comfort_c.h:11887
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_SRGB_D65
sRGB (standard RGB): standard illuminant D65 (6500 K), gamma 2.2.
Definition ids_peak_comfort_c.h:11884
@ PEAK_CHROMATIC_ADAPTION_COLOR_SPACE_INVALID
Invalid color space.
Definition ids_peak_comfort_c.h:11878
peak_bool peak_IPL_ColorCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the host color correction.
peak_status peak_IPL_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
Get the host color correction matrix.
peak_status peak_IPL_ColorCorrection_Saturation_Get(peak_camera_handle hCam, double *saturation)
Get the saturation value.
peak_status peak_IPL_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
Sets the host color correction matrix.
peak_status peak_IPL_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the host color correction.
peak_status peak_IPL_ColorCorrection_Saturation_GetRange(peak_camera_handle hCam, double *minSaturation, double *maxSaturation, double *incSaturation)
Get the current range of valid saturation values.
peak_status peak_IPL_ColorCorrection_Saturation_Set(peak_camera_handle hCam, double saturation)
Sets the saturation value.
peak_status peak_IPL_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t *decimationFactorXList, size_t *decimationFactorXCount)
Get the list of currently selectable factors for the host decimation in x direction.
peak_status peak_IPL_Decimation_Get(peak_camera_handle hCam, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
Get the decimation factors.
peak_status peak_IPL_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY)
Set the host decimation factors.
peak_status peak_IPL_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t *decimationFactorYList, size_t *decimationFactorYCount)
Get the list of currently selectable factors for the host decimation in y direction.
peak_status peak_IPL_DigitalBlack_Set(peak_camera_handle hCam, double digitalBlack)
Set the host digital black value.
peak_status peak_IPL_DigitalBlack_Get(peak_camera_handle hCam, double *digitalBlack)
Get the host digital black value.
peak_status peak_IPL_DigitalBlack_GetRange(peak_camera_handle hCam, double *minDigitalBlack, double *maxDigitalBlack)
Get the current range of valid host digital black values.
peak_status peak_IPL_EdgeEnhancement_Factor_Get(peak_camera_handle hCam, uint32_t *factor)
Get the currently set host edge enhancement factor.
peak_status peak_IPL_EdgeEnhancement_Factor_Set(peak_camera_handle hCam, uint32_t factor)
Set the host edge enhancement factor.
peak_status peak_IPL_EdgeEnhancement_Factor_GetDefault(peak_camera_handle hCam, uint32_t *defaultFactor)
Get the default host edge enhancement factor.
peak_bool peak_IPL_EdgeEnhancement_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the edge enhancement feature.
peak_status peak_IPL_EdgeEnhancement_Factor_GetRange(peak_camera_handle hCam, uint32_t *minFactor, uint32_t *maxFactor, uint32_t *incFactor)
Get the range for the host edge enhancement factor.
peak_status peak_IPL_EdgeEnhancement_Enable(peak_camera_handle hCam, peak_bool enable)
Enable/Disable the host edge enhancement.
peak_status peak_IPL_ReadImage(peak_camera_handle hCam, const char *path, peak_frame_handle *hFrame)
Reads an image file from the disk and returns the peak_frame_handle for it.
peak_status peak_IPL_ProcessFrame(peak_camera_handle hCam, peak_frame_handle hFrame, peak_frame_handle *hResultFrame)
Process a frame with the host image processing pipeline and store the result in a new frame.
peak_status peak_IPL_ProcessFrameInplace(peak_camera_handle hCam, peak_frame_handle hFrame)
Process a frame with the host image processing pipeline and replace the original frame.
peak_status peak_IPL_Gain_GetRange(peak_camera_handle hCam, peak_gain_channel gainChannel, double *minGain, double *maxGain, double *incGain)
Get the current range of valid host gain values for the specified gain channel.
peak_status peak_IPL_Gain_Set(peak_camera_handle hCam, peak_gain_channel gainChannel, double gain)
Set the host gain for the specified gain channel.
peak_status peak_IPL_Gain_Get(peak_camera_handle hCam, peak_gain_channel gainChannel, double *gain)
Get the host gain value for the specified gain channel.
peak_status peak_IPL_Gamma_GetRange(peak_camera_handle hCam, double *minGamma, double *maxGamma, double *incGamma)
Get the current range of valid host gamma values.
peak_status peak_IPL_Gamma_Set(peak_camera_handle hCam, double gamma)
Set the host gamma value.
peak_status peak_IPL_Gamma_Get(peak_camera_handle hCam, double *gamma)
Get the host gamma value.
peak_status peak_IPL_HotpixelCorrection_Sensitivity_Set(peak_camera_handle hCam, peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity)
Set the host hotpixel correction sensitivity level.
peak_status peak_IPL_HotpixelCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the host hotpixel correction.
peak_status peak_IPL_HotpixelCorrection_GetList(peak_camera_handle hCam, peak_position *hotpixelList, size_t *hotpixelCount)
Get the list of detected host hotpixel correction positions/pixels.
peak_hotpixel_correction_sensitivity
peak hotpixel correction sensitivity level
Definition ids_peak_comfort_c.h:13864
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:13876
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_4
hotpixel correction sensitivity level 4
Definition ids_peak_comfort_c.h:13888
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_INVALID
Invalid hotpixel correction sensitivity level.
Definition ids_peak_comfort_c.h:13869
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_3
hotpixel correction sensitivity level 3
Definition ids_peak_comfort_c.h:13885
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_2
hotpixel correction sensitivity level 2
Definition ids_peak_comfort_c.h:13879
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_5
hotpixel correction sensitivity level 5
Definition ids_peak_comfort_c.h:13894
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:19045
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:19065
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:19027
@ PEAK_LUT_CHANNEL_GREEN
Definition ids_peak_comfort_c.h:19050
@ PEAK_LUT_CHANNEL_BLUE
Definition ids_peak_comfort_c.h:19053
@ PEAK_LUT_CHANNEL_ALL
Definition ids_peak_comfort_c.h:19056
@ PEAK_LUT_CHANNEL_RED
Definition ids_peak_comfort_c.h:19047
@ PEAK_LUT_PRESET_ONLY_RED
Definition ids_peak_comfort_c.h:19103
@ PEAK_LUT_PRESET_INVERSE
Definition ids_peak_comfort_c.h:19076
@ PEAK_LUT_PRESET_JET
Definition ids_peak_comfort_c.h:19083
@ PEAK_LUT_PRESET_DIGITAL_GAIN2
Definition ids_peak_comfort_c.h:19120
@ PEAK_LUT_PRESET_RAINBOW
Definition ids_peak_comfort_c.h:19097
@ PEAK_LUT_PRESET_ONLY_GREEN
Definition ids_peak_comfort_c.h:19109
@ PEAK_LUT_PRESET_BINARIZE
Definition ids_peak_comfort_c.h:19131
@ PEAK_LUT_PRESET_IDENTITY
Definition ids_peak_comfort_c.h:19070
@ PEAK_LUT_PRESET_ONLY_BLUE
Definition ids_peak_comfort_c.h:19115
@ PEAK_LUT_PRESET_DIGITAL_BLACK_25_PERCENT
Definition ids_peak_comfort_c.h:19125
@ PEAK_LUT_PRESET_HOT
Definition ids_peak_comfort_c.h:19090
@ PEAK_LUT_12BIT
Definition ids_peak_comfort_c.h:19035
@ PEAK_LUT_10BIT
Definition ids_peak_comfort_c.h:19032
@ PEAK_LUT_8BIT
Definition ids_peak_comfort_c.h:19029
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:17544
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:17090
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:16825
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:16898
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:17561
@ PEAK_I2C_OPERATION_STATUS_ERROR
An error occured while reading or writing.
Definition ids_peak_comfort_c.h:17555
@ PEAK_I2C_OPERATION_STATUS_INVALID
Invalid operation status.
Definition ids_peak_comfort_c.h:17549
@ PEAK_I2C_OPERATION_STATUS_READY
I2C communication is ready or the last write/read was successful.
Definition ids_peak_comfort_c.h:17552
@ 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:17558
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_0BIT
0 bit register length. Register address will not be used
Definition ids_peak_comfort_c.h:17097
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_24BIT
24 bit register length
Definition ids_peak_comfort_c.h:17103
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_INVALID
Invalid register address length.
Definition ids_peak_comfort_c.h:17095
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_16BIT
16 bit register length
Definition ids_peak_comfort_c.h:17101
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_8BIT
8 bit register length
Definition ids_peak_comfort_c.h:17099
@ PEAK_I2C_MODE_INVALID
Invalid i2c mode.
Definition ids_peak_comfort_c.h:16903
@ PEAK_I2C_MODE_STANDARD
I2C fast mode with 100 kHz clock frequency.
Definition ids_peak_comfort_c.h:16905
@ PEAK_I2C_MODE_FAST
I2C fast mode with 400 kHz clock frequency.
Definition ids_peak_comfort_c.h:16907
@ PEAK_I2C_MODE_FAST_PLUS
I2C fast mode with 1000 kHz clock frequency.
Definition ids_peak_comfort_c.h:16909
peak_subsampling_engine
peak subsampling engine
Definition ids_peak_comfort_c.h:9372
@ PEAK_SUBSAMPLING_ENGINE_INVALID
invalid subsampling engine
Definition ids_peak_comfort_c.h:9377
@ PEAK_SUBSAMPLING_ENGINE_FPGA
subsampling engine fpga.
Definition ids_peak_comfort_c.h:9379
@ PEAK_SUBSAMPLING_ENGINE_UEYE
subsampling engine ueye.
Definition ids_peak_comfort_c.h:9383
@ PEAK_SUBSAMPLING_ENGINE_SENSOR
subsampling engine sensor.
Definition ids_peak_comfort_c.h:9381
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:17592
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:17657
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:17676
@ PEAK_IMAGEFILE_FORMAT_PNG
Image file format PNG.
Definition ids_peak_comfort_c.h:17669
@ PEAK_IMAGEFILE_FORMAT_RAW
Image file format RAW.
Definition ids_peak_comfort_c.h:17697
@ PEAK_IMAGEFILE_FORMAT_BMP
Image file format BMP.
Definition ids_peak_comfort_c.h:17690
@ PEAK_IMAGEFILE_FORMAT_INVALID
Invalid image file format.
Definition ids_peak_comfort_c.h:17662
@ PEAK_IMAGEFILE_FORMAT_TIFF
Image file format TIFF.
Definition ids_peak_comfort_c.h:17683
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:15056
struct peak_inference * peak_inference_handle
The handle to identify an inference instance.
Definition ids_peak_comfort_c.h:15023
struct peak_inference_result * peak_inference_result_handle
The handle to identify an inference result.
Definition ids_peak_comfort_c.h:15029
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:15038
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:15064
@ PEAK_INFERENCE_PREPROCESSING_MODE_TENSORFLOW
Tensorflow preprocessing mode.
Definition ids_peak_comfort_c.h:15067
@ PEAK_INFERENCE_PREPROCESSING_MODE_INVALID
Invalid inference preprocessing mode.
Definition ids_peak_comfort_c.h:15061
@ PEAK_INFERENCE_TYPE_CLASSIFICATION
CNN classification model.
Definition ids_peak_comfort_c.h:15049
@ PEAK_INFERENCE_TYPE_DETECTION
CNN detection model.
Definition ids_peak_comfort_c.h:15046
@ PEAK_INFERENCE_TYPE_INVALID
Invalid inference type.
Definition ids_peak_comfort_c.h:15043
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:4923
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:5082
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:5257
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:5018
@ PEAK_IO_CHANNEL_LINE_2
Line 2.
Definition ids_peak_comfort_c.h:4997
@ PEAK_IO_CHANNEL_LINE_1
Line 1.
Definition ids_peak_comfort_c.h:4990
@ PEAK_IO_CHANNEL_INVALID
Invalid io channel.
Definition ids_peak_comfort_c.h:4928
@ PEAK_IO_CHANNEL_LINE_6
Line 6.
Definition ids_peak_comfort_c.h:5025
@ PEAK_IO_CHANNEL_LINE_4
Line 4.
Definition ids_peak_comfort_c.h:5011
@ PEAK_IO_CHANNEL_SOFTWARE
Software.
Definition ids_peak_comfort_c.h:4940
@ PEAK_IO_CHANNEL_LINE_7
Line 7.
Definition ids_peak_comfort_c.h:5032
@ PEAK_IO_CHANNEL_NONE
None.
Definition ids_peak_comfort_c.h:4934
@ PEAK_IO_CHANNEL_LINE_0
Line 0.
Definition ids_peak_comfort_c.h:4983
@ PEAK_IO_CHANNEL_LINE_3
Line 3.
Definition ids_peak_comfort_c.h:5004
@ PEAK_IO_DIRECTION_ANY
Input or Output.
Definition ids_peak_comfort_c.h:5105
@ PEAK_IO_DIRECTION_OUTPUT
Output.
Definition ids_peak_comfort_c.h:5099
@ PEAK_IO_DIRECTION_UNKNOWN
Unknown io direction.
Definition ids_peak_comfort_c.h:5087
@ PEAK_IO_DIRECTION_INPUT
Input.
Definition ids_peak_comfort_c.h:5093
@ PEAK_IO_TYPE_INVALID
Invalid io type.
Definition ids_peak_comfort_c.h:5262
@ PEAK_IO_TYPE_UNKNOWN
Unknown io type.
Definition ids_peak_comfort_c.h:5268
@ PEAK_IO_TYPE_OPTO_COUPLED
Invalid io type.
Definition ids_peak_comfort_c.h:5281
@ PEAK_IO_TYPE_TRI_STATE
Invalid io type.
Definition ids_peak_comfort_c.h:5274
@ PEAK_IO_TYPE_LVTTL
Invalid io type.
Definition ids_peak_comfort_c.h:5287
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:18241
peak_led_mode
peak LED mode
Definition ids_peak_comfort_c.h:18263
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:18251
@ PEAK_LED_TARGET_INVALID
Invalid LED target.
Definition ids_peak_comfort_c.h:18247
@ PEAK_LED_TARGET_NETWORK
The camera network LED target.
Definition ids_peak_comfort_c.h:18249
@ PEAK_LED_MODE_INVALID
Invalid LED mode.
Definition ids_peak_comfort_c.h:18268
@ PEAK_LED_MODE_CAMERA_STATUS
Turns status LED to show camera status.
Definition ids_peak_comfort_c.h:18279
@ PEAK_LED_MODE_BLINK_FAST
Turns LED to fast flashing.
Definition ids_peak_comfort_c.h:18274
@ PEAK_LED_MODE_BLINK_SLOW
Turns LED to slow flashing.
Definition ids_peak_comfort_c.h:18272
@ PEAK_LED_MODE_OFF
Turns off LED.
Definition ids_peak_comfort_c.h:18270
@ PEAK_LED_MODE_NETWORK_STATUS
Turns network LED to show network status.
Definition ids_peak_comfort_c.h:18284
peak_status peak_Library_Init()
Init the IDS peak comfortC library.
peak_status peak_Library_Exit()
Exit the IDS peak comfortC library.
peak_status peak_Library_GetLastError(peak_status *lastErrorCode, char *lastErrorMessage, size_t *lastErrorMessageSize)
Query the last error.
peak_status peak_Library_GetVersion(uint32_t *majorVersion, uint32_t *minorVersion, uint32_t *patchVersion, uint32_t *legacyVersion)
Query the library version.
peak_bool peak_Library_InterfaceTechnology_IsSupported(peak_interface_technology interfaceTech)
Query the supported interface technologies.
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:2982
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:2993
@ PEAK_LOSS_HANDLING_MODE_LIMITED
Loss handling mode limited.
Definition ids_peak_comfort_c.h:3001
@ PEAK_LOSS_HANDLING_MODE_INVALID
Invalid loss handling mode.
Definition ids_peak_comfort_c.h:2987
@ PEAK_LOSS_HANDLING_MODE_UNLIMITED
Loss handling mode unlimited.
Definition ids_peak_comfort_c.h:3008
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:15645
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:15656
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE
Remote device message data type.
Definition ids_peak_comfort_c.h:15653
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED
Remote device dropped message data type.
Definition ids_peak_comfort_c.h:15659
@ PEAK_MESSAGE_DATA_TYPE_NO_DATA
No data message data type.
Definition ids_peak_comfort_c.h:15650
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME
Remote device frame message data type.
Definition ids_peak_comfort_c.h:15662
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_LOST
Camera manager device lost message data type.
Definition ids_peak_comfort_c.h:15674
@ PEAK_MESSAGE_DATA_TYPE_FIRMWARE_UPDATE
Firmware update message data type.
Definition ids_peak_comfort_c.h:15683
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE
Remote device temperature message data type.
Definition ids_peak_comfort_c.h:15665
@ PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA
Autofeature auto focus data message data type.
Definition ids_peak_comfort_c.h:15668
@ PEAK_MESSAGE_DATA_TYPE_INVALID
Invalid message data type.
Definition ids_peak_comfort_c.h:15647
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_DISCONNECTED
Camera manager device disconnected message data type.
Definition ids_peak_comfort_c.h:15680
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_RECONNECTED
Camera manager device reconnected message data type.
Definition ids_peak_comfort_c.h:15677
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_FOUND
Camera manager device found message data type.
Definition ids_peak_comfort_c.h:15671
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:15988
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:15981
peak_status peak_MessageQueue_Statistics_Reset(peak_message_queue_handle hMessageQueue)
Reset the queue statistic info.
peak_status peak_MessageQueue_EnableMessageList(peak_message_queue_handle hMessageQueue, peak_camera_handle hCam, const peak_message_type *messageTypesArray, size_t messageTypesArraySize)
Enable a list of message types at once.
peak_status peak_MessageQueue_GetMode(peak_message_queue_handle hMessageQueue, peak_message_queue_mode *queueMode)
Get the queue mode.
peak_status peak_MessageQueue_Start(peak_message_queue_handle hMessageQueue)
Start the queue.
peak_status peak_MessageQueue_EnableMessage(peak_message_queue_handle hMessageQueue, peak_camera_handle hCam, peak_message_type messageType)
Enable a message type for a message queue.
peak_status peak_MessageQueue_MaxQueueSize_Get(peak_message_queue_handle hMessageQueue, size_t *messageQueueMaxSize)
Gets the maximum queue size.
peak_message_queue_mode
peak queue mode Changes the behavior of the queue
Definition ids_peak_comfort_c.h:15467
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:15475
@ PEAK_QUEUE_MODE_INVALID
Invalid queue mode.
Definition ids_peak_comfort_c.h:15469
@ PEAK_QUEUE_MODE_OLDEST_FIRST
Oldest messages returned first (chronological order)
Definition ids_peak_comfort_c.h:15472
peak_message_type
The peak message types.
Definition ids_peak_comfort_c.h:15487
@ 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:15555
@ 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:15501
@ 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:15622
@ 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:15549
@ 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:15507
@ 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:15601
@ 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:15561
@ 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:15593
@ PEAK_MESSAGE_TYPE_DEVICE_DISCONNECTED
Camera manager device disconnected message type.
Definition ids_peak_comfort_c.h:15585
@ 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:15513
@ 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:15537
@ PEAK_MESSAGE_TYPE_DEVICE_RECONNECTED
Camera manager device reconnected message type.
Definition ids_peak_comfort_c.h:15580
@ 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:15495
@ 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:15525
@ 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:15629
@ 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:15519
@ 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:15531
@ 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:15568
@ 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:15543
@ 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:15575
@ 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:15636
@ 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:15615
@ PEAK_MESSAGE_TYPE_INVALID
Invalid message type.
Definition ids_peak_comfort_c.h:15489
@ 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:15608
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:900
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:3422
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:3499
@ PEAK_PIXEL_FORMAT_BAYER_BG12G24_IDS
BayerBG12 grouped 24.
Definition ids_peak_comfort_c.h:3595
@ PEAK_PIXEL_FORMAT_BAYER_BG10G40_IDS
BayerBG grouped 40.
Definition ids_peak_comfort_c.h:3571
@ PEAK_PIXEL_FORMAT_MONO8
Mono8.
Definition ids_peak_comfort_c.h:3466
@ PEAK_PIXEL_FORMAT_BGR8
BGR8.
Definition ids_peak_comfort_c.h:3484
@ PEAK_PIXEL_FORMAT_BAYER_RG12G24_IDS
BayerRG12 grouped 24.
Definition ids_peak_comfort_c.h:3583
@ PEAK_PIXEL_FORMAT_BAYER_GB8
BayerGB8.
Definition ids_peak_comfort_c.h:3448
@ PEAK_PIXEL_FORMAT_BAYER_GR10
BayerGR10.
Definition ids_peak_comfort_c.h:3433
@ PEAK_PIXEL_FORMAT_INVALID
Invalid pixel format.
Definition ids_peak_comfort_c.h:3427
@ PEAK_PIXEL_FORMAT_MONO12P
Mono12 packed.
Definition ids_peak_comfort_c.h:3538
@ PEAK_PIXEL_FORMAT_BGR12
BGR12.
Definition ids_peak_comfort_c.h:3490
@ PEAK_PIXEL_FORMAT_BGRA10
BGRa10.
Definition ids_peak_comfort_c.h:3505
@ PEAK_PIXEL_FORMAT_BAYER_RG10P
BayerRG10 packed.
Definition ids_peak_comfort_c.h:3517
@ PEAK_PIXEL_FORMAT_BAYER_BG10P
BayerBG10 packed.
Definition ids_peak_comfort_c.h:3529
@ PEAK_PIXEL_FORMAT_MONO12G24_IDS
Mono12 grouped 24.
Definition ids_peak_comfort_c.h:3607
@ PEAK_PIXEL_FORMAT_RGBA10
RGBa10.
Definition ids_peak_comfort_c.h:3496
@ PEAK_PIXEL_FORMAT_BAYER_GB10G40_IDS
BayerGB10 grouped 40.
Definition ids_peak_comfort_c.h:3565
@ PEAK_PIXEL_FORMAT_RGB12
RGB12.
Definition ids_peak_comfort_c.h:3481
@ PEAK_PIXEL_FORMAT_BAYER_RG10G40_IDS
BayerRG10 grouped 40.
Definition ids_peak_comfort_c.h:3559
@ PEAK_PIXEL_FORMAT_BAYER_BG12
BayerBG12.
Definition ids_peak_comfort_c.h:3463
@ PEAK_PIXEL_FORMAT_BAYER_GB12P
BayerGB12 packed.
Definition ids_peak_comfort_c.h:3526
@ PEAK_PIXEL_FORMAT_BAYER_GR12
BayerGR12.
Definition ids_peak_comfort_c.h:3436
@ PEAK_PIXEL_FORMAT_MONO10
Mono10.
Definition ids_peak_comfort_c.h:3469
@ PEAK_PIXEL_FORMAT_BAYER_GB10
BayerGB10.
Definition ids_peak_comfort_c.h:3451
@ PEAK_PIXEL_FORMAT_RGBA8
RGBa8.
Definition ids_peak_comfort_c.h:3493
@ PEAK_PIXEL_FORMAT_BAYER_GB10P
BayerGB10 packed.
Definition ids_peak_comfort_c.h:3523
@ PEAK_PIXEL_FORMAT_BGRA12
BGRa12.
Definition ids_peak_comfort_c.h:3508
@ PEAK_PIXEL_FORMAT_BAYER_RG10
BayerRG10.
Definition ids_peak_comfort_c.h:3442
@ PEAK_PIXEL_FORMAT_BAYER_RG8
BayerRG8.
Definition ids_peak_comfort_c.h:3439
@ PEAK_PIXEL_FORMAT_BAYER_BG8
BayerBG8.
Definition ids_peak_comfort_c.h:3457
@ PEAK_PIXEL_FORMAT_MONO10G40_IDS
Mono10 grouped 40.
Definition ids_peak_comfort_c.h:3601
@ PEAK_PIXEL_FORMAT_BAYER_GR10P
BayerGR10 packed.
Definition ids_peak_comfort_c.h:3511
@ PEAK_PIXEL_FORMAT_MONO12
Mono12.
Definition ids_peak_comfort_c.h:3472
@ PEAK_PIXEL_FORMAT_BAYER_GR12G24_IDS
BayerGR12 grouped 24.
Definition ids_peak_comfort_c.h:3577
@ PEAK_PIXEL_FORMAT_RGB10P32
RGB10 packed 32.
Definition ids_peak_comfort_c.h:3544
@ PEAK_PIXEL_FORMAT_BGR10P32
BGR10 packed 32.
Definition ids_peak_comfort_c.h:3547
@ PEAK_PIXEL_FORMAT_BGRA8
BGRa8.
Definition ids_peak_comfort_c.h:3502
@ PEAK_PIXEL_FORMAT_BAYER_GB12
BayerGB12.
Definition ids_peak_comfort_c.h:3454
@ PEAK_PIXEL_FORMAT_BAYER_GR8
BayerGR8.
Definition ids_peak_comfort_c.h:3430
@ PEAK_PIXEL_FORMAT_RGB10
RGB10.
Definition ids_peak_comfort_c.h:3478
@ PEAK_PIXEL_FORMAT_BAYER_GR12P
BayerGR12 packed.
Definition ids_peak_comfort_c.h:3514
@ PEAK_PIXEL_FORMAT_YUV422_8_UYVY
UYVY 4:2:2 8-Bit.
Definition ids_peak_comfort_c.h:3541
@ PEAK_PIXEL_FORMAT_BGR10
BGR10.
Definition ids_peak_comfort_c.h:3487
@ PEAK_PIXEL_FORMAT_BAYER_GB12G24_IDS
BayerGB12 grouped 24.
Definition ids_peak_comfort_c.h:3589
@ PEAK_PIXEL_FORMAT_BAYER_BG12P
BayerBG12 packed.
Definition ids_peak_comfort_c.h:3532
@ PEAK_PIXEL_FORMAT_RGB8
RGB8.
Definition ids_peak_comfort_c.h:3475
@ PEAK_PIXEL_FORMAT_BAYER_BG10
BayerBG10.
Definition ids_peak_comfort_c.h:3460
@ PEAK_PIXEL_FORMAT_BAYER_RG12P
BayerRG12 packed.
Definition ids_peak_comfort_c.h:3520
@ PEAK_PIXEL_FORMAT_BAYER_GR10G40_IDS
BayerGR10 grouped 40.
Definition ids_peak_comfort_c.h:3553
@ PEAK_PIXEL_FORMAT_BAYER_RG12
BayerRG12.
Definition ids_peak_comfort_c.h:3445
@ PEAK_PIXEL_FORMAT_MONO10P
Mono10 packed.
Definition ids_peak_comfort_c.h:3535
peak_access_status peak_Reconnect_GetAccessStatus(peak_interface_technology interfaceTech)
Query the reconnect access status.
peak_bool peak_Reconnect_IsEnabled(peak_interface_technology interfaceTech)
Indicates whether the reconnect is active or inactive for the specified specified interface technolog...
peak_status peak_Reconnect_Enable(peak_interface_technology interfaceTech, peak_bool enabled)
Control whether the reconnect is enabled or disabled.
peak_access_status peak_ROI_Offset_GetAccessStatus(peak_camera_handle hCam)
Query the ROI offset access status.
peak_status peak_ROI_Get(peak_camera_handle hCam, peak_roi *roi)
Get the ROI.
peak_status peak_ROI_Offset_Get(peak_camera_handle hCam, peak_position *position)
Get the ROI offset.
peak_status peak_ROI_Size_Get(peak_camera_handle hCam, peak_size *size)
Get the ROI size.
peak_status peak_ROI_Offset_Set(peak_camera_handle hCam, peak_position position)
Set the ROI offset.
peak_status peak_ROI_Size_Set(peak_camera_handle hCam, peak_size size)
Set the ROI size.
peak_status peak_ROI_Set(peak_camera_handle hCam, peak_roi roi)
Set the ROI.
peak_status peak_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minROIOffset, peak_position *maxROIOffset, peak_position *incROIOffset)
Get the current range of valid ROI offsets.
peak_status peak_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minROISize, peak_size *maxROISize, peak_size *incROISize)
Get the current range of valid ROI sizes.
peak_access_status peak_ROI_GetAccessStatus(peak_camera_handle hCam)
Query the ROI access status.
peak_access_status peak_ROI_Size_GetAccessStatus(peak_camera_handle hCam)
Query the ROI size access status.
peak_status peak_Scaling_FactorY_GetRange(peak_camera_handle hCam, double *minScalingFactorY, double *maxScalingFactorY, double *incScalingFactorY)
Get the current range of valid scaling factor y values.
peak_status peak_Scaling_FactorX_GetRange(peak_camera_handle hCam, double *minScalingFactorX, double *maxScalingFactorX, double *incScalingFactorX)
Get the current range of valid scaling factor x values.
peak_status peak_Scaling_Get(peak_camera_handle hCam, double *scalingFactorX, double *scalingFactorY)
Get the scaling factors.
peak_status peak_Scaling_Set(peak_camera_handle hCam, double scalingFactorX, double scalingFactorY)
Set the scaling factors.
peak_access_status peak_Scaling_GetAccessStatus(peak_camera_handle hCam)
Query the scaling access status.
peak_status peak_IPL_Sharpness_GetList(peak_sharpness_algorithm sharpnessAlgorithm, peak_pixel_format *pixelFormatList, size_t *pixelFormatSize)
Query the current supported pixel formats for the given algorithm.
peak_status peak_IPL_Sharpness_Measure(peak_frame_handle hFrame, peak_roi roi, peak_sharpness_algorithm sharpnessAlgorithm, double *calculatedValue)
Measures the sharpness in the image.
peak_status peak_ShutterMode_Get(peak_camera_handle hCam, peak_shutter_mode *shutterMode)
Get the shutter mode.
peak_access_status peak_ShutterMode_GetAccessStatus(peak_camera_handle hCam)
Query the shutter mode access status.
peak_shutter_mode
Definition ids_peak_comfort_c.h:4631
peak_status peak_ShutterMode_Set(peak_camera_handle hCam, peak_shutter_mode shutterMode)
Set the shutter mode.
peak_status peak_ShutterMode_GetList(peak_camera_handle hCam, peak_shutter_mode *shutterModeList, size_t *shutterModeCount)
Get the list of currently available shutter modes.
@ PEAK_SHUTTER_MODE_GLOBAL
Global Shutter.
Definition ids_peak_comfort_c.h:4650
@ PEAK_SHUTTER_MODE_GLOBAL_RESET
Global Reset.
Definition ids_peak_comfort_c.h:4659
@ PEAK_SHUTTER_MODE_UNKNOWN
Unknown shutter mode.
Definition ids_peak_comfort_c.h:4636
@ PEAK_SHUTTER_MODE_ROLLING
Rolling Shutter.
Definition ids_peak_comfort_c.h:4643
peak_status
peak Status codes
Definition ids_peak_comfort_c.h:1076
peak_access_status
peak Access status codes
Definition ids_peak_comfort_c.h:1218
@ PEAK_STATUS_SUCCESS
Success.
Definition ids_peak_comfort_c.h:1078
@ PEAK_STATUS_BUFFER_TOO_SMALL
The buffer is too small to take the complete data.
Definition ids_peak_comfort_c.h:1139
@ PEAK_STATUS_NOT_INITIALIZED
The library is not initialized.
Definition ids_peak_comfort_c.h:1115
@ PEAK_STATUS_VALUE_ADJUSTED
The set value was auto-adjusted.
Definition ids_peak_comfort_c.h:1088
@ PEAK_STATUS_NOT_IMPLEMENTED
The function is not implemented.
Definition ids_peak_comfort_c.h:1118
@ PEAK_STATUS_ERROR
Unspecified error.
Definition ids_peak_comfort_c.h:1109
@ PEAK_STATUS_OUT_OF_MEMORY
The system could not provide enough memory.
Definition ids_peak_comfort_c.h:1160
@ PEAK_STATUS_BUSY
Device or resource is busy.
Definition ids_peak_comfort_c.h:1157
@ PEAK_STATUS_TIMEOUT
A timeout occurred.
Definition ids_peak_comfort_c.h:1145
@ PEAK_STATUS_WARNING_OPERATION
A operation failed.
Definition ids_peak_comfort_c.h:1102
@ 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:1142
@ PEAK_STATUS_NOT_SUPPORTED
Indicates that the requested functionality is not supported.
Definition ids_peak_comfort_c.h:1166
@ PEAK_STATUS_NO_DATA
The specified or requested data is not present.
Definition ids_peak_comfort_c.h:1151
@ PEAK_STATUS_CAMERA_NOT_FOUND
There is no such camera.
Definition ids_peak_comfort_c.h:1124
@ PEAK_STATUS_INVALID_HANDLE
The handle is invalid.
Definition ids_peak_comfort_c.h:1130
@ PEAK_STATUS_IO
An I/O error occurred.
Definition ids_peak_comfort_c.h:1163
@ PEAK_STATUS_INVALID_PARAMETER
One or more parameters are invalid.
Definition ids_peak_comfort_c.h:1133
@ PEAK_STATUS_WARNING
Unspecified warning.
Definition ids_peak_comfort_c.h:1081
@ PEAK_STATUS_OUT_OF_RANGE
The value or configuration is out of the valid range.
Definition ids_peak_comfort_c.h:1136
@ PEAK_STATUS_WARNING_OVERFLOW
A value was dropped.
Definition ids_peak_comfort_c.h:1095
@ PEAK_STATUS_INVALID_PEAK_INSTALLATION
The peak installation is corrupted.
Definition ids_peak_comfort_c.h:1154
@ PEAK_STATUS_ABORTED
The operation was aborted.
Definition ids_peak_comfort_c.h:1148
@ PEAK_STATUS_ACCESS_DENIED
The access to the requested feature was denied due to the current system status.
Definition ids_peak_comfort_c.h:1121
@ PEAK_STATUS_CAMERA_NOT_AVAILABLE
The specified camera is not available.
Definition ids_peak_comfort_c.h:1127
@ PEAK_ACCESS_GFA_LOCK
No access.
Definition ids_peak_comfort_c.h:1247
@ PEAK_ACCESS_INVALID
Invalid access status code.
Definition ids_peak_comfort_c.h:1226
@ PEAK_ACCESS_WRITEONLY
Write only access.
Definition ids_peak_comfort_c.h:1259
@ PEAK_ACCESS_NOT_SUPPORTED
Not supported.
Definition ids_peak_comfort_c.h:1234
@ PEAK_ACCESS_READONLY
Read only access.
Definition ids_peak_comfort_c.h:1253
@ PEAK_ACCESS_NONE
No access.
Definition ids_peak_comfort_c.h:1240
@ PEAK_ACCESS_READWRITE
Read write access.
Definition ids_peak_comfort_c.h:1265
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:18072
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:18086
@ 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:18106
@ PEAK_TEST_PATTERN_GREYDIAGONALRAMPMOVING
GreyDiagonalRampMoving: Moving diagonal ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:18104
@ PEAK_TEST_PATTERN_FPGAGRAYSCALE
Grayscale generated by FPGA.
Definition ids_peak_comfort_c.h:18096
@ PEAK_TEST_PATTERN_INVALID
Invalid test pattern.
Definition ids_peak_comfort_c.h:18077
@ PEAK_TEST_PATTERN_GREYWEDGEMOVINGSENSOR
GreyWedgeMovingSensor: Moving grey wedges generated by the image sensor.
Definition ids_peak_comfort_c.h:18110
@ PEAK_TEST_PATTERN_FPGACOLORSTRIPE
ColorStripe generated by FPGA.
Definition ids_peak_comfort_c.h:18092
@ PEAK_TEST_PATTERN_FPGAFRAMECOUNT
Framecount generated by FPGA.
Definition ids_peak_comfort_c.h:18094
@ PEAK_TEST_PATTERN_WHITE
White: Image is filled with the brightest possible image.
Definition ids_peak_comfort_c.h:18120
@ PEAK_TEST_PATTERN_FPGAVERTICALGRAYSCALE
VerticalGrayscale generated by FPGA.
Definition ids_peak_comfort_c.h:18098
@ PEAK_TEST_PATTERN_GREYWEDGESENSOR
GreyWedgeSensor: Grey wedges generated by the image sensor.
Definition ids_peak_comfort_c.h:18112
@ PEAK_TEST_PATTERN_GREYVERTICALRAMP
GreyVerticalRamp: Vertical ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:18108
@ PEAK_TEST_PATTERN_CHESSPATTERN
Chessboard pattern.
Definition ids_peak_comfort_c.h:18084
@ PEAK_TEST_PATTERN_FPGACHESSBOARD
Chessboard generated by FPGA.
Definition ids_peak_comfort_c.h:18090
@ PEAK_TEST_PATTERN_OFF
Image is coming from the sensor.
Definition ids_peak_comfort_c.h:18080
@ PEAK_TEST_PATTERN_BLACK
Image is filled with the darkest possible image.
Definition ids_peak_comfort_c.h:18082
@ PEAK_TEST_PATTERN_RAMPINGPATTERN
RampingPattern: Diagonal color pattern.
Definition ids_peak_comfort_c.h:18114
@ PEAK_TEST_PATTERN_FPGAWHITE
White generated by FPGA.
Definition ids_peak_comfort_c.h:18100
@ PEAK_TEST_PATTERN_SEQUENCEPATTERN2
SequencePattern2: SequencePattern2.
Definition ids_peak_comfort_c.h:18118
@ PEAK_TEST_PATTERN_FPGABLACK
Black generated by FPGA.
Definition ids_peak_comfort_c.h:18088
@ PEAK_TEST_PATTERN_SEQUENCEPATTERN1
SequencePattern1: SequencePattern1.
Definition ids_peak_comfort_c.h:18116
@ PEAK_TEST_PATTERN_GREYDIAGONALRAMP
GreyDiagonalRamp: Diagonal ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:18102
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:5957
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:5974
@ PEAK_TRIGGER_EDGE_ANY
Any edge.
Definition ids_peak_comfort_c.h:5980
@ PEAK_TRIGGER_EDGE_INVALID
Invalid trigger edge.
Definition ids_peak_comfort_c.h:5962
@ PEAK_TRIGGER_EDGE_RISING
Rising edge.
Definition ids_peak_comfort_c.h:5968
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:5649
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:5654
@ PEAK_TRIGGER_TARGET_LEVEL_CONTROLLED_EXPOSURE
Level controlled exposure.
Definition ids_peak_comfort_c.h:5666
@ PEAK_TRIGGER_TARGET_FRAME_START
Frame start.
Definition ids_peak_comfort_c.h:5660
struct peak_video * peak_video_handle
peak Video handle
Definition ids_peak_comfort_c.h:14630
peak_video_encoder
peak Encoder types
Definition ids_peak_comfort_c.h:14639
peak_video_encoder_option
peak container options
Definition ids_peak_comfort_c.h:14901
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:14879
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:14658
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:14644
@ PEAK_VIDEO_ENCODER_MJPEG
Motion JPEG.
Definition ids_peak_comfort_c.h:14647
@ PEAK_VIDEO_ENCODER_OPTION_INVALID
Invalid encoder option.
Definition ids_peak_comfort_c.h:14906
@ PEAK_VIDEO_ENCODER_OPTION_QUALITY
Quality encoder option.
Definition ids_peak_comfort_c.h:14912
@ PEAK_VIDEO_CONTAINER_OPTION_FRAMERATE
Frame rate container option.
Definition ids_peak_comfort_c.h:14890
@ PEAK_VIDEO_CONTAINER_OPTION_INVALID
Invalid container option.
Definition ids_peak_comfort_c.h:14884
@ PEAK_VIDEO_CONTAINER_AVI
Audio Video Interleave.
Definition ids_peak_comfort_c.h:14666
@ PEAK_VIDEO_CONTAINER_INVALID
Invalid container.
Definition ids_peak_comfort_c.h:14663
peak_endianness
endianness order
Definition ids_peak_comfort_c.h:17189
@ PEAK_ENDIANNESS_INVALID
Invalid endianness.
Definition ids_peak_comfort_c.h:17194
@ PEAK_ENDIANNESS_BIG_ENDIAN
big-endian (BE)
Definition ids_peak_comfort_c.h:17200
@ PEAK_ENDIANNESS_LITTLE_ENDIAN
little-endian (LE)
Definition ids_peak_comfort_c.h:17206
peak_interface_technology
peak interface technology
Definition ids_peak_comfort_c.h:1322
@ PEAK_INTERFACE_TECHNOLOGY_UEYE
uEye interface technology
Definition ids_peak_comfort_c.h:1336
@ PEAK_INTERFACE_TECHNOLOGY_GEV
GigE vision interface technology.
Definition ids_peak_comfort_c.h:1330
@ PEAK_INTERFACE_TECHNOLOGY_INVALID
Invalid interface technology type.
Definition ids_peak_comfort_c.h:1327
@ PEAK_INTERFACE_TECHNOLOGY_U3V
USB3 vision interface technology.
Definition ids_peak_comfort_c.h:1333
peak Acquisition info
Definition ids_peak_comfort_c.h:2480
double fps
Measured framerate.
Definition ids_peak_comfort_c.h:2511
uint32_t numIncomplete
Number of incomplete frame transmissions.
Definition ids_peak_comfort_c.h:2503
uint32_t numUnderrun
Number of buffer underruns.
Definition ids_peak_comfort_c.h:2487
uint32_t numDropped
Number of dropped frames.
Definition ids_peak_comfort_c.h:2495
peak Buffer descriptor
Definition ids_peak_comfort_c.h:928
size_t memorySize
The size of allocated buffer memory.
Definition ids_peak_comfort_c.h:933
uint8_t * memoryAddress
The memory address at which the buffer starts.
Definition ids_peak_comfort_c.h:930
void * userContext
User context pointer.
Definition ids_peak_comfort_c.h:942
peak Camera descriptor
Definition ids_peak_comfort_c.h:1544
char serialNumber[64]
The cameras serial number.
Definition ids_peak_comfort_c.h:1561
char userDefinedName[64]
The cameras user defined name.
Definition ids_peak_comfort_c.h:1572
peak_interface_technology interfaceTechnology
The interface technology.
Definition ids_peak_comfort_c.h:1575
peak_camera_id cameraID
The camera id.
Definition ids_peak_comfort_c.h:1546
char modelName[64]
The cameras model name.
Definition ids_peak_comfort_c.h:1555
peak_camera_type cameraType
The camera type.
Definition ids_peak_comfort_c.h:1549
Structure representing the status of an auto feature.
Definition ids_peak_comfort_c.h:19698
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19703
peak_auto_feature_status status
Definition ids_peak_comfort_c.h:19700
Structure representing the status of multiple auto features.
Definition ids_peak_comfort_c.h:19711
peak_chunks_autofeature_status autoBrightnessStatus
Definition ids_peak_comfort_c.h:19713
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19719
peak_chunks_autofeature_status autoWhiteBalanceStatus
Definition ids_peak_comfort_c.h:19716
Structure representing exposure trigger timestamp information.
Definition ids_peak_comfort_c.h:19636
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19641
int64_t timestamp
Definition ids_peak_comfort_c.h:19638
Structure representing exposure information.
Definition ids_peak_comfort_c.h:19571
double exposureTime_us
Definition ids_peak_comfort_c.h:19573
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19576
Structure representing frame information.
Definition ids_peak_comfort_c.h:19555
peak_pixel_format pixelFormat
Definition ids_peak_comfort_c.h:19557
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19563
peak_roi roi
Definition ids_peak_comfort_c.h:19560
Structure representing gain information.
Definition ids_peak_comfort_c.h:19585
double digitalBlueGain
Definition ids_peak_comfort_c.h:19599
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19602
double digitalMasterGain
Definition ids_peak_comfort_c.h:19590
double digitalGreenGain
Definition ids_peak_comfort_c.h:19596
double analogMasterGain
Definition ids_peak_comfort_c.h:19587
double digitalRedGain
Definition ids_peak_comfort_c.h:19593
Structure representing line status information.
Definition ids_peak_comfort_c.h:19662
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19667
uint32_t lineStatusAll
Definition ids_peak_comfort_c.h:19664
Structure representing the PTP status.
Definition ids_peak_comfort_c.h:19765
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19770
peak_ptp_status ptpStatus
Definition ids_peak_comfort_c.h:19767
Structure representing sequencer status.
Definition ids_peak_comfort_c.h:19610
int64_t sequencerSetActive
Definition ids_peak_comfort_c.h:19612
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19615
Structure representing timestamp information.
Definition ids_peak_comfort_c.h:19623
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19628
int64_t timestamp
Definition ids_peak_comfort_c.h:19625
Structure representing usable ROI (Region of Interest).
Definition ids_peak_comfort_c.h:19649
uint8_t reserved[64]
Definition ids_peak_comfort_c.h:19654
peak_roi roi
Definition ids_peak_comfort_c.h:19651
peak Double Limit
Definition ids_peak_comfort_c.h:12490
double max
Maximum.
Definition ids_peak_comfort_c.h:12494
double min
Minimum.
Definition ids_peak_comfort_c.h:12492
peak Ethernet info
Definition ids_peak_comfort_c.h:2195
peak_mac_address cameraMAC
The mac address of the camera.
Definition ids_peak_comfort_c.h:2197
peak_mac_address hostMAC
The mac address of the host.
Definition ids_peak_comfort_c.h:2217
peak_ip_config cameraPersistentIP
The current persistent ip address of the camera.
Definition ids_peak_comfort_c.h:2206
peak_bool cameraDHCPEnabled
The current DHCP enabled status of the camera.
Definition ids_peak_comfort_c.h:2203
peak_ethernet_status cameraEthernetStatus
The current ethernet status of the camera.
Definition ids_peak_comfort_c.h:2209
peak_ip_config hostIP
The current subnet mask of the host.
Definition ids_peak_comfort_c.h:2214
peak_ip_config cameraIP
The current ip address of the camera.
Definition ids_peak_comfort_c.h:2200
peak Flash mode
Definition ids_peak_comfort_c.h:6465
peak_flash_reference flashReference
Flash reference.
Definition ids_peak_comfort_c.h:6470
peak_io_channel ioChannel
IO channel.
Definition ids_peak_comfort_c.h:6476
The peak focus ROI (2D) with weight.
Definition ids_peak_comfort_c.h:13432
peak_roi roi
The peak ROI (2D)
Definition ids_peak_comfort_c.h:13434
peak_focus_roi_weight weight
The ROI weight.
Definition ids_peak_comfort_c.h:13437
peak Frame info
Definition ids_peak_comfort_c.h:3736
uint64_t frameID
The frame id.
Definition ids_peak_comfort_c.h:3750
uint32_t processingTime_ms
The host side processing time.
Definition ids_peak_comfort_c.h:3790
peak_bool isComplete
'Complete' flag
Definition ids_peak_comfort_c.h:3768
peak_frame_type type
The type and format of the contents of the frame.
Definition ids_peak_comfort_c.h:3738
peak_pixel_format pixelFormat
The pixel format.
Definition ids_peak_comfort_c.h:3762
size_t bytesWritten
The number of bytes actually written to the buffer.
Definition ids_peak_comfort_c.h:3784
uint64_t timestamp_ns
The timestamp in nanoseconds.
Definition ids_peak_comfort_c.h:3756
peak_roi roi
The ROI of the frame.
Definition ids_peak_comfort_c.h:3759
peak_buffer buffer
The memory buffer that stores the frame contents.
Definition ids_peak_comfort_c.h:3741
size_t bytesExpected
The number of bytes expected for a complete image.
Definition ids_peak_comfort_c.h:3775
peak GFA enumeration entry
Definition ids_peak_comfort_c.h:11072
char symbolicValue[64]
The symbolic value of the enumeration entry as a zero-terminated string.
Definition ids_peak_comfort_c.h:11074
int64_t integerValue
The integer value of the enumeration entry.
Definition ids_peak_comfort_c.h:11077
peak histogram channel info
Definition ids_peak_comfort_c.h:14472
uint64_t pixelSum
The sum of all pixel values of the channel.
Definition ids_peak_comfort_c.h:14474
uint8_t reserved[64]
Reserved for future use.
Definition ids_peak_comfort_c.h:14484
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:14481
uint64_t pixelCount
The count of all pixels for the channel.
Definition ids_peak_comfort_c.h:14477
The peak information struct for CNN details.
Definition ids_peak_comfort_c.h:15155
peak_inference_type inferenceType
Inference type.
Definition ids_peak_comfort_c.h:15172
size_t inputHeight
Input height of the CNN.
Definition ids_peak_comfort_c.h:15178
size_t inputWidth
Input width of the CNN.
Definition ids_peak_comfort_c.h:15175
size_t numberOfClasses
Number of classes of the CNN.
Definition ids_peak_comfort_c.h:15187
char projectName[256]
Project name of the CNN.
Definition ids_peak_comfort_c.h:15166
uint64_t creationTime_s
Creation time (in Seconds) of the CNN.
Definition ids_peak_comfort_c.h:15163
char lighthouseID[256]
Lighthouse ID.
Definition ids_peak_comfort_c.h:15160
peak_version fileVersion
File version of the CNN.
Definition ids_peak_comfort_c.h:15157
peak_inference_preprocessing_mode preprocessingMode
Preprocessing mode used for the CNN.
Definition ids_peak_comfort_c.h:15184
peak_pixel_format inputPixelFormat
Input pixel format.
Definition ids_peak_comfort_c.h:15181
uint8_t reserved[256]
Reserved.
Definition ids_peak_comfort_c.h:15190
char networkName[256]
Network name of the CNN.
Definition ids_peak_comfort_c.h:15169
The inference classification result.
Definition ids_peak_comfort_c.h:15095
peak_inference_type type
inference CNN model
Definition ids_peak_comfort_c.h:15097
float score
Inference score.
Definition ids_peak_comfort_c.h:15100
char label[256]
Label of detected class.
Definition ids_peak_comfort_c.h:15103
The peak inference result.
Definition ids_peak_comfort_c.h:15112
uint32_t inference_time_us
Frame inference time (microseconds)
Definition ids_peak_comfort_c.h:15123
peak_frame_handle frameHandle
Handle to the frame.
Definition ids_peak_comfort_c.h:15117
uint32_t preprocessing_time_us
Frame preprocessing time (microseconds)
Definition ids_peak_comfort_c.h:15120
peak_inference_type type
Type of inference.
Definition ids_peak_comfort_c.h:15114
char reserved[256]
Reserved.
Definition ids_peak_comfort_c.h:15126
The inference detection result.
Definition ids_peak_comfort_c.h:15075
peak_roi rect
ROI of the detected class.
Definition ids_peak_comfort_c.h:15086
peak_inference_type type
inference CNN model
Definition ids_peak_comfort_c.h:15077
float score
Inference score.
Definition ids_peak_comfort_c.h:15080
char label[256]
Label of detected class.
Definition ids_peak_comfort_c.h:15083
peak IP configuration
Definition ids_peak_comfort_c.h:2128
peak_ip_address address
The ip address.
Definition ids_peak_comfort_c.h:2130
peak_ip_address subnetMask
The subnet mask.
Definition ids_peak_comfort_c.h:2133
peak message data for auto focus data messages.
Definition ids_peak_comfort_c.h:15780
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15788
int32_t focusValue
Focus value.
Definition ids_peak_comfort_c.h:15782
int32_t sharpnessValue
Sharpness value for the focus value.
Definition ids_peak_comfort_c.h:15785
peak message data for camera manager device disconnected messages.
Definition ids_peak_comfort_c.h:15844
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15846
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15849
peak message data for camera manager device found messages.
Definition ids_peak_comfort_c.h:15797
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15799
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15802
peak message data for camera manager device lost messages.
Definition ids_peak_comfort_c.h:15812
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15814
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15817
peak message data for camera manager device reconnected messages.
Definition ids_peak_comfort_c.h:15827
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:15829
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15834
Message data containing information about the current state of a firmware update.
Definition ids_peak_comfort_c.h:15897
char serialNumber[64]
Serial number of the camera that is currently being updated.
Definition ids_peak_comfort_c.h:15905
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:15920
peak_firmware_update_step step
Firmware update step that the message refers to.
Definition ids_peak_comfort_c.h:15908
char reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15923
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:15916
peak_camera_id cameraId
ID of the camera that the firmware update has been started with.
Definition ids_peak_comfort_c.h:15902
peak_firmware_update_status stepStatus
Status of the referred update step
Definition ids_peak_comfort_c.h:15911
peak message data for remote device dropped messages.
Definition ids_peak_comfort_c.h:15726
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15734
int64_t count
Number of dropped frames.
Definition ids_peak_comfort_c.h:15731
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15728
peak message data for remote device error messages.
Definition ids_peak_comfort_c.h:15708
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15716
int64_t error_type
The error type.
Definition ids_peak_comfort_c.h:15713
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15710
peak message data for remote device frame messages.
Definition ids_peak_comfort_c.h:15744
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15752
int64_t frameId
The Frame ID.
Definition ids_peak_comfort_c.h:15749
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15746
peak message data for remote device temperature messages.
Definition ids_peak_comfort_c.h:15762
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15770
double temperature
The temperature in °C.
Definition ids_peak_comfort_c.h:15767
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15764
peak message data for remote device messages.
Definition ids_peak_comfort_c.h:15693
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15698
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:15695
peak message info struct
Definition ids_peak_comfort_c.h:15956
uint64_t messageID
internal message ID
Definition ids_peak_comfort_c.h:15964
peak_camera_handle hCam
camera handle for device events or PEAK_INVALID_HANDLE for system messages
Definition ids_peak_comfort_c.h:15961
peak_message_type type
type of the message
Definition ids_peak_comfort_c.h:15958
uint8_t reserved[256]
Reserved for future use.
Definition ids_peak_comfort_c.h:15973
uint64_t hostMessageTimestamp_ns
message enqueue timestamp in nanoseconds. For further infos see peak_Message_HostTimestamp_Get.
Definition ids_peak_comfort_c.h:15967
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:15970
peak queue info struct
Definition ids_peak_comfort_c.h:15931
uint8_t reserved[32]
Reserved for future use.
Definition ids_peak_comfort_c.h:15948
uint64_t numInQueue
Number of messages currently in the message queue.
Definition ids_peak_comfort_c.h:15942
uint64_t numDelivered
Counter of messages delivered by the message queue.
Definition ids_peak_comfort_c.h:15936
uint64_t numDropped
Counter of messages dropped by the message queue.
Definition ids_peak_comfort_c.h:15939
uint64_t numMaxQueueSize
Maximum number of concurrent messages in the message queue.
Definition ids_peak_comfort_c.h:15945
uint64_t numQueued
Counter of messages which were queued in the message queue.
Definition ids_peak_comfort_c.h:15933
peak Pixel format info
Definition ids_peak_comfort_c.h:3619
uint32_t numSignificantBitsPerChannel
Significant bits per channel.
Definition ids_peak_comfort_c.h:3648
uint32_t numBitsPerPixel
Bits per pixel.
Definition ids_peak_comfort_c.h:3624
uint32_t numSignificantBitsPerPixel
Significant bits per pixel.
Definition ids_peak_comfort_c.h:3630
uint32_t numChannels
Number of channels.
Definition ids_peak_comfort_c.h:3636
uint32_t maxValuePerChannel
Maximum value per channel.
Definition ids_peak_comfort_c.h:3654
uint32_t numBitsPerChannel
Bits per channel.
Definition ids_peak_comfort_c.h:3642
peak Position (2D)
Definition ids_peak_comfort_c.h:977
uint32_t y
Y-Position.
Definition ids_peak_comfort_c.h:982
uint32_t x
X-Position.
Definition ids_peak_comfort_c.h:979
peak information whether reconnect is successful, the acquisition is running and the configuration is...
Definition ids_peak_comfort_c.h:1589
peak_bool isReconnectSuccessful
Reconnect successful status True if the reconnected was successful.
Definition ids_peak_comfort_c.h:1593
peak_bool isAcquisitionRunning
device acquisition restarted status True if the acquisition could be restarted
Definition ids_peak_comfort_c.h:1598
peak_bool isConfigurationRestored
device configuration restored status True if the configuration could be restored
Definition ids_peak_comfort_c.h:1603
The peak ROI (2D)
Definition ids_peak_comfort_c.h:993
peak_size size
ROI size.
Definition ids_peak_comfort_c.h:998
peak_position offset
ROI offset.
Definition ids_peak_comfort_c.h:995
peak Size (2D)
Definition ids_peak_comfort_c.h:957
uint32_t width
Width.
Definition ids_peak_comfort_c.h:959
uint32_t height
Height.
Definition ids_peak_comfort_c.h:962
peak Trigger mode
Definition ids_peak_comfort_c.h:5681
peak_io_channel ioChannel
The iO channel.
Definition ids_peak_comfort_c.h:5692
peak_trigger_target triggerTarget
The trigger target.
Definition ids_peak_comfort_c.h:5686
The peak version info.
Definition ids_peak_comfort_c.h:15135
uint32_t subMinor
Definition ids_peak_comfort_c.h:15143
uint32_t patch
Patch version.
Definition ids_peak_comfort_c.h:15146
uint32_t minor
Minor version.
Definition ids_peak_comfort_c.h:15140
uint32_t major
Major version.
Definition ids_peak_comfort_c.h:15137
video info structure
Definition ids_peak_comfort_c.h:14842
peak IPv4 address
Definition ids_peak_comfort_c.h:2110
uint8_t parts[4]
The IP address in little-endian byte array representation.
Definition ids_peak_comfort_c.h:2115
uint32_t addr
The IP address in little-endian word representation.
Definition ids_peak_comfort_c.h:2112
peak MAC-48 address
Definition ids_peak_comfort_c.h:1829
uint32_t low_part
Lower 4 bytes of the MAC address.
Definition ids_peak_comfort_c.h:1840
uint8_t octets[6]
The octets, i.e. the MAC address in byte array representation.
Definition ids_peak_comfort_c.h:1831
uint16_t high_part
Upper 2 bytes of the MAC address.
Definition ids_peak_comfort_c.h:1837
The peak 3x3 Matrix.
Definition ids_peak_comfort_c.h:1020
double element_00
Element 00.
Definition ids_peak_comfort_c.h:1025
double element_21
Element 21.
Definition ids_peak_comfort_c.h:1046
double element_12
Element 12.
Definition ids_peak_comfort_c.h:1040
double element_20
Element 20.
Definition ids_peak_comfort_c.h:1043
double elementArray[3][3]
The matrix elements in 2-dimensional array format.
Definition ids_peak_comfort_c.h:1054
double element_02
Element 02.
Definition ids_peak_comfort_c.h:1031
double element_11
Element 11.
Definition ids_peak_comfort_c.h:1037
double element_22
Element 22.
Definition ids_peak_comfort_c.h:1049
double element_01
Element 01.
Definition ids_peak_comfort_c.h:1028
double element_10
Element 10.
Definition ids_peak_comfort_c.h:1034