GoWebScan API
GoWebScanConfigNode Class Reference

Description

Represents a container for node-level parameters which are translated from user parameters set in GoWebScanSettings. This class maps the orientation of the node to a standard orientation, performs the X-axis layout of node, and determines node-specific algorithm parameters. This class is intended to be constructed from within a GoWebScanConfig object.

GoWebScanConfig organizes the configuration at the system, group, sensor, and node levels. Configuration of the groups within the system are represented by the GoWebScanConfigGroup class, sensors by the GoWebScanConfigSensor class, and nodes by the GoWebScanConfigNode class. GoWebScanConfig will construct and own these classes.

Inheritance diagram for GoWebScanConfigNode:
Inheritance graph

Public Member Functions

kSSize GoWebScanConfigNode_BankId (GoWebScanConfigNode node)
 Gets the bank ID of the node (index of the node with respect to the sensor). More...
 
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 array type. More...
 
kSSize GoWebScanConfigNode_Column (GoWebScanConfigNode node)
 Gets the column of the node. More...
 
kStatus GoWebScanConfigNode_Construct (GoWebScanConfigNode *node, kSSize bankId, GoWebScanConfigSensor sensor, GoWebScanSettingsSensor settingsSensor, GoWebScanCal calibration, const GoWebScanConfigSensorInfo *sensorInfo, kAlloc allocator)
 Constructs a GoWebScanConfigNode object. More...
 
k32s GoWebScanConfigNode_EOrientation (GoWebScanConfigNode node)
 Gets the sensor calibration edge-orientation: Normal (1) or opposite (0). More...
 
GoWebScanConfigGroup GoWebScanConfigNode_Group (GoWebScanConfigNode node)
 Gets the configuration of the group that the node is part of. More...
 
k64f GoWebScanConfigNode_InputDataRate (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the approximate input data rate of a data source (bytes per second). More...
 
kSSize GoWebScanConfigNode_LaserDotCount (GoWebScanConfigNode node)
 Gets the number of laser spots of the node. More...
 
k32s GoWebScanConfigNode_MinYStep (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the minimum Y-interval for unique/retained data during calibration data collection (mils) More...
 
k32s GoWebScanConfigNode_NominalFov (GoWebScanConfigNode node)
 Gets the nominal X width of the node (mils). More...
 
k32s GoWebScanConfigNode_NominalXCenter (GoWebScanConfigNode node)
 Gets the nominal X-center of the node in system coordinates (mils). More...
 
k32s GoWebScanConfigNode_OrientationXCenter (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the X-center of a data source in sensor coordinates (mils). More...
 
GoWebScanConfigSensor GoWebScanConfigNode_Parent (GoWebScanConfigNode node)
 Gets the configuration of the sensor that the node is part of. More...
 
GoWebScanSystemPlane GoWebScanConfigNode_Plane (GoWebScanConfigNode node)
 Gets the plane of the group that the node is part of. More...
 
k64s GoWebScanConfigNode_PlaneYOffset (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the Y-offset from laser/tracheid plane to a data source's plane (mils). More...
 
k32s GoWebScanConfigNode_ProfileId (GoWebScanConfigNode node)
 Gets the serial number of the sensor the node is part of. More...
 
k32s GoWebScanConfigNode_ProfileMaxZ (GoWebScanConfigNode node)
 Gets the maximum Z value expected from profile sensors (depends on the sensor's active area) (mils). More...
 
kArray1 GoWebScanConfigNode_ProfileYOffsets (GoWebScanConfigNode node)
 Gets the array of profile Y offsets calculated during system calibration. More...
 
kArray1 GoWebScanConfigNode_ProfileZOffsets (GoWebScanConfigNode node)
 Gets the array of profile Z offsets calculated during system calibration. More...
 
GoWebScanConfig GoWebScanConfigNode_Root (GoWebScanConfigNode node)
 Gets the configuration of the system that the node is part of. More...
 
k64f GoWebScanConfigNode_SampledDataRate (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the approximate sampled data rate of a data source (bytes per travel-mils) More...
 
kArray1 GoWebScanConfigNode_TracheidYOffsets (GoWebScanConfigNode node)
 Gets the array of tracheid Y offsets calculated during system calibration. More...
 
kStatus GoWebScanConfigNode_UpdateCalibration (GoWebScanConfigNode node, GoWebScanCal calibration)
 Update the calibration. More...
 
kSSize GoWebScanConfigNode_VisionCalGainHeight (GoWebScanConfigNode node)
 Gets the height of vision gain images stored in calibration files. More...
 
kSSize GoWebScanConfigNode_VisionCalGainWidth (GoWebScanConfigNode node)
 Gets the width of vision gain images stored in calibration files. More...
 
k32s GoWebScanConfigNode_VisionCalYOffsetCount (GoWebScanConfigNode node)
 Gets the width of vision Y-offset array stored in calibration files. More...
 
k32s GoWebScanConfigNode_VisionGainResBits (GoWebScanConfigNode node)
 Gets the vision flatfield gain fractional bits preserved in integer calculations. More...
 
kArray2 GoWebScanConfigNode_VisionGains (GoWebScanConfigNode node)
 Gets the array of vision Y offsets calculated during system calibration. More...
 
kSSize GoWebScanConfigNode_VisionHeight (GoWebScanConfigNode node)
 Gets the expected height of vision data in pixels. More...
 
k32s GoWebScanConfigNode_VisionId (GoWebScanConfigNode node)
 Gets the serial number of the vision sensor in a profile-vision sensor pair (for systems with vision). More...
 
k32s GoWebScanConfigNode_VisionMaxInputYExtent (GoWebScanConfigNode node)
 Gets the maximum Y-axis extent for vision data in mils. More...
 
k32s GoWebScanConfigNode_VisionMinInputYExtent (GoWebScanConfigNode node)
 Gets the minimum Y-axis extent for vision data in mils. More...
 
kSSize GoWebScanConfigNode_VisionWidth (GoWebScanConfigNode node)
 Gets the expected width of vision data in pixels. More...
 
GoWebScanLinearFunction GoWebScanConfigNode_VisionXResAsZ (GoWebScanConfigNode node)
 Gets the linear function representing the vision X resolution as a function of the Z range. More...
 
kArray1 GoWebScanConfigNode_VisionYOffsets (GoWebScanConfigNode node)
 Gets the array of vision Y offsets calculated during system calibration. More...
 
GoWebScanLinearFunction GoWebScanConfigNode_VisionYResAsZ (GoWebScanConfigNode node)
 Gets the linear function representing the vision Y resolution as a function of the Z range. More...
 
GoWebScanLinearFunction GoWebScanConfigNode_VisionZOffAsR (GoWebScanConfigNode node)
 Gets the linear function representing the vision Z offset as a function of the image row. More...
 
k32s GoWebScanConfigNode_XCenter (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the X-center of a data source in system coordinates (mils). More...
 
kSSize GoWebScanConfigNode_XCountPix (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the X-axis count of resampled data in system coords for a data source. More...
 
kSSize GoWebScanConfigNode_XEndPix (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the X-axis end of resampled data in system coords for a data source (pixels). More...
 
k32s GoWebScanConfigNode_XOrientation (GoWebScanConfigNode node)
 Gets the X-orientation of the node. More...
 
kSSize GoWebScanConfigNode_XStartPix (GoWebScanConfigNode node, GoWebScanDataSource source)
 Gets the X-axis start of resampled data in system coords for a data source (pixels). More...
 
k32s GoWebScanConfigNode_YOrientation (GoWebScanConfigNode node)
 Gets the Y-orientation of the node. More...
 
k32s GoWebScanConfigNode_ZOrientation (GoWebScanConfigNode node)
 Gets the Z-orientation of the node. More...
 

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