Gocator API
GoAdvanced.h
Go to the documentation of this file.
1 /**
2  * @file GoAdvanced.h
3  * @brief Declares the GoAdvanced class.
4  *
5  * @internal
6  * Copyright (C) 2016-2019 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_ADVANCED_H
11 #define GO_ADVANCED_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 
15 /**
16  * @class GoAdvanced
17  * @extends kObject
18  * @ingroup GoSdk
19  * @brief Represents configurable advanced acquisition settings.
20  */
21 typedef kObject GoAdvanced;
22 
23 /**
24  * Sets the advanced acquisition type.
25  *
26  * @public @memberof GoAdvanced
27  * @version Introduced in firmware 4.6.1.140
28  * @param advanced GoAdvanced object.
29  * @param type The advanced type to set.
30  * @return Operation status.
31  */
33 
34 /**
35  * Returns the user defined advanced acquisition type.
36  *
37  * @public @memberof GoAdvanced
38  * @version Introduced in firmware 4.6.1.140
39  * @param advanced GoAdvanced object.
40  * @return The advanced type.
41  */
43 
44 /**
45  * Returns a boolean relating to whether the user defined advanced acquisition type value will be used by the system.
46  *
47  * @public @memberof GoAdvanced
48  * @version Introduced in firmware 4.6.1.140
49  * @param advanced GoAdvanced object.
50  * @return kTRUE if the user defined advanced type will be used and kFALSE otherwise.
51  */
52 GoFx(kBool) GoAdvanced_IsTypeUsed(GoAdvanced advanced);
53 
54 /**
55  * Returns the advanced acquisition type to be used by the system.
56  *
57  * @public @memberof GoAdvanced
58  * @version Introduced in firmware 4.6.1.140
59  * @param advanced GoAdvanced object.
60  * @return The system value advanced type.
61  */
63 
64 /**
65  * Sets the spot threshold.
66  *
67  * @public @memberof GoAdvanced
68  * @note Supported with G1, G2
69  * @version Introduced in firmware 4.6.1.140
70  * @param advanced GoAdvanced object.
71  * @param value Spot threshold.
72  * @return Operation status.
73  */
74 GoFx(kStatus) GoAdvanced_SetSpotThreshold(GoAdvanced advanced, k32u value);
75 
76 /**
77  * Returns the user defined spot threshold.
78  *
79  * @public @memberof GoAdvanced
80  * @note Supported with G1, G2
81  * @version Introduced in firmware 4.6.1.140
82  * @param advanced GoAdvanced object.
83  * @return The spot threshold.
84  */
86 
87 /**
88  * Returns the minimum spot threshold limit.
89  *
90  * @public @memberof GoAdvanced
91  * @note Supported with G1, G2
92  * @version Introduced in firmware 4.6.1.140
93  * @param advanced GoAdvanced object.
94  * @return The minimum spot threshold.
95  */
97 
98 /**
99  * Returns the maximum spot threshold limit.
100  *
101  * @public @memberof GoAdvanced
102  * @note Supported with G1, G2
103  * @version Introduced in firmware 4.6.1.140
104  * @param advanced GoAdvanced object.
105  * @return The maximum spot threshold.
106  */
108 
109 /**
110  * Returns a boolean value representing whether the user specified spot threshold value is used.
111  *
112  * @public @memberof GoAdvanced
113  * @note Supported with G1, G2
114  * @version Introduced in firmware 4.6.1.140
115  * @param advanced GoAdvanced object.
116  * @return kTRUE if it is used and kFALSE otherwise.
117  */
119 
120 /**
121  * Returns the system spot threshold value.
122  *
123  * @public @memberof GoAdvanced
124  * @note Supported with G1, G2
125  * @version Introduced in firmware 4.6.1.140
126  * @param advanced GoAdvanced object.
127  * @return The system spot threshold.
128  */
130 
131 /**
132  * Sets the maximum spot width.
133  *
134  * @public @memberof GoAdvanced
135  * @version Introduced in firmware 4.6.1.140
136  * @param advanced GoAdvanced object.
137  * @param value Maximum spot width.
138  * @return Operation status.
139  */
140 GoFx(kStatus) GoAdvanced_SetSpotWidthMax(GoAdvanced advanced, k32u value);
141 
142 /**
143  * Returns the user defined maximum spot width.
144  *
145  * @public @memberof GoAdvanced
146  * @version Introduced in firmware 4.6.1.140
147  * @param advanced GoAdvanced object.
148  * @return The maximum spot width.
149  */
150 GoFx(k32u) GoAdvanced_SpotWidthMax(GoAdvanced advanced);
151 
152 /**
153  * Returns the maximum spot width minimum limit.
154  *
155  * @public @memberof GoAdvanced
156  * @version Introduced in firmware 4.6.1.140
157  * @param advanced GoAdvanced object.
158  * @return The maximum spot width minimum limit.
159  */
161 
162 /**
163  * Returns the maximum spot width maximum limit.
164  *
165  * @public @memberof GoAdvanced
166  * @version Introduced in firmware 4.6.1.140
167  * @param advanced GoAdvanced object.
168  * @return The maximum spot width maximum limit.
169  */
171 
172 /**
173  * Returns a boolean relating to whether the user defined spot width max value will be used by the system.
174  *
175  * @public @memberof GoAdvanced
176  * @version Introduced in firmware 4.6.1.140
177  * @param advanced GoAdvanced object.
178  * @return kTRUE if the user value will be used and kFALSE otherwise.
179  */
181 
182 /**
183  * Returns the maximum spot width system value.
184  *
185  * @public @memberof GoAdvanced
186  * @version Introduced in firmware 4.6.1.140
187  * @param advanced GoAdvanced object.
188  * @return The maximum spot width system value.
189  */
191 
192 /**
193  * Returns the number of spot selection type options.
194  *
195  * @public @memberof GoAdvanced
196  * @version Introduced in firmware 4.6.1.140
197  * @param advanced GoAdvanced object.
198  * @return The spot selection type option count.
199  */
201 
202 /**
203  * Returns the spot selection type option at the given index.
204  *
205  * @public @memberof GoAdvanced
206  * @version Introduced in firmware 4.6.1.140
207  * @param advanced GoAdvanced object.
208  * @param index The option list index to access.
209  * @return The spot selection type option at the given index.
210  */
212 
213 /**
214  * Sets the spot selection type.
215  *
216  * @public @memberof GoAdvanced
217  * @version Introduced in firmware 4.6.1.140
218  * @param advanced GoAdvanced object.
219  * @param type Spot selection type.
220  * @return Operation status.
221  */
223 
224 /**
225  * Returns the user defined spot selection type.
226  *
227  * @public @memberof GoAdvanced
228  * @version Introduced in firmware 4.6.1.140
229  * @param advanced GoAdvanced object.
230  * @return The maximum spot width.
231  */
233 
234 /**
235  * Returns a boolean relating to whether the user defined spot selection type will be used by the system.
236  *
237  * @public @memberof GoAdvanced
238  * @version Introduced in firmware 4.6.1.140
239  * @param advanced GoAdvanced object.
240  * @return kTRUE if the user value will be used and kFALSE otherwise.
241  */
243 
244 /**
245  * Returns the system spot selection type.
246  *
247  * @public @memberof GoAdvanced
248  * @version Introduced in firmware 4.6.1.140
249  * @param advanced GoAdvanced object.
250  * @return System spot selection type.
251  */
253 
254 /**
255 * Returns the minimum segment size used in continuity sorting spot detection.
256 *
257 * @public @memberof GoAdvanced
258 * @version Introduced in firmware 4.6.2.79
259 * @param advanced GoAdvanced object.
260 * @return Minimum segment size
261 */
263 
264 /**
265 * Sets the minimum segment size used in continuity sorting spot detection.
266 *
267 * @public @memberof GoAdvanced
268 * @version Introduced in firmware 4.6.2.79
269 * @param advanced GoAdvanced object.
270 * @param value Minimum Segment Size.
271 * @return Operation status.
272 */
274 
275 /**
276 * Returns the search window size in the X direction used in continuity sorting spot detection.
277 *
278 * @public @memberof GoAdvanced
279 * @version Introduced in firmware 4.6.2.79
280 * @param advanced GoAdvanced object.
281 * @return Search window X dimension
282 */
284 
285 /**
286 * Sets the search window size in the X direction used in continuity sorting spot detection.
287 *
288 * @public @memberof GoAdvanced
289 * @version Introduced in firmware 4.6.2.79
290 * @param advanced GoAdvanced object.
291 * @param value Search window X dimension.
292 * @return Operation status.
293 */
295 
296 /**
297 * Returns the search window size in the Y direction used in continuity sorting spot detection
298 *
299 * @public @memberof GoAdvanced
300 * @version Introduced in firmware 4.6.2.79
301 * @param advanced GoAdvanced object.
302 * @return Search window Y dimension
303 */
305 
306 /**
307 * Sets the search window size in the Y direction used in continuity sorting spot detection
308 *
309 * @public @memberof GoAdvanced
310 * @version Introduced in firmware 4.6.2.79
311 * @param advanced GoAdvanced object.
312 * @param value Search window Y dimension.
313 * @return Operation status.
314 */
316 
317 /**
318  * Sets the analog camera gain.
319  *
320  * @public @memberof GoAdvanced
321  * @version Introduced in firmware 4.6.1.140
322  * @param advanced GoAdvanced object.
323  * @param value Analog camera gain.
324  * @return Operation status.
325  */
327 
328 /**
329  * Returns the user defined analog camera gain value.
330  *
331  * @public @memberof GoAdvanced
332  * @version Introduced in firmware 4.6.1.140
333  * @param advanced GoAdvanced object.
334  * @return Analog camera gain value.
335  */
337 
338 /**
339  * Returns the analog camera gain minimum value limit.
340  *
341  * @public @memberof GoAdvanced
342  * @version Introduced in firmware 4.6.1.140
343  * @param advanced GoAdvanced object.
344  * @return Analog camera gain minimum value limit.
345  */
347 
348 /**
349  * Returns the analog camera gain maximum value limit.
350  *
351  * @public @memberof GoAdvanced
352  * @version Introduced in firmware 4.6.1.140
353  * @param advanced GoAdvanced object.
354  * @return Analog camera gain maximum value limit.
355  */
357 
358 /**
359  * Returns a boolean value representing whether the user defined analog camera gain is used.
360  *
361  * @public @memberof GoAdvanced
362  * @version Introduced in firmware 4.6.1.140
363  * @param advanced GoAdvanced object.
364  * @return kTRUE if the user defined analog camera gain is used and kFALSE otherwise.
365  */
367 
368 /**
369  * Returns the analog camera gain system value.
370  *
371  * @public @memberof GoAdvanced
372  * @version Introduced in firmware 4.6.1.140
373  * @param advanced GoAdvanced object.
374  * @return The analog camera gain system value.
375  */
377 
378 /**
379  * Sets the digital camera gain
380  *
381  * @public @memberof GoAdvanced
382  * @version Introduced in firmware 4.6.1.140
383  * @param advanced GoAdvanced object.
384  * @param value Digital camera gain.
385  * @return Operation status.
386  */
388 
389 /**
390  * Returns the user defined digital camera gain value.
391  *
392  * @public @memberof GoAdvanced
393  * @version Introduced in firmware 4.6.1.140
394  * @param advanced GoAdvanced object.
395  * @return The digital camera gain system value.
396  */
398 
399 /**
400  * Returns the digital camera gain minimum value limit.
401  *
402  * @public @memberof GoAdvanced
403  * @version Introduced in firmware 4.6.1.140
404  * @param advanced GoAdvanced object.
405  * @return Digital camera gain minimum value limit.
406  */
408 
409 /**
410  * Returns the digital camera gain maximum value limit.
411  *
412  * @public @memberof GoAdvanced
413  * @version Introduced in firmware 4.6.1.140
414  * @param advanced GoAdvanced object.
415  * @return Digital camera gain maximum value limit.
416  */
418 
419 /**
420  * Returns a boolean value representing whether the user's digital camera gain value is used by the system.
421  *
422  * @public @memberof GoAdvanced
423  * @version Introduced in firmware 4.6.1.140
424  * @param advanced GoAdvanced object.
425  * @return kTRUE if used and kFALSE otherwise.
426  */
428 
429 /**
430  * Returns the system's digital camera gain value.
431  *
432  * @public @memberof GoAdvanced
433  * @version Introduced in firmware 4.6.1.140
434  * @param advanced GoAdvanced object.
435  * @return Digital camera gain system value.
436  */
438 
439 /**
440  * Sets the dynamic sensitivity.
441  *
442  * @public @memberof GoAdvanced
443  * @version Introduced in firmware 4.6.1.140
444  * @param advanced GoAdvanced object.
445  * @param value Dynamic sensitivity.
446  * @return Operation status.
447  */
449 
450 /**
451  * Returns the user defined dynamic sensitivity value.
452  *
453  * @public @memberof GoAdvanced
454  * @version Introduced in firmware 4.6.1.140
455  * @param advanced GoAdvanced object.
456  * @return User defined dynamic sensitivity value.
457  */
459 
460 /**
461  * Returns the dynamic sensitivity minimum value limit.
462  *
463  * @public @memberof GoAdvanced
464  * @version Introduced in firmware 4.6.1.140
465  * @param advanced GoAdvanced object.
466  * @return Dynamic sensitivity minimum value limit.
467  */
469 
470 /**
471  * Returns the dynamic sensitivity maximum value limit.
472  *
473  * @public @memberof GoAdvanced
474  * @version Introduced in firmware 4.6.1.140
475  * @param advanced GoAdvanced object.
476  * @return Dynamic sensitivity maximum value limit.
477  */
479 
480 /**
481  * Returns a boolean representing whether the user defined dynamic sensitivity value is used.
482  *
483  * @public @memberof GoAdvanced
484  * @version Introduced in firmware 4.6.1.140
485  * @param advanced GoAdvanced object.
486  * @return kTRUE if used and kFALSE otherwise.
487  */
489 
490 /**
491  * Returns the dynamic sensitivity system value.
492  *
493  * @public @memberof GoAdvanced
494  * @version Introduced in firmware 4.6.1.140
495  * @param advanced GoAdvanced object.
496  * @return Dynamic sensitivity system value.
497  */
499 
500 /**
501  * Sets the dynamic threshold.
502  *
503  * @public @memberof GoAdvanced
504  * @version Introduced in firmware 4.6.1.140
505  * @param advanced GoAdvanced object.
506  * @param value Dynamic threshold.
507  * @return Operation status.
508  */
510 
511 /**
512  * Returns the dynamic threshold minimum value limit.
513  *
514  * @public @memberof GoAdvanced
515  * @version Introduced in firmware 4.6.1.140
516  * @param advanced GoAdvanced object.
517  * @return Dynamic threshold minimum value limit.
518  */
520 
521 /**
522  * Returns the dynamic threshold maximum value limit.
523  *
524  * @public @memberof GoAdvanced
525  * @version Introduced in firmware 4.6.1.140
526  * @param advanced GoAdvanced object.
527  * @return Dynamic threshold maximum value limit.
528  */
530 
531 /**
532  * Returns the user defined dynamic threshold value.
533  *
534  * @public @memberof GoAdvanced
535  * @version Introduced in firmware 4.6.1.140
536  * @param advanced GoAdvanced object.
537  * @return The user defined dynamic threshold value.
538  */
540 
541 /**
542  * Returns a boolean representing whether or not the user defined dynamic threshold is used by the system.
543  *
544  * @public @memberof GoAdvanced
545  * @version Introduced in firmware 4.6.1.140
546  * @param advanced GoAdvanced object.
547  * @return Dynamic threshold minimum value limit.
548  */
550 
551 /**
552  * Returns the dynamic threshold system value.
553  *
554  * @public @memberof GoAdvanced
555  * @version Introduced in firmware 4.6.1.140
556  * @param advanced GoAdvanced object.
557  * @return Dynamic threshold system value.
558  */
560 
561 /**
562  * Sets the gamma type.
563  *
564  * @public @memberof GoAdvanced
565  * @version Introduced in firmware 4.6.1.140
566  * @param advanced GoAdvanced object.
567  * @param value Gamma type.
568  * @return Operation status.
569  */
571 
572 /**
573  * Returns the user defined gamma type.
574  *
575  * @public @memberof GoAdvanced
576  * @version Introduced in firmware 4.6.1.140
577  * @param advanced GoAdvanced object.
578  * @return User defined gamma type.
579  */
581 
582 /**
583  * Returns a boolean representing whether the user defined gamma type is used by the system.
584  *
585  * @public @memberof GoAdvanced
586  * @version Introduced in firmware 4.6.1.140
587  * @param advanced GoAdvanced object.
588  * @return kTRUE if used and kFALSE otherwise.
589  */
591 
592 /**
593  * Returns the system's gamma type value.
594  *
595  * @public @memberof GoAdvanced
596  * @version Introduced in firmware 4.6.1.140
597  * @param advanced GoAdvanced object.
598  * @return The system gamma type value.
599  */
601 
602 /**
603  * Enables or disables senstivity compensation. NOTE: This is only applicable to
604  * 2300 B series sensors.
605  *
606  * @public @memberof GoAdvanced
607  * @version Introduced in firmware 4.6.1.140
608  * @param advanced GoAdvanced object.
609  * @param value kTRUE to enable and kFALSE to disable.
610  * @return Operation status.
611  */
613 
614 /**
615  * Returns the user defined sensitivity compensation value.
616  *
617  * @public @memberof GoAdvanced
618  * @version Introduced in firmware 4.6.1.140
619  * @param advanced GoAdvanced object.
620  * @return User defined sensitivity compensation.
621  */
623 
624 /**
625  * Returns a boolean representing whether the user defined sensitivity compensation is used by the system.
626  *
627  * @public @memberof GoAdvanced
628  * @version Introduced in firmware 4.6.1.140
629  * @param advanced GoAdvanced object.
630  * @return kTRUE if used and kFALSE otherwise.
631  */
633 
634 /**
635  * Returns the system's sensitivity compensation value.
636  *
637  * @public @memberof GoAdvanced
638  * @version Introduced in firmware 4.6.1.140
639  * @param advanced GoAdvanced object.
640  * @return kTRUE if enabled and kFALSE otherwise.
641  */
643 
644 /**
645 * Sets surface engine encoding type (Default Standard)
646 *
647 * @public @memberof GoAdvanced
648 * @note Supported with G3
649 * @version Introduced in firmware 4.7.3.22
650 * @param advanced GoAdvanced object.
651 * @param encoding Surface Engine Encoding type
652 * @return Operation status.
653 */
655 
656 /**
657 * Returns the surface engine encoding type.
658 *
659 * @public @memberof GoAdvanced
660 * @note Supported with G3
661 * @version Introduced in firmware 4.7.3.22
662 * @param advanced GoAdvanced object.
663 * @return The Surface Engine Encoding type.
664 */
666 
667 /**
668 * Returns the surface engine encoding type.
669 *
670 * @public @memberof GoAdvanced
671 * @note Supported with G3
672 * @version Introduced in firmware 5.3.19.50
673 * @param advanced GoAdvanced object.
674 * @return kTRUE if used and kFALSE otherwise.
675 */
677 
678 /**
679 * Returns the system's surface engine encoding type.
680 *
681 * @public @memberof GoAdvanced
682 * @note Supported with G3
683 * @version Introduced in firmware 5.3.19.50
684 * @param advanced GoAdvanced object.
685 * @return The Surface Engine Encoding type.
686 */
688 
689 /**
690 * Sets the phase filter type. (Default None)
691 *
692 * @public @memberof GoAdvanced
693 * @note Supported with G3
694 * @version Introduced in firmware 4.7.3.22
695 * @param advanced GoAdvanced object.
696 * @param phaseFilter Phase Filter type.
697 * @return Operation status.
698 */
700 
701 /**
702 * Returns the phase filter type.
703 *
704 * @public @memberof GoAdvanced
705 * @note Supported with G3
706 * @version Introduced in firmware 4.7.3.22
707 * @param advanced GoAdvanced object.
708 * @return The phase filter type.
709 */
711 
712 /**
713  * Sets the contrast threshold.
714  *
715  * @public @memberof GoAdvanced
716  * @note Supported with G3
717  * @version Introduced in firmware 5.3.12.7
718  * @param advanced GoAdvanced object.
719  * @param value Contrast threshold.
720  * @return Operation status.
721  */
723 
724 /**
725  * Returns the user defined contrast threshold.
726  *
727  * @public @memberof GoAdvanced
728  * @note Supported with G3
729  * @version Introduced in firmware 5.3.12.7
730  * @param advanced GoAdvanced object.
731  * @return The contrast threshold.
732  */
734 
735 /**
736  * Returns the minimum contrast threshold limit.
737  *
738  * @public @memberof GoAdvanced
739  * @note Supported with G3
740  * @version Introduced in firmware 5.3.12.7
741  * @param advanced GoAdvanced object.
742  * @return The minimum contrast threshold.
743  */
745 
746 /**
747  * Returns the maximum contrast threshold limit.
748  *
749  * @public @memberof GoAdvanced
750  * @note Supported with G3
751  * @version Introduced in firmware 5.3.12.7
752  * @param advanced GoAdvanced object.
753  * @return The maximum contrast threshold.
754  */
756 
757 /**
758  * Returns a boolean value representing whether the user specified contrast threshold value is used.
759  *
760  * @public @memberof GoAdvanced
761  * @note Supported with G3
762  * @version Introduced in firmware 5.3.12.7
763  * @param advanced GoAdvanced object.
764  * @return kTRUE if it is used and kFALSE otherwise.
765  */
767 
768 /**
769  * Returns the system contrast threshold value.
770  *
771  * @public @memberof GoAdvanced
772  * @note Supported with G3
773  * @version Introduced in firmware 5.3.12.7
774  * @param advanced GoAdvanced object.
775  * @return The system contrast threshold.
776  */
778 
779 #include <GoSdk/GoAdvanced.x.h>
780 
781 #endif
k64f GoAdvanced_CameraGainAnalog(GoAdvanced advanced)
Returns the user defined analog camera gain value.
kStatus GoAdvanced_SetDynamicThreshold(GoAdvanced advanced, k32u value)
Sets the dynamic threshold.
GoGammaType GoAdvanced_GammaType(GoAdvanced advanced)
Returns the user defined gamma type.
GoSurfaceEncoding GoAdvanced_SurfaceEncoding(GoAdvanced advanced)
Returns the surface engine encoding type.
Represents configurable advanced acquisition settings.
GoAdvancedType GoAdvanced_TypeSystemValue(GoAdvanced advanced)
Returns the advanced acquisition type to be used by the system.
kStatus GoAdvanced_SetGammaType(GoAdvanced advanced, GoGammaType value)
Sets the gamma type.
k64f GoAdvanced_CameraGainDigital(GoAdvanced advanced)
Returns the user defined digital camera gain value.
GoSpotSelectionType GoAdvanced_SpotSelectionTypeSystemValue(GoAdvanced advanced)
Returns the system spot selection type.
k64f GoAdvanced_DynamicSensitivitySystemValue(GoAdvanced advanced)
Returns the dynamic sensitivity system value.
k64f GoAdvanced_DynamicSensitivityLimitMax(GoAdvanced advanced)
Returns the dynamic sensitivity maximum value limit.
k64f GoAdvanced_CameraGainDigitalSystemValue(GoAdvanced advanced)
Returns the system's digital camera gain value.
kStatus GoAdvanced_SetSurfaceEncoding(GoAdvanced advanced, GoSurfaceEncoding encoding)
Sets surface engine encoding type (Default Standard)
Represents a surface phase filter type.
kBool GoAdvanced_IsDynamicSensitivityUsed(GoAdvanced advanced)
Returns a boolean representing whether the user defined dynamic sensitivity value is used.
k32u GoAdvanced_ContrastThresholdSystemValue(GoAdvanced advanced)
Returns the system contrast threshold value.
k32u GoAdvanced_ContrastThreshold(GoAdvanced advanced)
Returns the user defined contrast threshold.
Represents a surface scanning engine encoding type.
kBool GoAdvanced_IsGammaTypeUsed(GoAdvanced advanced)
Returns a boolean representing whether the user defined gamma type is used by the system.
kStatus GoAdvanced_SetSpotContinuitySearchWindowY(GoAdvanced advanced, k32u value)
Sets the search window size in the Y direction used in continuity sorting spot detection.
k32u GoAdvanced_SpotContinuitySearchWindowX(GoAdvanced advanced)
Returns the search window size in the X direction used in continuity sorting spot detection.
k32u GoAdvanced_SpotWidthMax(GoAdvanced advanced)
Returns the user defined maximum spot width.
kStatus GoAdvanced_SetCameraGainDigital(GoAdvanced advanced, k64f value)
Sets the digital camera gain.
kBool GoAdvanced_IsDynamicThresholdUsed(GoAdvanced advanced)
Returns a boolean representing whether or not the user defined dynamic threshold is used by the syste...
kBool GoAdvanced_IsCameraGainAnalogUsed(GoAdvanced advanced)
Returns a boolean value representing whether the user defined analog camera gain is used.
kStatus GoAdvanced_EnableSensitivityCompensation(GoAdvanced advanced, kBool value)
Enables or disables senstivity compensation.
k32u GoAdvanced_SpotThresholdLimitMin(GoAdvanced advanced)
Returns the minimum spot threshold limit.
kBool GoAdvanced_IsSpotThresholdUsed(GoAdvanced advanced)
Returns a boolean value representing whether the user specified spot threshold value is used.
k64f GoAdvanced_CameraGainAnalogLimitMax(GoAdvanced advanced)
Returns the analog camera gain maximum value limit.
Essential SDK declarations.
Represents an advanced gamma type.
k32u GoAdvanced_ContrastThresholdLimitMin(GoAdvanced advanced)
Returns the minimum contrast threshold limit.
k32u GoAdvanced_SpotWidthMaxLimitMax(GoAdvanced advanced)
Returns the maximum spot width maximum limit.
kStatus GoAdvanced_SetSpotContinuitySearchWindowX(GoAdvanced advanced, k32u value)
Sets the search window size in the X direction used in continuity sorting spot detection.
k64f GoAdvanced_DynamicSensitivity(GoAdvanced advanced)
Returns the user defined dynamic sensitivity value.
GoSurfaceEncoding GoAdvanced_SurfaceEncodingSystemValue(GoAdvanced advanced)
Returns the system's surface engine encoding type.
kStatus GoAdvanced_SetSpotThreshold(GoAdvanced advanced, k32u value)
Sets the spot threshold.
kBool GoAdvanced_IsSensitivityCompensationEnabledUsed(GoAdvanced advanced)
Returns a boolean representing whether the user defined sensitivity compensation is used by the syste...
kSize GoAdvanced_SpotSelectionTypeOptionCount(GoAdvanced advanced)
Returns the number of spot selection type options.
kBool GoAdvanced_IsSurfaceEncodingUsed(GoAdvanced advanced)
Returns the surface engine encoding type.
kBool GoAdvanced_IsContrastThresholdUsed(GoAdvanced advanced)
Returns a boolean value representing whether the user specified contrast threshold value is used.
k64f GoAdvanced_CameraGainDigitalLimitMax(GoAdvanced advanced)
Returns the digital camera gain maximum value limit.
k32u GoAdvanced_DynamicThresholdSystemValue(GoAdvanced advanced)
Returns the dynamic threshold system value.
k32u GoAdvanced_DynamicThreshold(GoAdvanced advanced)
Returns the user defined dynamic threshold value.
kStatus GoAdvanced_SetContrastThreshold(GoAdvanced advanced, k32u value)
Sets the contrast threshold.
kBool GoAdvanced_SensitivityCompensationEnabledSystemValue(GoAdvanced advanced)
Returns the system's sensitivity compensation value.
kStatus GoAdvanced_SetSpotContinuityMinimumSegmentSize(GoAdvanced advanced, k32u value)
Sets the minimum segment size used in continuity sorting spot detection.
GoSpotSelectionType GoAdvanced_SpotSelectionTypeOptionAt(GoAdvanced advanced, kSize index)
Returns the spot selection type option at the given index.
kStatus GoAdvanced_SetSpotWidthMax(GoAdvanced advanced, k32u value)
Sets the maximum spot width.
kStatus GoAdvanced_SetSurfacePhaseFilter(GoAdvanced advanced, GoSurfacePhaseFilter phaseFilter)
Sets the phase filter type.
kStatus GoAdvanced_SetSpotSelectionType(GoAdvanced advanced, GoSpotSelectionType type)
Sets the spot selection type.
kBool GoAdvanced_IsSpotWidthMaxUsed(GoAdvanced advanced)
Returns a boolean relating to whether the user defined spot width max value will be used by the syste...
k32u GoAdvanced_SpotThreshold(GoAdvanced advanced)
Returns the user defined spot threshold.
GoSpotSelectionType GoAdvanced_SpotSelectionType(GoAdvanced advanced)
Returns the user defined spot selection type.
k32u GoAdvanced_ContrastThresholdLimitMax(GoAdvanced advanced)
Returns the maximum contrast threshold limit.
k64f GoAdvanced_CameraGainDigitalLimitMin(GoAdvanced advanced)
Returns the digital camera gain minimum value limit.
kBool GoAdvanced_IsTypeUsed(GoAdvanced advanced)
Returns a boolean relating to whether the user defined advanced acquisition type value will be used b...
k32u GoAdvanced_SpotThresholdSystemValue(GoAdvanced advanced)
Returns the system spot threshold value.
k32u GoAdvanced_SpotThresholdLimitMax(GoAdvanced advanced)
Returns the maximum spot threshold limit.
GoAdvancedType GoAdvanced_Type(GoAdvanced advanced)
Returns the user defined advanced acquisition type.
kBool GoAdvanced_SensitivityCompensationEnabled(GoAdvanced advanced)
Returns the user defined sensitivity compensation value.
k64f GoAdvanced_DynamicSensitivityLimitMin(GoAdvanced advanced)
Returns the dynamic sensitivity minimum value limit.
Represents a spot selection type.
kBool GoAdvanced_IsSpotSelectionTypeUsed(GoAdvanced advanced)
Returns a boolean relating to whether the user defined spot selection type will be used by the system...
k32u GoAdvanced_DynamicThresholdLimitMax(GoAdvanced advanced)
Returns the dynamic threshold maximum value limit.
k32u GoAdvanced_SpotWidthMaxSystemValue(GoAdvanced advanced)
Returns the maximum spot width system value.
kStatus GoAdvanced_SetCameraGainAnalog(GoAdvanced advanced, k64f value)
Sets the analog camera gain.
k32u GoAdvanced_SpotContinuityMinimumSegmentSize(GoAdvanced advanced)
Returns the minimum segment size used in continuity sorting spot detection.
kStatus GoAdvanced_SetDynamicSensitivity(GoAdvanced advanced, k64f value)
Sets the dynamic sensitivity.
kBool GoAdvanced_IsCameraGainDigitalUsed(GoAdvanced advanced)
Returns a boolean value representing whether the user's digital camera gain value is used by the syst...
k64f GoAdvanced_CameraGainAnalogLimitMin(GoAdvanced advanced)
Returns the analog camera gain minimum value limit.
GoGammaType GoAdvanced_GammaTypeSystemValue(GoAdvanced advanced)
Returns the system's gamma type value.
Represents advanced acquisition type.
GoSurfacePhaseFilter GoAdvanced_SurfacePhaseFilter(GoAdvanced advanced)
Returns the phase filter type.
k32u GoAdvanced_SpotWidthMaxLimitMin(GoAdvanced advanced)
Returns the maximum spot width minimum limit.
kStatus GoAdvanced_SetType(GoAdvanced advanced, GoAdvancedType type)
Sets the advanced acquisition type.
k32u GoAdvanced_DynamicThresholdLimitMin(GoAdvanced advanced)
Returns the dynamic threshold minimum value limit.
k64f GoAdvanced_CameraGainAnalogSystemValue(GoAdvanced advanced)
Returns the analog camera gain system value.
k32u GoAdvanced_SpotContinuitySearchWindowY(GoAdvanced advanced)
Returns the search window size in the Y direction used in continuity sorting spot detection.