GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanCalNode.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanCalNode.h
3 * @brief Declares a GoWebScanCalNode 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_NODE_H
12 #define GO_WEB_SCAN_CAL_NODE_H
13 
15 
16 kBeginHeader()
17 
18 /**
19 * @class GoWebScanCalNode
20 * @extends kObject
21 * @ingroup GoWebScanSdk-Calibration
22 * @brief Represents a container for node-level system calibration data. Refer to GoWebScanCal
23 * for a description of system calibration.
24 * @see GoWebScanCal
25 */
27 
28 // Forward declaration
29 typedef kObject GoWebScanCal;
30 
31 /**
32  * Constructs a GoWebScanCalNode object.
33  *
34  * @public @memberof GoWebScanCalNode
35  * @param node Receives the constructed GoWebScanCalNode object.
36  * @param cal System calibration object that the node is part of.
37  * @param allocator Memory allocator (or kNULL for default).
38  * @return Operation status.
39  */
40 GoWebScanFx(kStatus) GoWebScanCalNode_Construct(GoWebScanCalNode* node, GoWebScanCal cal, kAlloc allocator);
41 
42 /**
43  * Gets the system plane the node is located in.
44  *
45  * @public @memberof GoWebScanCalNode
46  * @param node GoWebScanCalNode object.
47  * @return System plane.
48  */
49 GoWebScanFx(GoWebScanSystemPlane) GoWebScanCalNode_Plane(GoWebScanCalNode node);
50 
51 /**
52 * Gets the column the node is located in.
53 *
54 * @public @memberof GoWebScanCalNode
55 * @param node GoWebScanCalNode object.
56 * @return Column index of node.
57 * @see GoWebScanConfigNode_Column
58 */
59 GoWebScanFx(k32s) GoWebScanCalNode_Column(GoWebScanCalNode node);
60 
61 /**
62 * Gets the sensor ID of the node. For systems with vision sensors, this will be the ID
63 * of the connected profile sensor.
64 *
65 * @public @memberof GoWebScanCalNode
66 * @param node GoWebScanCalNode object.
67 * @return Device ID of node.
68 */
69 GoWebScanFx(k32s) GoWebScanCalNode_DeviceId(GoWebScanCalNode node);
70 
71 /**
72 * Gets the bank ID of the node. This is the index with respect to the sensor.
73 *
74 * @public @memberof GoWebScanCalNode
75 * @param node GoWebScanCalNode object.
76 * @return Bank ID of node.
77 */
78 GoWebScanFx(k32s) GoWebScanCalNode_BankId(GoWebScanCalNode node);
79 
80 /**
81  * Sets the X offset of the node in mils. This is only used when detection of locators is
82  * enabled during vision calibration, otherwise the offset is 0.
83  *
84  * @public @memberof GoWebScanCalNode
85  * @param node GoWebScanCalNode object.
86  * @param xOffset X offset (mils).
87  * @return Operation status.
88  */
89 GoWebScanFx(kStatus) GoWebScanCalNode_SetXOffset(GoWebScanCalNode node, k32s xOffset);
90 
91 /**
92 * Gets the X offset of the node in mils. This is only used when detection of locators is
93 * enabled during vision calibration, otherwise the offset is 0.
94 *
95 * @public @memberof GoWebScanCalNode
96 * @param node GoWebScanCalNode object.
97 * @return X offset (mils).
98 */
99 GoWebScanFx(k32s) GoWebScanCalNode_XOffset(GoWebScanCalNode node);
100 
101 /**
102  * Gets a pointer to the array of profile Y offsets, which represents alignment offsets in Y per
103  * spot.
104  *
105  * @public @memberof GoWebScanCalNode
106  * @param node GoWebScanCalNode object.
107  * @return Pointer to the array of profile Y offsets. Type k32s.
108  */
109 GoWebScanFx(kArray1*) GoWebScanCalNode_ProfileYOffsets(GoWebScanCalNode node);
110 
111 /**
112 * Gets a pointer to the array of profile Z offsets, which represents alignment offsets in Z per
113 * spot.
114 *
115 * @public @memberof GoWebScanCalNode
116 * @param node GoWebScanCalNode object.
117 * @return Pointer to the array of profile Z offsets. Type k16s.
118 */
119 GoWebScanFx(kArray1*) GoWebScanCalNode_ProfileZOffsets(GoWebScanCalNode node);
120 
121 /**
122 * Gets a pointer to the array of vision Y offsets, which represents alignment offsets in Y per
123 * column of the vision image.
124 *
125 * @public @memberof GoWebScanCalNode
126 * @param node GoWebScanCalNode object.
127 * @return Pointer to the array of vision Y offsets. Type k32s.
128 */
129 GoWebScanFx(kArray1*) GoWebScanCalNode_VisionYOffsets(GoWebScanCalNode node);
130 
131 /**
132 * Gets a pointer to the array of vision red gains, which represent correction gains to produce
133 * a balanced white image. Gains are for each pixel of the vision image.
134 *
135 * @public @memberof GoWebScanCalNode
136 * @param node GoWebScanCalNode object.
137 * @return Pointer to the array of vision red gains. Type k64f.
138 */
139 GoWebScanFx(kArray2*) GoWebScanCalNode_VisionRGains(GoWebScanCalNode node);
140 
141 /**
142 * Gets a pointer to the array of vision green gains, which represent correction gains to produce
143 * a balanced white image. Gains are for each pixel of the vision image.
144 *
145 * @public @memberof GoWebScanCalNode
146 * @param node GoWebScanCalNode object.
147 * @return Pointer to the array of vision green gains. Type k64f.
148 */
149 GoWebScanFx(kArray2*) GoWebScanCalNode_VisionGGains(GoWebScanCalNode node);
150 
151 /**
152 * Gets a pointer to the array of vision blue gains, which represent correction gains to produce
153 * a balanced white image. Gains are for each pixel of the vision image.
154 *
155 * @public @memberof GoWebScanCalNode
156 * @param node GoWebScanCalNode object.
157 * @return Pointer to the array of vision blue gains. Type k64f.
158 */
159 GoWebScanFx(kArray2*) GoWebScanCalNode_VisionBGains(GoWebScanCalNode node);
160 
161 /**
162  * Gets the color filter array type of the node (for vision only).
163  *
164  * @public @memberof GoWebScanCalNode
165  * @param node GoWebScanCalNode object.
166  * @return Color filter array type.
167  */
168 GoWebScanFx(kCfa) GoWebScanCalNode_Cfa(GoWebScanCalNode node);
169 
170 /**
171  * Sets the color filter array type of the node (for vision only).
172  *
173  * @public @memberof GoWebScanCalNode
174  * @param node GoWebScanCalNode object.
175  * @param cfa Color filter array type.
176  * @return Operation status.
177  */
178 GoWebScanFx(kStatus) GoWebScanCalNode_SetCfa(GoWebScanCalNode node, kCfa cfa);
179 
180 kEndHeader()
181 #include <GoWebScanSdk/GoWebScanCalNode.x.h>
182 
183 #endif
kCfa GoWebScanCalNode_Cfa(GoWebScanCalNode node)
Gets the color filter array type of the node (for vision only).
kArray2 * GoWebScanCalNode_VisionBGains(GoWebScanCalNode node)
Gets a pointer to the array of vision blue gains, which represent correction gains to produce a balan...
k32s GoWebScanCalNode_BankId(GoWebScanCalNode node)
Gets the bank ID of the node.
k32s GoWebScanCalNode_XOffset(GoWebScanCalNode node)
Gets the X offset of the node in mils.
k32s GoWebScanCalNode_Column(GoWebScanCalNode node)
Gets the column the node is located in.
Essential GoWebScan declarations.
kArray2 * GoWebScanCalNode_VisionRGains(GoWebScanCalNode node)
Gets a pointer to the array of vision red gains, which represent correction gains to produce a balanc...
kStatus GoWebScanCalNode_SetXOffset(GoWebScanCalNode node, k32s xOffset)
Sets the X offset of the node in mils.
kArray2 * GoWebScanCalNode_VisionGGains(GoWebScanCalNode node)
Gets a pointer to the array of vision green gains, which represent correction gains to produce a bala...
k32s GoWebScanCalNode_DeviceId(GoWebScanCalNode node)
Gets the sensor ID of the node.
kStatus GoWebScanCalNode_SetCfa(GoWebScanCalNode node, kCfa cfa)
Sets the color filter array type of the node (for vision only).
Represents a container for node-level system calibration data. Refer to GoWebScanCal for a descriptio...
kStatus GoWebScanCalNode_Construct(GoWebScanCalNode *node, GoWebScanCal cal, kAlloc allocator)
Constructs a GoWebScanCalNode object.
GoWebScanSystemPlane GoWebScanCalNode_Plane(GoWebScanCalNode node)
Gets the system plane the node is located in.
Represents the top or bottom plane of the system.
Represents a container for the system calibration. The system calibration corrects for mounting diffe...
kArray1 * GoWebScanCalNode_ProfileZOffsets(GoWebScanCalNode node)
Gets a pointer to the array of profile Z offsets, which represents alignment offsets in Z per spot...
kArray1 * GoWebScanCalNode_VisionYOffsets(GoWebScanCalNode node)
Gets a pointer to the array of vision Y offsets, which represents alignment offsets in Y per column o...
kArray1 * GoWebScanCalNode_ProfileYOffsets(GoWebScanCalNode node)
Gets a pointer to the array of profile Y offsets, which represents alignment offsets in Y per spot...