-
Notifications
You must be signed in to change notification settings - Fork 1
/
xiApiOthers.cs
2891 lines (2501 loc) · 95.9 KB
/
xiApiOthers.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System;
namespace XimeaWrapper
{
/// <summary>
/// Definitions containing information about acqisition timing modes.
/// </summary>
public static class ACQ_TIMING_MODE
{
/// <summary> Selects a mode when sensor timing is given by fastest framerate possible (by exposure time and readout)</summary>
public const int FREE_RUN = 0;
/// <summary> Selects a mode when sensor frame acquisition frequency is set to FRAMERATE</summary>
public const int FRAME_RATE = 1;
/// <summary> Selects a mode when sensor frame acquisition frequency is limited by FRAMERATE</summary>
public const int FRAME_RATE_LIMIT = 2;
}
/// <summary>
/// Acquisition status Selector
/// </summary>
public static class ACQUISITION_STATUS_SELECTOR
{
/// <summary> Device is currently doing an acquisition</summary>
public const int ACQUISITION_STATUS_ACQ_ACTIVE = 0;
}
/// <summary>
/// Selects binning mode
/// </summary>
public static class BINNING_MODE
{
/// <summary>
/// The response from the combined pixels will be added, resulting in increased sensitivity.
/// </summary>
public const int SUM = 0;
/// <summary>
/// The response from the combined pixels will be averaged, resulting in increased signal/noise ratio.
/// </summary>
public const int AVERAGE = 1;
}
// xiApi.NET.BINNING_PATTERN
/// <summary>
/// Selects Binning pattern type.
/// </summary>
public static class BINNING_PATTERN
{
/// <summary>
/// Monochrome type binning - adjacent pixels are combined.
/// </summary>
public const int MONO = 1;
/// <summary>
/// Bayer type binning - bayer pattern is preserved during pixel combining.
/// </summary>
public const int BAYER = 2;
}
// xiApi.NET.BINNING_SELECTOR
/// <summary>
/// Selects which binning engine is configured by BinningHorizontal, BinningVertical and BinningPattern parameters
/// </summary>
public static class BINNING_SELECTOR
{
/// <summary>
/// Sensor binning engine selected (if available)
/// </summary>
public const int SENSOR = 0;
}
// xiApi.NET.BUFF_POLICY
/// <summary>
/// Buffer policy settings(can be safe, data will be copied to user/app buffer or unsafe, user will get internally allocated buffer without data copy).
/// </summary>
public static class BUFF_POLICY
{
/// <summary>
/// User gets pointer to internally allocated circle buffer and data may be overwritten by device.
/// </summary>
public const int UNSAFE = 0;
/// <summary>
/// Data from device will be copied to user allocated buffer or xiApi allocated memory.
/// </summary>
public const int SAFE = 1;
}
// xiApi.NET.CMS_INTENTS
/// <summary>
/// CMS functionality options
/// </summary>
public static class CMS_INTENTS
{
/// <summary> intent perceptual.</summary>
public const int INTENT_PERCEPTUAL = 0;
/// <summary> intent relative colorimetric.</summary>
public const int RELATIVE_COLORIMETRIC = 1;
/// <summary> intent saturation.</summary>
public const int SATURATION = 2;
/// <summary> intent absolute colorimetric.</summary>
public const int ABSOLUTE_COLORIMETRIC = 3;
}
// xiApi.NET.CMS_MODE
/// <summary>
/// CMS functionality options
/// </summary>
public static class CMS_MODE
{
/// <summary> CMS disable.</summary>
public const int DIS = 0;
/// <summary> CMS enable.</summary>
public const int EN = 1;
/// <summary> CMS enable(fast).</summary>
public const int EN_FAST = 2;
}
// xiApi.NET.COUNTER_SELECTOR
/// <summary>
/// Definitions containing information about frames counter selector.
/// </summary>
public static class COUNTER_SELECTOR
{
/// <summary> Number of skipped frames on transport layer (e.g. when image gets lost while transmission). Occur when capacity of transport channel does not allow to transfer all data.</summary>
public const int CNT_SEL_TRANSPORT_SKIPPED_FRAMES = 0;
/// <summary> Number of skipped frames on API layer. Occur when application does not process the images as quick as they are received from the camera.</summary>
public const int CNT_SEL_API_SKIPPED_FRAMES = 1;
/// <summary> Number of successfully transferred frames on transport layer.</summary>
public const int CNT_SEL_TRANSPORT_TRANSFERRED_FRAMES = 2;
}
// xiApi.NET.DEBUG_LEVEL
/// <summary>
/// Debug level enumerator.
/// </summary>
public static class DEBUG_LEVEL
{
/// <summary> Information level.</summary>
public const int TRACE = 0;
/// <summary> Warning level.</summary>
public const int WARNING = 1;
/// <summary> Error level.</summary>
public const int ERROR = 2;
/// <summary> Fatal error level.</summary>
public const int FATAL = 3;
}
// xiApi.NET.DECIMATION_PATTERN
/// <summary>
/// Selects Decimation pattern type.
/// </summary>
public static class DECIMATION_PATTERN
{
/// <summary>
/// Monochrome type decimation - adjacent pixels are skipped.
/// </summary>
public const int MONO = 1;
/// <summary>
/// Bayer type decimation - bayer pattern is preserved during pixel skipping.
/// </summary>
public const int BAYER = 2;
}
// xiApi.NET.DECIMATION_SELECTOR
/// <summary>
/// Selects which decimation engine is configured by DecimationHorizontal, DecimationVertical and DecimationPattern parameters
/// </summary>
public static class DECIMATION_SELECTOR
{
/// <summary>
/// Sensor decimation engine selected (if available)
/// </summary>
public const int SENSOR = 0;
}
// xiApi.NET.DOWNSAMPLING_TYPE
/// <summary>
/// Downsampling type, switch between binning and skipping, to be used with the PRM.DOWNSAMPLING_TYPE function parameter.
/// </summary>
public static class DOWNSAMPLING_TYPE
{
/// <summary>
/// Binned type for higher sensitivity.
/// </summary>
public const int BINNING = 0;
/// <summary>
/// Skipped type for higher framerates.
/// </summary>
public const int SKIPPING = 1;
}
// xiApi.NET.GAIN_SELECTOR_TYPE
/// <summary>
/// Selects gain to be set with Gain parameters.
/// </summary>
public static class GAIN_SELECTOR_TYPE
{
/// <summary>
/// Gain selector selects all channels. Implementation of gain type depends on camera.
/// </summary>
public const int GAIN_SELECTOR_ALL = 0;
/// <summary>
/// Gain selector selects all analog channels. This is available only on some cameras.
/// </summary>
public const int GAIN_SELECTOR_ANALOG_ALL = 1;
/// <summary>
/// Gain selector selects all digital channels. This is available only on some cameras.
/// </summary>
public const int GAIN_SELECTOR_DIGITAL_ALL = 2;
}
// xiApi.NET.GPI_MODE
/// <summary>
/// GPI port state options
/// </summary>
public static class GPI_MODE
{
/// <summary> Input off.</summary>
public const int OFF = 0;
/// <summary> Trigger input.</summary>
public const int TRIGGER = 1;
/// <summary> External signal input. It is not implemented yet.</summary>
public const int EXT_EVENT = 2;
}
// xiApi.NET.GPO_MODE
/// <summary>
/// GPO port state options
/// </summary>
public static class GPO_MODE
{
/// <summary> Output off.</summary>
public const int OFF = 0;
/// <summary> Logical level.</summary>
public const int ON = 1;
/// <summary> High during exposure(integration) time + readout time + data transfer time.</summary>
public const int FRAME_ACTIVE = 2;
/// <summary> Low during exposure(integration) time + readout time + data trasnfer time.</summary>
public const int FRAME_ACTIVE_NEG = 3;
/// <summary> High during exposure(integration) time.</summary>
public const int EXPOSURE_ACTIVE = 4;
/// <summary> Low during exposure(integration) time.</summary>
public const int EXPOSURE_ACTIVE_NEG = 5;
/// <summary> On when sensor is ready for next trigger edge. </summary>
public const int FRAME_TRIGGER_READY = 6;
/// <summary> Off when sensor is ready for next trigger edge. </summary>
public const int FRAME_TRIGGER_READY_NEG = 7;
/// <summary> Short On/Off pulse on start of each exposure. </summary>
public const int EXPOSURE_PULSE = 8;
/// <summary> Short Off/On pulse on start of each exposure. </summary>
public const int EXPOSURE_PULSE_NEG = 9;
}
// xiApi.NET.IMG_COLOR_FILTER_ARRAY
/// <summary>
/// Output image color filter array of RAW images.
/// </summary>
public static class IMG_COLOR_FILTER_ARRAY
{
/// <summary>
/// B/W sensors.
/// </summary>
public const int NONE = 0;
/// <summary>
/// Regular Bayer RGGB readout
/// </summary>
public const int BAYER_RGGB = 1;
/// <summary>
/// AK Sony sensors
/// </summary>
public const int CMYG = 2;
/// <summary>
/// 2R+G readout of RGGB sensor
/// </summary>
public const int RGR = 3;
/// <summary>
/// Bayer BGGR readout
/// </summary>
public const int BAYER_BGGR = 4;
/// <summary>
/// Bayer GRBG readout
/// </summary>
public const int BAYER_GRBG = 5;
/// <summary>
/// Bayer GBRG readout
/// </summary>
public const int BAYER_GBRG = 6;
}
// xiApi.NET.IMG_FORMAT
/// <summary>
/// Output image format definitions to be used with the PRM.IMAGE_DATA_FORMAT function parameter.
/// </summary>
public static class IMG_FORMAT
{
/// <summary>
/// Monochrome image with 8 bits per pixel.
/// </summary>
public const int MONO8 = 0;
/// <summary>
/// Monochrome image with 16 bits per pixel.
/// </summary>
public const int MONO16 = 1;
/// <summary>
/// RGB image data format image with 8 bits per pixel.
/// </summary>
public const int RGB24 = 2;
/// <summary>
/// RGBA image data format image with 8 bits per pixel, Alpha values not valid.
/// </summary>
public const int RGB32 = 3;
/// <summary>
/// RGB planar image data format image with 8 bits per pixel.
/// </summary>
public const int RGBPLANAR = 4;
/// <summary>
/// 8 bits per pixel raw data from sensor.
/// </summary>
public const int RAW8 = 5;
/// <summary>
/// 16 bits per pixel raw data from sensor.
/// </summary>
public const int RAW16 = 6;
}
// xiApi.NET.LED_MODE
/// <summary>
/// Camera LED state options
/// </summary>
public static class LED_MODE
{
/// <summary> Blink if link is ok (led 1), heartbeat mode (led 2).</summary>
public const int LED_HEARTBEAT = 0;
/// <summary> Blink led if trigger detected.</summary>
public const int LED_TRIGGER_ACTIVE = 1;
/// <summary> Blink led if external signal detected.</summary>
public const int LED_EXT_EVENT_ACTIVE = 2;
/// <summary> Blink led during data streaming.</summary>
public const int LED_ACQUISITION = 3;
/// <summary> Blink led during sensor integration time.</summary>
public const int LED_EXPOSURE_ACTIVE = 4;
/// <summary> Blink if device busy/not busy.</summary>
public const int LED_FRAME_ACTIVE = 5;
/// <summary> Blink led if link is ok.</summary>
public const int LED_LINK = 6;
/// <summary> Set led to zero.</summary>
public const int LED_OFF = 7;
/// <summary> Set led to one.</summary>
public const int LED_ON = 8;
}
// xiApi.NET.LENS_FEATURE_SELECTOR
/// <summary>
/// Possible values for lens feature selector
/// </summary>
public static class LENS_FEATURE_SELECTOR
{
/// <summary>Status of lens motorized focus switch.</summary>
public const int MOTORIZED_FOCUS_SWITCH = 1;
/// <summary>On read = 1 if motorized focus is on one of limits.</summary>
public const int MOTORIZED_FOCUS_BOUNDED = 2;
/// <summary>On read = 1 if motorized focus is calibrated. Write 1 to start calibration.</summary>
public const int MOTORIZED_FOCUS_CALIBRATION = 3;
/// <summary>On read = 1 if image stabilization is enabled. Write 1 to enable image stabilization.</summary>
public const int IMAGE_STABILIZATION_ENABLED = 4;
/// <summary>On read = 1 if image stabilization switch is in position On.</summary>
public const int IMAGE_STABILIZATION_SWITCH_STATUS = 5;
/// <summary>On read = 1 if lens supports zoom = are not prime.</summary>
public const int IMAGE_ZOOM_SUPPORTED = 6;
}
// xiApi.NET.LENS_MODE
/// <summary>
/// Possible values for lens mode
/// </summary>
public static class LENS_MODE
{
/// <summary>Status of lens control when not initialized.</summary>
public const int OFF = 0;
/// <summary>Status of lens after being initialized and ready.</summary>
public const int ON = 1;
}
// xiApi.NET.OUTPUT_DATA_PACKING_TYPE
/// <summary>
/// Data packing(grouping) types.
/// </summary>
public static class OUTPUT_DATA_PACKING_TYPE
{
/// <summary>Data grouping (10g160, 12g192, 14g224).</summary>
public const int XI_GROUPING = 0;
/// <summary>Data packing (10p, 12p).</summary>
public const int PFNC_LSB_PACKING = 1;
}
// xiApi.NET.PRM
/// <summary>
/// Parameters available for set/get operations.
/// </summary>
public static class PRM
{
/// <summary>
/// Get camera model name. Type string.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_NAME, out string val);
/// </remarks>
public const string DEVICE_NAME = "device_name";
/// <summary>
/// Returns device type (1394, USB2.0, CURRERA…..). Type string.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_TYPE, out string val)
/// </remarks>
public const string DEVICE_TYPE = "device_type";
/// <summary>
/// Returns device model id . Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_MODEL_ID, out int val)
/// </remarks>
public const string DEVICE_MODEL_ID = "device_model_id";
/// <summary>
/// Returns device sensor model id . Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.SENSOR_MODEL_ID, out int val)
/// </remarks>
public const string SENSOR_MODEL_ID = "sensor_model_id";
/// <summary>
/// Set the amount of debug prints to be reported from dll. Type int.
/// Use DEBUG_LEVEL class to set parameter.
/// </summary>
/// <remarks>
/// xiCam.SetParam(PRM.DEBUG_LEVEL, out int val)
/// </remarks>
public const string DEBUG_LEVEL = "debug_level";
/// <summary>
/// Return device system instance path.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_INSTANCE_PATH, string val)
/// </remarks>
public const string DEVICE_INSTANCE_PATH = "device_inst_path";
/// <summary>
/// Represents the location of the device in the device tree.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_LOCATION_PATH, string val)
/// </remarks>
public const string DEVICE_LOCATION_PATH = "device_loc_path";
/// <summary>
/// Set/Get custom device ID string. Type string.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_USER_ID, string val)
/// </remarks>
public const string DEVICE_USER_ID = "device_user_id";
/// <summary>
/// Return device capability description XML. Type string.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_USER_ID, string val)
/// </remarks>
public const string DEVICE_MANIFEST = "device_manifest";
/// <summary>
/// User image data at image header to track parameters synchronization.
/// </summary>
/// <remarks>
/// xiCam.SetParam(PRM.IMAGE_USER_DATA, out int val)
/// </remarks>
public const string IMAGE_USER_DATA = "image_user_data";
/// <summary>
/// Get device ID string. Type string.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_ID, string val)
/// </remarks>
public const string DEVICE_ID = "device_id";
/// <summary>
/// Enable/disable automatic bus speed adjusting on device init. Type int.
/// </summary>
/// <remarks>
/// xiCam.SetParam(PRM.AUTO_BANDWIDTH_CALCULATION, int val)
/// </remarks>
public const string AUTO_BANDWIDTH_CALCULATION = "auto_bandwidth_calculation";
/// <summary>
/// Enable/disable Enables (2015/FAPI) processing chain for MQ MU cameras. Type int.
/// </summary>
/// <remarks>
/// xiCam.SetParam(PRM.NEW_PROCESS_CHAIN_ENABLE, int val)
/// </remarks>
public const string NEW_PROCESS_CHAIN_ENABLE = "new_process_chain_enable";
/// <summary>
/// Returns device serial number in string.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DEVICE_SN, out string val)
/// </remarks>
public const string DEVICE_SN = "device_sn";
/// <summary>
/// Returns sensor serial number in string
/// </summary>
/// <remarks>
/// xiCam.GetParam(DEVICE_SENS_SN, out string val)
/// </remarks>
public const string DEVICE_SENS_SN = "device_sens_sn";
/// <summary>
/// Set/Get exposure time in microseconds. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.EXPOSURE, out int val) or
/// xiCam.SetParam(PRM.EXPOSURE, int val)
/// </remarks>
public const string EXPOSURE = "exposure";
/// <summary>
/// Set exposure time in microseconds with direct update flag to be applied immediately. Type int.
/// </summary>
/// <remarks>
/// xiCam.SetParam(PRM.EXPOSURE, int val)
/// </remarks>
public const string EXPOSURE_DIRECT_UPDATE = "exposure:direct_update";
/// <summary>
/// Get longest possible exposure to be set on camera. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.EXPOSURE_MAX, out int val)
/// </remarks>
public const string EXPOSURE_MAX = "exposure:max";
/// <summary>
/// Get shortest possible exposure to be set on camera. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.EXPOSURE_MIN, out int val)
/// </remarks>
public const string EXPOSURE_MIN = "exposure:min";
/// <summary>
/// Set/Get the number of times of exposure in one frame. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.EXPOSURE_BURST_COUNT, out int val) or
/// xiCam.SetParam(PRM.EXPOSURE_BURST_COUNT, int val)
/// </remarks>
public const string EXPOSURE_BURST_COUNT = "exposure_burst_count";
/// <summary>
/// Select gain type to control with GAIN. Use class GAIN_SELECTOR_TYPE to set value. Type int.
/// </summary>
/// <remarks>
/// xiCam.SetParam(PRM.GAIN_SELECTOR, out int val)
/// </remarks>
public const string GAIN_SELECTOR = "gain_selector";
/// <example></example>
/// <summary>
/// Set/Get camera gain in dB. Type float.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.GAIN, out float val) or
/// xiCam.SetParam(PRM.GAIN, float val)
/// </remarks>
public const string GAIN = "gain";
/// <example></example>
/// <summary>
/// Set camera gain in dB with direct update flag to be applied immediately. Type float.
/// </summary>
/// <remarks>
/// xiCam.SetParam(PRM.GAIN, float val)
/// </remarks>
public const string GAIN_DIRECT_UPDATE = "gain:direct_update";
/// <example></example>
/// <summary>
/// Get highest possible camera gain in dB. Type float.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.GAIN_MAX, out float val)
/// </remarks>
public const string GAIN_MAX = "gain:max";
/// <summary>
/// Get lowest possible camera gain in dB. Type float.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.GAIN_MIN, out float val)
/// </remarks>
public const string GAIN_MIN = "gain:min";
/// <summary>
/// Set/Get image resolution by binning or skipping. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DOWNSAMPLING, out int val) or
/// xiCam.SetParam(PRM.DOWNSAMPLING, int val)
/// </remarks>
public const string DOWNSAMPLING = "downsampling";
/// <summary>
/// Get highest value for binning or skipping. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DOWNSAMPLING_MAX, out int val)
/// </remarks>
public const string DOWNSAMPLING_MAX = "downsampling:max";
/// <summary>
/// Get lowest value for binning or skipping. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DOWNSAMPLING_MIN, out int val)
/// </remarks>
public const string DOWNSAMPLING_MIN = "downsampling:min";
/// <summary>
/// Change image downsampling type. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DOWNSAMPLING_TYPE, out int val)
/// xiCam.SetParam(PRM.DOWNSAMPLING_TYPE, out int val)
/// </remarks>
public const string DOWNSAMPLING_TYPE = "downsampling_type";
/// <summary>
/// Select Binning engine to configure. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.BINNING_SELECTOR, out int val)
/// xiCam.SetParam(PRM.BINNING_SELECTOR, in int val)
/// </remarks>
public const string BINNING_SELECTOR = "binning_selector";
/// <summary>
/// Selects the mode to use to combine horizontal pixel together. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.BINNING_HORIZONTAL_MODE, out int val)
/// xiCam.SetParam(PRM.BINNING_HORIZONTAL_MODE, in int val)
/// </remarks>
public const string BINNING_HORIZONTAL_MODE = "binning_horizontal_mode";
/// <summary>
/// Selects the mode to use to combine vertical pixel together. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.BINNING_VERTICAL_MODE, out int val)
/// xiCam.SetParam(PRM.BINNING_VERTICAL_MODE, in int val)
/// </remarks>
public const string BINNING_VERTICAL_MODE = "binning_vertical_mode";
/// <summary>
/// Defines number of vertical photo-sensitive cells to combine. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.BINNING_VERTICAL, out int val)
/// xiCam.SetParam(PRM.BINNING_VERTICAL, in int val)
/// </remarks>
public const string BINNING_VERTICAL = "binning_vertical";
/// <summary>
/// Defines number of horizontal photo-sensitive cells to combine. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.BINNING_HORIZONTAL, out int val)
/// xiCam.SetParam(PRM.BINNING_HORIZONTAL, in int val)
/// </remarks>
public const string BINNING_HORIZONTAL = "binning_horizontal";
/// <summary>
/// Defines binning horizontal pattern. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.BINNING_HORIZONTAL_PATTERN, out int val)
/// xiCam.SetParam(PRM.BINNING_HORIZONTAL_PATTERN, in int val)
/// </remarks>
public const string BINNING_HORIZONTAL_PATTERN = "binning_horizontal_pattern";
/// <summary>
/// Defines binning vertical pattern. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.BINNING_VERTICAL_PATTERN, out int val)
/// xiCam.SetParam(PRM.BINNING_VERTICAL_PATTERN, in int val)
/// </remarks>
public const string BINNING_VERTICAL_PATTERN = "binning_vertical_pattern";
/// <summary>
/// Select Decimation engine to configure. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DECIMATION_SELECTOR, out int val)
/// xiCam.SetParam(PRM.DECIMATION_SELECTOR, in int val)
/// </remarks>
public const string DECIMATION_SELECTOR = "decimation_selector";
/// <summary>
/// Reduces the vertical resolution of the image by the specified decimation factor. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DECIMATION_VERTICAL, out int val)
/// xiCam.SetParam(PRM.DECIMATION_VERTICAL, in int val)
/// </remarks>
public const string DECIMATION_VERTICAL = "decimation_vertical";
/// <summary>
/// Reduces the horizontal resolution of the image by the specified decimation factor. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DECIMATION_HORIZONTAL, out int val)
/// xiCam.SetParam(PRM.DECIMATION_HORIZONTAL, in int val)
/// </remarks>
public const string DECIMATION_HORIZONTAL = "decimation_horizontal";
/// <summary>
/// Defines decimation horizontal pattern. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DECIMATION_HORIZONTAL_PATTERN, out int val)
/// xiCam.SetParam(PRM.DECIMATION_HORIZONTAL_PATTERN, in int val)
/// </remarks>
public const string DECIMATION_HORIZONTAL_PATTERN = "decimation_horizontal_pattern";
/// <summary>
/// Defines decimation vertical pattern. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.DECIMATION_VERTICAL_PATTERN, out int val)
/// xiCam.SetParam(PRM.DECIMATION_VERTICAL_PATTERN, in int val)
/// </remarks>
public const string DECIMATION_VERTICAL_PATTERN = "decimation_vertical_pattern";
/// <summary>
/// Selects which test pattern generator is controlled by the TestPattern feature. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.TEST_PATTERN_GENERATOR_SELECTOR, out int val)
/// xiCam.SetParam(PRM.TEST_PATTERN_GENERATOR_SELECTOR, in int val)
/// </remarks>
public const string TEST_PATTERN_GENERATOR_SELECTOR = "test_pattern_generator_selector";
/// <summary>
/// Selects which test pattern type is generated by the selected generator. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.TEST_PATTERN, out int val)
/// xiCam.SetParam(PRM.TEST_PATTERN, in int val)
/// </remarks>
public const string TEST_PATTERN = "test_pattern";
/// <summary>
/// Change sensor shutter type(CMOS sensor). Use class SHUTTER_TYPE to set value. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.SHUTTER_TYPE, out int val)
/// xiCam.SetParam(PRM.SHUTTER_TYPE, out int val)
/// </remarks>
public const string SHUTTER_TYPE = "shutter_type";
/// <summary>
/// Set/Get output image data format. Use class IMG_FORMAT to set value. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.IMAGE_DATA_FORMAT, out int val) or
/// xiCam.SetParam(PRM.IMAGE_DATA_FORMAT, int val)
/// </remarks>
public const string IMAGE_DATA_FORMAT = "imgdataformat";
/// <summary>
/// Set/Get the alpha channel of RGB32 output image format. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.IMAGE_DATA_FORMAT_RGB32_ALPHA, out int val) or
/// xiCam.SetParam(PRM.IMAGE_DATA_FORMAT_RGB32_ALPHA, int val)
/// </remarks>
public const string IMAGE_DATA_FORMAT_RGB32_ALPHA = "imgdataformatrgb32alpha";
/// <summary>
/// Current Image payload size in bytes. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.IMAGE_PAYLOAD_SIZE, out int val) or
/// xiCam.SetParam(PRM.IMAGE_PAYLOAD_SIZE, int val)
/// </remarks>
public const string IMAGE_PAYLOAD_SIZE = "imgpayloadsize";
/// <summary>
/// Type of pixel format on transport layer
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.TRANSPORT_PIXEL_FORMAT, out int val)
/// </remarks>
public const string TRANSPORT_PIXEL_FORMAT = "transport_pixel_format";
/// <summary>
/// Selector for transport data target (CPU RAM or GPU RAM)
/// Use TRANSPORT_DATA_TARGET_MODE
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.TRANSPORT_DATA_TARGET, out int val)
/// </remarks>
public const string TRANSPORT_DATA_TARGET = "transport_data_target";
/// <summary>
/// Set/Get number of sensor taps. Supported only by MD camera family. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.SENSOR_TAPS, out int val) or
/// xiCam.SetParam(PRM.SENSOR_TAPS, int val)
/// </remarks>
public const string SENSOR_TAPS = "sensor_taps";
/// <summary>
/// Set/Get sensor clock frequency in Hz. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.SENSOR_CLOCK_FREQ_HZ, out int val) or
/// xiCam.SetParam(PRM.SENSOR_CLOCK_FREQ_HZ, int val)
/// </remarks>
public const string SENSOR_CLOCK_FREQ_HZ = "sensor_clock_freq_hz";
/// <summary>
/// Sensor clock frequency index (available for some sensors). Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.SENSOR_CLOCK_FREQ_INDEX, out int val) or
/// xiCam.SetParam(PRM.SENSOR_CLOCK_FREQ_INDEX, int val)
/// </remarks>
public const string SENSOR_CLOCK_FREQ_INDEX = "sensor_clock_freq_index";
/// <summary>
/// Sensor output data channel count.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.SENSOR_OUTPUT_CHANNEL_COUNT, out int val) or
/// xiCam.SetParam(PRM.SENSOR_OUTPUT_CHANNEL_COUNT, int val)
/// </remarks>
public const string SENSOR_OUTPUT_CHANNEL_COUNT = "sensor_output_channel_count";
/// <summary>
/// Set/Get sensor output data bit depth. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.SENSOR_DATA_BIT_DEPTH, out int val) or
/// xiCam.SetParam(PRM.SENSOR_DATA_BIT_DEPTH, int val)
/// </remarks>
public const string SENSOR_DATA_BIT_DEPTH = "sensor_bit_depth";
/// <summary>
/// Set/Get device output data bit depth. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.OUTPUT_DATA_BIT_DEPTH, out int val) or
/// xiCam.SetParam(PRM.OUTPUT_DATA_BIT_DEPTH, int val)
/// </remarks>
public const string OUTPUT_DATA_BIT_DEPTH = "output_bit_depth";
/// <summary>
/// Set/Get bitdepth of data returned by function xiGetImage. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.IMAGE_DATA_BIT_DEPTH, out int val) or
/// xiCam.SetParam(PRM.IMAGE_DATA_BIT_DEPTH, int val)
/// </remarks>
public const string IMAGE_DATA_BIT_DEPTH = "image_data_bit_depth";
/// <summary>
/// Set/Get Device output data packing (or grouping) enabled. Packing could be enabled if output_data_bit_depth > 8 and packing is available. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.OUTPUT_DATA_PACKING, out int val) or
/// xiCam.SetParam(PRM.OUTPUT_DATA_PACKING, int val)
/// </remarks>
public const string OUTPUT_DATA_PACKING = "output_bit_packing";
/// <summary>
/// Set/Get Device output data packing (or grouping) type. Type int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.OUTPUT_DATA_PACKING_TYPE, out int val) or
/// xiCam.SetParam(PRM.OUTPUT_DATA_PACKING_TYPE, int val)
/// </remarks>
public const string OUTPUT_DATA_PACKING_TYPE = "output_bit_packing_type";
/// <summary>
/// Returns 1 for color cameras. By default -. Type Int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.IMAGE_IS_COLOR, out int val) or
/// xiCam.SetParam(PRM.IMAGE_IS_COLOR, int val)
/// </remarks>
public const string IMAGE_IS_COLOR = "iscolor";
/// <summary>
/// Returns color filter array type of RAW data. By default -. Type Int.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.COLOR_FILTER_ARRAY, out int val) or
/// xiCam.SetParam(PRM.COLOR_FILTER_ARRAY, int val)
/// </remarks>
public const string COLOR_FILTER_ARRAY = "cfa";
/// <summary>
/// Get frames per second. Type float.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.FRAMERATE, out float val)
/// </remarks>
public const string FRAMERATE = "framerate";
/// <summary>
/// Get highest possible framerate for current camera settings. Type float.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.FRAMERATE_MAX, out float val)
/// </remarks>
public const string FRAMERATE_MAX = "framerate:max";
/// <summary>
/// Get lowest framerate for current camera settings. Type float.
/// </summary>
/// <remarks>
/// xiCam.GetParam(PRM.FRAMERATE_MIN, out float val)
/// </remarks>
public const string FRAMERATE_MIN = "framerate:min";
/// <summary>