GoWebScan API
GoWebScanCalProcessor Class Reference

Description

Represents an algorithm for processing system tiles containing a calibration bar and generating the calibration containing profile Z and Y offsets and vision Y offsets and gains. Refer to GoWebScanCal for a description of the system calibration outputs and usage.

Internally, GoWebScanCalProcessor delegates the processing of offsets and gains for each node to the GoWebScanCalProcessorNode class. After each node has been processed, GoWebScanCalProcessor adjusts the profile and vision Y offsets per node based on the overall system Y bias (per plane). If GoWebScanConfig_CalDetectLocators() is enabled, the class also calculates the X bias per plane and adjusts the node X offsets. If GoWebScanConfig_CalUseVisionIntensity() is not enabled, the class also calculates the vision gain bias per channel and adjusts the node gains.

At the end of processing, a GoWebScanCal object is constructed and returned containing the offsets, gains, and other calibration properties.

Refer to GoWebScanCalProcessorNode for a detailed explanation of the calibration processing sequence.

See also
GoWebScanCal, GoWebScanCalProcessorNode, GoWebScanConfig_CalDetectLocators, GoWebScanConfig_CalUseVisionIntensity
Inheritance diagram for GoWebScanCalProcessor:
Inheritance graph

Public Member Functions

kStatus GoWebScanCalProcessor_Construct (GoWebScanCalProcessor *processor, GoWebScanConfig config, kAlloc allocator)
 Constructs a GoWebScanCalProcessor object. More...
 
kStatus GoWebScanCalProcessor_Execute (GoWebScanCalProcessor processor, GoWebScanCalInput input, GoWebScanCal *calibration)
 Executes the system calibration processing on an input dataset (consisting of Y-matched tile containing the calibration bar) and constructs and outputs the calibration object. More...
 
kSize GoWebScanCalProcessor_NodeCount (GoWebScanCalProcessor processor)
 Gets the number of system calibration processor nodes. More...
 
kBool GoWebScanCalProcessor_ProfileHasErrors (GoWebScanCalProcessor processor)
 Gets a flag for whether the processing of profile data had any errors. More...
 
kBool GoWebScanCalProcessor_ProfileHasWarnings (GoWebScanCalProcessor processor)
 Gets a flag for whether the processing of profile data had any warnings. More...
 
GoWebScanCalProcessorIssue GoWebScanCalProcessor_ProfileIssueAt (GoWebScanCalProcessor processor, kSize nodeIndex, kSize issueIndex)
 Gets the profile issue that occurred during system calibration processing at the specified index. More...
 
kSize GoWebScanCalProcessor_ProfileIssueCount (GoWebScanCalProcessor processor, kSize nodeIndex)
 Gets the number of profile issues that occurred during system calibration processing. More...
 
kStatus GoWebScanCalProcessor_Reset (GoWebScanCalProcessor processor)
 Reset the processor to its original state. More...
 
kBool GoWebScanCalProcessor_VisionHasErrors (GoWebScanCalProcessor processor)
 Gets a flag for whether the processing of vision data had any errors. More...
 
kBool GoWebScanCalProcessor_VisionHasWarnings (GoWebScanCalProcessor processor)
 Gets a flag for whether the processing of vision data had any warnings. More...
 
GoWebScanCalProcessorIssue GoWebScanCalProcessor_VisionIssueAt (GoWebScanCalProcessor processor, kSize nodeIndex, kSize issueIndex)
 Gets the vision issue that occurred during system calibration processing at the specified index. More...
 
kSize GoWebScanCalProcessor_VisionIssueCount (GoWebScanCalProcessor processor, kSize nodeIndex)
 Gets the number of vision issues that occurred during system calibration processing. More...
 

The documentation for this class was generated from the following file: