IDS peak comfortC v1.10.0
Loading...
Searching...
No Matches
ids_peak_comfort_c.h
Go to the documentation of this file.
1
9#ifndef PEAK_COMFORT_C_H
10#define PEAK_COMFORT_C_H
11
12/* Function declaration modifiers */
13#if defined(_WIN32)
14# ifndef PEAK_NO_DECLSPEC_STATEMENTS
15# ifdef paiconstant_EXPORTING
16# define PEAK_EXPORT __declspec(dllexport)
17# else
18# define PEAK_EXPORT __declspec(dllimport)
19# endif
20# else
21# define PEAK_EXPORT
22# endif
23# if defined(_M_IX86) || defined(__i386__)
24# define PEAK_CALLCONV __cdecl
25# else
26# define PEAK_CALLCONV
27# endif
28#elif defined(__linux__)
29# define PEAK_EXPORT
30# if defined(__i386__)
31# define PEAK_CALLCONV __attribute__((cdecl))
32# else
33# define PEAK_CALLCONV
34# endif
35#else
36# error Platform is not supported yet!
37#endif
38
39#ifdef __cplusplus
40# include <cstddef>
41# include <cstdint>
42
43extern "C" {
44#else
45# include <stddef.h>
46# include <stdint.h>
47#endif
48
49/* helper entities */
50struct peak_camera;
51struct peak_frame;
52struct peak_video;
53struct peak_inference;
54struct peak_inference_result;
55struct peak_message_queue;
56struct peak_message;
57struct peak_i2c;
58struct peak_imagewriter;
59
60#define PEAK_VERSION_CODE(major,minor,subminor,patch) (((major) << 24) + ((minor) << 16) + ((subminor) << 8) + (patch))
61#define PEAK_API_STATUS PEAK_EXPORT peak_status PEAK_CALLCONV
62#define PEAK_API_ACCESS_STATUS PEAK_EXPORT peak_access_status PEAK_CALLCONV
63#define PEAK_API_BOOL PEAK_EXPORT peak_bool PEAK_CALLCONV
64#define PEAK_API_CAMERA_ID PEAK_EXPORT peak_camera_id PEAK_CALLCONV
65
843#define PEAK_INVALID_HANDLE NULL
844
857#define PEAK_INFINITE 0xffffffff
858
866typedef uint8_t peak_bool;
867
875#define PEAK_TRUE 1
876
884#define PEAK_FALSE 0
885
886#pragma pack(push, 1)
893typedef struct
894{
897
900
909
911#pragma pack(pop)
912
913#pragma pack(push, 1)
922typedef struct
923{
925 uint32_t width;
926
928 uint32_t height;
929
930} peak_size;
931#pragma pack(pop)
932
933#pragma pack(push, 1)
942typedef struct
943{
945 uint32_t x;
946
948 uint32_t y;
949
951#pragma pack(pop)
952
953#pragma pack(push, 1)
958typedef struct
959{
962
965
966} peak_roi;
967#pragma pack(pop)
968
969#pragma pack(push, 1)
985typedef union
986{
988 struct
989 {
992
995
998
1001
1004
1007
1010
1013
1016
1017 } elements;
1018
1020 double elementArray[3][3];
1021
1022} peak_matrix;
1023#pragma pack(pop)
1024
1031#define PEAK_IDENTITY_MATRIX { 1.0, 0.0, 0.0, \
1032 0.0, 1.0, 0.0, \
1033 0.0, 0.0, 1.0 }
1034
1132
1144#define PEAK_SUCCESS(status) ((((status) & 0xf000) == 0x0000) ? PEAK_TRUE : PEAK_FALSE)
1145
1157#define PEAK_WARNING(status) ((((status) & 0xf000) == 0x4000) ? PEAK_TRUE : PEAK_FALSE)
1158
1170#define PEAK_ERROR(status) ((((status) & 0xf000) == 0x8000) ? PEAK_TRUE : PEAK_FALSE)
1171
1231
1246#define PEAK_IS_WRITEABLE(accessStatus) ((((accessStatus) & 0x2000) == 0x2000) ? PEAK_TRUE : PEAK_FALSE)
1247
1262#define PEAK_IS_READABLE(accessStatus) ((((accessStatus) & 0x1000) == 0x1000) ? PEAK_TRUE : PEAK_FALSE)
1263
1277#define PEAK_IS_SUPPORTED(accessStatus) (((accessStatus) != PEAK_ACCESS_NOT_SUPPORTED) ? PEAK_TRUE : PEAK_FALSE)
1278
1298
1299
1314PEAK_API_STATUS peak_Library_Init();
1315
1331PEAK_API_STATUS peak_Library_Exit();
1332
1350PEAK_API_STATUS peak_Library_GetVersion(uint32_t* majorVersion, uint32_t* minorVersion, uint32_t* subminorVersion,
1351 uint32_t* patchVersion);
1352
1393PEAK_API_STATUS peak_Library_GetLastError(peak_status* lastErrorCode, char* lastErrorMessage,
1394 size_t* lastErrorMessageSize);
1395
1413
1441
1453typedef struct peak_camera* peak_camera_handle;
1454
1468typedef uint64_t peak_camera_id;
1469
1476#define PEAK_INVALID_CAMERA_ID UINT64_C(0)
1477
1478#pragma pack(push, 1)
1488typedef struct
1489{
1492
1495
1500 char modelName[64];
1501
1506 char serialNumber[64];
1507
1517 char userDefinedName[64];
1518
1521
1522 uint8_t reserved[444];
1523
1525
1526#pragma pack(pop)
1527
1553
1574PEAK_API_STATUS peak_Reconnect_Enable(peak_interface_technology interfaceTech, peak_bool enabled);
1575
1591
1621PEAK_API_ACCESS_STATUS peak_Reconnect_GetAccessStatus(peak_interface_technology interfaceTech);
1622
1642PEAK_API_STATUS peak_CameraList_Update(size_t* cameraCount);
1643
1675PEAK_API_STATUS peak_CameraList_Get(peak_camera_descriptor* cameraList, size_t* cameraCount);
1676
1697
1718PEAK_API_CAMERA_ID peak_Camera_ID_FromSerialNumber(const char* serialNumber);
1719
1742PEAK_API_CAMERA_ID peak_Camera_ID_FromUserDefinedName(const char* userDefinedName);
1743
1744#pragma pack(push, 1)
1757typedef union
1758{
1760 uint8_t octets[6];
1761
1763 struct
1764 {
1766 uint16_t high_part;
1767
1769 uint32_t low_part;
1770
1771 } parts;
1772
1774#pragma pack(pop)
1775
1795PEAK_API_CAMERA_ID peak_Camera_ID_FromMAC(peak_mac_address macAddress);
1796
1817PEAK_API_ACCESS_STATUS peak_Camera_GetAccessStatus(peak_camera_id cameraID);
1818
1834PEAK_API_STATUS peak_Camera_GetDescriptor(peak_camera_id cameraID, peak_camera_descriptor* cameraDescriptor);
1835
1854PEAK_API_STATUS peak_Camera_Open(peak_camera_id cameraID, peak_camera_handle* hCam);
1855
1874
1891
1907
1936PEAK_API_STATUS peak_Camera_UserDefinedName_Set(peak_camera_handle hCam, const char* userDefinedName);
1937
1969PEAK_API_STATUS peak_Camera_UserDefinedName_Get(peak_camera_handle hCam, char* userDefinedName,
1970 size_t* userDefinedNameSize);
1971
1986
2002
2003#pragma pack(push, 1)
2016typedef union
2017{
2019 uint32_t addr;
2020
2022 uint8_t parts[4];
2023
2025#pragma pack (pop)
2026
2027#pragma pack (push, 1)
2034typedef struct
2035{
2038
2041
2042 uint8_t reserved[4];
2043
2045#pragma pack (pop)
2046
2091
2092#pragma pack (push, 1)
2129#pragma pack (pop)
2130
2162
2180PEAK_API_STATUS peak_EthernetConfig_GetInfo(peak_camera_id cameraID, peak_ethernet_info* ethernetInfo);
2181
2211
2244
2259
2292
2319
2339
2360typedef struct peak_frame* peak_frame_handle;
2361
2369#pragma pack(push, 1)
2370typedef struct
2371{
2378 uint32_t numUnderrun;
2379
2386 uint32_t numDropped;
2387
2395
2402 double fps;
2403
2404 uint8_t reserved[256];
2405
2407#pragma pack(pop)
2408
2452PEAK_API_STATUS peak_Acquisition_Start(peak_camera_handle hCam, uint32_t numberOfFrames);
2453
2477
2494
2529PEAK_API_STATUS peak_Acquisition_WaitForFrame(peak_camera_handle hCam, uint32_t timeout_ms, peak_frame_handle* hFrame);
2530
2549
2566PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredSize(peak_camera_handle hCam, size_t* requiredBufferSize);
2567
2583PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredCount(peak_camera_handle hCam, size_t* requiredBufferCount);
2584
2619PEAK_API_STATUS peak_Acquisition_Buffer_Announce(peak_camera_handle hCam, uint8_t* memoryAddress, size_t memorySize,
2620 void* userContext);
2621
2644PEAK_API_STATUS peak_Acquisition_Buffer_Revoke(peak_camera_handle hCam, uint8_t* memoryAddress);
2645
2666
2735
2761
2795PEAK_API_STATUS peak_Acquisition_BufferHandling_Mode_GetList(peak_camera_handle hCam, peak_buffer_handling_mode* bufferHandlingModeList, size_t* bufferHandlingModesCount);
2796
2818
2838
2874
2900
2934PEAK_API_STATUS peak_Acquisition_LossHandling_Mode_GetList(peak_camera_handle hCam, peak_loss_handling_mode* lossHandlingModeList, size_t* lossHandlingModesCount);
2935
2955
2975
3001
3022PEAK_API_STATUS peak_Acquisition_LossHandling_Extent_GetRange(peak_camera_handle hCam, int64_t* minExtent, int64_t* maxExtent, int64_t* incExtent);
3023
3043
3065
3091
3111PEAK_API_STATUS peak_Acquisition_LossHandling_FrameAbortTimeout_GetRange(peak_camera_handle hCam, int64_t* minTimeout, int64_t* maxTimeout, int64_t* incTimeout);
3112
3132
3152
3178
3202 int64_t* maxTimeout, int64_t* incTimeout);
3203
3225
3245
3252typedef enum
3253{
3259
3262
3265
3268
3271
3274
3277
3280
3283
3286
3289
3292
3295
3298
3301
3304
3307
3310
3313
3316
3319
3322
3325
3328
3331
3334
3337
3340
3343
3346
3349
3352
3355
3358
3361
3364
3367
3370
3373
3376
3382
3388
3394
3400
3406
3412
3418
3424
3430
3436
3438
3439#pragma pack(push, 1)
3446typedef struct
3447{
3453
3459
3464 uint32_t numChannels;
3465
3471
3477
3483
3484 uint8_t reserved[64];
3485
3487#pragma pack(pop)
3488
3505PEAK_API_STATUS peak_PixelFormat_GetInfo(peak_pixel_format pixelFormat, peak_pixel_format_info* pixelFormatInfo);
3506
3528
3535typedef enum
3536{
3542
3548 PEAK_FRAME_TYPE_IMAGE = 0x1001
3549
3551
3558#pragma pack(push, 1)
3559typedef struct
3560{
3563
3566
3574 uint64_t frameID;
3575
3581
3584
3587
3593
3600
3609
3615
3616 uint8_t reserved[256];
3617
3619#pragma pack(pop)
3620
3636PEAK_API_STATUS peak_Frame_GetInfo(peak_frame_handle hFrame, peak_frame_info* frameInfo);
3637
3653PEAK_API_STATUS peak_Frame_Type_Get(peak_frame_handle hFrame, peak_frame_type* frameType);
3654
3670PEAK_API_STATUS peak_Frame_Buffer_Get(peak_frame_handle hFrame, peak_buffer* buffer);
3671
3687PEAK_API_STATUS peak_Frame_ID_Get(peak_frame_handle hFrame, uint64_t* frameID);
3688
3704PEAK_API_STATUS peak_Frame_Timestamp_Get(peak_frame_handle hFrame, uint64_t* timestamp_ns);
3705
3721PEAK_API_STATUS peak_Frame_ROI_Get(peak_frame_handle hFrame, peak_roi* roi);
3722
3739
3755
3771PEAK_API_STATUS peak_Frame_BytesExpected_Get(peak_frame_handle hFrame, size_t* bytesExpected);
3772
3788PEAK_API_STATUS peak_Frame_BytesWritten_Get(peak_frame_handle hFrame, size_t* bytesWritten);
3789
3805PEAK_API_STATUS peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t* processingTime_ms);
3806
3830PEAK_API_STATUS peak_Frame_Save(peak_frame_handle hFrame, const char* fileName);
3831
3888
3917 peak_parameter_set parameterSet);
3918
3958 size_t* parameterSetCount);
3959
3984
4007
4033
4059
4079
4106
4129PEAK_API_STATUS peak_CameraSettings_DiskFile_Store(peak_camera_handle hCam, const char* file);
4130
4153PEAK_API_STATUS peak_CameraSettings_DiskFile_Apply(peak_camera_handle hCam, const char* file);
4154
4180
4203PEAK_API_STATUS peak_FrameRate_GetRange(peak_camera_handle hCam, double* minFrameRate_fps, double* maxFrameRate_fps,
4204 double* incFrameRate_fps);
4205
4224PEAK_API_STATUS peak_FrameRate_Set(peak_camera_handle hCam, double frameRate_fps);
4225
4243PEAK_API_STATUS peak_FrameRate_Get(peak_camera_handle hCam, double* frameRate_fps);
4244
4270
4293PEAK_API_STATUS peak_ExposureTime_GetRange(peak_camera_handle hCam, double* minExposureTime_us,
4294 double* maxExposureTime_us, double* incExposureTime_us);
4295
4314PEAK_API_STATUS peak_ExposureTime_Set(peak_camera_handle hCam, double exposureTime_us);
4315
4333PEAK_API_STATUS peak_ExposureTime_Get(peak_camera_handle hCam, double* exposureTime_us);
4334
4360
4375
4401PEAK_API_STATUS peak_PixelClock_GetRange(peak_camera_handle hCam, double* minPixelClock_MHz, double* maxPixelClock_MHz,
4402 double* incPixelClock_MHz);
4403
4444PEAK_API_STATUS peak_PixelClock_GetList(peak_camera_handle hCam, double* pixelClockList, size_t* pixelClockCount);
4445
4466PEAK_API_STATUS peak_PixelClock_Set(peak_camera_handle hCam, double pixelClock_MHz);
4467
4485PEAK_API_STATUS peak_PixelClock_Get(peak_camera_handle hCam, double* pixelClock_MHz);
4486
4541
4571
4603PEAK_API_STATUS peak_IOChannel_GetList(peak_camera_handle hCam, peak_io_channel* ioChannelList, size_t* ioChannelCount);
4604
4633
4649
4679
4699
4715
4746
4766 peak_bool enabled);
4767
4783
4810 double* minNoiseFilterDuration_us, double* maxNoiseFilterDuration_us, double* incNoiseFilterDuration_us);
4811
4834 double noiseFilterDuration_us);
4835
4856 double* noiseFilterDuration_us);
4857
4885
4922
4938#define PEAK_TRIGGER_MODE_HARDWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_TRIGGER_INPUT }
4939
4953#define PEAK_TRIGGER_MODE_SOFTWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_SOFTWARE }
4954
4980
5000PEAK_API_STATUS peak_Trigger_Enable(peak_camera_handle hCam, peak_bool enabled);
5001
5016
5033
5057
5088
5118
5138
5174
5202
5242 size_t* triggerEdgeCount);
5243
5265
5285
5313
5338PEAK_API_STATUS peak_Trigger_Delay_GetRange(peak_camera_handle hCam, double* minTriggerDelay_us,
5339 double* maxTriggerDelay_us, double* incTriggerDelay_us);
5340
5361PEAK_API_STATUS peak_Trigger_Delay_Set(peak_camera_handle hCam, double triggerDelay_us);
5362
5381PEAK_API_STATUS peak_Trigger_Delay_Get(peak_camera_handle hCam, double* triggerDelay_us);
5382
5410
5435PEAK_API_STATUS peak_Trigger_Divider_GetRange(peak_camera_handle hCam, uint32_t* minTriggerDivider,
5436 uint32_t* maxTriggerDivider, uint32_t* incTriggerDivider);
5437
5457PEAK_API_STATUS peak_Trigger_Divider_Set(peak_camera_handle hCam, uint32_t triggerDivider);
5458
5477PEAK_API_STATUS peak_Trigger_Divider_Get(peak_camera_handle hCam, uint32_t* triggerDivider);
5478
5506
5531PEAK_API_STATUS peak_Trigger_Burst_GetRange(peak_camera_handle hCam, uint32_t* minTriggerBurst,
5532 uint32_t* maxTriggerBurst, uint32_t* incTriggerBurst);
5533
5553PEAK_API_STATUS peak_Trigger_Burst_Set(peak_camera_handle hCam, uint32_t triggerBurst);
5554
5573PEAK_API_STATUS peak_Trigger_Burst_Get(peak_camera_handle hCam, uint32_t* triggerBurst);
5574
5608
5646
5662#define PEAK_FLASH_MODE_EXPOSURE_ACTIVE { PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
5663
5677#define PEAK_FLASH_MODE_ACQUISITION_ACTIVE { PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
5678
5692#define PEAK_FLASH_MODE_GLOBAL_START_WINDOW { PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW, PEAK_IO_CHANNEL_FLASH_OUTPUT }
5693
5719
5738PEAK_API_STATUS peak_Flash_Enable(peak_camera_handle hCam, peak_bool enabled);
5739
5754
5784
5815
5835
5863
5888PEAK_API_STATUS peak_Flash_StartDelay_GetRange(peak_camera_handle hCam, double* minFlashStartDelay_us,
5889 double* maxFlashStartDelay_us, double* incFlashStartDelay_us);
5890
5910PEAK_API_STATUS peak_Flash_StartDelay_Set(peak_camera_handle hCam, double flashStartDelay_us);
5911
5930PEAK_API_STATUS peak_Flash_StartDelay_Get(peak_camera_handle hCam, double* flashStartDelay_us);
5931
5959
5984PEAK_API_STATUS peak_Flash_EndDelay_GetRange(peak_camera_handle hCam, double* minFlashEndDelay_us,
5985 double* maxFlashEndDelay_us, double* incFlashEndDelay_us);
5986
6007PEAK_API_STATUS peak_Flash_EndDelay_Set(peak_camera_handle hCam, double flashEndDelay_us);
6008
6027PEAK_API_STATUS peak_Flash_EndDelay_Get(peak_camera_handle hCam, double* flashEndDelay_us);
6028
6056
6081PEAK_API_STATUS peak_Flash_Duration_GetRange(peak_camera_handle hCam, double* minFlashDuration_us,
6082 double* maxFlashDuration_us, double* incFlashDuration_us);
6083
6102PEAK_API_STATUS peak_Flash_Duration_Set(peak_camera_handle hCam, double flashDuration_us);
6103
6122PEAK_API_STATUS peak_Flash_Duration_Get(peak_camera_handle hCam, double* flashDuration_us);
6123
6148
6169PEAK_API_STATUS peak_Focus_GetRange(peak_camera_handle hCam, uint32_t* minFocus, uint32_t* maxFocus,
6170 uint32_t* incFocus);
6171
6193PEAK_API_STATUS peak_Focus_Set(peak_camera_handle hCam, uint32_t focus);
6194
6212PEAK_API_STATUS peak_Focus_Get(peak_camera_handle hCam, uint32_t* focus);
6213
6239
6279 size_t* pixelFormatCount);
6280
6300
6319
6326typedef enum
6327{
6333
6336
6339
6342
6344
6372
6402 peak_gain_channel gainChannel);
6403
6438 peak_gain_channel* gainChannelList, size_t* gainChannelCount);
6439
6467PEAK_API_STATUS peak_Gain_GetRange(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
6468 double* minGain, double* maxGain, double* incGain);
6469
6493PEAK_API_STATUS peak_Gain_Set(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
6494 double gain);
6495
6518PEAK_API_STATUS peak_Gain_Get(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
6519 double* gain);
6520
6545
6566PEAK_API_STATUS peak_Gamma_GetRange(peak_camera_handle hCam, double* minGamma, double* maxGamma, double* incGamma);
6567
6586PEAK_API_STATUS peak_Gamma_Set(peak_camera_handle hCam, double gamma);
6587
6605PEAK_API_STATUS peak_Gamma_Get(peak_camera_handle hCam, double* gamma);
6606
6638
6664
6707 peak_color_correction_mode* colorCorrectionModeList, size_t* colorCorrectionModeCount);
6708
6731
6749
6775
6796PEAK_API_STATUS peak_ColorCorrection_Matrix_GetRange(peak_camera_handle hCam, double* minMatrixElementValue,
6797 double* maxMatrixElementValue, double* incMatrixElementValue);
6798
6817PEAK_API_STATUS peak_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix);
6818
6836PEAK_API_STATUS peak_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix* colorCorrectionMatrix);
6837
6854
6869
6905
6933
6967
6993
7014PEAK_API_STATUS peak_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t* minAutoBrightnessTarget,
7015 uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
7016
7035PEAK_API_STATUS peak_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget);
7036
7054PEAK_API_STATUS peak_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t* autoBrightnessTarget);
7055
7078 uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
7079 uint32_t* incAutoBrightnessTargetTolerance);
7080
7101 uint32_t autoBrightnessTargetTolerance);
7102
7121 uint32_t* autoBrightnessTargetTolerance);
7122
7145 double* minAutoBrightnessTargetPercentile, double* maxAutoBrightnessTargetPercentile,
7146 double* incAutoBrightnessTargetPercentile);
7147
7168 double autoBrightnessTargetPercentile);
7169
7188 double* autoBrightnessTargetPercentile);
7189
7209 peak_auto_feature_roi_mode autoBrightnessROIMode);
7210
7229 peak_auto_feature_roi_mode* autoBrightnessROIMode);
7230
7256 peak_position* minAutoBrightnessROIOffset, peak_position* maxAutoBrightnessROIOffset,
7257 peak_position* incAutoBrightnessROIOffset);
7258
7283PEAK_API_STATUS peak_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minAutoBrightnessROISize,
7284 peak_size* maxAutoBrightnessROISize, peak_size* incAutoBrightnessROISize);
7285
7311PEAK_API_STATUS peak_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI);
7312
7330PEAK_API_STATUS peak_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi* autoBrightnessROI);
7331
7359
7379
7398
7426
7446
7465
7491
7511 peak_auto_feature_roi_mode autoWhiteBalanceROIMode);
7512
7531 peak_auto_feature_roi_mode* autoWhiteBalanceROIMode);
7532
7560 peak_position* minAutoWhiteBalanceROIOffset, peak_position* maxAutoWhiteBalanceROIOffset,
7561 peak_position* incAutoWhiteBalanceROIOffset);
7562
7589PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minAutoWhiteBalanceROISize,
7590 peak_size* maxAutoWhiteBalanceROISize, peak_size* incAutoWhiteBalanceROISize);
7591
7617PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI);
7618
7636PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi* autoWhiteBalanceROI);
7637
7657
7676
7701
7726 peak_position* maxROIOffset, peak_position* incROIOffset);
7727
7752
7772
7791
7815PEAK_API_STATUS peak_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minROISize, peak_size* maxROISize,
7816 peak_size* incROISize);
7817
7842
7862
7881
7901PEAK_API_STATUS peak_ROI_Set(peak_camera_handle hCam, peak_roi roi);
7902
7920PEAK_API_STATUS peak_ROI_Get(peak_camera_handle hCam, peak_roi* roi);
7921
7946
7985PEAK_API_STATUS peak_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t* binningFactorXList,
7986 size_t* binningFactorXCount);
7987
8026PEAK_API_STATUS peak_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t* binningFactorYList,
8027 size_t* binningFactorYCount);
8028
8054PEAK_API_STATUS peak_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY);
8055
8074PEAK_API_STATUS peak_Binning_Get(peak_camera_handle hCam, uint32_t* binningFactorX, uint32_t* binningFactorY);
8075
8094
8117 peak_subsampling_engine subsamplingEngine);
8118
8159 peak_subsampling_engine subsamplingEngine, uint32_t* binningFactorXList, size_t* binningFactorXCount);
8160
8200 peak_subsampling_engine subsamplingEngine, uint32_t* binningFactorYList, size_t* binningFactorYCount);
8201
8226 peak_subsampling_engine subsamplingEngine, uint32_t binningFactorX, uint32_t binningFactorY);
8227
8248 peak_subsampling_engine subsamplingEngine, uint32_t *binningFactorX, uint32_t *binningFactorY);
8249
8275
8316PEAK_API_STATUS peak_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t* decimationFactorXList,
8317 size_t* decimationFactorXCount);
8318
8359PEAK_API_STATUS peak_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t* decimationFactorYList,
8360 size_t* decimationFactorYCount);
8361
8384PEAK_API_STATUS peak_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY);
8385
8404PEAK_API_STATUS peak_Decimation_Get(peak_camera_handle hCam, uint32_t* decimationFactorX, uint32_t* decimationFactorY);
8405
8431 peak_subsampling_engine subsamplingEngine);
8432
8474 peak_subsampling_engine subsamplingEngine, uint32_t* decimationFactorXList, size_t* decimationFactorXCount);
8475
8517 peak_subsampling_engine subsamplingEngine, uint32_t* decimationFactorYList, size_t* decimationFactorYCount);
8518
8543 peak_subsampling_engine subsamplingEngine, uint32_t decimationFactorX, uint32_t decimationFactorY);
8544
8565 peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorX, uint32_t *decimationFactorY);
8566
8592
8613PEAK_API_STATUS peak_Scaling_FactorX_GetRange(peak_camera_handle hCam, double* minScalingFactorX,
8614 double* maxScalingFactorX, double* incScalingFactorX);
8615
8636PEAK_API_STATUS peak_Scaling_FactorY_GetRange(peak_camera_handle hCam, double* minScalingFactorY,
8637 double* maxScalingFactorY, double* incScalingFactorY);
8638
8664PEAK_API_STATUS peak_Scaling_Set(peak_camera_handle hCam, double scalingFactorX, double scalingFactorY);
8665
8684PEAK_API_STATUS peak_Scaling_Get(peak_camera_handle hCam, double* scalingFactorX, double* scalingFactorY);
8685
8711
8729
8744
8770
8788
8803
8831
8860 peak_camera_memory_area cameraMemoryArea);
8861
8902 peak_camera_memory_area* cameraMemoryAreaList, size_t* cameraMemoryAreaCount);
8903
8927 peak_camera_memory_area cameraMemoryArea, size_t* cameraMemoryAreaSize);
8928
8950 peak_camera_memory_area cameraMemoryArea);
8951
8984 peak_camera_memory_area cameraMemoryArea, const uint8_t* data, size_t dataSize);
8985
9016 peak_camera_memory_area cameraMemoryArea, uint8_t* data, size_t dataSize);
9017
9055
9072
9106
9139 const char* featureName);
9140
9156PEAK_API_BOOL peak_GFA_Float_HasRange(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName);
9157
9191PEAK_API_STATUS peak_GFA_Float_GetRange(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
9192 double* minFloatValue, double* maxFloatValue, double* incFloatValue);
9193
9238PEAK_API_STATUS peak_GFA_Float_GetList(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
9239 double* floatList, size_t* floatCount);
9240
9271PEAK_API_STATUS peak_GFA_Float_Set(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
9272 double floatValue);
9273
9298PEAK_API_STATUS peak_GFA_Float_Get(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
9299 double* floatValue);
9300
9317 const char* integerFeatureName);
9318
9353 const char* integerFeatureName, int64_t* minIntegerValue, int64_t* maxIntegerValue, int64_t* incIntegerValue);
9354
9402 const char* integerFeatureName, int64_t* integerList, size_t* integerCount);
9403
9434PEAK_API_STATUS peak_GFA_Integer_Set(peak_camera_handle hCam, peak_gfa_module module, const char* integerFeatureName,
9435 int64_t integerValue);
9436
9461PEAK_API_STATUS peak_GFA_Integer_Get(peak_camera_handle hCam, peak_gfa_module module, const char* integerFeatureName,
9462 int64_t* integerValue);
9463
9493PEAK_API_STATUS peak_GFA_Boolean_Set(peak_camera_handle hCam, peak_gfa_module module, const char* booleanFeatureName,
9494 peak_bool booleanValue);
9495
9520PEAK_API_STATUS peak_GFA_Boolean_Get(peak_camera_handle hCam, peak_gfa_module module, const char* booleanFeatureName,
9521 peak_bool* booleanValue);
9522
9551PEAK_API_STATUS peak_GFA_String_Set(peak_camera_handle hCam, peak_gfa_module module, const char* stringFeatureName,
9552 const char* stringValue);
9553
9598PEAK_API_STATUS peak_GFA_String_Get(peak_camera_handle hCam, peak_gfa_module module, const char* stringFeatureName,
9599 char* stringValue, size_t* stringValueSize);
9600
9628 const char* commandFeatureName);
9629
9663 const char* commandFeatureName, uint32_t timeout_ms);
9664
9674 typedef struct
9675{
9677 char symbolicValue[64];
9678
9681
9683
9730 const char* enumerationFeatureName, peak_gfa_enumeration_entry* enumerationEntryList,
9731 size_t* enumerationEntryCount);
9732
9768 const char* enumerationFeatureName, const peak_gfa_enumeration_entry* enumerationEntry);
9769
9803 peak_gfa_module module, const char* enumerationFeatureName, const char* enumerationEntrySymbolicValue);
9804
9837 peak_gfa_module module, const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
9838
9873 const char* enumerationFeatureName, const peak_gfa_enumeration_entry* enumerationEntry);
9874
9907 const char* enumerationFeatureName, const char* enumerationEntrySymbolicValue);
9908
9940 const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
9941
9967 const char* enumerationFeatureName, peak_gfa_enumeration_entry* enumerationEntry);
9968
9999PEAK_API_STATUS peak_GFA_Register_Set(peak_camera_handle hCam, peak_gfa_module module, const char* registerFeatureName,
10000 const uint8_t* registerValue, size_t registerValueSize);
10001
10041PEAK_API_STATUS peak_GFA_Register_Get(peak_camera_handle hCam, peak_gfa_module module, const char* registerFeatureName,
10042 uint8_t* registerValue, size_t* registerValueSize);
10043
10073PEAK_API_STATUS peak_GFA_Data_Write(peak_camera_handle hCam, peak_gfa_module module, uint64_t address,
10074 const uint8_t* data, size_t dataSize);
10075
10100PEAK_API_STATUS peak_GFA_Data_Read(peak_camera_handle hCam, peak_gfa_module module, uint64_t address, uint8_t* data,
10101 size_t dataSize);
10102
10140 peak_pixel_format* outputPixelFormatList, size_t* outputPixelFormatCount);
10141
10166
10183
10202PEAK_API_STATUS peak_IPL_Gain_GetRange(peak_camera_handle hCam, peak_gain_channel gainChannel, double* minGain,
10203 double* maxGain, double* incGain);
10204
10224PEAK_API_STATUS peak_IPL_Gain_Set(peak_camera_handle hCam, peak_gain_channel gainChannel, double gain);
10225
10244PEAK_API_STATUS peak_IPL_Gain_Get(peak_camera_handle hCam, peak_gain_channel gainChannel, double* gain);
10245
10263PEAK_API_STATUS peak_IPL_Gamma_GetRange(peak_camera_handle hCam, double* minGamma, double* maxGamma, double* incGamma);
10264
10281PEAK_API_STATUS peak_IPL_Gamma_Set(peak_camera_handle hCam, double gamma);
10282
10298PEAK_API_STATUS peak_IPL_Gamma_Get(peak_camera_handle hCam, double* gamma);
10299
10314PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix);
10315
10331PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix* colorCorrectionMatrix);
10332
10348PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Get(peak_camera_handle hCam, double* saturation);
10349
10366PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Set(peak_camera_handle hCam, double saturation);
10367
10386PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_GetRange(peak_camera_handle hCam, double* minSaturation, double* maxSaturation, double* incSaturation);
10387
10403
10418
10437PEAK_API_STATUS peak_IPL_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t* minAutoBrightnessTarget,
10438 uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
10439
10456PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget);
10457
10473PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t* autoBrightnessTarget);
10474
10495 uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
10496 uint32_t* incAutoBrightnessTargetTolerance);
10497
10516 uint32_t autoBrightnessTargetTolerance);
10517
10534 uint32_t* autoBrightnessTargetTolerance);
10535
10556 double* minAutoBrightnessTargetPercentile, double* maxAutoBrightnessTargetPercentile,
10557 double* incAutoBrightnessTargetPercentile);
10558
10577 double autoBrightnessTargetPercentile);
10578
10595 double* autoBrightnessTargetPercentile);
10596
10614 peak_auto_feature_roi_mode autoBrightnessROIMode);
10615
10632 peak_auto_feature_roi_mode* autoBrightnessROIMode);
10633
10656 peak_position* minAutoBrightnessROIOffset, peak_position* maxAutoBrightnessROIOffset,
10657 peak_position* incAutoBrightnessROIOffset);
10658
10681 peak_size* minAutoBrightnessROISize, peak_size* maxAutoBrightnessROISize, peak_size* incAutoBrightnessROISize);
10682
10707PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI);
10708
10724PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi* autoBrightnessROI);
10725
10743 peak_auto_feature_mode autoExposureMode);
10744
10761 peak_auto_feature_mode* autoExposureMode);
10762
10769typedef struct
10770{
10772 double min;
10774 double max;
10775}
10777
10792
10807
10826
10843
10862
10879
10898
10915
10933
10950
10969
10986
11004
11021
11037PEAK_API_STATUS peak_IPL_AutoBrightness_AverageLast_Get(peak_camera_handle hCam, uint32_t* lastAverage);
11038
11060
11075
11093
11115
11130
11147
11169
11184
11201
11223
11238
11255
11277
11292
11309
11322PEAK_API_STATUS peak_IPL_AutoBrightness_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames);
11323
11337PEAK_API_STATUS peak_IPL_AutoBrightness_SkipFrames_Get(peak_camera_handle hCam, uint32_t* skipFrames);
11338
11356 uint32_t* skipFramesMin, uint32_t* skipFramesMax, uint32_t* skipFramesInc);
11357
11375 peak_auto_feature_roi_mode autoWhiteBalanceROIMode);
11376
11393 peak_auto_feature_roi_mode* autoWhiteBalanceROIMode);
11394
11417 peak_position* minAutoWhiteBalanceROIOffset, peak_position* maxAutoWhiteBalanceROIOffset,
11418 peak_position* incAutoWhiteBalanceROIOffset);
11419
11442 peak_size* minAutoWhiteBalanceROISize, peak_size* maxAutoWhiteBalanceROISize,
11443 peak_size* incAutoWhiteBalanceROISize);
11444
11471PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI);
11472
11488PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi* autoWhiteBalanceROI);
11489
11507
11524 peak_auto_feature_mode* autoWhiteBalanceMode);
11525
11526
11539PEAK_API_STATUS peak_IPL_AutoWhiteBalance_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames);
11540
11554PEAK_API_STATUS peak_IPL_AutoWhiteBalance_SkipFrames_Get(peak_camera_handle hCam, uint32_t* skipFrames);
11555
11573 uint32_t* skipFramesMin, uint32_t* skipFramesMax, uint32_t* skipFramesInc);
11574
11597
11598#pragma pack(push, 1)
11599
11604typedef struct
11605{
11608
11611
11613#pragma pack(pop)
11614
11640
11661PEAK_API_STATUS peak_IPL_AutoFocus_ROI_Set(peak_camera_handle hCam, const peak_focus_roi* autoFocusROIList,
11662 size_t autoFocusROICount);
11663
11695PEAK_API_STATUS peak_IPL_AutoFocus_ROI_Get(peak_camera_handle hCam, peak_focus_roi* autoFocusROIList,
11696 size_t* autoFocusROICount);
11697
11715
11732
11771
11794 peak_auto_focus_search_algorithm searchAlgorithm);
11795
11814 peak_auto_focus_search_algorithm* searchAlgorithm);
11815
11853
11876 peak_sharpness_algorithm sharpnessAlgorithm);
11877
11896 peak_sharpness_algorithm* sharpnessAlgorithm);
11897
11917PEAK_API_STATUS peak_IPL_AutoFocus_Range_Set(peak_camera_handle hCam, uint32_t rangeBegin, uint32_t rangeEnd);
11918
11937PEAK_API_STATUS peak_IPL_AutoFocus_Range_Get(peak_camera_handle hCam, uint32_t* rangeBegin, uint32_t* rangeEnd);
11938
11957PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Set(peak_camera_handle hCam, uint8_t hysteresis);
11958
11976PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Get(peak_camera_handle hCam, uint8_t* hysteresis);
11977
11998PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_GetRange(peak_camera_handle hCam, uint8_t* minHysteresis,
11999 uint8_t* maxHysteresis, uint8_t* incHysteresis);
12000
12042
12063 peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity);
12064
12081 peak_hotpixel_correction_sensitivity* hotpixelCorrectionSensitivity);
12082
12118 size_t* hotpixelCount);
12119
12140 size_t hotpixelCount);
12141
12160
12177
12192
12209
12224
12241
12256
12281 peak_frame_handle* hResultFrame);
12282
12310
12327
12342
12343
12360PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_Set(peak_camera_handle hCam, uint32_t factor);
12361
12377PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_Get(peak_camera_handle hCam, uint32_t* factor);
12378
12394PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_GetDefault(peak_camera_handle hCam, uint32_t* defaultFactor);
12395
12414 uint32_t* minFactor, uint32_t* maxFactor, uint32_t* incFactor);
12415
12437 peak_sharpness_algorithm sharpnessAlgorithm, double* calculatedValue);
12438
12466PEAK_API_STATUS peak_IPL_Sharpness_GetList(peak_sharpness_algorithm sharpnessAlgorithm, peak_pixel_format* pixelFormatList, size_t* pixelFormatSize);
12467
12479typedef struct peak_video* peak_video_handle;
12480
12487typedef enum
12488{
12494
12497
12499
12506typedef enum
12507{
12513
12516
12518
12534PEAK_API_STATUS peak_VideoWriter_Open(peak_video_handle* hVideo, const char* fileName,
12535 peak_video_container container, peak_video_encoder encoder);
12536
12551
12568
12598 peak_video_encoder* encoderList, size_t* encoderCount);
12599
12638 peak_pixel_format* pixelFormatList, size_t* pixelFormatCount);
12639
12669 peak_video_container* containerList, size_t* containerCount);
12670
12678typedef struct
12679{
12680 /* \brief Overall encoded frames */
12681 uint64_t encodedFrames;
12682
12683 /* \brief Overall dropped frames */
12684 uint64_t droppedFrames;
12685
12686 /* \brief Current file size in bytes */
12687 uint64_t fileSize;
12688
12689 uint8_t reserved[256];
12691
12707
12729
12751
12770 peak_video_container_option containerOption, const void* value, size_t count);
12771
12791 peak_video_container_option containerOption, void* value, size_t count, size_t* outCount);
12792
12811 peak_video_encoder_option encoderOption, const void* value, size_t count);
12812
12832 peak_video_encoder_option encoderOption, void* value, size_t count, size_t* outCount);
12833
12848PEAK_API_STATUS peak_VideoWriter_WaitUntilQueueEmpty(peak_video_handle hVideo, int32_t timeout_ms);
12849
12854typedef struct peak_inference* peak_inference_handle;
12855
12860typedef struct peak_inference_result* peak_inference_result_handle;
12861
12882
12900
12905typedef struct
12906{
12909
12911 float score;
12912
12914 char label[256];
12915
12918
12920
12925typedef struct
12926{
12929
12931 float score;
12932
12934 char label[256];
12935
12937
12942typedef struct
12943{
12946
12949
12952
12955
12957 char reserved[256];
12958
12960
12965typedef struct
12966{
12968 uint32_t major;
12969
12971 uint32_t minor;
12972
12974 uint32_t subMinor;
12975
12977 uint32_t patch;
12978} peak_version;
12979
12980
12985typedef struct
12986{
12989
12991 char lighthouseID[256];
12992
12995
12997 char projectName[256];
12998
13000 char networkName[256];
13001
13004
13007
13010
13013
13016
13019
13021 uint8_t reserved[256];
13023
13038PEAK_API_STATUS peak_Inference_CNN_Open(const char* path, peak_inference_handle* hInference);
13039
13053
13072 peak_inference_result_handle* hInferenceHandle);
13073
13089
13106
13121
13151 peak_inference_result_classification* resultList, size_t* resultCount);
13152
13182 peak_inference_result_detection* resultList, size_t* resultCount);
13183
13184typedef struct
13185{
13187 uint32_t numInferencesSuccessful;
13188
13190 uint32_t numInferencesFailed;
13191
13193 char reserved[256];
13194} peak_inference_statistics;
13195
13210PEAK_API_STATUS peak_Inference_Statistics_Get(peak_inference_handle hInference, peak_inference_statistics* statistics);
13211
13225
13240PEAK_API_STATUS peak_Inference_ConfidenceThreshold_Get(peak_inference_handle hInference, uint32_t* threshold);
13241
13258PEAK_API_STATUS peak_Inference_ConfidenceThreshold_GetRange(peak_inference_handle hInference, uint32_t* minThreshold,
13259 uint32_t* maxThreshold, uint32_t* incThreshold);
13260
13275PEAK_API_STATUS peak_Inference_ConfidenceThreshold_Set(peak_inference_handle hInference, uint32_t threshold);
13276
13294
13302typedef enum
13303{
13306
13312
13318
13324
13330
13336
13342
13348
13354
13360
13366
13372
13378
13385
13392
13397
13402
13410
13418
13425
13432
13439
13446
13454
13501
13508typedef struct
13509{
13512
13514 uint8_t reserved[32];
13516
13523typedef struct
13524{
13527
13529 int64_t error_type;
13530
13532 uint8_t reserved[32];
13534
13541typedef struct
13542{
13545
13547 int64_t count;
13548
13550 uint8_t reserved[32];
13552
13559typedef struct
13560{
13563
13565 int64_t frameId;
13566
13568 uint8_t reserved[32];
13570
13577typedef struct
13578{
13581
13584
13586 uint8_t reserved[32];
13588
13595typedef struct
13596{
13598 int32_t focusValue;
13599
13602
13604 uint8_t reserved[32];
13606
13613typedef struct {
13616
13618 uint8_t reserved[32];
13620
13627typedef struct
13628{
13631
13633 uint8_t reserved[32];
13635
13642typedef struct
13643{
13646
13647 peak_reconnect_information reconnectInformation;
13648
13650 uint8_t reserved[32];
13652
13659typedef struct
13660{
13663
13665 uint8_t reserved[32];
13667
13691
13707
13712typedef struct
13713{
13719
13721 char serialNumber[64];
13722
13725
13728
13733
13736 char description[256];
13737
13739 char reserved[32];
13741
13746typedef struct
13747{
13749 uint64_t numQueued;
13750
13753
13755 uint64_t numDropped;
13756
13758 uint64_t numInQueue;
13759
13762
13764 uint8_t reserved[32];
13766
13771typedef struct
13772{
13775
13778
13780 uint64_t messageID;
13781
13784
13787
13789 uint8_t reserved[256];
13791
13797typedef struct peak_message_queue* peak_message_queue_handle;
13798
13804typedef struct peak_message* peak_message_handle;
13805
13818
13833
13857 peak_camera_handle hCam, peak_message_type messageType);
13881 peak_camera_handle hCam, peak_message_type messageType);
13882
13907 peak_camera_handle hCam, const peak_message_type* messageTypesArray, size_t messageTypesArraySize);
13908
13933 peak_camera_handle hCam, const peak_message_type* messageTypesArray, size_t messageTypesArraySize);
13934
13967 peak_message_type* messageTypesArray, size_t* messageTypesArraySize);
13968
13990 peak_message_queue_mode queueMode);
13991
14009 peak_message_queue_mode* queueMode);
14010
14026
14045
14058
14088 uint32_t timeout_ms, peak_message_handle* hMessage);
14089
14105
14124 peak_camera_handle hCam, peak_message_type messageType);
14125
14142 peak_message_queue_statistics_info* messageQueueInfo);
14143
14158
14182 size_t messageQueueMaxSize);
14183
14200 size_t* messageQueueMaxSize);
14201
14216
14233 peak_message_info* messageInfo);
14234
14251 peak_message_type* messageType);
14252
14270 peak_camera_handle* hCam);
14271
14287PEAK_API_STATUS peak_Message_ID_Get(peak_message_handle hMessage, uint64_t* messageID);
14288
14306 uint64_t* hostTimestamp_ns);
14307
14339 peak_message_data_type* messageType);
14340
14367
14387
14407
14427
14447
14467
14487
14507
14525
14543
14561
14567typedef struct peak_i2c* peak_i2c_handle;
14568
14583
14598PEAK_API_STATUS peak_I2C_Destroy(peak_i2c_handle hI2C);
14599
14625PEAK_API_ACCESS_STATUS peak_I2C_GetAccessStatus(peak_i2c_handle hI2C);
14626
14647
14687PEAK_API_STATUS peak_I2C_Mode_GetList(peak_i2c_handle hI2C, peak_i2c_mode* modeList, size_t* modeListSize);
14688
14711
14732
14760PEAK_API_STATUS peak_I2C_DeviceAddress_GetRange(peak_i2c_handle hI2C, uint32_t* minAddress, uint32_t* maxAddress);
14761
14784PEAK_API_STATUS peak_I2C_DeviceAddress_Set(peak_i2c_handle hI2C, uint32_t address);
14785
14805PEAK_API_STATUS peak_I2C_DeviceAddress_Get(peak_i2c_handle hI2C, uint32_t* address);
14806
14829
14859 peak_i2c_register_address_length* i2cLengthList, size_t* i2cLengthCount);
14860
14879
14900
14926
14947
14968
14994PEAK_API_STATUS peak_I2C_RegisterAddress_Set(peak_i2c_handle hI2C, uint32_t address);
14995
15015PEAK_API_STATUS peak_I2C_RegisterAddress_Get(peak_i2c_handle hI2C, uint32_t* address);
15016
15041
15056
15083
15108PEAK_API_STATUS peak_I2C_AckPolling_Timeout_GetRange(peak_i2c_handle hI2C, uint32_t* minTimeout_ms, uint32_t* maxTimeout_ms, uint32_t* incTimeout_ms);
15109
15130PEAK_API_STATUS peak_I2C_AckPolling_Timeout_Set(peak_i2c_handle hI2C, uint32_t timeout_ms);
15131
15151PEAK_API_STATUS peak_I2C_AckPolling_Timeout_Get(peak_i2c_handle hI2C, uint32_t* timeout_ms);
15152
15184PEAK_API_STATUS peak_I2C_Data_Write(peak_i2c_handle hI2C, const uint8_t* data, size_t dataSize);
15185
15206PEAK_API_STATUS peak_I2C_Data_Read(peak_i2c_handle hI2C, size_t maxDataSize, uint8_t* data, size_t* dataSize);
15207
15227PEAK_API_STATUS peak_I2C_Data_MaxSize_Get(peak_i2c_handle hI2C, size_t* maxDataSize);
15228
15255
15275
15276
15282typedef struct peak_imagewriter* peak_imagewriter_handle;
15283
15296
15312
15329PEAK_API_STATUS peak_IPL_ImageWriter_Save(peak_imagewriter_handle hImageWriter, peak_frame_handle hFrame, const char* fileName);
15330
15382
15399
15416
15432PEAK_API_STATUS peak_IPL_ImageWriter_Compression_Set(peak_imagewriter_handle hImageWriter, uint32_t compression);
15433
15449PEAK_API_STATUS peak_IPL_ImageWriter_Compression_Get(peak_imagewriter_handle hImageWriter, uint32_t* compression);
15450
15481PEAK_API_STATUS peak_IPL_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t* binningFactorXList,
15482 size_t* binningFactorXCount);
15483
15513PEAK_API_STATUS peak_IPL_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t* binningFactorYList,
15514 size_t* binningFactorYCount);
15515
15539PEAK_API_STATUS peak_IPL_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY);
15540
15557PEAK_API_STATUS peak_IPL_Binning_Get(peak_camera_handle hCam, uint32_t* binningFactorX, uint32_t* binningFactorY);
15558
15591PEAK_API_STATUS peak_IPL_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t* decimationFactorXList,
15592 size_t* decimationFactorXCount);
15593
15626PEAK_API_STATUS peak_IPL_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t* decimationFactorYList,
15627 size_t* decimationFactorYCount);
15628
15649PEAK_API_STATUS peak_IPL_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY);
15650
15667PEAK_API_STATUS peak_IPL_Decimation_Get(peak_camera_handle hCam, uint32_t* decimationFactorX, uint32_t* decimationFactorY);
15668
15695PEAK_API_STATUS peak_FirmwareUpdate_CompatibleCameraList_Get(const char* gufFileName, peak_camera_descriptor* cameraList, size_t* cameraCount);
15696
15721PEAK_API_STATUS peak_FirmwareUpdate_Execute(peak_camera_id cameraID, const char* gufFileName);
15722
15779
15805
15827
15847
15882 size_t* testPatternCount);
15883
15902
15935
15961
15995PEAK_API_STATUS peak_LED_Target_GetList(peak_camera_handle hCam, peak_led_target* targetList, size_t* targetCount);
15996
16031PEAK_API_STATUS peak_LED_Mode_GetList(peak_camera_handle hCam, peak_led_target target, peak_led_mode* modeList, size_t* ledModeCount);
16032
16057
16078
16079
16080#ifdef __cplusplus
16081} // extern "C"
16082#endif // __cplusplus
16083
16084#endif // PEAK_COMFORT_C_H
PEAK_API_BOOL peak_Acquisition_IsStarted(peak_camera_handle hCam)
Check whether the acquisition is currently started or not.
PEAK_API_STATUS peak_Acquisition_WaitForFrame(peak_camera_handle hCam, uint32_t timeout_ms, peak_frame_handle *hFrame)
Wait for an acquired frame.
PEAK_API_STATUS peak_Acquisition_Stop(peak_camera_handle hCam)
Stops an acquisition.
PEAK_API_STATUS peak_Acquisition_Start(peak_camera_handle hCam, uint32_t numberOfFrames)
Start an acquisition.
PEAK_API_STATUS peak_Acquisition_GetInfo(peak_camera_handle hCam, peak_acquisition_info *acquisitionInfo)
Query the acquisition info.
PEAK_API_STATUS peak_AutoBrightness_TargetTolerance_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
Get the auto brightness target tolerance value.
PEAK_API_STATUS peak_AutoBrightness_TargetPercentile_Get(peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
Get the auto brightness target percentile value.
PEAK_API_ACCESS_STATUS peak_AutoBrightness_Exposure_GetAccessStatus(peak_camera_handle hCam)
Query the auto exposure control access status.
PEAK_API_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_API_STATUS peak_AutoBrightness_TargetTolerance_Set(peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
Set the auto brightness target tolerance value.
PEAK_API_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_API_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_API_STATUS peak_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi *autoBrightnessROI)
Get the auto brightness ROI.
PEAK_API_STATUS peak_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget)
Set the auto brightness target value.
PEAK_API_ACCESS_STATUS peak_AutoBrightness_GetAccessStatus(peak_camera_handle hCam)
Query the auto brightness access status.
PEAK_API_ACCESS_STATUS peak_AutoBrightness_Gain_GetAccessStatus(peak_camera_handle hCam)
Query the auto gain control access status.
PEAK_API_STATUS peak_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the auto gain control mode.
PEAK_API_STATUS peak_AutoBrightness_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
Get the auto brightness ROI mode.
PEAK_API_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_API_STATUS peak_AutoBrightness_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
Set the auto brightness ROI mode.
PEAK_API_STATUS peak_AutoBrightness_Exposure_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
Get the auto exposure control mode.
PEAK_API_STATUS peak_AutoBrightness_TargetPercentile_Set(peak_camera_handle hCam, double autoBrightnessTargetPercentile)
Set the auto brightness target percentile value.
PEAK_API_STATUS peak_AutoBrightness_Exposure_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
Set the auto exposure control mode.
PEAK_API_STATUS peak_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI)
Set the auto brightness ROI.
PEAK_API_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_API_STATUS peak_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the auto gain control mode.
PEAK_API_STATUS peak_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
Get the auto brightness target value.
PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
Set the auto white balance ROI mode.
PEAK_API_STATUS peak_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
Get the auto white balance control mode.
PEAK_API_STATUS peak_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
Set the auto white balance control mode.
PEAK_API_ACCESS_STATUS peak_AutoWhiteBalance_GetAccessStatus(peak_camera_handle hCam)
Query the auto white balance access status.
PEAK_API_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_API_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_API_STATUS peak_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
Set the auto white balance ROI.
PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
Get the auto white balance ROI.
PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
Get the auto white balance ROI mode.
PEAK_API_ACCESS_STATUS peak_BinningManual_GetAccessStatus(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine)
Query the binning manual access status.
PEAK_API_STATUS peak_BinningManual_Set(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t binningFactorX, uint32_t binningFactorY)
Set the binning factors.
PEAK_API_STATUS peak_BinningManual_Get(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *binningFactorX, uint32_t *binningFactorY)
Get the binning factors.
PEAK_API_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_API_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_API_ACCESS_STATUS peak_Binning_GetAccessStatus(peak_camera_handle hCam)
Query the binning access status.
PEAK_API_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_API_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_API_STATUS peak_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
Set the binning factors.
PEAK_API_STATUS peak_Binning_Get(peak_camera_handle hCam, uint32_t *binningFactorX, uint32_t *binningFactorY)
Get the binning factors.
PEAK_API_STATUS peak_Acquisition_BufferHandling_Mode_Get(peak_camera_handle hCam, peak_buffer_handling_mode *mode)
Get the buffer handling mode.
PEAK_API_STATUS peak_Acquisition_BufferHandling_Mode_Set(peak_camera_handle hCam, peak_buffer_handling_mode mode)
Set the buffer handling mode.
PEAK_API_ACCESS_STATUS peak_Acquisition_BufferHandling_Mode_GetAccessStatus(peak_camera_handle hCam)
Query the buffer handling mode access status.
PEAK_API_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_buffer_handling_mode
peak buffer handling modes
Definition ids_peak_comfort_c.h:2673
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST_SINGLE_BUFFER
Oldest First Single Buffer Mode.
Definition ids_peak_comfort_c.h:2719
@ PEAK_BUFFER_HANDLING_MODE_NEWEST_ONLY
Newest Only Mode.
Definition ids_peak_comfort_c.h:2701
@ PEAK_BUFFER_HANDLING_MODE_INVALID
Invalid buffer handling mode.
Definition ids_peak_comfort_c.h:2678
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST_DEPEND_ON_CAMERA_FIFO
Oldest First Depend On Camera FIFO Mode.
Definition ids_peak_comfort_c.h:2733
@ PEAK_BUFFER_HANDLING_MODE_OLDEST_FIRST
Oldest First Mode.
Definition ids_peak_comfort_c.h:2692
PEAK_API_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_camera_memory_area
peak Camera Memory Area
Definition ids_peak_comfort_c.h:8811
PEAK_API_STATUS peak_CameraMemory_Area_Data_Clear(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea)
Clear a camera memory area.
PEAK_API_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_API_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_API_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_API_ACCESS_STATUS peak_CameraMemory_Area_GetAccessStatus(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea)
Query the camera memory area access status.
@ PEAK_CAMERA_MEMORY_AREA_USER_DATA_2
Cameras User Data 2 memory.
Definition ids_peak_comfort_c.h:8828
@ PEAK_CAMERA_MEMORY_AREA_INVALID
Invalid memory area.
Definition ids_peak_comfort_c.h:8816
@ PEAK_CAMERA_MEMORY_AREA_USER_DATA_1
Cameras User Data 1 memory.
Definition ids_peak_comfort_c.h:8822
PEAK_API_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_API_STATUS peak_CameraSettings_ParameterSet_Startup_Get(peak_camera_handle hCam, peak_parameter_set *parameterSet)
Get the startup parameter set.
PEAK_API_ACCESS_STATUS peak_CameraSettings_DiskFile_GetAccessStatus(peak_camera_handle hCam)
Query the disk file settings access status.
PEAK_API_STATUS peak_CameraSettings_DiskFile_Store(peak_camera_handle hCam, const char *file)
Store the current camera configuration to a disk file.
PEAK_API_ACCESS_STATUS peak_CameraSettings_ParameterSet_Startup_GetAccessStatus(peak_camera_handle hCam)
Query the startup parameter set access status.
peak_parameter_set
peak Parameter set
Definition ids_peak_comfort_c.h:3848
PEAK_API_ACCESS_STATUS peak_CameraSettings_ParameterSet_GetAccessStatus(peak_camera_handle hCam, peak_parameter_set parameterSet)
Query the parameter set access status.
PEAK_API_STATUS peak_CameraSettings_ParameterSet_Startup_Set(peak_camera_handle hCam, peak_parameter_set parameterSet)
Set the startup parameter set.
PEAK_API_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_API_STATUS peak_CameraSettings_ParameterSet_Apply(peak_camera_handle hCam, peak_parameter_set parameterSet)
Apply the specified parameter set.
PEAK_API_STATUS peak_CameraSettings_DiskFile_Apply(peak_camera_handle hCam, const char *file)
Apply the camera configuration from the specified disk file.
@ PEAK_PARAMETER_SET_LONG_EXPOSURE
Long exposure set.
Definition ids_peak_comfort_c.h:3871
@ PEAK_PARAMETER_SET_USER_1
User set 1.
Definition ids_peak_comfort_c.h:3878
@ PEAK_PARAMETER_SET_INVALID
Invalid parameter set.
Definition ids_peak_comfort_c.h:3853
@ PEAK_PARAMETER_SET_LINESCAN
Linescan set.
Definition ids_peak_comfort_c.h:3865
@ PEAK_PARAMETER_SET_USER_2
User set 2.
Definition ids_peak_comfort_c.h:3885
@ PEAK_PARAMETER_SET_DEFAULT
Default set.
Definition ids_peak_comfort_c.h:3859
PEAK_API_STATUS peak_CameraList_Get(peak_camera_descriptor *cameraList, size_t *cameraCount)
Query the current camera list.
PEAK_API_STATUS peak_Camera_GetDescriptor(peak_camera_id cameraID, peak_camera_descriptor *cameraDescriptor)
Query the camera descriptor.
PEAK_API_STATUS peak_CameraList_Update(size_t *cameraCount)
Update the camera list.
uint64_t peak_camera_id
peak Camera ID
Definition ids_peak_comfort_c.h:1468
PEAK_API_STATUS peak_Camera_UserDefinedName_Get(peak_camera_handle hCam, char *userDefinedName, size_t *userDefinedNameSize)
Get the user defined name.
struct peak_camera * peak_camera_handle
peak Camera handle
Definition ids_peak_comfort_c.h:1453
PEAK_API_CAMERA_ID peak_Camera_ID_FromHandle(peak_camera_handle hCam)
Query the camera id by the camera handle.
PEAK_API_STATUS peak_Camera_OpenFirstAvailable(peak_camera_handle *hCam)
Open the first available camera.
PEAK_API_CAMERA_ID peak_Camera_ID_FromMAC(peak_mac_address macAddress)
Query the camera id by the mac address.
PEAK_API_ACCESS_STATUS peak_Camera_GetAccessStatus(peak_camera_id cameraID)
Query the camera access status.
PEAK_API_STATUS peak_Camera_Open(peak_camera_id cameraID, peak_camera_handle *hCam)
Open the camera by the Camera id.
PEAK_API_STATUS peak_Camera_Close(peak_camera_handle hCam)
Close the camera.
PEAK_API_BOOL peak_Camera_IsConnected(peak_camera_handle hCam)
Get the connected status of the camera.
PEAK_API_CAMERA_ID peak_Camera_ID_FromUserDefinedName(const char *userDefinedName)
Query the camera id by the user defined name.
PEAK_API_STATUS peak_Camera_UserDefinedName_Set(peak_camera_handle hCam, const char *userDefinedName)
Set the user defined name.
peak_camera_type
peak Camera types
Definition ids_peak_comfort_c.h:1421
PEAK_API_CAMERA_ID peak_Camera_ID_FromSerialNumber(const char *serialNumber)
Query the camera id by the serial number.
PEAK_API_STATUS peak_Camera_ResetToDefaultSettings(peak_camera_handle hCam)
Reset the camera configuration.
PEAK_API_STATUS peak_Camera_Reboot(peak_camera_handle hCam)
Reboot the camera.
@ PEAK_CAMERA_TYPE_UEYE_USB
uEye USB camera
Definition ids_peak_comfort_c.h:1429
@ PEAK_CAMERA_TYPE_UEYE_PLUS_GEV
uEye+ GigE Vision camera
Definition ids_peak_comfort_c.h:1438
@ PEAK_CAMERA_TYPE_UEYE_PLUS_U3V
uEye+ USB3 Vision camera
Definition ids_peak_comfort_c.h:1435
@ PEAK_CAMERA_TYPE_INVALID
Invalid camera type.
Definition ids_peak_comfort_c.h:1426
@ PEAK_CAMERA_TYPE_UEYE_ETH
uEye Eth camera
Definition ids_peak_comfort_c.h:1432
PEAK_API_STATUS peak_ColorCorrection_Mode_Set(peak_camera_handle hCam, peak_color_correction_mode colorCorrectionMode)
Set the color correction mode.
PEAK_API_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_API_STATUS peak_ColorCorrection_Mode_Get(peak_camera_handle hCam, peak_color_correction_mode *colorCorrectionMode)
Get the color correction mode.
PEAK_API_STATUS peak_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the color correction.
PEAK_API_STATUS peak_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
Get the color correction matrix.
PEAK_API_ACCESS_STATUS peak_ColorCorrection_GetAccessStatus(peak_camera_handle hCam)
Query the color correction access status.
PEAK_API_STATUS peak_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
Sets the color correction matrix for the current selected color correction.
PEAK_API_BOOL peak_ColorCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the color correction.
peak_color_correction_mode
peak Color correction mode
Definition ids_peak_comfort_c.h:6615
PEAK_API_ACCESS_STATUS peak_ColorCorrection_Matrix_GetAccessStatus(peak_camera_handle hCam)
Query the color correction matrix access status.
PEAK_API_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_COLOR_CORRECTION_MODE_HQ
HQ.
Definition ids_peak_comfort_c.h:6626
@ PEAK_COLOR_CORRECTION_MODE_INVALID
Invalid color correction.
Definition ids_peak_comfort_c.h:6620
@ PEAK_COLOR_CORRECTION_MODE_USER_1
User 1.
Definition ids_peak_comfort_c.h:6635
PEAK_API_STATUS peak_DecimationManual_Set(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t decimationFactorX, uint32_t decimationFactorY)
Set the decimation factors.
PEAK_API_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_API_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_API_STATUS peak_DecimationManual_Get(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
Get the decimation factors.
PEAK_API_ACCESS_STATUS peak_DecimationManual_GetAccessStatus(peak_camera_handle hCam, peak_subsampling_engine subsamplingEngine)
Query the decimation manual access status.
PEAK_API_STATUS peak_Decimation_Get(peak_camera_handle hCam, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
Get the decimation factors.
PEAK_API_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_API_STATUS peak_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY)
Set the decimation factors.
PEAK_API_ACCESS_STATUS peak_Decimation_GetAccessStatus(peak_camera_handle hCam)
Query the decimation access status.
PEAK_API_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_ethernet_status
peak Ethernet status
Definition ids_peak_comfort_c.h:2054
PEAK_API_ACCESS_STATUS peak_EthernetConfig_GetAccessStatus(peak_camera_id cameraID)
Query the ethernet configuration access status.
PEAK_API_BOOL peak_EthernetConfig_DHCP_IsEnabled(peak_camera_id cameraID)
Get the enabled status of dhcp.
PEAK_API_STATUS peak_EthernetConfig_PersistentIP_Get(peak_camera_id cameraID, peak_ip_config *persistentIP)
Get the persistent ip.
PEAK_API_STATUS peak_EthernetConfig_PersistentIP_Set(peak_camera_id cameraID, peak_ip_config persistentIP)
Set the persistent ip.
PEAK_API_ACCESS_STATUS peak_EthernetConfig_DHCP_GetAccessStatus(peak_camera_id cameraID)
Query the dhcp access status.
PEAK_API_STATUS peak_EthernetConfig_DHCP_Enable(peak_camera_id cameraID, peak_bool enabled)
Enable/Disable dhcp.
PEAK_API_ACCESS_STATUS peak_EthernetConfig_PersistentIP_GetAccessStatus(peak_camera_id cameraID)
Query the persistent ip access status.
PEAK_API_STATUS peak_EthernetConfig_GetInfo(peak_camera_id cameraID, peak_ethernet_info *ethernetInfo)
Query the ethernet information.
@ PEAK_ETHERNET_STATUS_SUBNET_MISMATCH
The camera persistent IP is not in the hosts subnet.
Definition ids_peak_comfort_c.h:2079
@ PEAK_ETHERNET_STATUS_INVALID
Invalid ethernet status.
Definition ids_peak_comfort_c.h:2059
@ PEAK_ETHERNET_STATUS_NOK
The cameras ethernet status is not ok.
Definition ids_peak_comfort_c.h:2071
@ PEAK_ETHERNET_STATUS_OK
The cameras ethernet status is ok.
Definition ids_peak_comfort_c.h:2065
@ PEAK_ETHERNET_STATUS_INAPPLICABLE_IP
The camera IP is not applicable.
Definition ids_peak_comfort_c.h:2088
PEAK_API_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_API_STATUS peak_ExposureTime_Set(peak_camera_handle hCam, double exposureTime_us)
Set the exposure time.
PEAK_API_STATUS peak_ExposureTime_Get(peak_camera_handle hCam, double *exposureTime_us)
Get the exposure time.
PEAK_API_ACCESS_STATUS peak_ExposureTime_GetAccessStatus(peak_camera_handle hCam)
Query the exposure time access status.
peak_firmware_update_status
Status of a firmware update step.
Definition ids_peak_comfort_c.h:13697
PEAK_API_STATUS peak_FirmwareUpdate_Execute(peak_camera_id cameraID, const char *gufFileName)
Upload the firmware provided by the guf file to the given camera.
PEAK_API_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:13673
@ PEAK_FIRMWARE_UPDATE_STATUS_FAILED
The update (step) has failed.
Definition ids_peak_comfort_c.h:13705
@ PEAK_FIRMWARE_UPDATE_STATUS_FINSIHED
The update (step) has successfully finished.
Definition ids_peak_comfort_c.h:13703
@ PEAK_FIRMWARE_UPDATE_STATUS_PROGRESS
The update step has made progress.
Definition ids_peak_comfort_c.h:13701
@ PEAK_FIRMWARE_UPDATE_STATUS_STARTED
The update (step) has been started.
Definition ids_peak_comfort_c.h:13699
@ PEAK_FIRMWARE_UPDATE_STEP_TOTAL
Step representing the whole update process.
Definition ids_peak_comfort_c.h:13675
@ PEAK_FIRMWARE_UPDATE_STEP_WRITEFEATURE
The firmware update is modifying camera properties.
Definition ids_peak_comfort_c.h:13681
@ PEAK_FIRMWARE_UPDATE_STEP_UPLOADFILE
The firmware file is uploaded to the camera.
Definition ids_peak_comfort_c.h:13687
@ PEAK_FIRMWARE_UPDATE_STEP_RESETDEVICE
The firmware update resets the device and waits for it to reconnect.
Definition ids_peak_comfort_c.h:13689
@ PEAK_FIRMWARE_UPDATE_STEP_ASSERTFEATURE
The firmware update is validating the cameras state.
Definition ids_peak_comfort_c.h:13685
@ PEAK_FIRMWARE_UPDATE_STEP_CHECKPRECONDITIONS
The firmware update is checking for compatability with the camera.
Definition ids_peak_comfort_c.h:13677
@ PEAK_FIRMWARE_UPDATE_STEP_EXECUTEFEATURE
The firmware update is running tasks on the camera.
Definition ids_peak_comfort_c.h:13683
@ PEAK_FIRMWARE_UPDATE_STEP_ACQUIREUPDATEDATA
The firmware update is loading the firmware files to be uploaded.
Definition ids_peak_comfort_c.h:13679
PEAK_API_ACCESS_STATUS peak_Flash_Duration_GetAccessStatus(peak_camera_handle hCam)
Query the flash duration property access status.
PEAK_API_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_API_STATUS peak_Flash_Duration_Set(peak_camera_handle hCam, double flashDuration_us)
Set the flash duration.
PEAK_API_STATUS peak_Flash_Duration_Get(peak_camera_handle hCam, double *flashDuration_us)
Get the flash duration.
PEAK_API_STATUS peak_Flash_EndDelay_Set(peak_camera_handle hCam, double flashEndDelay_us)
Set the flash end delay.
PEAK_API_ACCESS_STATUS peak_Flash_EndDelay_GetAccessStatus(peak_camera_handle hCam)
Query the flash end delay property access status.
PEAK_API_STATUS peak_Flash_EndDelay_Get(peak_camera_handle hCam, double *flashEndDelay_us)
Get the flash end delay.
PEAK_API_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_API_STATUS peak_Flash_StartDelay_Set(peak_camera_handle hCam, double flashStartDelay_us)
Set the flash start delay.
PEAK_API_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_API_STATUS peak_Flash_StartDelay_Get(peak_camera_handle hCam, double *flashStartDelay_us)
Get the flash start delay.
PEAK_API_ACCESS_STATUS peak_Flash_StartDelay_GetAccessStatus(peak_camera_handle hCam)
Query the flash start delay property access status.
PEAK_API_ACCESS_STATUS peak_Flash_Mode_GetAccessStatus(peak_camera_handle hCam, peak_flash_mode flashMode)
Query the flash mode access status.
PEAK_API_STATUS peak_Flash_Mode_Get(peak_camera_handle hCam, peak_flash_mode *flashMode)
Get the flash mode.
PEAK_API_BOOL peak_Flash_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the flash.
PEAK_API_STATUS peak_Flash_Mode_Set(peak_camera_handle hCam, peak_flash_mode flashMode)
Set the flash mode.
PEAK_API_ACCESS_STATUS peak_Flash_GetAccessStatus(peak_camera_handle hCam)
Query the flash feature access status.
PEAK_API_STATUS peak_Flash_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the flash.
peak_flash_reference
peak Flash reference
Definition ids_peak_comfort_c.h:5582
@ PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW
Global start window.
Definition ids_peak_comfort_c.h:5599
@ PEAK_FLASH_REFERENCE_INVALID
Invalid flash reference.
Definition ids_peak_comfort_c.h:5587
@ PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE
Acquisition active.
Definition ids_peak_comfort_c.h:5605
@ PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE
Exposure active.
Definition ids_peak_comfort_c.h:5593
PEAK_API_STATUS peak_Focus_Get(peak_camera_handle hCam, uint32_t *focus)
Get the focus value.
PEAK_API_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_API_ACCESS_STATUS peak_Focus_GetAccessStatus(peak_camera_handle hCam)
Query the focus access status.
PEAK_API_STATUS peak_Focus_Set(peak_camera_handle hCam, uint32_t focus)
Set the focus value.
PEAK_API_STATUS peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t *processingTime_ms)
Query the processing time of a frame.
PEAK_API_STATUS peak_Frame_Timestamp_Get(peak_frame_handle hFrame, uint64_t *timestamp_ns)
Query the timestamp of a frame.
PEAK_API_BOOL peak_Frame_IsComplete(peak_frame_handle hFrame)
Check whether the frame is complete.
PEAK_API_STATUS peak_Frame_BytesWritten_Get(peak_frame_handle hFrame, size_t *bytesWritten)
Query the bytes written to the buffer of a frame.
PEAK_API_STATUS peak_Frame_GetInfo(peak_frame_handle hFrame, peak_frame_info *frameInfo)
Query the frame info.
PEAK_API_STATUS peak_Frame_Type_Get(peak_frame_handle hFrame, peak_frame_type *frameType)
Query the type of a frame.
PEAK_API_STATUS peak_Frame_ID_Get(peak_frame_handle hFrame, uint64_t *frameID)
Query the frame id of a frame.
PEAK_API_STATUS peak_Frame_BytesExpected_Get(peak_frame_handle hFrame, size_t *bytesExpected)
Query the bytes expected for a complete image.
peak_frame_type
peak Frame type
Definition ids_peak_comfort_c.h:3536
PEAK_API_STATUS peak_Frame_ROI_Get(peak_frame_handle hFrame, peak_roi *roi)
Query the size parameters of a frame.
PEAK_API_STATUS peak_Frame_Buffer_Get(peak_frame_handle hFrame, peak_buffer *buffer)
Query the buffer of a frame.
PEAK_API_STATUS peak_Frame_PixelFormat_Get(peak_frame_handle hFrame, peak_pixel_format *pixelFormat)
Query the pixel format of a frame.
@ PEAK_FRAME_TYPE_IMAGE
Image data.
Definition ids_peak_comfort_c.h:3548
@ PEAK_FRAME_TYPE_INVALID
Invalid frame type.
Definition ids_peak_comfort_c.h:3541
PEAK_API_STATUS peak_Frame_Save(peak_frame_handle hFrame, const char *fileName)
Write the frame as image to the file system.
PEAK_API_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:2360
PEAK_API_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_API_ACCESS_STATUS peak_FrameRate_GetAccessStatus(peak_camera_handle hCam)
Query the frame rate access status.
PEAK_API_STATUS peak_FrameRate_Get(peak_camera_handle hCam, double *frameRate_fps)
Get the frame rate.
PEAK_API_STATUS peak_FrameRate_Set(peak_camera_handle hCam, double frameRate_fps)
Set the frame rate.
PEAK_API_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_API_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_API_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_gain_type
peak Gain type
Definition ids_peak_comfort_c.h:6327
peak_gain_channel
peak Gain channel
Definition ids_peak_comfort_c.h:6352
PEAK_API_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_API_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_GAIN_TYPE_DIGITAL
Digital gain is used.
Definition ids_peak_comfort_c.h:6338
@ PEAK_GAIN_TYPE_ANALOG
Analog gain is used.
Definition ids_peak_comfort_c.h:6335
@ PEAK_GAIN_TYPE_INVALID
Invalid gain type.
Definition ids_peak_comfort_c.h:6332
@ PEAK_GAIN_TYPE_COMBINED
Combined gain is used.
Definition ids_peak_comfort_c.h:6341
@ PEAK_GAIN_CHANNEL_INVALID
Invalid gain channel.
Definition ids_peak_comfort_c.h:6357
@ PEAK_GAIN_CHANNEL_MASTER
Master channel.
Definition ids_peak_comfort_c.h:6369
@ PEAK_GAIN_CHANNEL_BLUE
Blue channel.
Definition ids_peak_comfort_c.h:6366
@ PEAK_GAIN_CHANNEL_RED
Red channel.
Definition ids_peak_comfort_c.h:6360
@ PEAK_GAIN_CHANNEL_GREEN
Green channel.
Definition ids_peak_comfort_c.h:6363
PEAK_API_ACCESS_STATUS peak_Gamma_GetAccessStatus(peak_camera_handle hCam)
Query the gamma access status.
PEAK_API_STATUS peak_Gamma_Get(peak_camera_handle hCam, double *gamma)
Get the gamma value.
PEAK_API_STATUS peak_Gamma_Set(peak_camera_handle hCam, double gamma)
Set the gamma value.
PEAK_API_STATUS peak_Gamma_GetRange(peak_camera_handle hCam, double *minGamma, double *maxGamma, double *incGamma)
Get the current range of valid gamma values.
peak_auto_feature_roi_mode
peak Auto feature ROI mode
Definition ids_peak_comfort_c.h:6941
peak_auto_feature_brightness_algorithm
peak Auto feature brightness algorithm
Definition ids_peak_comfort_c.h:6913
peak_auto_feature_mode
peak Auto feature mode
Definition ids_peak_comfort_c.h:6877
@ PEAK_AUTO_FEATURE_ROI_MODE_MANUAL
Auto feature ROI mode Manual.
Definition ids_peak_comfort_c.h:6964
@ PEAK_AUTO_FEATURE_ROI_MODE_INVALID
Invalid auto feature ROI mode.
Definition ids_peak_comfort_c.h:6946
@ PEAK_AUTO_FEATURE_ROI_MODE_FULL_IMAGE
Auto feature ROI mode Full Image.
Definition ids_peak_comfort_c.h:6955
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_INVALID
Invalid auto feature brightness algorithm.
Definition ids_peak_comfort_c.h:6918
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEAN
brightness algorithm mean
Definition ids_peak_comfort_c.h:6930
@ PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEDIAN
default brightness algorithm
Definition ids_peak_comfort_c.h:6924
@ PEAK_AUTO_FEATURE_MODE_CONTINUOUS
Auto feature mode Continuous.
Definition ids_peak_comfort_c.h:6902
@ PEAK_AUTO_FEATURE_MODE_OFF
Auto feature Off.
Definition ids_peak_comfort_c.h:6890
@ PEAK_AUTO_FEATURE_MODE_ONCE
Auto feature mode Once.
Definition ids_peak_comfort_c.h:6896
@ PEAK_AUTO_FEATURE_MODE_INVALID
Invalid auto feature mode.
Definition ids_peak_comfort_c.h:6882
PEAK_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_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_API_STATUS peak_GFA_EnableWriteAccess(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the GFA write access.
peak_gfa_module
peak GFA modules
Definition ids_peak_comfort_c.h:9083
PEAK_API_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_API_BOOL peak_GFA_IsWriteAccessEnabled(peak_camera_handle hCam)
Get the enabled status of 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:9091
@ PEAK_GFA_MODULE_INVALID
Invalid GFA module.
Definition ids_peak_comfort_c.h:9088
@ PEAK_GFA_MODULE_REMOTE_DEVICE
The GFA module for the access of the GenICam Remote Device module.
Definition ids_peak_comfort_c.h:9100
@ PEAK_GFA_MODULE_INTERFACE
The GFA module for the access of the GenICam GenTL Interface module.
Definition ids_peak_comfort_c.h:9094
@ PEAK_GFA_MODULE_DATA_STREAM
The GFA module for the access of the GenICam GenTL Data Stream module.
Definition ids_peak_comfort_c.h:9103
@ PEAK_GFA_MODULE_LOCAL_DEVICE
The GFA module for the access of the GenICam GenTL Local Device module.
Definition ids_peak_comfort_c.h:9097
PEAK_API_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_API_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_API_STATUS peak_IPL_AutoBrightness_TargetPercentile_Set(peak_camera_handle hCam, double autoBrightnessTargetPercentile)
Set the host auto brightness target percentile value.
PEAK_API_STATUS peak_IPL_AutoBrightness_TargetPercentile_Get(peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
Get the host auto brightness target percentile value.
PEAK_API_STATUS peak_IPL_AutoBrightness_SkipFrames_Get(peak_camera_handle hCam, uint32_t *skipFrames)
Get the skip frames for the auto brightness controller.
PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI)
Set the host auto brightness ROI.
PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
Get the host auto brightness target value.
PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget)
Set the host auto brightness target value.
PEAK_API_STATUS peak_IPL_AutoBrightness_TargetTolerance_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
Get the host auto brightness target tolerance value.
PEAK_API_STATUS peak_IPL_AutoBrightness_Algorithm_Set(peak_camera_handle hCam, peak_auto_feature_brightness_algorithm algorithm)
Set the host auto brightness control algorithm.
PEAK_API_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_API_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_API_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_API_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_API_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_API_STATUS peak_IPL_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi *autoBrightnessROI)
Get the host auto brightness ROI.
PEAK_API_STATUS peak_IPL_AutoBrightness_AverageLast_Get(peak_camera_handle hCam, uint32_t *lastAverage)
Get the last calculated brightness average value.
PEAK_API_STATUS peak_IPL_AutoBrightness_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames)
Set the skip frames for the auto brightness controller.
PEAK_API_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_API_STATUS peak_IPL_AutoBrightness_Algorithm_Get(peak_camera_handle hCam, peak_auto_feature_brightness_algorithm *algorithm)
Get the host auto brightness control algorithm.
PEAK_API_STATUS peak_IPL_AutoBrightness_TargetTolerance_Set(peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
Set the host auto brightness target tolerance value.
PEAK_API_STATUS peak_IPL_AutoBrightness_ExposureLimit_Get(peak_camera_handle hCam, peak_double_limit *exposureLimit)
Get the host auto exposure limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_Exposure_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
Set the host auto exposure control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_ExposureLimit_Set(peak_camera_handle hCam, peak_double_limit exposureLimit)
Set the host auto exposure limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_Exposure_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
Get the host auto exposure control mode.
PEAK_API_STATUS peak_IPL_AutoFocus_SearchAlgorithm_Get(peak_camera_handle hCam, peak_auto_focus_search_algorithm *searchAlgorithm)
Get the host auto focus search algorithm.
PEAK_API_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_API_STATUS peak_IPL_AutoFocus_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoFocusMode)
Get the host auto focus control mode.
PEAK_API_STATUS peak_IPL_AutoFocus_SharpnessAlgorithm_Get(peak_camera_handle hCam, peak_sharpness_algorithm *sharpnessAlgorithm)
Get the focus sharpness algorithm.
PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Set(peak_camera_handle hCam, uint8_t hysteresis)
Set the host auto focus hysteresis.
PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Get(peak_camera_handle hCam, uint8_t *hysteresis)
Get the host auto focus hysteresis.
PEAK_API_STATUS peak_IPL_AutoFocus_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoFocusMode)
Set the host auto focus control mode.
PEAK_API_STATUS peak_IPL_AutoFocus_Range_Set(peak_camera_handle hCam, uint32_t rangeBegin, uint32_t rangeEnd)
Set the host auto focus range.
PEAK_API_STATUS peak_IPL_AutoFocus_SearchAlgorithm_Set(peak_camera_handle hCam, peak_auto_focus_search_algorithm searchAlgorithm)
Set the host auto focus search algorithm.
PEAK_API_STATUS peak_IPL_AutoFocus_SharpnessAlgorithm_Set(peak_camera_handle hCam, peak_sharpness_algorithm sharpnessAlgorithm)
Set the host auto focus sharpness algorithm.
peak_focus_roi_weight
The peak focus ROI weight classes.
Definition ids_peak_comfort_c.h:11580
PEAK_API_ACCESS_STATUS peak_IPL_AutoFocus_GetAccessStatus(peak_camera_handle hCam)
Query the auto focus access status.
PEAK_API_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_API_STATUS peak_IPL_AutoFocus_Range_Get(peak_camera_handle hCam, uint32_t *rangeBegin, uint32_t *rangeEnd)
Get the host auto focus range.
PEAK_API_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:11738
peak_sharpness_algorithm
The peak sharpness measurement algorithm.
Definition ids_peak_comfort_c.h:11821
@ PEAK_FOCUS_ROI_WEIGHT_STRONG
Focus ROI weight strong.
Definition ids_peak_comfort_c.h:11594
@ PEAK_FOCUS_ROI_WEIGHT_MEDIUM
Focus ROI weight medium.
Definition ids_peak_comfort_c.h:11591
@ PEAK_FOCUS_ROI_WEIGHT_INVALID
Invalid focus ROI weight.
Definition ids_peak_comfort_c.h:11585
@ PEAK_FOCUS_ROI_WEIGHT_WEAK
Focus ROI weight weak.
Definition ids_peak_comfort_c.h:11588
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_GOLDEN_RATIO
Search algorithm Golden Ratio.
Definition ids_peak_comfort_c.h:11749
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_HILL_CLIMBING
Search algorithm Hill Climbing.
Definition ids_peak_comfort_c.h:11756
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_GLOBAL_SEARCH
Search algorithm Full Scan.
Definition ids_peak_comfort_c.h:11768
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_INVALID
Invalid search algorithm type.
Definition ids_peak_comfort_c.h:11743
@ PEAK_AUTO_FOCUS_SEARCH_ALGORITHM_FULL_SCAN
Search algorithm Full Scan.
Definition ids_peak_comfort_c.h:11762
@ PEAK_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE
Sharpness algorithm Histogram Variance.
Definition ids_peak_comfort_c.h:11850
@ PEAK_SHARPNESS_ALGORITHM_TENENGRAD
Sharpness algorithm Tenengrad.
Definition ids_peak_comfort_c.h:11832
@ PEAK_SHARPNESS_ALGORITHM_SOBEL
Sharpness algorithm Sobel.
Definition ids_peak_comfort_c.h:11838
@ PEAK_SHARPNESS_ALGORITHM_INVALID
Invalid sharpness algorithm type.
Definition ids_peak_comfort_c.h:11826
@ PEAK_SHARPNESS_ALGORITHM_MEAN_SCORE
Sharpness algorithm Mean Score.
Definition ids_peak_comfort_c.h:11844
PEAK_API_STATUS peak_IPL_AutoBrightness_GainAnalogLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain analog limit range.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainAnalogLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain analog limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainAnalogLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain analog limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainAnalog_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainAnalog_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain limit range.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainCombinedLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain combined limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainCombined_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host combined gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainCombined_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the combined gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainCombinedLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host gain combined limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainCombinedLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain combined limit range.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainDigitalLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain digital limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainDigitalLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain digital limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainDigital_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainDigital_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainDigitalLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the host auto gain digital limit range.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainHost_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host gain control mode.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainHostLimit_Get(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the auto host gain limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainHostLimit_GetRange(peak_camera_handle hCam, peak_double_limit *gainLimit)
Get the auto host gain limit range.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainHostLimit_Set(peak_camera_handle hCam, peak_double_limit gainLimit)
Set the host auto gain limit.
PEAK_API_STATUS peak_IPL_AutoBrightness_GainHost_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host gain control mode.
PEAK_API_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_API_STATUS peak_IPL_AutoWhiteBalance_SkipFrames_Get(peak_camera_handle hCam, uint32_t *skipFrames)
Get the skip frames for the auto white balance controller.
PEAK_API_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_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
Get the host auto white balance ROI.
PEAK_API_STATUS peak_IPL_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
Get the host auto white balance control mode.
PEAK_API_STATUS peak_IPL_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
Set the host auto white balance control mode.
PEAK_API_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_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
Set the host auto white balance ROI.
PEAK_API_STATUS peak_IPL_AutoWhiteBalance_SkipFrames_Set(peak_camera_handle hCam, uint32_t skipFrames)
Set the skip frames for the auto white balance controller.
PEAK_API_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_API_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_API_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_API_STATUS peak_IPL_Binning_Get(peak_camera_handle hCam, uint32_t *binningFactorX, uint32_t *binningFactorY)
Get the host binning factors.
PEAK_API_STATUS peak_IPL_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
Set the host binning factors.
PEAK_API_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_API_STATUS peak_IPL_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the host color correction.
PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
Get the host color correction matrix.
PEAK_API_BOOL peak_IPL_ColorCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the host color correction.
PEAK_API_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_API_STATUS peak_IPL_ColorCorrection_Saturation_Set(peak_camera_handle hCam, double saturation)
Sets the saturation value.
PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Get(peak_camera_handle hCam, double *saturation)
Get the saturation value.
PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
Sets the cost color correction matrix.
PEAK_API_STATUS peak_IPL_Decimation_Get(peak_camera_handle hCam, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
Get the decimation factors.
PEAK_API_STATUS peak_IPL_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY)
Set the host decimation factors.
PEAK_API_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_API_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_API_STATUS peak_IPL_EdgeEnhancement_Factor_Set(peak_camera_handle hCam, uint32_t factor)
Set the host edge enhancement factor.
PEAK_API_STATUS peak_IPL_EdgeEnhancement_Enable(peak_camera_handle hCam, peak_bool enable)
Enable/Disable the host edge enhancement.
PEAK_API_BOOL peak_IPL_EdgeEnhancement_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the edge enhancement feature.
PEAK_API_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_API_STATUS peak_IPL_EdgeEnhancement_Factor_GetDefault(peak_camera_handle hCam, uint32_t *defaultFactor)
Get the default host edge enhancement factor.
PEAK_API_STATUS peak_IPL_EdgeEnhancement_Factor_Get(peak_camera_handle hCam, uint32_t *factor)
Get the currently set host edge enhancement factor.
PEAK_API_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_API_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_API_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_API_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_API_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_API_STATUS peak_IPL_Gamma_Set(peak_camera_handle hCam, double gamma)
Set the host gamma value.
PEAK_API_STATUS peak_IPL_Gamma_Get(peak_camera_handle hCam, double *gamma)
Get the host gamma value.
PEAK_API_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_API_STATUS peak_IPL_HotpixelCorrection_SetList(peak_camera_handle hCam, const peak_position *hotpixelList, size_t hotpixelCount)
Set the list of host hotpixel positions.
PEAK_API_BOOL peak_IPL_HotpixelCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the host hotpixel correction.
peak_hotpixel_correction_sensitivity
peak hotpixel correction sensitivity level
Definition ids_peak_comfort_c.h:12009
PEAK_API_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_API_STATUS peak_IPL_HotpixelCorrection_Sensitivity_Set(peak_camera_handle hCam, peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity)
Set the host hotpixel correction sensitivity level.
PEAK_API_STATUS peak_IPL_HotpixelCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the host hotpixel correction.
PEAK_API_STATUS peak_IPL_HotpixelCorrection_ResetList(peak_camera_handle hCam)
Reset the list of host hotpixel positions.
PEAK_API_STATUS peak_IPL_HotpixelCorrection_Sensitivity_Get(peak_camera_handle hCam, peak_hotpixel_correction_sensitivity *hotpixelCorrectionSensitivity)
Get the host hotpixel correction sensitivity level.
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_1
hotpixel correction sensitivity level 1
Definition ids_peak_comfort_c.h:12021
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_4
hotpixel correction sensitivity level 4
Definition ids_peak_comfort_c.h:12033
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_INVALID
Invalid hotpixel correction sensitivity level.
Definition ids_peak_comfort_c.h:12014
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_3
hotpixel correction sensitivity level 3
Definition ids_peak_comfort_c.h:12030
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_2
hotpixel correction sensitivity level 2
Definition ids_peak_comfort_c.h:12024
@ PEAK_HOTPIXEL_CORRECTION_SENSITIVITY_LEVEL_5
hotpixel correction sensitivity level 5
Definition ids_peak_comfort_c.h:12039
PEAK_API_STATUS peak_IPL_Mirror_LeftRight_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the left-right host mirroring.
PEAK_API_STATUS peak_IPL_Mirror_UpDown_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the up-down host mirroring.
PEAK_API_BOOL peak_IPL_Mirror_LeftRight_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the left-right host mirroring.
PEAK_API_BOOL peak_IPL_Mirror_UpDown_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the up-down host mirroring.
PEAK_API_STATUS peak_IPL_PixelFormat_Set(peak_camera_handle hCam, peak_pixel_format pixelFormat)
Set the output pixel format for host processing.
PEAK_API_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_API_STATUS peak_IPL_PixelFormat_Get(peak_camera_handle hCam, peak_pixel_format *pixelFormat)
Get the output pixel format of the host processing.
PEAK_API_STATUS peak_I2C_AckPolling_Timeout_Get(peak_i2c_handle hI2C, uint32_t *timeout_ms)
Get the i2c ack polling timeout in milliseconds.
PEAK_API_STATUS peak_I2C_DeviceAddress_Set(peak_i2c_handle hI2C, uint32_t address)
Set the i2c device address.
PEAK_API_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_API_STATUS peak_I2C_DeviceAddress_Get(peak_i2c_handle hI2C, uint32_t *address)
Get the i2c device address.
PEAK_API_STATUS peak_I2C_Create(peak_camera_handle hCam, peak_i2c_handle *hI2C)
Creates a new i2c instance.
PEAK_API_BOOL peak_I2C_AckPolling_IsEnabled(peak_i2c_handle hI2C)
Get the enabled status of the i2c ack polling.
PEAK_API_ACCESS_STATUS peak_I2C_GetAccessStatus(peak_i2c_handle hI2C)
Query the i2c access status.
PEAK_API_STATUS peak_I2C_OperationStatus_Get(peak_i2c_handle hI2C, peak_i2c_operation_status *operationStatus)
Get the i2c operation status.
PEAK_API_STATUS peak_I2C_RegisterAddress_Set(peak_i2c_handle hI2C, uint32_t address)
Set the i2c register address.
peak_i2c_operation_status
peak i2c operation status
Definition ids_peak_comfort_c.h:15236
PEAK_API_STATUS peak_I2C_RegisterAddress_Length_Get(peak_i2c_handle hI2C, peak_i2c_register_address_length *length)
Get the i2c register address length.
PEAK_API_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_API_STATUS peak_I2C_RegisterAddress_Endianness_Get(peak_i2c_handle hI2C, peak_endianness *endianness)
Get the i2c register endianness.
peak_i2c_register_address_length
peak i2c register address length
Definition ids_peak_comfort_c.h:14814
PEAK_API_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_API_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_API_STATUS peak_I2C_RegisterAddress_Get(peak_i2c_handle hI2C, uint32_t *address)
Get the i2c register address.
PEAK_API_STATUS peak_I2C_Destroy(peak_i2c_handle hI2C)
Destroys a i2c handle.
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:14567
PEAK_API_STATUS peak_I2C_AckPolling_Enable(peak_i2c_handle hI2C, peak_bool enabled)
Enable/Disable the i2c ack polling.
PEAK_API_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_API_STATUS peak_I2C_AckPolling_Timeout_Set(peak_i2c_handle hI2C, uint32_t timeout_ms)
Set the i2c ack polling timeout in milliseconds.
PEAK_API_ACCESS_STATUS peak_I2C_AckPolling_Timeout_GetAccessStatus(peak_i2c_handle hI2C)
Query the i2c ack polling timeout access status.
PEAK_API_STATUS peak_I2C_RegisterAddress_Endianness_Set(peak_i2c_handle hI2C, peak_endianness endianness)
Set the i2c register address endianness.
PEAK_API_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_API_STATUS peak_I2C_RegisterAddress_Length_Set(peak_i2c_handle hI2C, peak_i2c_register_address_length length)
Set the i2c register address length.
PEAK_API_STATUS peak_I2C_Mode_Set(peak_i2c_handle hI2C, peak_i2c_mode mode)
Set the i2c mode.
peak_i2c_mode
peak i2c modes
Definition ids_peak_comfort_c.h:14634
PEAK_API_STATUS peak_I2C_Data_Write(peak_i2c_handle hI2C, const uint8_t *data, size_t dataSize)
Write to a i2c device register.
PEAK_API_STATUS peak_I2C_Mode_Get(peak_i2c_handle hI2C, peak_i2c_mode *mode)
Get the i2c mode.
@ PEAK_I2C_OPERATION_STATUS_INVALID_DEVICE_ADDRESS
The device address is not allowed.
Definition ids_peak_comfort_c.h:15253
@ PEAK_I2C_OPERATION_STATUS_ERROR
An error occured while reading or writing.
Definition ids_peak_comfort_c.h:15247
@ PEAK_I2C_OPERATION_STATUS_INVALID
Invalid operation status.
Definition ids_peak_comfort_c.h:15241
@ PEAK_I2C_OPERATION_STATUS_READY
I2C communication is ready or the last write/read was successful.
Definition ids_peak_comfort_c.h:15244
@ 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:15250
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_0BIT
0 bit register length. Register address will not be used
Definition ids_peak_comfort_c.h:14821
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_24BIT
24 bit register length
Definition ids_peak_comfort_c.h:14827
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_INVALID
Invalid register address length.
Definition ids_peak_comfort_c.h:14819
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_16BIT
16 bit register length
Definition ids_peak_comfort_c.h:14825
@ PEAK_I2C_REGISTER_ADDRESS_LENGTH_8BIT
8 bit register length
Definition ids_peak_comfort_c.h:14823
@ PEAK_I2C_MODE_INVALID
Invalid i2c mode.
Definition ids_peak_comfort_c.h:14639
@ PEAK_I2C_MODE_STANDARD
I2C fast mode with 100 kHz clock frequency.
Definition ids_peak_comfort_c.h:14641
@ PEAK_I2C_MODE_FAST
I2C fast mode with 400 kHz clock frequency.
Definition ids_peak_comfort_c.h:14643
@ PEAK_I2C_MODE_FAST_PLUS
I2C fast mode with 1000 kHz clock frequency.
Definition ids_peak_comfort_c.h:14645
peak_subsampling_engine
peak subsampling engine
Definition ids_peak_comfort_c.h:8081
@ PEAK_SUBSAMPLING_ENGINE_INVALID
invalid subsampling engine
Definition ids_peak_comfort_c.h:8086
@ PEAK_SUBSAMPLING_ENGINE_FPGA
subsampling engine fpga.
Definition ids_peak_comfort_c.h:8088
@ PEAK_SUBSAMPLING_ENGINE_UEYE
subsampling engine ueye.
Definition ids_peak_comfort_c.h:8092
@ PEAK_SUBSAMPLING_ENGINE_SENSOR
subsampling engine sensor.
Definition ids_peak_comfort_c.h:8090
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:15282
PEAK_API_STATUS peak_IPL_ImageWriter_Destroy(peak_imagewriter_handle hImageWriter)
Destroys an ImageWriter instance.
PEAK_API_STATUS peak_IPL_ImageWriter_Create(peak_imagewriter_handle *hImageWriter)
Creates a new ImageWriter instance.
PEAK_API_STATUS peak_IPL_ImageWriter_Format_Set(peak_imagewriter_handle hImageWriter, papientitiy_imagefile_format imageFormat)
Sets an image file format for the ImageWriter instance.
PEAK_API_STATUS peak_IPL_ImageWriter_Save(peak_imagewriter_handle hImageWriter, peak_frame_handle hFrame, const char *fileName)
Save the given frame.
papientitiy_imagefile_format
ImageWriter image file formats.
Definition ids_peak_comfort_c.h:15339
PEAK_API_STATUS peak_IPL_ImageWriter_Format_Get(peak_imagewriter_handle hImageWriter, papientitiy_imagefile_format *imageFormat)
Reads the currently set image file format from the ImageWriter instance.
PEAK_API_STATUS peak_IPL_ImageWriter_Compression_Get(peak_imagewriter_handle hImageWriter, uint32_t *compression)
Reads the currently set compression ratio from the ImageWriter instance.
PEAK_API_STATUS peak_IPL_ImageWriter_Compression_Set(peak_imagewriter_handle hImageWriter, uint32_t compression)
Sets a compression for the ImageWriter instance.
@ PEAK_IMAGEFILE_FORMAT_JPEG
Image file format JPEG.
Definition ids_peak_comfort_c.h:15358
@ PEAK_IMAGEFILE_FORMAT_PNG
Image file format PNG.
Definition ids_peak_comfort_c.h:15351
@ PEAK_IMAGEFILE_FORMAT_RAW
Image file format RAW.
Definition ids_peak_comfort_c.h:15379
@ PEAK_IMAGEFILE_FORMAT_BMP
Image file format BMP.
Definition ids_peak_comfort_c.h:15372
@ PEAK_IMAGEFILE_FORMAT_INVALID
Invalid image file format.
Definition ids_peak_comfort_c.h:15344
@ PEAK_IMAGEFILE_FORMAT_TIFF
Image file format TIFF.
Definition ids_peak_comfort_c.h:15365
PEAK_API_STATUS peak_Inference_CNN_Info_Get(peak_inference_handle hInference, peak_inference_info *info)
Gets detailed info about the loaded CNN.
PEAK_API_STATUS peak_Inference_CNN_Close(peak_inference_handle hInference)
Unloads a cnn instance.
PEAK_API_STATUS peak_Inference_ConfidenceThreshold_Get(peak_inference_handle hInference, uint32_t *threshold)
Gets the confidence threshold of the inference.
peak_inference_preprocessing_mode
peak inference preprocessing modes.
Definition ids_peak_comfort_c.h:12887
PEAK_API_STATUS peak_Inference_Statistics_Get(peak_inference_handle hInference, peak_inference_statistics *statistics)
Gets the inference statistics.
PEAK_API_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.
struct peak_inference * peak_inference_handle
The handle to identify an inference instance.
Definition ids_peak_comfort_c.h:12854
struct peak_inference_result * peak_inference_result_handle
The handle to identify an inference result.
Definition ids_peak_comfort_c.h:12860
PEAK_API_STATUS peak_Inference_Statistics_Reset(peak_inference_handle hInference)
Resets the inference statistics.
PEAK_API_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_API_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_API_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_API_STATUS peak_Inference_Result_Release(peak_inference_result_handle hInferenceHandle)
Releases a inference result that was previously received from peak_Inference_CNN_ProcessFrame.
peak_inference_type
peak inference types
Definition ids_peak_comfort_c.h:12869
PEAK_API_STATUS peak_Inference_Result_Get(peak_inference_result_handle hInferenceHandle, peak_inference_result_data *result)
Get the result from a previous inference call.
PEAK_API_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_API_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_INFERENCE_PREPROCESSING_MODE_CAFFE
Caffe preprocessing mode.
Definition ids_peak_comfort_c.h:12895
@ PEAK_INFERENCE_PREPROCESSING_MODE_TENSORFLOW
Tensorflow preprocessing mode.
Definition ids_peak_comfort_c.h:12898
@ PEAK_INFERENCE_PREPROCESSING_MODE_INVALID
Invalid inference preprocessing mode.
Definition ids_peak_comfort_c.h:12892
@ PEAK_INFERENCE_TYPE_CLASSIFICATION
CNN classification model.
Definition ids_peak_comfort_c.h:12880
@ PEAK_INFERENCE_TYPE_DETECTION
CNN detection model.
Definition ids_peak_comfort_c.h:12877
@ PEAK_INFERENCE_TYPE_INVALID
Invalid inference type.
Definition ids_peak_comfort_c.h:12874
PEAK_API_ACCESS_STATUS peak_IOChannel_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel access status.
peak_io_channel
peak IO channel
Definition ids_peak_comfort_c.h:4497
PEAK_API_STATUS peak_IOChannel_Inverter_Enable(peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
Enable/Disable the io channel inverter property.
PEAK_API_ACCESS_STATUS peak_IOChannel_Level_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel level property access status.
PEAK_API_BOOL peak_IOChannel_Level_IsHigh(peak_camera_handle hCam, peak_io_channel ioChannel)
Get the level of the io channel.
PEAK_API_BOOL peak_IOChannel_Inverter_IsEnabled(peak_camera_handle hCam, peak_io_channel ioChannel)
Get the enabled status of the io channel inverter property.
PEAK_API_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_API_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_API_ACCESS_STATUS peak_IOChannel_NoiseFilter_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel noise filter property access status.
PEAK_API_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_API_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_API_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_API_STATUS peak_IOChannel_GetList(peak_camera_handle hCam, peak_io_channel *ioChannelList, size_t *ioChannelCount)
Get the list of supported io channels.
PEAK_API_ACCESS_STATUS peak_IOChannel_Inverter_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel inverter property access status.
@ PEAK_IO_CHANNEL_GPIO_2
GPIO 2 pin.
Definition ids_peak_comfort_c.h:4538
@ PEAK_IO_CHANNEL_GPIO_1
GPIO 1 pin.
Definition ids_peak_comfort_c.h:4532
@ PEAK_IO_CHANNEL_INVALID
Invalid io channel.
Definition ids_peak_comfort_c.h:4502
@ PEAK_IO_CHANNEL_FLASH_OUTPUT
Flash output pin.
Definition ids_peak_comfort_c.h:4526
@ PEAK_IO_CHANNEL_SOFTWARE
Software.
Definition ids_peak_comfort_c.h:4514
@ PEAK_IO_CHANNEL_NONE
None.
Definition ids_peak_comfort_c.h:4508
@ PEAK_IO_CHANNEL_TRIGGER_INPUT
Trigger input pin.
Definition ids_peak_comfort_c.h:4520
PEAK_API_ACCESS_STATUS peak_LED_GetAccessStatus(peak_camera_handle hCam)
Query LED access status.
PEAK_API_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_API_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_led_target
peak LED target
Definition ids_peak_comfort_c.h:15890
peak_led_mode
peak LED mode
Definition ids_peak_comfort_c.h:15912
PEAK_API_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_API_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_LED_TARGET_STATUS
The camera status LED target.
Definition ids_peak_comfort_c.h:15900
@ PEAK_LED_TARGET_INVALID
Invalid LED target.
Definition ids_peak_comfort_c.h:15896
@ PEAK_LED_TARGET_NETWORK
The camera network LED target.
Definition ids_peak_comfort_c.h:15898
@ PEAK_LED_MODE_INVALID
Invalid LED mode.
Definition ids_peak_comfort_c.h:15917
@ PEAK_LED_MODE_CAMERA_STATUS
Turns status LED to show camera status.
Definition ids_peak_comfort_c.h:15928
@ PEAK_LED_MODE_BLINK_FAST
Turns LED to fast flashing.
Definition ids_peak_comfort_c.h:15923
@ PEAK_LED_MODE_BLINK_SLOW
Turns LED to slow flashing.
Definition ids_peak_comfort_c.h:15921
@ PEAK_LED_MODE_OFF
Turns off LED.
Definition ids_peak_comfort_c.h:15919
@ PEAK_LED_MODE_NETWORK_STATUS
Turns network LED to show network status.
Definition ids_peak_comfort_c.h:15933
PEAK_API_STATUS peak_Library_Exit()
Exit the peak comfortC library.
PEAK_API_STATUS peak_Library_GetLastError(peak_status *lastErrorCode, char *lastErrorMessage, size_t *lastErrorMessageSize)
Query the last error.
PEAK_API_STATUS peak_Library_Init()
Init the peak comfortC library.
PEAK_API_STATUS peak_Library_GetVersion(uint32_t *majorVersion, uint32_t *minorVersion, uint32_t *subminorVersion, uint32_t *patchVersion)
Query the library version.
PEAK_API_BOOL peak_Library_InterfaceTechnology_IsSupported(peak_interface_technology interfaceTech)
Query the supported interface technologies.
PEAK_API_STATUS peak_Acquisition_LossHandling_FrameAbortTimeout_Get(peak_camera_handle hCam, int64_t *timeout)
Get the loss handling frame abort timeout.
PEAK_API_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_API_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_API_STATUS peak_Acquisition_LossHandling_ResendRequestTimeout_Get(peak_camera_handle hCam, int64_t *timeout)
Get the loss handling resend request timeout.
peak_loss_handling_mode
peak Loss handling modes
Definition ids_peak_comfort_c.h:2845
PEAK_API_STATUS peak_Acquisition_LossHandling_Mode_Get(peak_camera_handle hCam, peak_loss_handling_mode *mode)
Get the loss handling mode.
PEAK_API_ACCESS_STATUS peak_Acquisition_LossHandling_ResendRequestTimeout_GetAccessStatus(peak_camera_handle hCam)
Query the loss handling resend request timeout access status.
PEAK_API_STATUS peak_Acquisition_LossHandling_FrameAbortTimeout_Set(peak_camera_handle hCam, int64_t timeout)
Set the loss handling frame abort timeout.
PEAK_API_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_API_STATUS peak_Acquisition_LossHandling_Extent_Set(peak_camera_handle hCam, int64_t extent)
Set the loss handling extent.
PEAK_API_ACCESS_STATUS peak_Acquisition_LossHandling_Mode_GetAccessStatus(peak_camera_handle hCam)
Query the loss handling mode access status.
PEAK_API_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_API_STATUS peak_Acquisition_LossHandling_Mode_Set(peak_camera_handle hCam, peak_loss_handling_mode mode)
Set the loss handling mode.
PEAK_API_STATUS peak_Acquisition_LossHandling_Extent_Get(peak_camera_handle hCam, int64_t *extent)
Get the loss handling extent.
PEAK_API_ACCESS_STATUS peak_Acquisition_LossHandling_Extent_GetAccessStatus(peak_camera_handle hCam)
Query the loss handling extent access status.
PEAK_API_ACCESS_STATUS peak_Acquisition_LossHandling_FrameAbortTimeout_GetAccessStatus(peak_camera_handle hCam)
Query the loss handling frame abort timeout access status.
PEAK_API_STATUS peak_Acquisition_LossHandling_ResendRequestTimeout_Set(peak_camera_handle hCam, int64_t timeout)
Set the loss handling resend request timeout.
@ PEAK_LOSS_HANDLING_MODE_OFF
Loss handling mode off.
Definition ids_peak_comfort_c.h:2856
@ PEAK_LOSS_HANDLING_MODE_LIMITED
Loss handling mode limited.
Definition ids_peak_comfort_c.h:2864
@ PEAK_LOSS_HANDLING_MODE_INVALID
Invalid loss handling mode.
Definition ids_peak_comfort_c.h:2850
@ PEAK_LOSS_HANDLING_MODE_UNLIMITED
Loss handling mode unlimited.
Definition ids_peak_comfort_c.h:2871
PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredCount(peak_camera_handle hCam, size_t *requiredBufferCount)
Query the required image buffer count.
PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredSize(peak_camera_handle hCam, size_t *requiredBufferSize)
Query the required image buffer size.
PEAK_API_STATUS peak_Acquisition_Buffer_Revoke(peak_camera_handle hCam, uint8_t *memoryAddress)
Revoke an image buffer.
PEAK_API_STATUS peak_Acquisition_Buffer_RevokeAll(peak_camera_handle hCam)
Revoke all image buffers.
PEAK_API_STATUS peak_Acquisition_Buffer_Announce(peak_camera_handle hCam, uint8_t *memoryAddress, size_t memorySize, void *userContext)
Announce an image buffer.
PEAK_API_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_API_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_API_STATUS peak_Message_Data_Type_Get(peak_message_handle hMessage, peak_message_data_type *messageType)
Get the message data type.
PEAK_API_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_API_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_message_data_type
peak message data types valid message data types
Definition ids_peak_comfort_c.h:13461
PEAK_API_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_API_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_API_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_API_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_API_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_API_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_API_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_MESSAGE_DATA_TYPE_REMOTE_DEVICE_ERROR
Remote device error message data type.
Definition ids_peak_comfort_c.h:13472
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE
Remote device message data type.
Definition ids_peak_comfort_c.h:13469
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED
Remote device dropped message data type.
Definition ids_peak_comfort_c.h:13475
@ PEAK_MESSAGE_DATA_TYPE_NO_DATA
No data message data type.
Definition ids_peak_comfort_c.h:13466
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME
Remote device frame message data type.
Definition ids_peak_comfort_c.h:13478
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_LOST
Camera manager device lost message data type.
Definition ids_peak_comfort_c.h:13490
@ PEAK_MESSAGE_DATA_TYPE_FIRMWARE_UPDATE
Firmware update message data type.
Definition ids_peak_comfort_c.h:13499
@ PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE
Remote device temperature message data type.
Definition ids_peak_comfort_c.h:13481
@ PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA
Autofeature auto focus data message data type.
Definition ids_peak_comfort_c.h:13484
@ PEAK_MESSAGE_DATA_TYPE_INVALID
Invalid message data type.
Definition ids_peak_comfort_c.h:13463
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_DISCONNECTED
Camera manager device disconnected message data type.
Definition ids_peak_comfort_c.h:13496
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_RECONNECTED
Camera manager device reconnected message data type.
Definition ids_peak_comfort_c.h:13493
@ PEAK_MESSAGE_DATA_TYPE_DEVICE_FOUND
Camera manager device found message data type.
Definition ids_peak_comfort_c.h:13487
PEAK_API_STATUS peak_Message_ID_Get(peak_message_handle hMessage, uint64_t *messageID)
Get the message id.
PEAK_API_STATUS peak_Message_Type_Get(peak_message_handle hMessage, peak_message_type *messageType)
Get the message type.
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:13804
PEAK_API_STATUS peak_Message_GetInfo(peak_message_handle hMessage, peak_message_info *messageInfo)
Get the info for a message.
PEAK_API_STATUS peak_Message_HostTimestamp_Get(peak_message_handle hMessage, uint64_t *hostTimestamp_ns)
Get the host timestamp for a message.
PEAK_API_STATUS peak_Message_CameraHandle_Get(peak_message_handle hMessage, peak_camera_handle *hCam)
Get the camera handle for a message.
PEAK_API_STATUS peak_Message_Release(peak_message_handle hMessage)
Release a message.
PEAK_API_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_API_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_API_STATUS peak_MessageQueue_Destroy(peak_message_queue_handle hMessageQueue)
Destroy a message queue.
PEAK_API_BOOL peak_MessageQueue_IsStarted(peak_message_queue_handle hMessageQueue)
Checks if the queue is started.
PEAK_API_STATUS peak_MessageQueue_WaitForMessage(peak_message_queue_handle hMessageQueue, uint32_t timeout_ms, peak_message_handle *hMessage)
Wait for a new message.
PEAK_API_STATUS peak_MessageQueue_SetMode(peak_message_queue_handle hMessageQueue, peak_message_queue_mode queueMode)
Set the queue mode.
PEAK_API_STATUS peak_MessageQueue_Create(peak_message_queue_handle *hMessageQueue)
Creates a new message queue.
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:13797
PEAK_API_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_API_STATUS peak_MessageQueue_Flush(peak_message_queue_handle hMessageQueue)
Flushes the queue.
PEAK_API_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_API_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_API_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_API_STATUS peak_MessageQueue_Statistics_Reset(peak_message_queue_handle hMessageQueue)
Reset the queue statistic info.
PEAK_API_STATUS peak_MessageQueue_Stop(peak_message_queue_handle hMessageQueue)
Stop the queue.
PEAK_API_STATUS peak_MessageQueue_Statistics_Get(peak_message_queue_handle hMessageQueue, peak_message_queue_statistics_info *messageQueueInfo)
Get the queue statistic info.
peak_message_queue_mode
peak queue mode Changes the behaviour of the queue
Definition ids_peak_comfort_c.h:13283
PEAK_API_STATUS peak_MessageQueue_GetMode(peak_message_queue_handle hMessageQueue, peak_message_queue_mode *queueMode)
Get the queue mode.
PEAK_API_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_API_STATUS peak_MessageQueue_Start(peak_message_queue_handle hMessageQueue)
Start the queue.
PEAK_API_STATUS peak_MessageQueue_MaxQueueSize_Get(peak_message_queue_handle hMessageQueue, size_t *messageQueueMaxSize)
Gets the maximum queue size.
@ PEAK_QUEUE_MODE_NEWEST_ONLY
Newest messages returned only (event order)
Definition ids_peak_comfort_c.h:13291
@ PEAK_QUEUE_MODE_INVALID
Invalid queue mode.
Definition ids_peak_comfort_c.h:13285
@ PEAK_QUEUE_MODE_OLDEST_FIRST
Oldest messages returned first (chronological order)
Definition ids_peak_comfort_c.h:13288
peak_message_type
The peak message types.
Definition ids_peak_comfort_c.h:13303
@ 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:13371
@ 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:13317
@ 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:13438
@ 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:13365
@ 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:13323
@ 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:13417
@ 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:13377
@ 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:13409
@ PEAK_MESSAGE_TYPE_DEVICE_DISCONNECTED
Camera manager device disconnected message type.
Definition ids_peak_comfort_c.h:13401
@ 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:13329
@ 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:13353
@ PEAK_MESSAGE_TYPE_DEVICE_RECONNECTED
Camera manager device reconnected message type.
Definition ids_peak_comfort_c.h:13396
@ 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:13311
@ 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:13341
@ 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:13445
@ 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:13335
@ 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:13347
@ 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:13384
@ 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:13359
@ 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:13391
@ 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:13452
@ 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:13431
@ PEAK_MESSAGE_TYPE_INVALID
Invalid message type.
Definition ids_peak_comfort_c.h:13305
@ 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:13424
PEAK_API_ACCESS_STATUS peak_Mirror_UpDown_GetAccessStatus(peak_camera_handle hCam)
Query the up-down mirroring access status.
PEAK_API_STATUS peak_Mirror_UpDown_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the up-down mirroring.
PEAK_API_STATUS peak_Mirror_LeftRight_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the left-right mirroring.
PEAK_API_ACCESS_STATUS peak_Mirror_LeftRight_GetAccessStatus(peak_camera_handle hCam)
Query the left-right mirroring access status.
PEAK_API_BOOL peak_Mirror_LeftRight_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the left-right mirroring.
PEAK_API_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:866
PEAK_API_BOOL peak_PixelClock_HasRange(peak_camera_handle hCam)
Check whether the valid values for the pixel clock feature are organized as a range.
PEAK_API_STATUS peak_PixelClock_Set(peak_camera_handle hCam, double pixelClock_MHz)
Set the pixel clock.
PEAK_API_STATUS peak_PixelClock_Get(peak_camera_handle hCam, double *pixelClock_MHz)
Get the pixel clock.
PEAK_API_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_API_STATUS peak_PixelClock_GetList(peak_camera_handle hCam, double *pixelClockList, size_t *pixelClockCount)
Get the list of currently selectable pixel clock values.
PEAK_API_ACCESS_STATUS peak_PixelClock_GetAccessStatus(peak_camera_handle hCam)
Query the pixel clock access status.
peak_pixel_format
peak Pixel format
Definition ids_peak_comfort_c.h:3253
PEAK_API_STATUS peak_PixelFormat_Set(peak_camera_handle hCam, peak_pixel_format pixelFormat)
Set the pixel format.
PEAK_API_STATUS peak_PixelFormat_GetInfo(peak_pixel_format pixelFormat, peak_pixel_format_info *pixelFormatInfo)
Query the pixel format info.
PEAK_API_ACCESS_STATUS peak_PixelFormat_GetAccessStatus(peak_camera_handle hCam)
Query the pixel format access status.
PEAK_API_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_API_STATUS peak_PixelFormat_GetList(peak_camera_handle hCam, peak_pixel_format *pixelFormatList, size_t *pixelFormatCount)
Get the list of currently selectable pixel formats.
PEAK_API_STATUS peak_PixelFormat_Get(peak_camera_handle hCam, peak_pixel_format *pixelFormat)
Get the pixel format.
@ PEAK_PIXEL_FORMAT_RGBA12
RGBa12.
Definition ids_peak_comfort_c.h:3330
@ PEAK_PIXEL_FORMAT_BAYER_BG12G24_IDS
BayerBG12 grouped 24.
Definition ids_peak_comfort_c.h:3423
@ PEAK_PIXEL_FORMAT_BAYER_BG10G40_IDS
BayerBG grouped 40.
Definition ids_peak_comfort_c.h:3399
@ PEAK_PIXEL_FORMAT_MONO8
Mono8.
Definition ids_peak_comfort_c.h:3297
@ PEAK_PIXEL_FORMAT_BGR8
BGR8.
Definition ids_peak_comfort_c.h:3315
@ PEAK_PIXEL_FORMAT_BAYER_RG12G24_IDS
BayerRG12 grouped 24.
Definition ids_peak_comfort_c.h:3411
@ PEAK_PIXEL_FORMAT_BAYER_GB8
BayerGB8.
Definition ids_peak_comfort_c.h:3279
@ PEAK_PIXEL_FORMAT_BAYER_GR10
BayerGR10.
Definition ids_peak_comfort_c.h:3264
@ PEAK_PIXEL_FORMAT_INVALID
Invalid pixel format.
Definition ids_peak_comfort_c.h:3258
@ PEAK_PIXEL_FORMAT_MONO12P
Mono12 packed.
Definition ids_peak_comfort_c.h:3369
@ PEAK_PIXEL_FORMAT_BGR12
BGR12.
Definition ids_peak_comfort_c.h:3321
@ PEAK_PIXEL_FORMAT_BGRA10
BGRa10.
Definition ids_peak_comfort_c.h:3336
@ PEAK_PIXEL_FORMAT_BAYER_RG10P
BayerRG10 packed.
Definition ids_peak_comfort_c.h:3348
@ PEAK_PIXEL_FORMAT_BAYER_BG10P
BayerBG10 packed.
Definition ids_peak_comfort_c.h:3360
@ PEAK_PIXEL_FORMAT_MONO12G24_IDS
Mono12 grouped 24.
Definition ids_peak_comfort_c.h:3435
@ PEAK_PIXEL_FORMAT_RGBA10
RGBa10.
Definition ids_peak_comfort_c.h:3327
@ PEAK_PIXEL_FORMAT_BAYER_GB10G40_IDS
BayerGB10 grouped 40.
Definition ids_peak_comfort_c.h:3393
@ PEAK_PIXEL_FORMAT_RGB12
RGB12.
Definition ids_peak_comfort_c.h:3312
@ PEAK_PIXEL_FORMAT_BAYER_RG10G40_IDS
BayerRG10 grouped 40.
Definition ids_peak_comfort_c.h:3387
@ PEAK_PIXEL_FORMAT_BAYER_BG12
BayerBG12.
Definition ids_peak_comfort_c.h:3294
@ PEAK_PIXEL_FORMAT_BAYER_GB12P
BayerGB12 packed.
Definition ids_peak_comfort_c.h:3357
@ PEAK_PIXEL_FORMAT_BAYER_GR12
BayerGR12.
Definition ids_peak_comfort_c.h:3267
@ PEAK_PIXEL_FORMAT_MONO10
Mono10.
Definition ids_peak_comfort_c.h:3300
@ PEAK_PIXEL_FORMAT_BAYER_GB10
BayerGB10.
Definition ids_peak_comfort_c.h:3282
@ PEAK_PIXEL_FORMAT_RGBA8
RGBa8.
Definition ids_peak_comfort_c.h:3324
@ PEAK_PIXEL_FORMAT_BAYER_GB10P
BayerGB10 packed.
Definition ids_peak_comfort_c.h:3354
@ PEAK_PIXEL_FORMAT_BGRA12
BGRa12.
Definition ids_peak_comfort_c.h:3339
@ PEAK_PIXEL_FORMAT_BAYER_RG10
BayerRG10.
Definition ids_peak_comfort_c.h:3273
@ PEAK_PIXEL_FORMAT_BAYER_RG8
BayerRG8.
Definition ids_peak_comfort_c.h:3270
@ PEAK_PIXEL_FORMAT_BAYER_BG8
BayerBG8.
Definition ids_peak_comfort_c.h:3288
@ PEAK_PIXEL_FORMAT_MONO10G40_IDS
Mono10 grouped 40.
Definition ids_peak_comfort_c.h:3429
@ PEAK_PIXEL_FORMAT_BAYER_GR10P
BayerGR10 packed.
Definition ids_peak_comfort_c.h:3342
@ PEAK_PIXEL_FORMAT_MONO12
Mono12.
Definition ids_peak_comfort_c.h:3303
@ PEAK_PIXEL_FORMAT_BAYER_GR12G24_IDS
BayerGR12 grouped 24.
Definition ids_peak_comfort_c.h:3405
@ PEAK_PIXEL_FORMAT_RGB10P32
RGB10 packed 32.
Definition ids_peak_comfort_c.h:3372
@ PEAK_PIXEL_FORMAT_BGR10P32
BGR10 packed 32.
Definition ids_peak_comfort_c.h:3375
@ PEAK_PIXEL_FORMAT_BGRA8
BGRa8.
Definition ids_peak_comfort_c.h:3333
@ PEAK_PIXEL_FORMAT_BAYER_GB12
BayerGB12.
Definition ids_peak_comfort_c.h:3285
@ PEAK_PIXEL_FORMAT_BAYER_GR8
BayerGR8.
Definition ids_peak_comfort_c.h:3261
@ PEAK_PIXEL_FORMAT_RGB10
RGB10.
Definition ids_peak_comfort_c.h:3309
@ PEAK_PIXEL_FORMAT_BAYER_GR12P
BayerGR12 packed.
Definition ids_peak_comfort_c.h:3345
@ PEAK_PIXEL_FORMAT_BGR10
BGR10.
Definition ids_peak_comfort_c.h:3318
@ PEAK_PIXEL_FORMAT_BAYER_GB12G24_IDS
BayerGB12 grouped 24.
Definition ids_peak_comfort_c.h:3417
@ PEAK_PIXEL_FORMAT_BAYER_BG12P
BayerBG12 packed.
Definition ids_peak_comfort_c.h:3363
@ PEAK_PIXEL_FORMAT_RGB8
RGB8.
Definition ids_peak_comfort_c.h:3306
@ PEAK_PIXEL_FORMAT_BAYER_BG10
BayerBG10.
Definition ids_peak_comfort_c.h:3291
@ PEAK_PIXEL_FORMAT_BAYER_RG12P
BayerRG12 packed.
Definition ids_peak_comfort_c.h:3351
@ PEAK_PIXEL_FORMAT_BAYER_GR10G40_IDS
BayerGR10 grouped 40.
Definition ids_peak_comfort_c.h:3381
@ PEAK_PIXEL_FORMAT_BAYER_RG12
BayerRG12.
Definition ids_peak_comfort_c.h:3276
@ PEAK_PIXEL_FORMAT_MONO10P
Mono10 packed.
Definition ids_peak_comfort_c.h:3366
PEAK_API_BOOL peak_Reconnect_IsEnabled(peak_interface_technology interfaceTech)
Indicates whether the reconnect is active or inactive for the specified specified interface technolog...
PEAK_API_ACCESS_STATUS peak_Reconnect_GetAccessStatus(peak_interface_technology interfaceTech)
Query the reconnect access status.
PEAK_API_STATUS peak_Reconnect_Enable(peak_interface_technology interfaceTech, peak_bool enabled)
Control whether the reconnect is enabled or disabled.
PEAK_API_STATUS peak_ROI_Get(peak_camera_handle hCam, peak_roi *roi)
Get the ROI.
PEAK_API_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_API_STATUS peak_ROI_Size_Get(peak_camera_handle hCam, peak_size *size)
Get the ROI size.
PEAK_API_STATUS peak_ROI_Offset_Set(peak_camera_handle hCam, peak_position position)
Set the ROI offset.
PEAK_API_ACCESS_STATUS peak_ROI_Size_GetAccessStatus(peak_camera_handle hCam)
Query the ROI size access status.
PEAK_API_STATUS peak_ROI_Size_Set(peak_camera_handle hCam, peak_size size)
Set the ROI size.
PEAK_API_STATUS peak_ROI_Offset_Get(peak_camera_handle hCam, peak_position *position)
Get the ROI offset.
PEAK_API_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_API_STATUS peak_ROI_Set(peak_camera_handle hCam, peak_roi roi)
Set the ROI.
PEAK_API_ACCESS_STATUS peak_ROI_GetAccessStatus(peak_camera_handle hCam)
Query the ROI access status.
PEAK_API_ACCESS_STATUS peak_ROI_Offset_GetAccessStatus(peak_camera_handle hCam)
Query the ROI offset access status.
PEAK_API_STATUS peak_Scaling_Get(peak_camera_handle hCam, double *scalingFactorX, double *scalingFactorY)
Get the scaling factors.
PEAK_API_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_API_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_API_STATUS peak_Scaling_Set(peak_camera_handle hCam, double scalingFactorX, double scalingFactorY)
Set the scaling factors.
PEAK_API_ACCESS_STATUS peak_Scaling_GetAccessStatus(peak_camera_handle hCam)
Query the scaling access status.
PEAK_API_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_API_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 Status codes
Definition ids_peak_comfort_c.h:1042
peak_access_status
peak Access status codes
Definition ids_peak_comfort_c.h:1181
@ PEAK_STATUS_SUCCESS
Success.
Definition ids_peak_comfort_c.h:1044
@ PEAK_STATUS_BUFFER_TOO_SMALL
The buffer is too small to take the complete data.
Definition ids_peak_comfort_c.h:1105
@ PEAK_STATUS_NOT_INITIALIZED
The library is not initialized.
Definition ids_peak_comfort_c.h:1081
@ PEAK_STATUS_VALUE_ADJUSTED
The set value was auto-adjusted.
Definition ids_peak_comfort_c.h:1054
@ PEAK_STATUS_NOT_IMPLEMENTED
The function is not implemented.
Definition ids_peak_comfort_c.h:1084
@ PEAK_STATUS_ERROR
Unspecified error.
Definition ids_peak_comfort_c.h:1075
@ PEAK_STATUS_OUT_OF_MEMORY
The system could not provide enough memory.
Definition ids_peak_comfort_c.h:1126
@ PEAK_STATUS_BUSY
Device or resource is busy.
Definition ids_peak_comfort_c.h:1123
@ PEAK_STATUS_TIMEOUT
A timeout occurred.
Definition ids_peak_comfort_c.h:1111
@ PEAK_STATUS_WARNING_OPERATION
A operation failed.
Definition ids_peak_comfort_c.h:1068
@ 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:1108
@ PEAK_STATUS_NO_DATA
The specified or requested data is not present.
Definition ids_peak_comfort_c.h:1117
@ PEAK_STATUS_CAMERA_NOT_FOUND
There is no such camera.
Definition ids_peak_comfort_c.h:1090
@ PEAK_STATUS_INVALID_HANDLE
The handle is invalid.
Definition ids_peak_comfort_c.h:1096
@ PEAK_STATUS_IO
Communication with the camera failed.
Definition ids_peak_comfort_c.h:1129
@ PEAK_STATUS_INVALID_PARAMETER
One or more parameters are invalid.
Definition ids_peak_comfort_c.h:1099
@ PEAK_STATUS_WARNING
Unspecified warning.
Definition ids_peak_comfort_c.h:1047
@ PEAK_STATUS_OUT_OF_RANGE
The value or configuration is out of the valid range.
Definition ids_peak_comfort_c.h:1102
@ PEAK_STATUS_WARNING_OVERFLOW
A value was dropped.
Definition ids_peak_comfort_c.h:1061
@ PEAK_STATUS_INVALID_PEAK_INSTALLATION
The peak installation is corrupted.
Definition ids_peak_comfort_c.h:1120
@ PEAK_STATUS_ABORTED
The operation was aborted.
Definition ids_peak_comfort_c.h:1114
@ PEAK_STATUS_ACCESS_DENIED
The access to the requested feature was denied due to the current system status.
Definition ids_peak_comfort_c.h:1087
@ PEAK_STATUS_CAMERA_NOT_AVAILABLE
The specified camera is not available.
Definition ids_peak_comfort_c.h:1093
@ PEAK_ACCESS_GFA_LOCK
No access.
Definition ids_peak_comfort_c.h:1210
@ PEAK_ACCESS_INVALID
Invalid access status code.
Definition ids_peak_comfort_c.h:1189
@ PEAK_ACCESS_WRITEONLY
Write only access.
Definition ids_peak_comfort_c.h:1222
@ PEAK_ACCESS_NOT_SUPPORTED
Not supported.
Definition ids_peak_comfort_c.h:1197
@ PEAK_ACCESS_READONLY
Read only access.
Definition ids_peak_comfort_c.h:1216
@ PEAK_ACCESS_NONE
No access.
Definition ids_peak_comfort_c.h:1203
@ PEAK_ACCESS_READWRITE
Read write access.
Definition ids_peak_comfort_c.h:1228
PEAK_API_STATUS peak_TestPattern_GetList(peak_camera_handle hCam, peak_test_pattern *testPatternList, size_t *testPatternCount)
Get the list of currently usable test pattern.
PEAK_API_STATUS peak_TestPattern_Get(peak_camera_handle hCam, peak_test_pattern *pattern)
Get the test pattern.
PEAK_API_ACCESS_STATUS peak_TestPattern_GetAccessStatus(peak_camera_handle hCam)
Query the test pattern access status.
PEAK_API_STATUS peak_TestPattern_Set(peak_camera_handle hCam, peak_test_pattern pattern)
Set the test pattern.
peak_test_pattern
peak test pattern
Definition ids_peak_comfort_c.h:15729
@ PEAK_TEST_PATTERN_COLORBAR
Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan,...
Definition ids_peak_comfort_c.h:15743
@ 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:15763
@ PEAK_TEST_PATTERN_GREYDIAGONALRAMPMOVING
GreyDiagonalRampMoving: Moving diagonal ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:15761
@ PEAK_TEST_PATTERN_FPGAGRAYSCALE
Grayscale generated by FPGA.
Definition ids_peak_comfort_c.h:15753
@ PEAK_TEST_PATTERN_INVALID
Invalid test pattern.
Definition ids_peak_comfort_c.h:15734
@ PEAK_TEST_PATTERN_GREYWEDGEMOVINGSENSOR
GreyWedgeMovingSensor: Moving grey wedges generated by the image sensor.
Definition ids_peak_comfort_c.h:15767
@ PEAK_TEST_PATTERN_FPGACOLORSTRIPE
ColorStripe generated by FPGA.
Definition ids_peak_comfort_c.h:15749
@ PEAK_TEST_PATTERN_FPGAFRAMECOUNT
Framecount generated by FPGA.
Definition ids_peak_comfort_c.h:15751
@ PEAK_TEST_PATTERN_WHITE
White: Image is filled with the brightest possible image.
Definition ids_peak_comfort_c.h:15777
@ PEAK_TEST_PATTERN_FPGAVERTICALGRAYSCALE
VerticalGrayscale generated by FPGA.
Definition ids_peak_comfort_c.h:15755
@ PEAK_TEST_PATTERN_GREYWEDGESENSOR
GreyWedgeSensor: Grey wedges generated by the image sensor.
Definition ids_peak_comfort_c.h:15769
@ PEAK_TEST_PATTERN_GREYVERTICALRAMP
GreyVerticalRamp: Vertical ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:15765
@ PEAK_TEST_PATTERN_CHESSPATTERN
Chessboard pattern.
Definition ids_peak_comfort_c.h:15741
@ PEAK_TEST_PATTERN_FPGACHESSBOARD
Chessboard generated by FPGA.
Definition ids_peak_comfort_c.h:15747
@ PEAK_TEST_PATTERN_OFF
Image is coming from the sensor.
Definition ids_peak_comfort_c.h:15737
@ PEAK_TEST_PATTERN_BLACK
Image is filled with the darkest possible image.
Definition ids_peak_comfort_c.h:15739
@ PEAK_TEST_PATTERN_RAMPINGPATTERN
RampingPattern: Diagonal color pattern.
Definition ids_peak_comfort_c.h:15771
@ PEAK_TEST_PATTERN_FPGAWHITE
White generated by FPGA.
Definition ids_peak_comfort_c.h:15757
@ PEAK_TEST_PATTERN_SEQUENCEPATTERN2
SequencePattern2: SequencePattern2.
Definition ids_peak_comfort_c.h:15775
@ PEAK_TEST_PATTERN_FPGABLACK
Black generated by FPGA.
Definition ids_peak_comfort_c.h:15745
@ PEAK_TEST_PATTERN_SEQUENCEPATTERN1
SequencePattern1: SequencePattern1.
Definition ids_peak_comfort_c.h:15773
@ PEAK_TEST_PATTERN_GREYDIAGONALRAMP
GreyDiagonalRamp: Diagonal ramp with grey values from black to white.
Definition ids_peak_comfort_c.h:15759
PEAK_API_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_API_ACCESS_STATUS peak_Trigger_Burst_GetAccessStatus(peak_camera_handle hCam)
Query the trigger burst property access status.
PEAK_API_STATUS peak_Trigger_Burst_Get(peak_camera_handle hCam, uint32_t *triggerBurst)
Get the trigger burst.
PEAK_API_STATUS peak_Trigger_Burst_Set(peak_camera_handle hCam, uint32_t triggerBurst)
Set the trigger burst.
PEAK_API_STATUS peak_Trigger_Delay_Set(peak_camera_handle hCam, double triggerDelay_us)
Set the trigger delay.
PEAK_API_ACCESS_STATUS peak_Trigger_Delay_GetAccessStatus(peak_camera_handle hCam)
Query the trigger delay property access status.
PEAK_API_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_API_STATUS peak_Trigger_Delay_Get(peak_camera_handle hCam, double *triggerDelay_us)
Get the trigger delay.
PEAK_API_STATUS peak_Trigger_Divider_Get(peak_camera_handle hCam, uint32_t *triggerDivider)
Get the trigger divider.
PEAK_API_STATUS peak_Trigger_Divider_Set(peak_camera_handle hCam, uint32_t triggerDivider)
Set the trigger divider.
PEAK_API_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_API_ACCESS_STATUS peak_Trigger_Divider_GetAccessStatus(peak_camera_handle hCam)
Query the trigger divider property access status.
peak_trigger_edge
peak Trigger edge
Definition ids_peak_comfort_c.h:5148
PEAK_API_STATUS peak_Trigger_Edge_Get(peak_camera_handle hCam, peak_trigger_edge *triggerEdge)
Get the trigger edge.
PEAK_API_ACCESS_STATUS peak_Trigger_Edge_GetAccessStatus(peak_camera_handle hCam)
Query the trigger edge property access status.
PEAK_API_STATUS peak_Trigger_Edge_Set(peak_camera_handle hCam, peak_trigger_edge triggerEdge)
Set the trigger edge.
PEAK_API_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_TRIGGER_EDGE_FALLING
Falling edge.
Definition ids_peak_comfort_c.h:5165
@ PEAK_TRIGGER_EDGE_ANY
Any edge.
Definition ids_peak_comfort_c.h:5171
@ PEAK_TRIGGER_EDGE_INVALID
Invalid trigger edge.
Definition ids_peak_comfort_c.h:5153
@ PEAK_TRIGGER_EDGE_RISING
Rising edge.
Definition ids_peak_comfort_c.h:5159
PEAK_API_STATUS peak_Trigger_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the trigger.
PEAK_API_BOOL peak_Trigger_IsExecutable(peak_camera_handle hCam)
Check whether the trigger is executable or not.
PEAK_API_STATUS peak_Trigger_Mode_Set(peak_camera_handle hCam, peak_trigger_mode triggerMode)
Set the trigger mode.
PEAK_API_BOOL peak_Trigger_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the trigger.
peak_trigger_target
peak Trigger target
Definition ids_peak_comfort_c.h:4865
PEAK_API_ACCESS_STATUS peak_Trigger_Mode_GetAccessStatus(peak_camera_handle hCam, peak_trigger_mode triggerMode)
Query the trigger mode access status.
PEAK_API_ACCESS_STATUS peak_Trigger_GetAccessStatus(peak_camera_handle hCam)
Query the trigger feature access status.
PEAK_API_STATUS peak_Trigger_Execute(peak_camera_handle hCam)
Execute the trigger.
PEAK_API_STATUS peak_Trigger_Mode_Get(peak_camera_handle hCam, peak_trigger_mode *triggerMode)
Get the trigger mode.
@ PEAK_TRIGGER_TARGET_INVALID
Invalid trigger target.
Definition ids_peak_comfort_c.h:4870
@ PEAK_TRIGGER_TARGET_LEVEL_CONTROLLED_EXPOSURE
Level controlled exposure.
Definition ids_peak_comfort_c.h:4882
@ PEAK_TRIGGER_TARGET_FRAME_START
Frame start.
Definition ids_peak_comfort_c.h:4876
struct peak_video * peak_video_handle
peak Video handle
Definition ids_peak_comfort_c.h:12479
PEAK_API_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_video_encoder
peak Encoder types
Definition ids_peak_comfort_c.h:12488
peak_video_encoder_option
peak container options
Definition ids_peak_comfort_c.h:12737
PEAK_API_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:12715
PEAK_API_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_API_STATUS peak_VideoWriter_Close(peak_video_handle hVideo)
Closes a video file.
PEAK_API_STATUS peak_VideoWriter_WaitUntilQueueEmpty(peak_video_handle hVideo, int32_t timeout_ms)
Wait until queue is empty.
PEAK_API_STATUS peak_VideoWriter_Encoder_GetContainerList(peak_video_encoder encoder, peak_video_container *containerList, size_t *containerCount)
Get the list of currently usable containers.
PEAK_API_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_API_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_API_STATUS peak_VideoWriter_Container_GetEncoderList(peak_video_container container, peak_video_encoder *encoderList, size_t *encoderCount)
Get the list of currently usable encoders.
peak_video_container
peak Container types
Definition ids_peak_comfort_c.h:12507
PEAK_API_STATUS peak_VideoWriter_AddFrame(peak_video_handle hVideo, peak_frame_handle hFrame)
Writes a image frame into the video file.
PEAK_API_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_VIDEO_ENCODER_INVALID
Invalid encoder.
Definition ids_peak_comfort_c.h:12493
@ PEAK_VIDEO_ENCODER_MJPEG
Motion JPEG.
Definition ids_peak_comfort_c.h:12496
@ PEAK_VIDEO_ENCODER_OPTION_INVALID
Invalid encoder option.
Definition ids_peak_comfort_c.h:12742
@ PEAK_VIDEO_ENCODER_OPTION_QUALITY
Quality encoder option.
Definition ids_peak_comfort_c.h:12748
@ PEAK_VIDEO_CONTAINER_OPTION_FRAMERATE
Framerate container option.
Definition ids_peak_comfort_c.h:12726
@ PEAK_VIDEO_CONTAINER_OPTION_INVALID
Invalid container option.
Definition ids_peak_comfort_c.h:12720
@ PEAK_VIDEO_CONTAINER_AVI
Audio Video Interleave.
Definition ids_peak_comfort_c.h:12515
@ PEAK_VIDEO_CONTAINER_INVALID
Invalid container.
Definition ids_peak_comfort_c.h:12512
peak_endianness
endianness order
Definition ids_peak_comfort_c.h:14907
@ PEAK_ENDIANNESS_INVALID
Invalid endianness.
Definition ids_peak_comfort_c.h:14912
@ PEAK_ENDIANNESS_BIG_ENDIAN
big-endian (BE)
Definition ids_peak_comfort_c.h:14918
@ PEAK_ENDIANNESS_LITTLE_ENDIAN
little-endian (LE)
Definition ids_peak_comfort_c.h:14924
peak_interface_technology
peak interface technology
Definition ids_peak_comfort_c.h:1285
@ peak_interface_technology_INVALID
Invalid interface technology type.
Definition ids_peak_comfort_c.h:1290
@ peak_interface_technology_GEV
GigE vision interface technology.
Definition ids_peak_comfort_c.h:1292
@ peak_interface_technology_UEYE
uEye interface technology
Definition ids_peak_comfort_c.h:1296
@ peak_interface_technology_U3V
USB3 vision interface technology.
Definition ids_peak_comfort_c.h:1294
peak Acquisition info
Definition ids_peak_comfort_c.h:2371
double fps
Measured framerate.
Definition ids_peak_comfort_c.h:2402
uint32_t numIncomplete
Number of incomplete frame transmissions.
Definition ids_peak_comfort_c.h:2394
uint32_t numUnderrun
Number of buffer underruns.
Definition ids_peak_comfort_c.h:2378
uint32_t numDropped
Number of dropped frames.
Definition ids_peak_comfort_c.h:2386
peak Buffer descriptor
Definition ids_peak_comfort_c.h:894
size_t memorySize
The size of allocated buffer memory.
Definition ids_peak_comfort_c.h:899
uint8_t * memoryAddress
The memory address at which the buffer starts.
Definition ids_peak_comfort_c.h:896
void * userContext
User context pointer.
Definition ids_peak_comfort_c.h:908
peak Camera descriptor
Definition ids_peak_comfort_c.h:1489
peak_interface_technology interfaceTechnology
The interface technology.
Definition ids_peak_comfort_c.h:1520
peak_camera_id cameraID
The camera id.
Definition ids_peak_comfort_c.h:1491
peak_camera_type cameraType
The camera type.
Definition ids_peak_comfort_c.h:1494
peak Double Limit
Definition ids_peak_comfort_c.h:10770
double max
Maximum.
Definition ids_peak_comfort_c.h:10774
double min
Minimum.
Definition ids_peak_comfort_c.h:10772
peak Ethernet info
Definition ids_peak_comfort_c.h:2102
peak_mac_address cameraMAC
The mac address of the camera.
Definition ids_peak_comfort_c.h:2104
peak_mac_address hostMAC
The mac address of the host.
Definition ids_peak_comfort_c.h:2124
peak_ip_config cameraPersistentIP
The current persistent ip address of the camera.
Definition ids_peak_comfort_c.h:2113
peak_bool cameraDHCPEnabled
The current DHCP enabled status of the camera.
Definition ids_peak_comfort_c.h:2110
peak_ethernet_status cameraEthernetStatus
The current ethernet status of the camera.
Definition ids_peak_comfort_c.h:2116
peak_ip_config hostIP
The current subnet mask of the host.
Definition ids_peak_comfort_c.h:2121
peak_ip_config cameraIP
The current ip address of the camera.
Definition ids_peak_comfort_c.h:2107
peak Flash mode
Definition ids_peak_comfort_c.h:5632
peak_flash_reference flashReference
Flash reference.
Definition ids_peak_comfort_c.h:5637
peak_io_channel ioChannel
IO channel.
Definition ids_peak_comfort_c.h:5643
The peak focus ROI (2D) with weight.
Definition ids_peak_comfort_c.h:11605
peak_roi roi
The peak ROI (2D)
Definition ids_peak_comfort_c.h:11607
peak_focus_roi_weight weight
The ROI weight.
Definition ids_peak_comfort_c.h:11610
peak Frame info
Definition ids_peak_comfort_c.h:3560
uint64_t frameID
The frame id.
Definition ids_peak_comfort_c.h:3574
uint32_t processingTime_ms
The host side processing time.
Definition ids_peak_comfort_c.h:3614
peak_bool isComplete
'Complete' flag
Definition ids_peak_comfort_c.h:3592
peak_frame_type type
The type and format of the contents of the frame.
Definition ids_peak_comfort_c.h:3562
peak_pixel_format pixelFormat
The pixel format.
Definition ids_peak_comfort_c.h:3586
size_t bytesWritten
The number of bytes actually written to the buffer.
Definition ids_peak_comfort_c.h:3608
uint64_t timestamp_ns
The timestamp in nanoseconds.
Definition ids_peak_comfort_c.h:3580
peak_roi roi
The ROI of the frame.
Definition ids_peak_comfort_c.h:3583
peak_buffer buffer
The memory buffer that stores the frame contents.
Definition ids_peak_comfort_c.h:3565
size_t bytesExpected
The number of bytes expected for a complete image.
Definition ids_peak_comfort_c.h:3599
peak GFA enumeration entry
Definition ids_peak_comfort_c.h:9675
int64_t integerValue
The integer value of the enumeration entry.
Definition ids_peak_comfort_c.h:9680
The peak information struct for CNN details.
Definition ids_peak_comfort_c.h:12986
peak_inference_type inferenceType
Inference type.
Definition ids_peak_comfort_c.h:13003
size_t inputHeight
Input height of the CNN.
Definition ids_peak_comfort_c.h:13009
size_t inputWidth
Input width of the CNN.
Definition ids_peak_comfort_c.h:13006
size_t numberOfClasses
Number of classes of the CNN.
Definition ids_peak_comfort_c.h:13018
uint64_t creationTime_s
Creation time (in Seconds) of the CNN.
Definition ids_peak_comfort_c.h:12994
peak_version fileVersion
File version of the CNN.
Definition ids_peak_comfort_c.h:12988
peak_inference_preprocessing_mode preprocessingMode
Preprocessing mode used for the CNN.
Definition ids_peak_comfort_c.h:13015
peak_pixel_format inputPixelFormat
Input pixel format.
Definition ids_peak_comfort_c.h:13012
The inference classification result.
Definition ids_peak_comfort_c.h:12926
peak_inference_type type
inference CNN model
Definition ids_peak_comfort_c.h:12928
float score
Inference score.
Definition ids_peak_comfort_c.h:12931
The peak inference result.
Definition ids_peak_comfort_c.h:12943
uint32_t inference_time_us
Frame inference time (microseconds)
Definition ids_peak_comfort_c.h:12954
peak_frame_handle frameHandle
Handle to the frame.
Definition ids_peak_comfort_c.h:12948
uint32_t preprocessing_time_us
Frame preprocessing time (microseconds)
Definition ids_peak_comfort_c.h:12951
peak_inference_type type
Type of inference.
Definition ids_peak_comfort_c.h:12945
The inference detection result.
Definition ids_peak_comfort_c.h:12906
peak_roi rect
ROI of the detected class.
Definition ids_peak_comfort_c.h:12917
peak_inference_type type
inference CNN model
Definition ids_peak_comfort_c.h:12908
float score
Inference score.
Definition ids_peak_comfort_c.h:12911
peak IP configuration
Definition ids_peak_comfort_c.h:2035
peak_ip_address address
The ip address.
Definition ids_peak_comfort_c.h:2037
peak_ip_address subnetMask
The subnet mask.
Definition ids_peak_comfort_c.h:2040
peak message data for auto focus data messages.
Definition ids_peak_comfort_c.h:13596
int32_t focusValue
Focus value.
Definition ids_peak_comfort_c.h:13598
int32_t sharpnessValue
Sharpness value for the focus value.
Definition ids_peak_comfort_c.h:13601
peak message data for camera manager device disconnected messages.
Definition ids_peak_comfort_c.h:13660
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:13662
peak message data for camera manager device found messages.
Definition ids_peak_comfort_c.h:13613
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:13615
peak message data for camera manager device lost messages.
Definition ids_peak_comfort_c.h:13628
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:13630
peak message data for camera manager device reconnected messages.
Definition ids_peak_comfort_c.h:13643
peak_camera_descriptor cameraDescriptor
The camera descriptor.
Definition ids_peak_comfort_c.h:13645
Message data containing information about the current state of a firmware update.
Definition ids_peak_comfort_c.h:13713
peak_firmware_update_step step
Firmware update step that the message refers to.
Definition ids_peak_comfort_c.h:13724
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:13732
peak_camera_id cameraId
ID of the camera that the firmware update has been started with.
Definition ids_peak_comfort_c.h:13718
peak_firmware_update_status stepStatus
Status of the referred update step
Definition ids_peak_comfort_c.h:13727
peak message data for remote device dropped messages.
Definition ids_peak_comfort_c.h:13542
int64_t count
Number of dropped frames.
Definition ids_peak_comfort_c.h:13547
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:13544
peak message data for remote device error messages.
Definition ids_peak_comfort_c.h:13524
int64_t error_type
The error type.
Definition ids_peak_comfort_c.h:13529
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:13526
peak message data for remote device frame messages.
Definition ids_peak_comfort_c.h:13560
int64_t frameId
The Frame ID.
Definition ids_peak_comfort_c.h:13565
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:13562
peak message data for remote device temperature messages.
Definition ids_peak_comfort_c.h:13578
double temperature
The temperature in °C.
Definition ids_peak_comfort_c.h:13583
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:13580
peak message data for remote device messages.
Definition ids_peak_comfort_c.h:13509
int64_t timestamp_ns
Camera timestamp in nanoseconds the event occurred.
Definition ids_peak_comfort_c.h:13511
peak message info struct
Definition ids_peak_comfort_c.h:13772
uint64_t messageID
internal message ID
Definition ids_peak_comfort_c.h:13780
peak_camera_handle hCam
camera handle for device events or PEAK_INVALID_HANDLE for system messages
Definition ids_peak_comfort_c.h:13777
peak_message_type type
type of the message
Definition ids_peak_comfort_c.h:13774
uint64_t hostMessageTimestamp_ns
message enqueue timestamp in nanoseconds. For further infos see peak_Message_HostTimestamp_Get.
Definition ids_peak_comfort_c.h:13783
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:13786
peak queue info struct
Definition ids_peak_comfort_c.h:13747
uint64_t numInQueue
Number of messages currently in the message queue.
Definition ids_peak_comfort_c.h:13758
uint64_t numDelivered
Counter of messages delivered by the message queue.
Definition ids_peak_comfort_c.h:13752
uint64_t numDropped
Counter of messages dropped by the message queue.
Definition ids_peak_comfort_c.h:13755
uint64_t numMaxQueueSize
Maximum number of concurrent messages in the message queue.
Definition ids_peak_comfort_c.h:13761
uint64_t numQueued
Counter of messages which were queued in the message queue.
Definition ids_peak_comfort_c.h:13749
peak Pixel format info
Definition ids_peak_comfort_c.h:3447
uint32_t numSignificantBitsPerChannel
Significant bits per channel.
Definition ids_peak_comfort_c.h:3476
uint32_t numBitsPerPixel
Bits per pixel.
Definition ids_peak_comfort_c.h:3452
uint32_t numSignificantBitsPerPixel
Significant bits per pixel.
Definition ids_peak_comfort_c.h:3458
uint32_t numChannels
Number of channels.
Definition ids_peak_comfort_c.h:3464
uint32_t maxValuePerChannel
Maximum value per channel.
Definition ids_peak_comfort_c.h:3482
uint32_t numBitsPerChannel
Bits per channel.
Definition ids_peak_comfort_c.h:3470
peak Position (2D)
Definition ids_peak_comfort_c.h:943
uint32_t y
Y-Position.
Definition ids_peak_comfort_c.h:948
uint32_t x
X-Position.
Definition ids_peak_comfort_c.h:945
peak information whether reconnect is successful, the acquisition is running and the configuration is...
Definition ids_peak_comfort_c.h:1534
peak_bool isReconnectSuccessful
Reconnect successful status True if the reconnected was successful.
Definition ids_peak_comfort_c.h:1538
peak_bool isAcquisitionRunning
device acquisition restarted status True if the acquisition could be restarted
Definition ids_peak_comfort_c.h:1543
peak_bool isConfigurationRestored
device configuration restored status True if the configuration could be restored
Definition ids_peak_comfort_c.h:1548
The peak ROI (2D)
Definition ids_peak_comfort_c.h:959
peak_size size
ROI size.
Definition ids_peak_comfort_c.h:964
peak_position offset
ROI offset.
Definition ids_peak_comfort_c.h:961
peak Size (2D)
Definition ids_peak_comfort_c.h:923
uint32_t width
Width.
Definition ids_peak_comfort_c.h:925
uint32_t height
Height.
Definition ids_peak_comfort_c.h:928
peak Trigger mode
Definition ids_peak_comfort_c.h:4908
peak_io_channel ioChannel
The iO channel.
Definition ids_peak_comfort_c.h:4919
peak_trigger_target triggerTarget
The trigger target.
Definition ids_peak_comfort_c.h:4913
The peak version info.
Definition ids_peak_comfort_c.h:12966
uint32_t subMinor
Subminor version.
Definition ids_peak_comfort_c.h:12974
uint32_t patch
Patch level.
Definition ids_peak_comfort_c.h:12977
uint32_t minor
Minor version.
Definition ids_peak_comfort_c.h:12971
uint32_t major
Major version.
Definition ids_peak_comfort_c.h:12968
video info structure
Definition ids_peak_comfort_c.h:12679
peak IPv4 address
Definition ids_peak_comfort_c.h:2017
uint32_t addr
The IP address in little-endian word representation.
Definition ids_peak_comfort_c.h:2019
peak MAC-48 address
Definition ids_peak_comfort_c.h:1758
uint32_t low_part
Lower 4 bytes of the MAC address.
Definition ids_peak_comfort_c.h:1769
uint16_t high_part
Upper 2 bytes of the MAC address.
Definition ids_peak_comfort_c.h:1766
The peak 3x3 Matrix.
Definition ids_peak_comfort_c.h:986
double element_00
Element 00.
Definition ids_peak_comfort_c.h:991
double element_21
Element 21.
Definition ids_peak_comfort_c.h:1012
double element_12
Element 12.
Definition ids_peak_comfort_c.h:1006
double element_20
Element 20.
Definition ids_peak_comfort_c.h:1009
double element_02
Element 02.
Definition ids_peak_comfort_c.h:997
double element_11
Element 11.
Definition ids_peak_comfort_c.h:1003
double element_22
Element 22.
Definition ids_peak_comfort_c.h:1015
double element_01
Element 01.
Definition ids_peak_comfort_c.h:994
double element_10
Element 10.
Definition ids_peak_comfort_c.h:1000