Gocator API
 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  */
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 * Returns the spot width threshold below which spots are considered to be in an opaque section of the profile. This is in number of pixels in the video image Y direction.
319 *
320 * @public @memberof GoAdvanced
321 * @version Introduced in firmware 6.1.18.16
322 * @param advanced GoAdvanced object.
323 * @return The spot width threshold below which spots are considered to be in an opaque section of the profile.
324 */
326 
327 /**
328 * Sets the spot width threshold below which spots are considered to be in an opaque section of the profile. This is in number of pixels in the video image Y direction.
329 *
330 * @public @memberof GoAdvanced
331 * @version Introduced in firmware 6.1.18.16
332 * @param advanced GoAdvanced object.
333 * @param value The spot width threshold below which spots are considered to be in an opaque section of the profile.
334 * @return Operation status.
335 */
337 
338 /**
339  * Returns the minimum limit of the spot width threshold below which spots are considered to be in an opaque section of the profile.
340 *
341  *
342  * @public @memberof GoAdvanced
343  * @version Introduced in firmware 6.1.18.16
344  * @param advanced GoAdvanced object.
345  * @return The minimum limit of the spot width threshold below which spots are considered to be in an opaque section of the profile.
346  */
348 
349 /**
350  * Returns the maximum limit of the spot width threshold below which spots are considered to be in an opaque section of the profile.
351  *
352  * @public @memberof GoAdvanced
353  * @version Introduced in firmware 6.1.18.16
354  * @param advanced GoAdvanced object.
355  * @return The maximum limit of the spot width threshold below which spots are considered to be in an opaque section of the profile.
356  */
358 
359 /**
360  * Returns a boolean value representing whether the spot width threshold is used in translucent sorting algorithm.
361  *
362  * @public @memberof GoAdvanced
363  * @version Introduced in firmware 6.1.18.16
364  * @param advanced GoAdvanced object.
365  * @return kTRUE if it is used and kFALSE otherwise.
366  */
368 
369 /**
370  * Returns the system value of the spot width threshold below which spots are considered to be in an opaque section of the profile.
371  *
372  * @public @memberof GoAdvanced
373  * @version Introduced in firmware 6.1.18.16
374  * @param advanced GoAdvanced object.
375  * @return The system value of the spot width threshold below which spots are considered to be in an opaque section of the profile.
376  */
378 
379 /**
380 * Returns the spot width required to activate a translucent section in the profile. This is in number of pixels in the video image Y direction.
381 *
382 * @public @memberof GoAdvanced
383 * @version Introduced in firmware 6.1.18.16
384 * @param advanced GoAdvanced object.
385 * @return The spot width required to activate a translucent section in the profile. This is in number of pixels in the video image Y direction.
386 */
388 
389 /**
390 * Sets the spot width required to activate a translucent section in the profile. This is in number of pixels in the video image Y direction.
391 *
392 * @public @memberof GoAdvanced
393 * @version Introduced in firmware 6.1.18.16
394 * @param advanced GoAdvanced object.
395 * @param value The spot width required to activate a translucent section in the profile.
396 * @return Operation status.
397 */
399 
400 /**
401  * Returns the minimum limit of the spot width required to activate a translucent section in the profile. This is in number of pixels in the video image Y direction.
402 *
403  *
404  * @public @memberof GoAdvanced
405  * @version Introduced in firmware 6.1.18.16
406  * @param advanced GoAdvanced object.
407  * @return The minimum limit of the spot width required to activate a translucent section in the profile.
408  */
410 
411 /**
412  * Returns the maximum limit of the spot width required to activate a translucent section in the profile.
413  *
414  * @public @memberof GoAdvanced
415  * @version Introduced in firmware 6.1.18.16
416  * @param advanced GoAdvanced object.
417  * @return The maximum limit of the spot width required to activate a translucent section in the profile.
418  */
420 
421 /**
422  * Returns a boolean value representing whether the spot width required to activate a translucent section is used in translucent sorting algorithm.
423  *
424  * @public @memberof GoAdvanced
425  * @version Introduced in firmware 6.1.18.16
426  * @param advanced GoAdvanced object.
427  * @return kTRUE if it is used and kFALSE otherwise.
428  */
430 
431 /**
432  * Returns the system value of the spot width required to activate a translucent section in the profile.
433  *
434  * @public @memberof GoAdvanced
435  * @version Introduced in firmware 6.1.18.16
436  * @param advanced GoAdvanced object.
437  * @return The system value of the spot width required to activate a translucent section in the profile.
438  */
440 
441 /**
442  * Returns the minimum length of a translucent section. This is in number of pixels in the video image X direction.
443  *
444  * @public @memberof GoAdvanced
445  * @version Introduced in firmware 6.1.18.16
446  * @param advanced GoAdvanced object.
447  * @return The minimum length of a translucent section.
448  */
450 
451 /**
452 * Sets the minimum length of a translucent section. This is in number of pixels in the video image X direction.
453 *
454 * @public @memberof GoAdvanced
455 * @version Introduced in firmware 6.1.18.16
456 * @param advanced GoAdvanced object.
457 * @param value The minimum length of a translucent section.
458 * @return Operation status.
459 */
461 
462 /**
463  * Returns the minimum limit of minimum length of a translucent section.
464  *
465  *
466  * @public @memberof GoAdvanced
467  * @version Introduced in firmware 6.1.18.16
468  * @param advanced GoAdvanced object.
469  * @return The minimum limit of the minimum length of a translucent section.
470  */
472 
473 /**
474  * Returns the maximum limit of the minimum length of a translucent section.
475  *
476  * @public @memberof GoAdvanced
477  * @version Introduced in firmware 6.1.18.16
478  * @param advanced GoAdvanced object.
479  * @return The maximum limit of the minimum length of a translucent section.
480  */
482 
483 /**
484  * Returns a boolean value representing whether the minimum length of a translucent section is used in translucent sorting algorithm.
485  *
486  * @public @memberof GoAdvanced
487  * @version Introduced in firmware 6.1.18.16
488  * @param advanced GoAdvanced object.
489  * @return kTRUE if it is used and kFALSE otherwise.
490  */
492 
493 /**
494  * Returns the system value of the minimum length of a translucent section.
495  *
496  * @public @memberof GoAdvanced
497  * @version Introduced in firmware 6.1.18.16
498  * @param advanced GoAdvanced object.
499  * @return The system value of the minimum length of a translucent section.
500  */
502 
503 /**
504  * Returns the threading mode options count used in translucent sorting algorithm.
505  *
506  * @public @memberof GoAdvanced
507  * @version Introduced in firmware 6.1.18.16
508  * @param advanced GoAdvanced object.
509  * @return The threading mode options count used in translucent sorthing algorithm.
510  */
512 
513 /**
514  * Returns the threading mode option at the given index used in translucent sorting algorithm.
515  *
516  * @public @memberof GoAdvanced
517  * @version Introduced in firmware 6.1.18.16
518  * @param advanced GoAdvanced object.
519  * @param index The option list index to access.
520  * @return The threading mode option at the given index used in translucent sorthing algorithm.
521  */
523 
524 /**
525  * Sets the threading mode used in translucent sorting algorithm.
526  *
527  * @public @memberof GoAdvanced
528  * @version Introduced in firmware 6.1.18.16
529  * @param advanced GoAdvanced object.
530  * @param mode Threading mode.
531  * @return Operation status.
532  */
534 
535 /**
536  * Returns the threading mode used in translucent sorting algorithm.
537  *
538  * @public @memberof GoAdvanced
539  * @version Introduced in firmware 6.1.18.16
540  * @param advanced GoAdvanced object.
541  * @return The threading mode used in translucent sorting algorithm.
542  */
544 
545 /**
546  * Returns a boolean value representing whether threading mode is used in translucent sorting algorithm.
547  *
548  * @public @memberof GoAdvanced
549  * @version Introduced in firmware 6.1.18.16
550  * @param advanced GoAdvanced object.
551  * @return kTRUE if it is used and kFALSE otherwise.
552  */
554 
555 /**
556  * Returns the system value of threading mode used in translucent sorting algorithm.
557  *
558  * @public @memberof GoAdvanced
559  * @version Introduced in firmware 6.1.18.16
560  * @param advanced GoAdvanced object.
561  * @return The system value of threading mode used in translucent sorting algorithm.
562  */
564 
565 /**
566  * Sets the analog camera gain.
567  *
568  * @public @memberof GoAdvanced
569  * @version Introduced in firmware 4.6.1.140
570  * @param advanced GoAdvanced object.
571  * @param value Analog camera gain.
572  * @return Operation status.
573  */
575 
576 /**
577  * Returns the user defined analog camera gain value.
578  *
579  * @public @memberof GoAdvanced
580  * @version Introduced in firmware 4.6.1.140
581  * @param advanced GoAdvanced object.
582  * @return Analog camera gain value.
583  */
585 
586 /**
587  * Returns the analog camera gain minimum value limit.
588  *
589  * @public @memberof GoAdvanced
590  * @version Introduced in firmware 4.6.1.140
591  * @param advanced GoAdvanced object.
592  * @return Analog camera gain minimum value limit.
593  */
595 
596 /**
597  * Returns the analog camera gain maximum value limit.
598  *
599  * @public @memberof GoAdvanced
600  * @version Introduced in firmware 4.6.1.140
601  * @param advanced GoAdvanced object.
602  * @return Analog camera gain maximum value limit.
603  */
605 
606 /**
607  * Returns a boolean value representing whether the user defined analog camera gain is used.
608  *
609  * @public @memberof GoAdvanced
610  * @version Introduced in firmware 4.6.1.140
611  * @param advanced GoAdvanced object.
612  * @return kTRUE if the user defined analog camera gain is used and kFALSE otherwise.
613  */
615 
616 /**
617  * Returns the analog camera gain system value.
618  *
619  * @public @memberof GoAdvanced
620  * @version Introduced in firmware 4.6.1.140
621  * @param advanced GoAdvanced object.
622  * @return The analog camera gain system value.
623  */
625 
626 /**
627  * Sets the digital camera gain
628  *
629  * @public @memberof GoAdvanced
630  * @version Introduced in firmware 4.6.1.140
631  * @param advanced GoAdvanced object.
632  * @param value Digital camera gain.
633  * @return Operation status.
634  */
636 
637 /**
638  * Returns the user defined digital camera gain value.
639  *
640  * @public @memberof GoAdvanced
641  * @version Introduced in firmware 4.6.1.140
642  * @param advanced GoAdvanced object.
643  * @return The digital camera gain system value.
644  */
646 
647 /**
648  * Returns the digital camera gain minimum value limit.
649  *
650  * @public @memberof GoAdvanced
651  * @version Introduced in firmware 4.6.1.140
652  * @param advanced GoAdvanced object.
653  * @return Digital camera gain minimum value limit.
654  */
656 
657 /**
658  * Returns the digital camera gain maximum value limit.
659  *
660  * @public @memberof GoAdvanced
661  * @version Introduced in firmware 4.6.1.140
662  * @param advanced GoAdvanced object.
663  * @return Digital camera gain maximum value limit.
664  */
666 
667 /**
668  * Returns a boolean value representing whether the user's digital camera gain value is used by the system.
669  *
670  * @public @memberof GoAdvanced
671  * @version Introduced in firmware 4.6.1.140
672  * @param advanced GoAdvanced object.
673  * @return kTRUE if used and kFALSE otherwise.
674  */
676 
677 /**
678  * Returns the system's digital camera gain value.
679  *
680  * @public @memberof GoAdvanced
681  * @version Introduced in firmware 4.6.1.140
682  * @param advanced GoAdvanced object.
683  * @return Digital camera gain system value.
684  */
686 
687 /**
688  * Sets the dynamic sensitivity.
689  *
690  * @public @memberof GoAdvanced
691  * @version Introduced in firmware 4.6.1.140
692  * @param advanced GoAdvanced object.
693  * @param value Dynamic sensitivity.
694  * @return Operation status.
695  */
697 
698 /**
699  * Returns the user defined dynamic sensitivity value.
700  *
701  * @public @memberof GoAdvanced
702  * @version Introduced in firmware 4.6.1.140
703  * @param advanced GoAdvanced object.
704  * @return User defined dynamic sensitivity value.
705  */
707 
708 /**
709  * Returns the dynamic sensitivity minimum value limit.
710  *
711  * @public @memberof GoAdvanced
712  * @version Introduced in firmware 4.6.1.140
713  * @param advanced GoAdvanced object.
714  * @return Dynamic sensitivity minimum value limit.
715  */
717 
718 /**
719  * Returns the dynamic sensitivity maximum value limit.
720  *
721  * @public @memberof GoAdvanced
722  * @version Introduced in firmware 4.6.1.140
723  * @param advanced GoAdvanced object.
724  * @return Dynamic sensitivity maximum value limit.
725  */
727 
728 /**
729  * Returns a boolean representing whether the user defined dynamic sensitivity value is used.
730  *
731  * @public @memberof GoAdvanced
732  * @version Introduced in firmware 4.6.1.140
733  * @param advanced GoAdvanced object.
734  * @return kTRUE if used and kFALSE otherwise.
735  */
737 
738 /**
739  * Returns the dynamic sensitivity system value.
740  *
741  * @public @memberof GoAdvanced
742  * @version Introduced in firmware 4.6.1.140
743  * @param advanced GoAdvanced object.
744  * @return Dynamic sensitivity system value.
745  */
747 
748 /**
749  * Sets the dynamic threshold.
750  *
751  * @public @memberof GoAdvanced
752  * @version Introduced in firmware 4.6.1.140
753  * @param advanced GoAdvanced object.
754  * @param value Dynamic threshold.
755  * @return Operation status.
756  */
758 
759 /**
760  * Returns the dynamic threshold minimum value limit.
761  *
762  * @public @memberof GoAdvanced
763  * @version Introduced in firmware 4.6.1.140
764  * @param advanced GoAdvanced object.
765  * @return Dynamic threshold minimum value limit.
766  */
768 
769 /**
770  * Returns the dynamic threshold maximum value limit.
771  *
772  * @public @memberof GoAdvanced
773  * @version Introduced in firmware 4.6.1.140
774  * @param advanced GoAdvanced object.
775  * @return Dynamic threshold maximum value limit.
776  */
778 
779 /**
780  * Returns the user defined dynamic threshold value.
781  *
782  * @public @memberof GoAdvanced
783  * @version Introduced in firmware 4.6.1.140
784  * @param advanced GoAdvanced object.
785  * @return The user defined dynamic threshold value.
786  */
788 
789 /**
790  * Returns a boolean representing whether or not the user defined dynamic threshold is used by the system.
791  *
792  * @public @memberof GoAdvanced
793  * @version Introduced in firmware 4.6.1.140
794  * @param advanced GoAdvanced object.
795  * @return Dynamic threshold minimum value limit.
796  */
798 
799 /**
800  * Returns the dynamic threshold system value.
801  *
802  * @public @memberof GoAdvanced
803  * @version Introduced in firmware 4.6.1.140
804  * @param advanced GoAdvanced object.
805  * @return Dynamic threshold system value.
806  */
808 
809 /**
810  * Sets the gamma type.
811  *
812  * @public @memberof GoAdvanced
813  * @version Introduced in firmware 4.6.1.140
814  * @param advanced GoAdvanced object.
815  * @param value Gamma type.
816  * @return Operation status.
817  */
819 
820 /**
821  * Returns the user defined gamma type.
822  *
823  * @public @memberof GoAdvanced
824  * @version Introduced in firmware 4.6.1.140
825  * @param advanced GoAdvanced object.
826  * @return User defined gamma type.
827  */
829 
830 /**
831  * Returns a boolean representing whether the user defined gamma type is used by the system.
832  *
833  * @public @memberof GoAdvanced
834  * @version Introduced in firmware 4.6.1.140
835  * @param advanced GoAdvanced object.
836  * @return kTRUE if used and kFALSE otherwise.
837  */
839 
840 /**
841  * Returns the system's gamma type value.
842  *
843  * @public @memberof GoAdvanced
844  * @version Introduced in firmware 4.6.1.140
845  * @param advanced GoAdvanced object.
846  * @return The system gamma type value.
847  */
849 
850 /**
851  * Enables or disables senstivity compensation. NOTE: This is only applicable to
852  * 2300 B series sensors.
853  *
854  * @public @memberof GoAdvanced
855  * @version Introduced in firmware 4.6.1.140
856  * @param advanced GoAdvanced object.
857  * @param value kTRUE to enable and kFALSE to disable.
858  * @return Operation status.
859  */
861 
862 /**
863  * Returns the user defined sensitivity compensation value.
864  *
865  * @public @memberof GoAdvanced
866  * @version Introduced in firmware 4.6.1.140
867  * @param advanced GoAdvanced object.
868  * @return User defined sensitivity compensation.
869  */
871 
872 /**
873  * Returns a boolean representing whether the user defined sensitivity compensation is used by the system.
874  *
875  * @public @memberof GoAdvanced
876  * @version Introduced in firmware 4.6.1.140
877  * @param advanced GoAdvanced object.
878  * @return kTRUE if used and kFALSE otherwise.
879  */
881 
882 /**
883  * Returns the system's sensitivity compensation value.
884  *
885  * @public @memberof GoAdvanced
886  * @version Introduced in firmware 4.6.1.140
887  * @param advanced GoAdvanced object.
888  * @return kTRUE if enabled and kFALSE otherwise.
889  */
891 
892 /**
893 * Sets surface engine encoding type (Default Standard)
894 *
895 * @public @memberof GoAdvanced
896 * @note Supported with G3
897 * @version Introduced in firmware 4.7.3.22
898 * @param advanced GoAdvanced object.
899 * @param encoding Surface Engine Encoding type
900 * @return Operation status.
901 */
903 
904 /**
905 * Returns the surface engine encoding type.
906 *
907 * @public @memberof GoAdvanced
908 * @note Supported with G3
909 * @version Introduced in firmware 4.7.3.22
910 * @param advanced GoAdvanced object.
911 * @return The Surface Engine Encoding type.
912 */
914 
915 /**
916 * Returns the surface engine encoding type.
917 *
918 * @public @memberof GoAdvanced
919 * @note Supported with G3
920 * @version Introduced in firmware 5.3.19.50
921 * @param advanced GoAdvanced object.
922 * @return kTRUE if used and kFALSE otherwise.
923 */
925 
926 /**
927 * Returns the system's surface engine encoding type.
928 *
929 * @public @memberof GoAdvanced
930 * @note Supported with G3
931 * @version Introduced in firmware 5.3.19.50
932 * @param advanced GoAdvanced object.
933 * @return The Surface Engine Encoding type.
934 */
936 
937 /**
938 * Sets the phase filter type. (Default None)
939 *
940 * @public @memberof GoAdvanced
941 * @note Supported with G3
942 * @version Introduced in firmware 4.7.3.22
943 * @param advanced GoAdvanced object.
944 * @param phaseFilter Phase Filter type.
945 * @return Operation status.
946 */
948 
949 /**
950 * Returns the phase filter type.
951 *
952 * @public @memberof GoAdvanced
953 * @note Supported with G3
954 * @version Introduced in firmware 4.7.3.22
955 * @param advanced GoAdvanced object.
956 * @return The phase filter type.
957 */
959 
960 /**
961  * Sets the contrast threshold.
962  *
963  * @public @memberof GoAdvanced
964  * @note Supported with G3
965  * @version Introduced in firmware 5.3.12.7
966  * @param advanced GoAdvanced object.
967  * @param value Contrast threshold.
968  * @return Operation status.
969  */
971 
972 /**
973  * Returns the user defined contrast threshold.
974  *
975  * @public @memberof GoAdvanced
976  * @note Supported with G3
977  * @version Introduced in firmware 5.3.12.7
978  * @param advanced GoAdvanced object.
979  * @return The contrast threshold.
980  */
982 
983 /**
984  * Returns the minimum contrast threshold limit.
985  *
986  * @public @memberof GoAdvanced
987  * @note Supported with G3
988  * @version Introduced in firmware 5.3.12.7
989  * @param advanced GoAdvanced object.
990  * @return The minimum contrast threshold.
991  */
993 
994 /**
995  * Returns the maximum contrast threshold limit.
996  *
997  * @public @memberof GoAdvanced
998  * @note Supported with G3
999  * @version Introduced in firmware 5.3.12.7
1000  * @param advanced GoAdvanced object.
1001  * @return The maximum contrast threshold.
1002  */
1004 
1005 /**
1006  * Returns a boolean value representing whether the user specified contrast threshold value is used.
1007  *
1008  * @public @memberof GoAdvanced
1009  * @note Supported with G3
1010  * @version Introduced in firmware 5.3.12.7
1011  * @param advanced GoAdvanced object.
1012  * @return kTRUE if it is used and kFALSE otherwise.
1013  */
1015 
1016 /**
1017  * Returns the system contrast threshold value.
1018  *
1019  * @public @memberof GoAdvanced
1020  * @note Supported with G3
1021  * @version Introduced in firmware 5.3.12.7
1022  * @param advanced GoAdvanced object.
1023  * @return The system contrast threshold.
1024  */
1026 
1027 #include <GoSdk/GoAdvanced.x.h>
1028 
1029 #endif
kSize GoAdvanced_SpotTranslucentThreadingModeOptionCount(GoAdvanced advanced)
Returns the threading mode options count used in translucent sorting algorithm.
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.
kBool GoAdvanced_IsSpotTranslucentOpaqueWidthUsed(GoAdvanced advanced)
Returns a boolean value representing whether the spot width threshold is used in translucent sorting ...
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.
k32u GoAdvanced_SpotTranslucentTranslucentWidthSystemValue(GoAdvanced advanced)
Returns the system value of the spot width required to activate a translucent section in the profile...
GoTranslucentThreadingMode GoAdvanced_SpotTranslucentThreadingModeOptionAt(GoAdvanced advanced, kSize index)
Returns the threading mode option at the given index used in translucent sorting algorithm.
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_SpotTranslucentOpaqueWidthLimitMin(GoAdvanced advanced)
Returns the minimum limit of the spot width threshold below which spots are considered to be in an op...
k32u GoAdvanced_ContrastThreshold(GoAdvanced advanced)
Returns the user defined contrast threshold.
Represents a surface scanning engine encoding type.
k32u GoAdvanced_SpotTranslucentOpaqueWidthLimitMax(GoAdvanced advanced)
Returns the maximum limit of the spot width threshold below which spots are considered to be in an op...
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.
kStatus GoAdvanced_SetSpotTranslucentOpaqueWidth(GoAdvanced advanced, k32u value)
Sets the spot width threshold below which spots are considered to be in an opaque section of the prof...
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.
kStatus GoAdvanced_SetSpotTranslucentThreadingMode(GoAdvanced advanced, GoTranslucentThreadingMode mode)
Sets the threading mode used in translucent sorting algorithm.
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.
k32u GoAdvanced_SpotTranslucentTranslucentWidth(GoAdvanced advanced)
Returns the spot width required to activate a translucent section in the profile. ...
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_SetSpotTranslucentMinimumLength(GoAdvanced advanced, k32u value)
Sets the minimum length of a translucent section.
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.
kBool GoAdvanced_IsSpotTranslucentMinimumLengthUsed(GoAdvanced advanced)
Returns a boolean value representing whether the minimum length of a translucent section is used in t...
GoSurfaceEncoding GoAdvanced_SurfaceEncodingSystemValue(GoAdvanced advanced)
Returns the system's surface engine encoding type.
kStatus GoAdvanced_SetSpotThreshold(GoAdvanced advanced, k32u value)
Sets the spot threshold.
GoTranslucentThreadingMode GoAdvanced_SpotTranslucentThreadingMode(GoAdvanced advanced)
Returns the threading mode used in translucent sorting algorithm.
k32u GoAdvanced_SpotTranslucentMinimumLengthSystemValue(GoAdvanced advanced)
Returns the system value of the minimum length of a translucent section.
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.
Represents a translucent spot threading mode.
k32u GoAdvanced_DynamicThresholdSystemValue(GoAdvanced advanced)
Returns the dynamic threshold system value.
GoTranslucentThreadingMode GoAdvanced_SpotTranslucentThreadingModeSystemValue(GoAdvanced advanced)
Returns the system value of threading mode used in translucent sorting algorithm. ...
kStatus GoAdvanced_SetSpotTranslucentTranslucentWidth(GoAdvanced advanced, k32u value)
Sets the spot width required to activate a translucent section in the profile.
k32u GoAdvanced_SpotTranslucentTranslucentWidthLimitMax(GoAdvanced advanced)
Returns the maximum limit of the spot width required to activate a translucent section in the profile...
k32u GoAdvanced_DynamicThreshold(GoAdvanced advanced)
Returns the user defined dynamic threshold value.
k32u GoAdvanced_SpotTranslucentOpaqueWidth(GoAdvanced advanced)
Returns the spot width threshold below which spots are considered to be in an opaque section of the p...
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.
k32u GoAdvanced_SpotTranslucentMinimumLength(GoAdvanced advanced)
Returns the minimum length of a translucent section.
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_SpotTranslucentOpaqueWidthSystemValue(GoAdvanced advanced)
Returns the system value of the spot width threshold below which spots are considered to be in an opa...
k32u GoAdvanced_ContrastThresholdLimitMax(GoAdvanced advanced)
Returns the maximum contrast threshold limit.
k32u GoAdvanced_SpotTranslucentTranslucentWidthLimitMin(GoAdvanced advanced)
Returns the minimum limit of the spot width required to activate a translucent section in the profile...
kBool GoAdvanced_IsSpotTranslucentTranslucentWidthUsed(GoAdvanced advanced)
Returns a boolean value representing whether the spot width required to activate a translucent sectio...
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_SpotTranslucentMinimumLengthLimitMax(GoAdvanced advanced)
Returns the maximum limit of the minimum length of a translucent section.
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...
kBool GoAdvanced_IsSpotTranslucentThreadingModeUsed(GoAdvanced advanced)
Returns a boolean value representing whether threading mode is used in translucent sorting algorithm...
k32u GoAdvanced_SpotTranslucentMinimumLengthLimitMin(GoAdvanced advanced)
Returns the minimum limit of minimum length of a translucent section.
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...