Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
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-2022 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 */
32 GoFx(kStatus) GoAdvanced_SetType(GoAdvanced advanced, GoAdvancedType type);
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 */
42 GoFx(GoAdvancedType) GoAdvanced_Type(GoAdvanced advanced);
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 */
62 GoFx(GoAdvancedType) GoAdvanced_TypeSystemValue(GoAdvanced advanced);
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 */
85 GoFx(k32u) GoAdvanced_SpotThreshold(GoAdvanced advanced);
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 */
96 GoFx(k32u) GoAdvanced_SpotThresholdLimitMin(GoAdvanced advanced);
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 */
107 GoFx(k32u) GoAdvanced_SpotThresholdLimitMax(GoAdvanced advanced);
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 */
118 GoFx(kBool) GoAdvanced_IsSpotThresholdUsed(GoAdvanced advanced);
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 */
129 GoFx(k32u) GoAdvanced_SpotThresholdSystemValue(GoAdvanced advanced);
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 */
160 GoFx(k32u) GoAdvanced_SpotWidthMaxLimitMin(GoAdvanced advanced);
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 */
170 GoFx(k32u) GoAdvanced_SpotWidthMaxLimitMax(GoAdvanced advanced);
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 */
180 GoFx(kBool) GoAdvanced_IsSpotWidthMaxUsed(GoAdvanced advanced);
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 */
190 GoFx(k32u) GoAdvanced_SpotWidthMaxSystemValue(GoAdvanced advanced);
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 */
200 GoFx(kSize) GoAdvanced_SpotSelectionTypeOptionCount(GoAdvanced advanced);
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 */
211 GoFx(GoSpotSelectionType) GoAdvanced_SpotSelectionTypeOptionAt(GoAdvanced advanced, kSize index);
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 */
222 GoFx(kStatus) GoAdvanced_SetSpotSelectionType(GoAdvanced advanced, GoSpotSelectionType type);
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 */
232 GoFx(GoSpotSelectionType) GoAdvanced_SpotSelectionType(GoAdvanced advanced);
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 */
242 GoFx(kBool) GoAdvanced_IsSpotSelectionTypeUsed(GoAdvanced advanced);
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 */
252 GoFx(GoSpotSelectionType) GoAdvanced_SpotSelectionTypeSystemValue(GoAdvanced advanced);
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 */
262 GoFx(k32u) GoAdvanced_SpotContinuityMinimumSegmentSize(GoAdvanced advanced);
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 */
273 GoFx(kStatus) GoAdvanced_SetSpotContinuityMinimumSegmentSize(GoAdvanced advanced, k32u value);
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 */
283 GoFx(k32u) GoAdvanced_SpotContinuitySearchWindowX(GoAdvanced advanced);
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 */
294 GoFx(kStatus) GoAdvanced_SetSpotContinuitySearchWindowX(GoAdvanced advanced, k32u value);
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 */
304 GoFx(k32u) GoAdvanced_SpotContinuitySearchWindowY(GoAdvanced advanced);
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 */
315 GoFx(kStatus) GoAdvanced_SetSpotContinuitySearchWindowY(GoAdvanced advanced, k32u value);
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 */
326 GoFx(kStatus) GoAdvanced_SetCameraGainAnalog(GoAdvanced advanced, k64f value);
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 */
336 GoFx(k64f) GoAdvanced_CameraGainAnalog(GoAdvanced advanced);
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 */
346 GoFx(k64f) GoAdvanced_CameraGainAnalogLimitMin(GoAdvanced advanced);
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 */
356 GoFx(k64f) GoAdvanced_CameraGainAnalogLimitMax(GoAdvanced advanced);
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 */
366 GoFx(kBool) GoAdvanced_IsCameraGainAnalogUsed(GoAdvanced advanced);
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 */
376 GoFx(k64f) GoAdvanced_CameraGainAnalogSystemValue(GoAdvanced advanced);
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 */
387 GoFx(kStatus) GoAdvanced_SetCameraGainDigital(GoAdvanced advanced, k64f value);
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 */
397 GoFx(k64f) GoAdvanced_CameraGainDigital(GoAdvanced advanced);
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 */
407 GoFx(k64f) GoAdvanced_CameraGainDigitalLimitMin(GoAdvanced advanced);
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 */
417 GoFx(k64f) GoAdvanced_CameraGainDigitalLimitMax(GoAdvanced advanced);
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 */
427 GoFx(kBool) GoAdvanced_IsCameraGainDigitalUsed(GoAdvanced advanced);
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 */
437 GoFx(k64f) GoAdvanced_CameraGainDigitalSystemValue(GoAdvanced advanced);
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 */
448 GoFx(kStatus) GoAdvanced_SetDynamicSensitivity(GoAdvanced advanced, k64f value);
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 */
458 GoFx(k64f) GoAdvanced_DynamicSensitivity(GoAdvanced advanced);
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 */
468 GoFx(k64f) GoAdvanced_DynamicSensitivityLimitMin(GoAdvanced advanced);
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 */
478 GoFx(k64f) GoAdvanced_DynamicSensitivityLimitMax(GoAdvanced advanced);
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 */
488 GoFx(kBool) GoAdvanced_IsDynamicSensitivityUsed(GoAdvanced advanced);
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 */
498 GoFx(k64f) GoAdvanced_DynamicSensitivitySystemValue(GoAdvanced advanced);
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 */
509 GoFx(kStatus) GoAdvanced_SetDynamicThreshold(GoAdvanced advanced, k32u value);
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 */
519 GoFx(k32u) GoAdvanced_DynamicThresholdLimitMin(GoAdvanced advanced);
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 */
529 GoFx(k32u) GoAdvanced_DynamicThresholdLimitMax(GoAdvanced advanced);
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 */
539 GoFx(k32u) GoAdvanced_DynamicThreshold(GoAdvanced advanced);
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 */
549 GoFx(kBool) GoAdvanced_IsDynamicThresholdUsed(GoAdvanced advanced);
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 */
559 GoFx(k32u) GoAdvanced_DynamicThresholdSystemValue(GoAdvanced advanced);
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 */
570 GoFx(kStatus) GoAdvanced_SetGammaType(GoAdvanced advanced, GoGammaType value);
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 */
580 GoFx(GoGammaType) GoAdvanced_GammaType(GoAdvanced advanced);
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 */
590 GoFx(kBool) GoAdvanced_IsGammaTypeUsed(GoAdvanced advanced);
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 */
600 GoFx(GoGammaType) GoAdvanced_GammaTypeSystemValue(GoAdvanced advanced);
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 */
612 GoFx(kStatus) GoAdvanced_EnableSensitivityCompensation(GoAdvanced advanced, kBool value);
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 */
622 GoFx(kBool) GoAdvanced_SensitivityCompensationEnabled(GoAdvanced advanced);
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 */
632 GoFx(kBool) GoAdvanced_IsSensitivityCompensationEnabledUsed(GoAdvanced advanced);
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 */
642 GoFx(kBool) GoAdvanced_SensitivityCompensationEnabledSystemValue(GoAdvanced advanced);
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 */
654 GoFx(kStatus) GoAdvanced_SetSurfaceEncoding(GoAdvanced advanced, GoSurfaceEncoding encoding);
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 */
665 GoFx(GoSurfaceEncoding) GoAdvanced_SurfaceEncoding(GoAdvanced advanced);
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 */
676 GoFx(kBool) GoAdvanced_IsSurfaceEncodingUsed(GoAdvanced advanced);
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 */
687 GoFx(GoSurfaceEncoding) GoAdvanced_SurfaceEncodingSystemValue(GoAdvanced advanced);
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 */
699 GoFx(kStatus) GoAdvanced_SetSurfacePhaseFilter(GoAdvanced advanced, GoSurfacePhaseFilter phaseFilter);
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 */
710 GoFx(GoSurfacePhaseFilter) GoAdvanced_SurfacePhaseFilter(GoAdvanced advanced);
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 */
722 GoFx(kStatus) GoAdvanced_SetContrastThreshold(GoAdvanced advanced, k32u value);
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 */
733 GoFx(k32u) GoAdvanced_ContrastThreshold(GoAdvanced advanced);
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 */
744 GoFx(k32u) GoAdvanced_ContrastThresholdLimitMin(GoAdvanced advanced);
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 */
755 GoFx(k32u) GoAdvanced_ContrastThresholdLimitMax(GoAdvanced advanced);
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 */
766 GoFx(kBool) GoAdvanced_IsContrastThresholdUsed(GoAdvanced advanced);
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 */
777 GoFx(k32u) GoAdvanced_ContrastThresholdSystemValue(GoAdvanced advanced);
778
779 #include <GoSdk/GoAdvanced.x.h>
780
781 #endif
GoAdvanced::GoAdvanced_CameraGainAnalog
k64f GoAdvanced_CameraGainAnalog(GoAdvanced advanced)
Returns the user defined analog camera gain value.
k32u
GoAdvanced::GoAdvanced_SetDynamicThreshold
kStatus GoAdvanced_SetDynamicThreshold(GoAdvanced advanced, k32u value)
Sets the dynamic threshold.
GoAdvanced::GoAdvanced_GammaType
GoGammaType GoAdvanced_GammaType(GoAdvanced advanced)
Returns the user defined gamma type.
GoAdvanced::GoAdvanced_SurfaceEncoding
GoSurfaceEncoding GoAdvanced_SurfaceEncoding(GoAdvanced advanced)
Returns the surface engine encoding type.
GoAdvanced
Represents configurable advanced acquisition settings.
GoAdvanced::GoAdvanced_TypeSystemValue
GoAdvancedType GoAdvanced_TypeSystemValue(GoAdvanced advanced)
Returns the advanced acquisition type to be used by the system.
GoAdvanced::GoAdvanced_SetGammaType
kStatus GoAdvanced_SetGammaType(GoAdvanced advanced, GoGammaType value)
Sets the gamma type.
GoAdvanced::GoAdvanced_CameraGainDigital
k64f GoAdvanced_CameraGainDigital(GoAdvanced advanced)
Returns the user defined digital camera gain value.
GoAdvanced::GoAdvanced_SpotSelectionTypeSystemValue
GoSpotSelectionType GoAdvanced_SpotSelectionTypeSystemValue(GoAdvanced advanced)
Returns the system spot selection type.
GoAdvanced::GoAdvanced_DynamicSensitivitySystemValue
k64f GoAdvanced_DynamicSensitivitySystemValue(GoAdvanced advanced)
Returns the dynamic sensitivity system value.
GoAdvanced::GoAdvanced_DynamicSensitivityLimitMax
k64f GoAdvanced_DynamicSensitivityLimitMax(GoAdvanced advanced)
Returns the dynamic sensitivity maximum value limit.
GoAdvanced::GoAdvanced_CameraGainDigitalSystemValue
k64f GoAdvanced_CameraGainDigitalSystemValue(GoAdvanced advanced)
Returns the system's digital camera gain value.
GoAdvanced::GoAdvanced_SetSurfaceEncoding
kStatus GoAdvanced_SetSurfaceEncoding(GoAdvanced advanced, GoSurfaceEncoding encoding)
Sets surface engine encoding type (Default Standard)
GoSurfacePhaseFilter
Represents a surface phase filter type.
kSize
GoAdvanced::GoAdvanced_IsDynamicSensitivityUsed
kBool GoAdvanced_IsDynamicSensitivityUsed(GoAdvanced advanced)
Returns a boolean representing whether the user defined dynamic sensitivity value is used...
GoAdvanced::GoAdvanced_ContrastThresholdSystemValue
k32u GoAdvanced_ContrastThresholdSystemValue(GoAdvanced advanced)
Returns the system contrast threshold value.
GoAdvanced::GoAdvanced_ContrastThreshold
k32u GoAdvanced_ContrastThreshold(GoAdvanced advanced)
Returns the user defined contrast threshold.
GoSurfaceEncoding
Represents a surface scanning engine encoding type.
GoAdvanced::GoAdvanced_IsGammaTypeUsed
kBool GoAdvanced_IsGammaTypeUsed(GoAdvanced advanced)
Returns a boolean representing whether the user defined gamma type is used by the system...
GoAdvanced::GoAdvanced_SetSpotContinuitySearchWindowY
kStatus GoAdvanced_SetSpotContinuitySearchWindowY(GoAdvanced advanced, k32u value)
Sets the search window size in the Y direction used in continuity sorting spot detection.
GoAdvanced::GoAdvanced_SpotContinuitySearchWindowX
k32u GoAdvanced_SpotContinuitySearchWindowX(GoAdvanced advanced)
Returns the search window size in the X direction used in continuity sorting spot detection...
GoAdvanced::GoAdvanced_SpotWidthMax
k32u GoAdvanced_SpotWidthMax(GoAdvanced advanced)
Returns the user defined maximum spot width.
GoAdvanced::GoAdvanced_SetCameraGainDigital
kStatus GoAdvanced_SetCameraGainDigital(GoAdvanced advanced, k64f value)
Sets the digital camera gain.
GoAdvanced::GoAdvanced_IsDynamicThresholdUsed
kBool GoAdvanced_IsDynamicThresholdUsed(GoAdvanced advanced)
Returns a boolean representing whether or not the user defined dynamic threshold is used by the syste...
GoAdvanced::GoAdvanced_IsCameraGainAnalogUsed
kBool GoAdvanced_IsCameraGainAnalogUsed(GoAdvanced advanced)
Returns a boolean value representing whether the user defined analog camera gain is used...
GoAdvanced::GoAdvanced_EnableSensitivityCompensation
kStatus GoAdvanced_EnableSensitivityCompensation(GoAdvanced advanced, kBool value)
Enables or disables senstivity compensation.
GoAdvanced::GoAdvanced_SpotThresholdLimitMin
k32u GoAdvanced_SpotThresholdLimitMin(GoAdvanced advanced)
Returns the minimum spot threshold limit.
GoAdvanced::GoAdvanced_IsSpotThresholdUsed
kBool GoAdvanced_IsSpotThresholdUsed(GoAdvanced advanced)
Returns a boolean value representing whether the user specified spot threshold value is used...
GoAdvanced::GoAdvanced_CameraGainAnalogLimitMax
k64f GoAdvanced_CameraGainAnalogLimitMax(GoAdvanced advanced)
Returns the analog camera gain maximum value limit.
GoSdkDef.h
Essential SDK declarations.
GoGammaType
Represents an advanced gamma type.
GoAdvanced::GoAdvanced_ContrastThresholdLimitMin
k32u GoAdvanced_ContrastThresholdLimitMin(GoAdvanced advanced)
Returns the minimum contrast threshold limit.
GoAdvanced::GoAdvanced_SpotWidthMaxLimitMax
k32u GoAdvanced_SpotWidthMaxLimitMax(GoAdvanced advanced)
Returns the maximum spot width maximum limit.
GoAdvanced::GoAdvanced_SetSpotContinuitySearchWindowX
kStatus GoAdvanced_SetSpotContinuitySearchWindowX(GoAdvanced advanced, k32u value)
Sets the search window size in the X direction used in continuity sorting spot detection.
GoAdvanced::GoAdvanced_DynamicSensitivity
k64f GoAdvanced_DynamicSensitivity(GoAdvanced advanced)
Returns the user defined dynamic sensitivity value.
GoAdvanced::GoAdvanced_SurfaceEncodingSystemValue
GoSurfaceEncoding GoAdvanced_SurfaceEncodingSystemValue(GoAdvanced advanced)
Returns the system's surface engine encoding type.
GoAdvanced::GoAdvanced_SetSpotThreshold
kStatus GoAdvanced_SetSpotThreshold(GoAdvanced advanced, k32u value)
Sets the spot threshold.
GoAdvanced::GoAdvanced_IsSensitivityCompensationEnabledUsed
kBool GoAdvanced_IsSensitivityCompensationEnabledUsed(GoAdvanced advanced)
Returns a boolean representing whether the user defined sensitivity compensation is used by the syste...
GoAdvanced::GoAdvanced_SpotSelectionTypeOptionCount
kSize GoAdvanced_SpotSelectionTypeOptionCount(GoAdvanced advanced)
Returns the number of spot selection type options.
GoAdvanced::GoAdvanced_IsSurfaceEncodingUsed
kBool GoAdvanced_IsSurfaceEncodingUsed(GoAdvanced advanced)
Returns the surface engine encoding type.
GoAdvanced::GoAdvanced_IsContrastThresholdUsed
kBool GoAdvanced_IsContrastThresholdUsed(GoAdvanced advanced)
Returns a boolean value representing whether the user specified contrast threshold value is used...
GoAdvanced::GoAdvanced_CameraGainDigitalLimitMax
k64f GoAdvanced_CameraGainDigitalLimitMax(GoAdvanced advanced)
Returns the digital camera gain maximum value limit.
GoAdvanced::GoAdvanced_DynamicThresholdSystemValue
k32u GoAdvanced_DynamicThresholdSystemValue(GoAdvanced advanced)
Returns the dynamic threshold system value.
GoAdvanced::GoAdvanced_DynamicThreshold
k32u GoAdvanced_DynamicThreshold(GoAdvanced advanced)
Returns the user defined dynamic threshold value.
GoAdvanced::GoAdvanced_SetContrastThreshold
kStatus GoAdvanced_SetContrastThreshold(GoAdvanced advanced, k32u value)
Sets the contrast threshold.
GoAdvanced::GoAdvanced_SensitivityCompensationEnabledSystemValue
kBool GoAdvanced_SensitivityCompensationEnabledSystemValue(GoAdvanced advanced)
Returns the system's sensitivity compensation value.
GoAdvanced::GoAdvanced_SetSpotContinuityMinimumSegmentSize
kStatus GoAdvanced_SetSpotContinuityMinimumSegmentSize(GoAdvanced advanced, k32u value)
Sets the minimum segment size used in continuity sorting spot detection.
GoAdvanced::GoAdvanced_SpotSelectionTypeOptionAt
GoSpotSelectionType GoAdvanced_SpotSelectionTypeOptionAt(GoAdvanced advanced, kSize index)
Returns the spot selection type option at the given index.
GoAdvanced::GoAdvanced_SetSpotWidthMax
kStatus GoAdvanced_SetSpotWidthMax(GoAdvanced advanced, k32u value)
Sets the maximum spot width.
GoAdvanced::GoAdvanced_SetSurfacePhaseFilter
kStatus GoAdvanced_SetSurfacePhaseFilter(GoAdvanced advanced, GoSurfacePhaseFilter phaseFilter)
Sets the phase filter type.
GoAdvanced::GoAdvanced_SetSpotSelectionType
kStatus GoAdvanced_SetSpotSelectionType(GoAdvanced advanced, GoSpotSelectionType type)
Sets the spot selection type.
GoAdvanced::GoAdvanced_IsSpotWidthMaxUsed
kBool GoAdvanced_IsSpotWidthMaxUsed(GoAdvanced advanced)
Returns a boolean relating to whether the user defined spot width max value will be used by the syste...
GoAdvanced::GoAdvanced_SpotThreshold
k32u GoAdvanced_SpotThreshold(GoAdvanced advanced)
Returns the user defined spot threshold.
GoAdvanced::GoAdvanced_SpotSelectionType
GoSpotSelectionType GoAdvanced_SpotSelectionType(GoAdvanced advanced)
Returns the user defined spot selection type.
GoAdvanced::GoAdvanced_ContrastThresholdLimitMax
k32u GoAdvanced_ContrastThresholdLimitMax(GoAdvanced advanced)
Returns the maximum contrast threshold limit.
GoAdvanced::GoAdvanced_CameraGainDigitalLimitMin
k64f GoAdvanced_CameraGainDigitalLimitMin(GoAdvanced advanced)
Returns the digital camera gain minimum value limit.
GoAdvanced::GoAdvanced_IsTypeUsed
kBool GoAdvanced_IsTypeUsed(GoAdvanced advanced)
Returns a boolean relating to whether the user defined advanced acquisition type value will be used b...
kObject
GoAdvanced::GoAdvanced_SpotThresholdSystemValue
k32u GoAdvanced_SpotThresholdSystemValue(GoAdvanced advanced)
Returns the system spot threshold value.
kStatus
GoAdvanced::GoAdvanced_SpotThresholdLimitMax
k32u GoAdvanced_SpotThresholdLimitMax(GoAdvanced advanced)
Returns the maximum spot threshold limit.
GoAdvanced::GoAdvanced_Type
GoAdvancedType GoAdvanced_Type(GoAdvanced advanced)
Returns the user defined advanced acquisition type.
GoAdvanced::GoAdvanced_SensitivityCompensationEnabled
kBool GoAdvanced_SensitivityCompensationEnabled(GoAdvanced advanced)
Returns the user defined sensitivity compensation value.
GoAdvanced::GoAdvanced_DynamicSensitivityLimitMin
k64f GoAdvanced_DynamicSensitivityLimitMin(GoAdvanced advanced)
Returns the dynamic sensitivity minimum value limit.
GoSpotSelectionType
Represents a spot selection type.
GoAdvanced::GoAdvanced_IsSpotSelectionTypeUsed
kBool GoAdvanced_IsSpotSelectionTypeUsed(GoAdvanced advanced)
Returns a boolean relating to whether the user defined spot selection type will be used by the system...
k64f
GoAdvanced::GoAdvanced_DynamicThresholdLimitMax
k32u GoAdvanced_DynamicThresholdLimitMax(GoAdvanced advanced)
Returns the dynamic threshold maximum value limit.
GoAdvanced::GoAdvanced_SpotWidthMaxSystemValue
k32u GoAdvanced_SpotWidthMaxSystemValue(GoAdvanced advanced)
Returns the maximum spot width system value.
GoAdvanced::GoAdvanced_SetCameraGainAnalog
kStatus GoAdvanced_SetCameraGainAnalog(GoAdvanced advanced, k64f value)
Sets the analog camera gain.
GoAdvanced::GoAdvanced_SpotContinuityMinimumSegmentSize
k32u GoAdvanced_SpotContinuityMinimumSegmentSize(GoAdvanced advanced)
Returns the minimum segment size used in continuity sorting spot detection.
kBool
GoAdvanced::GoAdvanced_SetDynamicSensitivity
kStatus GoAdvanced_SetDynamicSensitivity(GoAdvanced advanced, k64f value)
Sets the dynamic sensitivity.
GoAdvanced::GoAdvanced_IsCameraGainDigitalUsed
kBool GoAdvanced_IsCameraGainDigitalUsed(GoAdvanced advanced)
Returns a boolean value representing whether the user's digital camera gain value is used by the syst...
GoAdvanced::GoAdvanced_CameraGainAnalogLimitMin
k64f GoAdvanced_CameraGainAnalogLimitMin(GoAdvanced advanced)
Returns the analog camera gain minimum value limit.
GoAdvanced::GoAdvanced_GammaTypeSystemValue
GoGammaType GoAdvanced_GammaTypeSystemValue(GoAdvanced advanced)
Returns the system's gamma type value.
GoAdvancedType
Represents advanced acquisition type.
GoAdvanced::GoAdvanced_SurfacePhaseFilter
GoSurfacePhaseFilter GoAdvanced_SurfacePhaseFilter(GoAdvanced advanced)
Returns the phase filter type.
GoAdvanced::GoAdvanced_SpotWidthMaxLimitMin
k32u GoAdvanced_SpotWidthMaxLimitMin(GoAdvanced advanced)
Returns the maximum spot width minimum limit.
GoAdvanced::GoAdvanced_SetType
kStatus GoAdvanced_SetType(GoAdvanced advanced, GoAdvancedType type)
Sets the advanced acquisition type.
GoAdvanced::GoAdvanced_DynamicThresholdLimitMin
k32u GoAdvanced_DynamicThresholdLimitMin(GoAdvanced advanced)
Returns the dynamic threshold minimum value limit.
GoAdvanced::GoAdvanced_CameraGainAnalogSystemValue
k64f GoAdvanced_CameraGainAnalogSystemValue(GoAdvanced advanced)
Returns the analog camera gain system value.
GoAdvanced::GoAdvanced_SpotContinuitySearchWindowY
k32u GoAdvanced_SpotContinuitySearchWindowY(GoAdvanced advanced)
Returns the search window size in the Y direction used in continuity sorting spot detection...