GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanConfigNode.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanConfigNode.h
3 * @brief Declares a GoWebScanConfigNode 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_CONFIG_NODE_H
12 #define GO_WEB_SCAN_CONFIG_NODE_H
13 
21 #include <GoSdk/GoSdk.h>
22 
23 kBeginHeader()
24 
25 /**
26 * @class GoWebScanConfigNode
27 * @extends kObject
28 * @ingroup GoWebScanSdk-Config
29 * @brief Represents a container for node-level parameters which are translated from user
30 * parameters set in GoWebScanSettings. This class maps the orientation of the node
31 * to a standard orientation, performs the X-axis layout of node, and determines
32 * node-specific algorithm parameters. This class is intended to be constructed from
33 * within a GoWebScanConfig object.
34 *
35 * GoWebScanConfig organizes the configuration at the system, group, sensor, and node
36 * levels. Configuration of the groups within the system are represented by the
37 * GoWebScanConfigGroup class, sensors by the GoWebScanConfigSensor class, and nodes
38 * by the GoWebScanConfigNode class. GoWebScanConfig will construct and own these
39 * classes.
40 */
42 
43 // Forward declarations
44 typedef kObject GoWebScanConfig;
47 
48 /**
49  * Constructs a GoWebScanConfigNode object.
50  *
51  * @public @memberof GoWebScanConfigNode
52  * @param node Receives the constructed GoWebScanConfigNode object.
53  * @param bankId Bank ID of node (index of node with respect to sensor).
54  * @param sensor Configuration of parent sensor.
55  * @param settingsSensor User settings for the sensor.
56  * @param calibration System calibration. Set to kNULL if running system uncalibrated or if
57  * running system calibration.
58  * @param sensorInfo List of GoWebScanConfigSensorInfo structs representing information
59  * from each sensor in the system.
60  * @param allocator Memory allocator (or kNULL for default).
61  * @return Operation status.
62  */
63 GoWebScanFx(kStatus) GoWebScanConfigNode_Construct(GoWebScanConfigNode* node, kSSize bankId, GoWebScanConfigSensor sensor,
64  GoWebScanSettingsSensor settingsSensor, GoWebScanCal calibration, const GoWebScanConfigSensorInfo* sensorInfo, kAlloc allocator);
65 
66 /**
67 * Gets the configuration of the sensor that the node is part of.
68 *
69 * @public @memberof GoWebScanConfigNode
70 * @param node GoWebScanConfigNode object.
71 * @return GoWebScanConfigSensor object representing sensor configuration.
72 */
73 GoWebScanFx(GoWebScanConfigSensor) GoWebScanConfigNode_Parent(GoWebScanConfigNode node);
74 
75 /**
76 * Gets the configuration of the group that the node is part of.
77 *
78 * @public @memberof GoWebScanConfigNode
79 * @param node GoWebScanConfigNode object.
80 * @return GoWebScanConfigGroup object representing group configuration.
81 */
82 GoWebScanFx(GoWebScanConfigGroup) GoWebScanConfigNode_Group(GoWebScanConfigNode node);
83 
84 /**
85 * Gets the configuration of the system that the node is part of.
86 *
87 * @public @memberof GoWebScanConfigNode
88 * @param node GoWebScanConfigNode object.
89 * @return GoWebScanConfig object representing system configuration.
90 */
91 GoWebScanFx(GoWebScanConfig) GoWebScanConfigNode_Root(GoWebScanConfigNode node);
92 
93 /**
94  * Gets the serial number of the sensor the node is part of. In systems with vision sensors,
95  * this is the profile sensor's ID.
96  *
97  * @public @memberof GoWebScanConfigNode
98  * @param node GoWebScanConfigNode object.
99  * @return Profile sensor ID.
100  */
101 GoWebScanFx(k32s) GoWebScanConfigNode_ProfileId(GoWebScanConfigNode node);
102 
103 /**
104 * Gets the serial number of the vision sensor in a profile-vision sensor pair (for systems with
105 * vision). For systems without vision, this will return GO_WEB_SCAN_UNASSIGNED_SERIAL_NUMBER.
106 *
107 * @public @memberof GoWebScanConfigNode
108 * @param node GoWebScanConfigNode object.
109 * @return Vision sensor ID.
110 */
111 GoWebScanFx(k32s) GoWebScanConfigNode_VisionId(GoWebScanConfigNode node);
112 
113 /**
114  * Gets the bank ID of the node (index of the node with respect to the sensor).
115  *
116  * @public @memberof GoWebScanConfigNode
117  * @param node GoWebScanConfigNode object.
118  * @return Bank ID.
119  */
120 GoWebScanFx(kSSize) GoWebScanConfigNode_BankId(GoWebScanConfigNode node);
121 
122 /**
123  * Gets the plane of the group that the node is part of.
124  *
125  * @public @memberof GoWebScanConfigNode
126  * @param node GoWebScanConfigNode object.
127  * @return Plane of node.
128  */
129 GoWebScanFx(GoWebScanSystemPlane) GoWebScanConfigNode_Plane(GoWebScanConfigNode node);
130 
131 /**
132  * Gets the column of the node. The columns increase left-to-right or right-to-left based on the
133  * X orientation.
134  *
135  * @public @memberof GoWebScanConfigNode
136  * @param node GoWebScanConfigNode object.
137  * @return Column of node.
138  */
139 GoWebScanFx(kSSize) GoWebScanConfigNode_Column(GoWebScanConfigNode node);
140 
141 /**
142  * Gets the number of laser spots of the node.
143  *
144  * @public @memberof GoWebScanConfigNode
145  * @param node GoWebScanConfigNode object.
146  * @return Number of laser spots.
147  */
148 GoWebScanFx(kSSize) GoWebScanConfigNode_LaserDotCount(GoWebScanConfigNode node);
149 
150 /**
151 * Gets the nominal X width of the node (mils).
152 *
153 * @public @memberof GoWebScanConfigNode
154 * @param node GoWebScanConfigNode object.
155 * @return X width of node (mils).
156 */
157 GoWebScanFx(k32s) GoWebScanConfigNode_NominalFov(GoWebScanConfigNode node);
158 
159 /**
160 * Gets the maximum Z value expected from profile sensors (depends on the
161 * sensor's active area) (mils).
162 *
163 * @public @memberof GoWebScanConfigNode
164 * @param node GoWebScanConfigNode object.
165 * @return Max Z (mils).
166 */
167 GoWebScanFx(k32s) GoWebScanConfigNode_ProfileMaxZ(GoWebScanConfigNode node);
168 
169 /**
170 * Gets the vision flatfield gain fractional bits preserved in integer calculations
171 *
172 * @public @memberof GoWebScanConfigNode
173 * @param node GoWebScanConfigNode object.
174 * @return Gain resolution bits.
175 */
176 GoWebScanFx(k32s) GoWebScanConfigNode_VisionGainResBits(GoWebScanConfigNode node);
177 
178 /**
179  * Gets the expected width of vision data in pixels.
180  *
181  * @public @memberof GoWebScanConfigNode
182  * @param node GoWebScanConfigNode object.
183  * @return Vision data width (pixels).
184  */
185 GoWebScanFx(kSSize) GoWebScanConfigNode_VisionWidth(GoWebScanConfigNode node);
186 
187 /**
188 * Gets the expected height of vision data in pixels.
189 *
190 * @public @memberof GoWebScanConfigNode
191 * @param node GoWebScanConfigNode object.
192 * @return Vision data height (pixels).
193 */
194 GoWebScanFx(kSSize) GoWebScanConfigNode_VisionHeight(GoWebScanConfigNode node);
195 
196 /**
197  * Gets the linear function representing the vision X resolution as a function of the Z range.
198  * These coefficients are read from the sensor's GoGeoCal file.
199  *
200  * @public @memberof GoWebScanConfigNode
201  * @param node GoWebScanConfigNode object.
202  * @return XRes(z) linear fit coefficients.
203  */
204 GoWebScanFx(GoWebScanLinearFunction) GoWebScanConfigNode_VisionXResAsZ(GoWebScanConfigNode node);
205 
206 /**
207 * Gets the linear function representing the vision Y resolution as a function of the Z range.
208 * These coefficients are read from the sensor's GoGeoCal file.
209 *
210 * @public @memberof GoWebScanConfigNode
211 * @param node GoWebScanConfigNode object.
212 * @return YRes(z) linear fit coefficients.
213 */
214 GoWebScanFx(GoWebScanLinearFunction) GoWebScanConfigNode_VisionYResAsZ(GoWebScanConfigNode node);
215 
216 /**
217  * Gets the maximum Y-axis extent for vision data in mils. Calculates the extent using the
218  * vision Y resolution, the expected maximum Z range for the profile-vision pair, and the
219  * expected vision height.
220  *
221  * @public @memberof GoWebScanConfigNode
222  * @param node GoWebScanConfigNode object.
223  * @return Maximum Y-axis extent (mils).
224  */
225 GoWebScanFx(k32s) GoWebScanConfigNode_VisionMaxInputYExtent(GoWebScanConfigNode node);
226 
227 /**
228 * Gets the minimum Y-axis extent for vision data in mils. Calculates the extent using the
229 * vision Y resolution, the expected minimum Z range for the profile-vision pair, and the
230 * expected vision height.
231 *
232 * @public @memberof GoWebScanConfigNode
233 * @param node GoWebScanConfigNode object.
234 * @return Maximum Y-axis extent (mils).
235 */
236 GoWebScanFx(k32s) GoWebScanConfigNode_VisionMinInputYExtent(GoWebScanConfigNode node);
237 
238 /**
239  * Maps the RGB target intensities (for flatfield calibration) to a Bayer cell given the color
240  * filter array type.
241  *
242  * @public @memberof GoWebScanConfigNode
243  * @param node GoWebScanConfigNode object.
244  * @param targets Pointer to buffer representing Bayer cell.
245  * @param channelCount Number of color channels in Bayer cell.
246  * @param cfa Color filter array type of vision data.
247  * @return Operation status.
248  */
249 GoWebScanFx(kStatus) GoWebScanConfigNode_CalTargetVisionIntensity(GoWebScanConfigNode node, k32s* targets, kSize channelCount, kCfa cfa);
250 
251 /**
252  * Gets the width of vision gain images stored in calibration files.
253  *
254  * @public @memberof GoWebScanConfigNode
255  * @param node GoWebScanConfigNode object.
256  * @return Width of gain images.
257  */
258 GoWebScanFx(kSSize) GoWebScanConfigNode_VisionCalGainWidth(GoWebScanConfigNode node);
259 
260 /**
261 * Gets the height of vision gain images stored in calibration files.
262 *
263 * @public @memberof GoWebScanConfigNode
264 * @param node GoWebScanConfigNode object.
265 * @return Height of gain images.
266 */
267 GoWebScanFx(kSSize) GoWebScanConfigNode_VisionCalGainHeight(GoWebScanConfigNode node);
268 
269 /**
270 * Gets the width of vision Y-offset array stored in calibration files.
271 *
272 * @public @memberof GoWebScanConfigNode
273 * @param node GoWebScanConfigNode object.
274 * @return Width of vision Y-offset array.
275 */
276 GoWebScanFx(k32s) GoWebScanConfigNode_VisionCalYOffsetCount(GoWebScanConfigNode node);
277 
278 /**
279 * Gets the X-orientation of the node. Normal (1) or opposite (0). Normal is defined as node
280 * X-axis aligned to the system X-axis in standard orientation (Refer to GoWebScanConfig for
281 * a description of standard orientation).
282 *
283 * @public @memberof GoWebScanConfigNode
284 * @param node GoWebScanConfigNode object.
285 * @return Node X-orientation.
286 * @see GoWebScanConfig
287 */
288 GoWebScanFx(k32s) GoWebScanConfigNode_XOrientation(GoWebScanConfigNode node);
289 
290 /**
291 * Gets the Y-orientation of the node. Normal (1) or opposite (0). Normal is defined as node
292 * Y-axis opposite to the system Y-axis in standard orientation (Refer to GoWebScanConfig for
293 * a description of standard orientation).
294 *
295 * @public @memberof GoWebScanConfigNode
296 * @param node GoWebScanConfigNode object.
297 * @return Node Y-orientation.
298 * @see GoWebScanConfig
299 */
300 GoWebScanFx(k32s) GoWebScanConfigNode_YOrientation(GoWebScanConfigNode node);
301 
302 /**
303 * Gets the Z-orientation of the node. Normal (1) or opposite (0). Normal is defined as node
304 * Z-axis opposite to the system Z-axis in standard orientation (Refer to GoWebScanConfig for
305 * a description of standard orientation).
306 *
307 * @public @memberof GoWebScanConfigNode
308 * @param node GoWebScanConfigNode object.
309 * @return Node Z-orientation.
310 * @see GoWebScanConfig
311 */
312 GoWebScanFx(k32s) GoWebScanConfigNode_ZOrientation(GoWebScanConfigNode node);
313 
314 /**
315 * Gets the sensor calibration edge-orientation: Normal (1) or opposite (0).
316 *
317 * @public @memberof GoWebScanConfigNode
318 * @param node GoWebScanConfigNode object.
319 * @return Node calibration edge orientation.
320 */
321 GoWebScanFx(k32s) GoWebScanConfigNode_EOrientation(GoWebScanConfigNode node);
322 
323 /**
324  * Gets the X-center of a data source in sensor coordinates (mils).
325  *
326  * @public @memberof GoWebScanConfigNode
327  * @param node GoWebScanConfigNode object.
328  * @param source Data source.
329  * @return X-center (mils).
330  */
331 GoWebScanFx(k32s) GoWebScanConfigNode_OrientationXCenter(GoWebScanConfigNode node, GoWebScanDataSource source);
332 
333 /**
334 * Gets the nominal X-center of the node in system coordinates (mils).
335 *
336 * @public @memberof GoWebScanConfigNode
337 * @param node GoWebScanConfigNode object.
338 * @return X-center (mils).
339 */
340 GoWebScanFx(k32s) GoWebScanConfigNode_NominalXCenter(GoWebScanConfigNode node);
341 
342 /**
343 * Gets the X-center of a data source in system coordinates (mils).
344 *
345 * @public @memberof GoWebScanConfigNode
346 * @param node GoWebScanConfigNode object.
347 * @param source Data source.
348 * @return X-center of data source (mils).
349 */
350 GoWebScanFx(k32s) GoWebScanConfigNode_XCenter(GoWebScanConfigNode node, GoWebScanDataSource source);
351 
352 /**
353 * Gets the X-axis start of resampled data in system coords for a data source (pixels).
354 *
355 * @public @memberof GoWebScanConfigNode
356 * @param node GoWebScanConfigNode object.
357 * @param source Data source.
358 * @return X-axis start of resampled data (pixels).
359 */
360 GoWebScanFx(kSSize) GoWebScanConfigNode_XStartPix(GoWebScanConfigNode node, GoWebScanDataSource source);
361 
362 /**
363 * Gets the X-axis end of resampled data in system coords for a data source (pixels).
364 *
365 * @public @memberof GoWebScanConfigNode
366 * @param node GoWebScanConfigNode object.
367 * @param source Data source.
368 * @return X-axis end of resampled data (pixels).
369 */
370 GoWebScanFx(kSSize) GoWebScanConfigNode_XEndPix(GoWebScanConfigNode node, GoWebScanDataSource source);
371 
372 /**
373 * Gets the X-axis count of resampled data in system coords for a data source.
374 *
375 * @public @memberof GoWebScanConfigNode
376 * @param node GoWebScanConfigNode object.
377 * @param source Data source.
378 * @return X-axis count of resampled data.
379 */
380 GoWebScanFx(kSSize) GoWebScanConfigNode_XCountPix(GoWebScanConfigNode node, GoWebScanDataSource source);
381 
382 /**
383 * Gets the approximate input data rate of a data source (bytes per second).
384 *
385 * @public @memberof GoWebScanConfigNode
386 * @param node GoWebScanConfigNode object.
387 * @param source Data source.
388 * @return Input data rate (bytes per second).
389 */
390 GoWebScanFx(k64f) GoWebScanConfigNode_InputDataRate(GoWebScanConfigNode node, GoWebScanDataSource source);
391 
392 /**
393 * Gets the approximate sampled data rate of a data source (bytes per travel-mils)
394 *
395 * @public @memberof GoWebScanConfigNode
396 * @param node GoWebScanConfigNode object.
397 * @param source Data source.
398 * @return Sampled data rate (bytes per travel-mils).
399 */
400 GoWebScanFx(k64f) GoWebScanConfigNode_SampledDataRate(GoWebScanConfigNode node, GoWebScanDataSource source);
401 
402 /**
403 * Gets the Y-offset from laser/tracheid plane to a data source's plane (mils).
404 *
405 * @public @memberof GoWebScanConfigNode
406 * @param node GoWebScanConfigNode object.
407 * @param source Data source.
408 * @return Y-offset (mils).
409 */
410 GoWebScanFx(k64s) GoWebScanConfigNode_PlaneYOffset(GoWebScanConfigNode node, GoWebScanDataSource source);
411 
412 /**
413 * Gets the minimum Y-interval for unique/retained data during calibration data collection (mils)
414 *
415 * @public @memberof GoWebScanConfigNode
416 * @param node GoWebScanConfigNode object.
417 * @param source Data source.
418 * @return Minimum Y-interval (mils).
419 */
420 GoWebScanFx(k32s) GoWebScanConfigNode_MinYStep(GoWebScanConfigNode node, GoWebScanDataSource source);
421 
422 /**
423  * Gets the array of profile Z offsets calculated during system calibration. Offsets are per
424  * laser spot.
425  *
426  * @public @memberof GoWebScanConfigNode
427  * @param node GoWebScanConfigNode object.
428  * @return Z offsets. Type k16s. Size of GoWebScanConfigNode_LaserDotCount().
429  */
430 GoWebScanFx(kArray1) GoWebScanConfigNode_ProfileZOffsets(GoWebScanConfigNode node);
431 
432 /**
433 * Gets the array of profile Y offsets calculated during system calibration. Offsets are per
434 * laser spot.
435 *
436 * @public @memberof GoWebScanConfigNode
437 * @param node GoWebScanConfigNode object.
438 * @return Y offsets. Type k32s. Size of GoWebScanConfigNode_LaserDotCount().
439 */
440 GoWebScanFx(kArray1) GoWebScanConfigNode_ProfileYOffsets(GoWebScanConfigNode node);
441 
442 /**
443  * Gets the array of vision Y offsets calculated during system calibration. Offsets are per
444  * demosaiced vision column.
445  *
446  * @public @memberof GoWebScanConfigNode
447  * @param node GoWebScanConfigNode object.
448  * @return Y offsets. Type k32s. Size of GoWebScanConfigNode_VisionWidth().
449  */
450 GoWebScanFx(kArray1) GoWebScanConfigNode_VisionYOffsets(GoWebScanConfigNode node);
451 
452 /**
453  * Gets the array of vision Y offsets calculated during system calibration. Offsets are per raw
454  * vision pixel.
455  *
456  * @public @memberof GoWebScanConfigNode
457  * @param node GoWebScanConfigNode object.
458  * @return Vision gains. Type k16u. Size of GoWebScanConfigNode_VisionHeight() by
459  * GoWebScanConfigNode_VisionWidth().
460  */
461 GoWebScanFx(kArray2) GoWebScanConfigNode_VisionGains(GoWebScanConfigNode node);
462 
463 /**
464 * Gets the array of tracheid Y offsets calculated during system calibration. Offsets are per
465 * laser spot.
466 *
467 * @public @memberof GoWebScanConfigNode
468 * @param node GoWebScanConfigNode object.
469 * @return Y offsets. Type k32s. Size of GoWebScanConfigNode_LaserDotCount().
470 */
471 GoWebScanFx(kArray1) GoWebScanConfigNode_TracheidYOffsets(GoWebScanConfigNode node);
472 
473 kEndHeader()
474 #include <GoWebScanSdk/GoWebScanConfigNode.x.h>
475 
476 #endif
Represents a container for node-level parameters which are translated from user parameters set in GoW...
kSSize GoWebScanConfigNode_BankId(GoWebScanConfigNode node)
Gets the bank ID of the node (index of the node with respect to the sensor).
Represents coefficients of a linear fit. The fit can be applied as follows: y(x) = c1*x + c0...
Definition: GoWebScanSdkDef.h:509
k64f GoWebScanConfigNode_InputDataRate(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the approximate input data rate of a data source (bytes per second).
GoWebScanLinearFunction GoWebScanConfigNode_VisionXResAsZ(GoWebScanConfigNode node)
Gets the linear function representing the vision X resolution as a function of the Z range...
kSSize GoWebScanConfigNode_VisionCalGainHeight(GoWebScanConfigNode node)
Gets the height of vision gain images stored in calibration files.
k32s GoWebScanConfigNode_VisionMaxInputYExtent(GoWebScanConfigNode node)
Gets the maximum Y-axis extent for vision data in mils.
k32s GoWebScanConfigNode_VisionId(GoWebScanConfigNode node)
Gets the serial number of the vision sensor in a profile-vision sensor pair (for systems with vision)...
kSSize GoWebScanConfigNode_Column(GoWebScanConfigNode node)
Gets the column of the node.
kSSize GoWebScanConfigNode_VisionCalGainWidth(GoWebScanConfigNode node)
Gets the width of vision gain images stored in calibration files.
k32s GoWebScanConfigNode_VisionCalYOffsetCount(GoWebScanConfigNode node)
Gets the width of vision Y-offset array stored in calibration files.
k32s GoWebScanConfigNode_XOrientation(GoWebScanConfigNode node)
Gets the X-orientation of the node.
Represents a type of sensor data.
GoWebScanSystemPlane GoWebScanConfigNode_Plane(GoWebScanConfigNode node)
Gets the plane of the group that the node is part of.
kStatus GoWebScanConfigNode_Construct(GoWebScanConfigNode *node, kSSize bankId, GoWebScanConfigSensor sensor, GoWebScanSettingsSensor settingsSensor, GoWebScanCal calibration, const GoWebScanConfigSensorInfo *sensorInfo, kAlloc allocator)
Constructs a GoWebScanConfigNode object.
Essential GoWebScan declarations.
k64s GoWebScanConfigNode_PlaneYOffset(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the Y-offset from laser/tracheid plane to a data source's plane (mils).
k64f GoWebScanConfigNode_SampledDataRate(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the approximate sampled data rate of a data source (bytes per travel-mils)
Represents information from each sensor in the system, collected and provided by the user application...
Definition: GoWebScanConfig.h:77
k32s GoWebScanConfigNode_EOrientation(GoWebScanConfigNode node)
Gets the sensor calibration edge-orientation: Normal (1) or opposite (0).
kArray1 GoWebScanConfigNode_TracheidYOffsets(GoWebScanConfigNode node)
Gets the array of tracheid Y offsets calculated during system calibration.
k32s GoWebScanConfigNode_NominalFov(GoWebScanConfigNode node)
Gets the nominal X width of the node (mils).
k32s GoWebScanConfigNode_YOrientation(GoWebScanConfigNode node)
Gets the Y-orientation of the node.
kArray1 GoWebScanConfigNode_ProfileZOffsets(GoWebScanConfigNode node)
Gets the array of profile Z offsets calculated during system calibration.
GoWebScanConfigGroup GoWebScanConfigNode_Group(GoWebScanConfigNode node)
Gets the configuration of the group that the node is part of.
Represents a container for sensor-level parameters which are translated from user parameters set in G...
Declares a GoWebScanCalNode object.
kArray1 GoWebScanConfigNode_VisionYOffsets(GoWebScanConfigNode node)
Gets the array of vision Y offsets calculated during system calibration.
Declares a GoWebScanConfigSensor object.
k32s GoWebScanConfigNode_ProfileId(GoWebScanConfigNode node)
Gets the serial number of the sensor the node is part of.
k32s GoWebScanConfigNode_ZOrientation(GoWebScanConfigNode node)
Gets the Z-orientation of the node.
GoWebScanConfig GoWebScanConfigNode_Root(GoWebScanConfigNode node)
Gets the configuration of the system that the node is part of.
GoWebScanConfigSensor GoWebScanConfigNode_Parent(GoWebScanConfigNode node)
Gets the configuration of the sensor that the node is part of.
kStatus GoWebScanConfigNode_CalTargetVisionIntensity(GoWebScanConfigNode node, k32s *targets, kSize channelCount, kCfa cfa)
Maps the RGB target intensities (for flatfield calibration) to a Bayer cell given the color filter ar...
Represents a container for group-level parameters which are translated from user parameters set in Go...
k32s GoWebScanConfigNode_XCenter(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the X-center of a data source in system coordinates (mils).
kSSize GoWebScanConfigNode_XStartPix(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the X-axis start of resampled data in system coords for a data source (pixels).
Declares a GoWebScanCal object.
kArray1 GoWebScanConfigNode_ProfileYOffsets(GoWebScanConfigNode node)
Gets the array of profile Y offsets calculated during system calibration.
k32s GoWebScanConfigNode_VisionMinInputYExtent(GoWebScanConfigNode node)
Gets the minimum Y-axis extent for vision data in mils.
k32s GoWebScanConfigNode_VisionGainResBits(GoWebScanConfigNode node)
Gets the vision flatfield gain fractional bits preserved in integer calculations. ...
k32s GoWebScanConfigNode_MinYStep(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the minimum Y-interval for unique/retained data during calibration data collection (mils) ...
kSSize GoWebScanConfigNode_XEndPix(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the X-axis end of resampled data in system coords for a data source (pixels).
kSSize GoWebScanConfigNode_VisionHeight(GoWebScanConfigNode node)
Gets the expected height of vision data in pixels.
Represents the top or bottom plane of the system.
Declares a GoWebScanProcess object.
kSSize GoWebScanConfigNode_LaserDotCount(GoWebScanConfigNode node)
Gets the number of laser spots of the node.
Represents a container for the system calibration. The system calibration corrects for mounting diffe...
k32s GoWebScanConfigNode_NominalXCenter(GoWebScanConfigNode node)
Gets the nominal X-center of the node in system coordinates (mils).
k32s GoWebScanConfigNode_ProfileMaxZ(GoWebScanConfigNode node)
Gets the maximum Z value expected from profile sensors (depends on the sensor's active area) (mils)...
kArray2 GoWebScanConfigNode_VisionGains(GoWebScanConfigNode node)
Gets the array of vision Y offsets calculated during system calibration.
kSSize GoWebScanConfigNode_XCountPix(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the X-axis count of resampled data in system coords for a data source.
GoWebScanLinearFunction GoWebScanConfigNode_VisionYResAsZ(GoWebScanConfigNode node)
Gets the linear function representing the vision Y resolution as a function of the Z range...
Represents a container for user-configurable settings of a sensor within the system. For systems with vision, a GoWebScanSettingsSensor object represents a pair of vision and profile sensors (sensor mounted together).
Declares a GoWebScanConfigGroup object.
k32s GoWebScanConfigNode_OrientationXCenter(GoWebScanConfigNode node, GoWebScanDataSource source)
Gets the X-center of a data source in sensor coordinates (mils).
Represents a container for system-level parameters which are translated from user parameters set in G...
kSSize GoWebScanConfigNode_VisionWidth(GoWebScanConfigNode node)
Gets the expected width of vision data in pixels.
Declares a GoWebScanConfig object.