GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanCalProcessor.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanCalProcessor.h
3 * @brief Declares a GoWebScanCalProcessor object.
4 *
5 * @internal
6 * Copyright (C) 2017-2018 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 
11 #ifndef GO_WEB_SCAN_CAL_PROCESSOR_H
12 #define GO_WEB_SCAN_CAL_PROCESSOR_H
13 
21 
22 kBeginHeader()
23 
24 /**
25 * @class GoWebScanCalProcessor
26 * @extends kObject
27 * @ingroup GoWebScanSdk-Calibration
28 * @brief Represents an algorithm for processing system tiles containing a calibration bar
29 * and generating the calibration containing profile Z and Y offsets and vision Y
30 * offsets and gains. Refer to GoWebScanCal for a description of the system
31 * calibration outputs and usage.
32 *
33 * Internally, GoWebScanCalProcessor delegates the processing of offsets and gains
34 * for each node to the GoWebScanCalProcessorNode class. After each node has been
35 * processed, GoWebScanCalProcessor adjusts the profile and vision Y offsets per
36 * node based on the overall system Y bias (per plane). If
37 * GoWebScanConfig_CalDetectLocators() is enabled, the class also calculates the X
38 * bias per plane and adjusts the node X offsets. If
39 * GoWebScanConfig_CalUseVisionIntensity() is not enabled, the class also calculates
40 * the vision gain bias per channel and adjusts the node gains.
41 *
42 * At the end of processing, a GoWebScanCal object is constructed and returned
43 * containing the offsets, gains, and other calibration properties.
44 *
45 * Refer to GoWebScanCalProcessorNode for a detailed explaination of the calibration
46 * processing sequence.
47 * @see GoWebScanCal, GoWebScanCalProcessorNode, GoWebScanConfig_CalDetectLocators,
48 * GoWebScanConfig_CalUseVisionIntensity
49 */
51 
52 /**
53  * Constructs a GoWebScanCalProcessor object.
54  *
55  * @public @memberof GoWebScanCalProcessor
56  * @param processor Receives the constructed GoWebScanCalProcessor object.
57  * @param config System configuration.
58  * @param allocator Memory allocator (or kNULL for default).
59  * @return Operation status.
60  */
61 GoWebScanFx(kStatus) GoWebScanCalProcessor_Construct(GoWebScanCalProcessor* processor, GoWebScanConfig config, kAlloc allocator);
62 
63 /**
64  * Executes the system calibration processing on an input dataset (consisting of
65  * Y-matched tile containing the calibration bar) and constructs and outputs
66  * the calibration object. Refer to GoWebScanCal for a description of the system
67  * calibration outputs and usage.
68  *
69  * @public @memberof GoWebScanCalProcessor
70  * @param processor GoWebScanCalProcessor object.
71  * @param input Calibration input dataset.
72  * @param calibration Receives the constructed GoWebScanCal object.
73  * @return Operation status.
74  * @see GoWebScanCal, GoWebScanCalProcessorNode
75  */
76 GoWebScanFx(kStatus) GoWebScanCalProcessor_Execute(GoWebScanCalProcessor processor, GoWebScanCalInput input, GoWebScanCal* calibration);
77 
78 /**
79  * Gets a flag for whether the processing of profile data had any warnings. Warnings
80 * mean the calibration completed but may be suboptimal.
81  *
82  * @public @memberof GoWebScanCalProcessor
83  * @param processor GoWebScanCalProcessor object.
84  * @return Boolean for whether profile calibration processing had warnings.
85  */
86 GoWebScanFx(kBool) GoWebScanCalProcessor_ProfileHasWarnings(GoWebScanCalProcessor processor);
87 
88 /**
89 * Gets a flag for whether the processing of vision data had any warnings. Warnings
90 * mean the calibration completed but may be suboptimal.
91 *
92 * @public @memberof GoWebScanCalProcessor
93 * @param processor GoWebScanCalProcessor object.
94 * @return Boolean for whether vision calibration processing had warnings.
95 */
96 GoWebScanFx(kBool) GoWebScanCalProcessor_VisionHasWarnings(GoWebScanCalProcessor processor);
97 
98 /**
99 * Gets a flag for whether the processing of profile data had any errors. Errors mean all
100 * or some aspects of the processing were not able to proceed and the generated
101 * calibration file may be incomplete.
102 *
103 * @public @memberof GoWebScanCalProcessor
104 * @param processor GoWebScanCalProcessor object.
105 * @return Boolean for whether profile calibration processing had errors.
106 */
107 GoWebScanFx(kBool) GoWebScanCalProcessor_ProfileHasErrors(GoWebScanCalProcessor processor);
108 
109 /**
110 * Gets a flag for whether the processing of vision data had any errors. Errors mean all
111 * or some aspects of the processing were not able to proceed and the generated
112 * calibration file may be incomplete.
113 *
114 * @public @memberof GoWebScanCalProcessor
115 * @param processor GoWebScanCalProcessor object.
116 * @return Boolean for whether vision calibration processing had errors.
117 */
118 GoWebScanFx(kBool) GoWebScanCalProcessor_VisionHasErrors(GoWebScanCalProcessor processor);
119 
120 kEndHeader()
121 #include <GoWebScanSdk/GoWebScanCalProcessor.x.h>
122 
123 #endif
Represents an algorithm for processing system tiles containing a calibration bar and generating the c...
Declares a GoWebScanCalInput object.
kStatus GoWebScanCalProcessor_Construct(GoWebScanCalProcessor *processor, GoWebScanConfig config, kAlloc allocator)
Constructs a GoWebScanCalProcessor object.
Essential GoWebScan declarations.
kBool GoWebScanCalProcessor_VisionHasErrors(GoWebScanCalProcessor processor)
Gets a flag for whether the processing of vision data had any errors.
Represents Y-matched system data containing a calibration bar, used for calibration processing...
Declares a GoWebScanCalNode object.
Declares a GoWebScanCalInputNode object.
kStatus GoWebScanCalProcessor_Execute(GoWebScanCalProcessor processor, GoWebScanCalInput input, GoWebScanCal *calibration)
Executes the system calibration processing on an input dataset (consisting of Y-matched tile containi...
Declares a GoWebScanCal object.
kBool GoWebScanCalProcessor_ProfileHasErrors(GoWebScanCalProcessor processor)
Gets a flag for whether the processing of profile data had any errors.
Represents a container for the system calibration. The system calibration corrects for mounting diffe...
kBool GoWebScanCalProcessor_VisionHasWarnings(GoWebScanCalProcessor processor)
Gets a flag for whether the processing of vision data had any warnings.
Declares a GoWebScanConfigGroup object.
Represents a container for system-level parameters which are translated from user parameters set in G...
Declares a GoWebScanConfig object.
kBool GoWebScanCalProcessor_ProfileHasWarnings(GoWebScanCalProcessor processor)
Gets a flag for whether the processing of profile data had any warnings.