|
GoWebScan API
|
Essential GoWebScan declarations.
Go to the source code of this file.
Macros | |
| #define | GO_WEB_SCAN_CAL_GAIN_HEIGHT |
| Height of gain images stored in calibration files. | |
| #define | GO_WEB_SCAN_CAL_GAIN_WIDTH |
| Width of gain images stored in calibration files. | |
| #define | GO_WEB_SCAN_CAL_TILE_Y_EXTENT |
| Tile size for internal calibration calculations. | |
| #define | GO_WEB_SCAN_CAL_TRIGGER_THRESHOLD |
| At least this proportion profile dots must be valid for object detection. | |
| #define | GO_WEB_SCAN_CAL_VISION_Y_OFFSET_COUNT |
| Width of y-offset array stored in calibration files. | |
| #define | GO_WEB_SCAN_CAL_Y_MIN_GAP |
| Minimum gap between successive objects for calibration object detection (mils). | |
| #define | GO_WEB_SCAN_CAMERA_MARGIN |
| Amount of extra camera FOV (beyond nominal FOV) that can be included in results. | |
| #define | GO_WEB_SCAN_CONCURRENCY_DEFAULT |
| Concurrency is not specified in settings.xml. | |
| #define | GO_WEB_SCAN_CONCURRENCY_OPTIMIZE |
| Concurrency should be optimized for the number of CPU cores. | |
| #define | GO_WEB_SCAN_DATA_SOURCE_COUNT |
| Number of data sources. | |
| #define | GO_WEB_SCAN_EXTENSION_WINDOW |
| Maximum number of null range spot data before or after board edge along X axis. | |
| #define | GO_WEB_SCAN_FLATFIELD_RES_BITS |
| Vision flatfield gain fractional bits preserved in integer calculations. | |
| #define | GO_WEB_SCAN_INPUT_ID_COUNT |
| Number of input message IDs. | |
| #define | GO_WEB_SCAN_MAX_SENSOR_DATA_RATE |
| Max sensor output data rate (MB/s). | |
| #define | GO_WEB_SCAN_MAX_SYSTEM_SPEED |
| Maximum supported system speed (mils per second). | |
| #define | GO_WEB_SCAN_MAX_TRACHEID_ANGLE |
| Maximum tracheid angle (degrees). | |
| #define | GO_WEB_SCAN_MIN_OBJECT_GAP |
| Minimum detection mode object gap (mils). | |
| #define | GO_WEB_SCAN_MIN_OBJECT_Y_EXTENT |
| Minimum detection mode object width (mils). | |
| #define | GO_WEB_SCAN_MSG_ID_COUNT |
| Number of message IDs. | |
| #define | GO_WEB_SCAN_NODE_TILE_ID_COUNT |
| Number of tile message IDs. | |
| #define | GO_WEB_SCAN_NULL_TRACHEID_ANGLE |
| Null tracheid angle. | |
| #define | GO_WEB_SCAN_NULL_TRACHEID_AREA |
| Null tracheid area. | |
| #define | GO_WEB_SCAN_NULL_TRACHEID_SCATTER |
| Null tracheid scatter. | |
| #define | GO_WEB_SCAN_PLANE_TILE_ID_COUNT |
| Number of plane tile message IDs. | |
| #define | GO_WEB_SCAN_PROFILE_CAMERA_COUNT |
| Count of profile cameras per sensor. | |
| #define | GO_WEB_SCAN_PROFILE_READOUT_TIME |
| Camera buffer readout time in microseconds. | |
| #define | GO_WEB_SCAN_RATE_LIMIT_SAFETY_FACTOR |
| Safety factor applied to expected data rate in calculating actual limit. | |
| #define | GO_WEB_SCAN_STAGE_COUNT |
| Number of processing stages. | |
| #define | GO_WEB_SCAN_SYNC_BREAK_DISTANCE |
| Drop all data further than this amount from the current position (mils). | |
| #define | GO_WEB_SCAN_SYNC_COHERENCY_DISTANCE |
| Data from different nodes should be at least this far apart before forcing drop (mils). | |
| #define | GO_WEB_SCAN_SYNC_COHERENCY_TIME |
| Data from different nodes should be at least this far apart before forcing drop (microseconds). | |
| #define | GO_WEB_SCAN_SYNC_ID_COUNT |
| Number of sync message IDs. | |
| #define | GO_WEB_SCAN_SYSTEM_PLANE_COUNT |
| Number of system planes. | |
| #define | GO_WEB_SCAN_TASK_BUFFER_TIME |
| Approximate maximum amount of time to buffer data at input to each pipe task. | |
| #define | GO_WEB_SCAN_TRACHEID_AREA_EXPORT_DIV |
| Tracheid area is divided before sending to user application. | |
| #define | GO_WEB_SCAN_TRACHEID_POINT_SET_NULL(X) |
| Sets the GoWebScanTracheidPoint struct to null. | |
| #define | GO_WEB_SCAN_TRACHEID_TO_PROFILE_MULTIPLIER_COMBINED |
| Combined profile/tracheid exposure mode. | |
| #define | GO_WEB_SCAN_TRACHEID_TO_PROFILE_MULTIPLIER_SEPARATE |
| Separate tracheid exposure mode. | |
| #define | GO_WEB_SCAN_TRACHEID_VALUE_SET_NULL(X) |
| Sets the GoWebScanTracheidValue struct to null. | |
| #define | GO_WEB_SCAN_UNASSIGNED_SERIAL_NUMBER |
| Serial number of unassigned node. | |
| #define | GO_WEB_SCAN_VIEW_SPOT_COUNT_G210 |
| Expected width of G210 raw profile messages. | |
| #define | GO_WEB_SCAN_VIEW_SPOT_COUNT_G250 |
| Expected width of G250, G240, and G230 raw profile messages. | |
| #define | GO_WEB_SCAN_VISION_CAMERA_COUNT |
| Count of vision cameras per sensor. | |
| #define | GO_WEB_SCAN_VISION_FRAME_RATE_DIVISOR |
| Profile frame rate should be this value times larger than vision frame rate to prevent interference. | |
| #define | GO_WEB_SCAN_VISION_FRAME_RATE_DIVISOR_SEPARATE_EXPOSURES |
| Vision frame rate divisor for when separate tracheid exposure is enabled. 32 profile periods contain 24 profile messages. | |
| #define | GO_WEB_SCAN_VISION_TERRAIN_TARGET_X_RES |
| Desired X resolution of profile data used for vision resampling (aka terrains) (mils). | |
| #define | GO_WEB_SCAN_X_TILE_LCM |
| Least common multiple for every supported x-resolution. | |
GoWebScanMode | |
| #define | GO_WEB_SCAN_MODE_UNKNOWN |
| Mode of system is unknown. | |
| #define | GO_WEB_SCAN_MODE_CALIBRATION |
| Mode for running and generating system calibration. | |
| #define | GO_WEB_SCAN_MODE_DETECTION |
| Mode for detecting discrete objects. | |
| #define | GO_WEB_SCAN_MODE_WEB |
| Mode for producing uniform resolution tiles. | |
GoWebScanDataSource | |
| #define | GO_WEB_SCAN_DATA_SOURCE_PROFILE |
| Geometric data consisting of X and Z measurements. | |
| #define | GO_WEB_SCAN_DATA_SOURCE_VISION |
| Raw Bayer video images. | |
| #define | GO_WEB_SCAN_DATA_SOURCE_TRACHEID |
| Spot shape information. Consists of scatter (minor to major ratio), angle, and area. | |
GoWebScanDetectionStyle | |
| #define | GO_WEB_SCAN_DETECTION_STYLE_GLOBAL |
| Global detection triggering. | |
| #define | GO_WEB_SCAN_DETECTION_STYLE_LOCAL |
| Local detection triggering. | |
GoWebScanInterpolation | |
| #define | GO_WEB_SCAN_INTERPOLATION_NEAREST |
| Nearest neighbour. | |
| #define | GO_WEB_SCAN_INTERPOLATION_LINEAR |
| Linear interpolation. | |
GoWebScanStage | |
| #define | GO_WEB_SCAN_STAGE_SAMPLE |
| Resampling stage. | |
| #define | GO_WEB_SCAN_STAGE_SYNC |
| Synchronization and matching of resampled tiles. | |
| #define | GO_WEB_SCAN_STAGE_MERGE |
| Merging stage. | |
| #define | GO_WEB_SCAN_STAGE_WEB |
| Web mode output stage. | |
| #define | GO_WEB_SCAN_STAGE_DETECTION |
| Board detection stage. | |
GoWebScanMsgId | |
| #define | GO_WEB_SCAN_MSG_ID_INPUT |
| Message containing raw sensor data. | |
| #define | GO_WEB_SCAN_MSG_ID_NODE_TILE |
| Message containing resampled tiles for a node. | |
| #define | GO_WEB_SCAN_MSG_ID_SYNC_LIST |
| Message containing list of Y-matched tiles for the system. | |
| #define | GO_WEB_SCAN_MSG_ID_PLANE_TILE |
| Message containing resampled and merged tiles for the system. | |
| #define | GO_WEB_SCAN_MSG_ID_WEB_SET |
| Message containing set of plane tiles. | |
| #define | GO_WEB_SCAN_MSG_ID_DETECTION_SET |
| Message containing a detected board. | |
GoWebScanInputId | |
| #define | GO_WEB_SCAN_INPUT_ID_PROFILE |
| Message containing raw profile data. | |
| #define | GO_WEB_SCAN_INPUT_ID_VISION |
| Message containing raw vision data. | |
| #define | GO_WEB_SCAN_INPUT_ID_TRACHEID |
| Message containing raw tracheid data. | |
GoWebScanNodeTileId | |
| #define | GO_WEB_SCAN_NODE_TILE_ID_PRESENCE |
| Message containing presence tiles (used for object detection). | |
| #define | GO_WEB_SCAN_NODE_TILE_ID_PROFILE |
| Message containing profile tiles. | |
| #define | GO_WEB_SCAN_NODE_TILE_ID_TERRAIN |
| Message containing terrain tiles (used for vision resampling). | |
| #define | GO_WEB_SCAN_NODE_TILE_ID_VISION |
| Message containing vision tiles. | |
| #define | GO_WEB_SCAN_NODE_TILE_ID_TRACHEID |
| Message containing tracheid tiles. | |
GoWebScanSyncId | |
| #define | GO_WEB_SCAN_SYNC_ID_PRESENCE |
| Message containing presence list. | |
| #define | GO_WEB_SCAN_SYNC_ID_PROFILE |
| Message containing profile list. | |
| #define | GO_WEB_SCAN_SYNC_ID_VISION |
| Message containing vision list. | |
| #define | GO_WEB_SCAN_SYNC_ID_TRACHEID |
| Message containing tracheid list. | |
GoWebScanPlaneTileId | |
| #define | GO_WEB_SCAN_PLANE_TILE_ID_PRESENCE |
| Message containing presence plane tile. | |
| #define | GO_WEB_SCAN_PLANE_TILE_ID_PROFILE |
| Message containing profile plane tile. | |
| #define | GO_WEB_SCAN_PLANE_TILE_ID_VISION |
| Message containing vision plane tile. | |
| #define | GO_WEB_SCAN_PLANE_TILE_ID_TRACHEID |
| Message containing tracheid plane tile. | |
GoWebScanMsgType | |
| #define | GO_WEB_SCAN_MSG_TYPE_PROFILE_INPUT |
| Message containing raw profile data. | |
| #define | GO_WEB_SCAN_MSG_TYPE_TRACHEID_INPUT |
| Message containing raw tracheid data. | |
| #define | GO_WEB_SCAN_MSG_TYPE_VISION_INPUT |
| Message containing raw vision data. | |
| #define | GO_WEB_SCAN_MSG_TYPE_PROFILE_TILE |
| Message containing profile tiles. | |
| #define | GO_WEB_SCAN_MSG_TYPE_TRACHEID_TILE |
| Message containing tracheid tiles. | |
| #define | GO_WEB_SCAN_MSG_TYPE_VISION_TILE |
| Message containing vision tiles. | |
| #define | GO_WEB_SCAN_MSG_TYPE_TILE_LIST |
| Message containing a list of tiles. | |
| #define | GO_WEB_SCAN_MSG_TYPE_SYSTEM |
| Message containing tiles for the whole system. | |
GoWebScanSystemPlane | |
| #define | GO_WEB_SCAN_SYSTEM_PLANE_TOP |
| Top plane of the system. | |
| #define | GO_WEB_SCAN_SYSTEM_PLANE_BOTTOM |
| Bottom plane of the system. | |
GoWebScanXOrientation | |
| #define | GO_WEB_SCAN_X_ORIENTATION_RIGHT_TO_LEFT |
| Right-to-left orientation. | |
| #define | GO_WEB_SCAN_X_ORIENTATION_LEFT_TO_RIGHT |
| Left-to-right orientation. | |
GoWebScanYOrientation | |
| #define | GO_WEB_SCAN_Y_ORIENTATION_AWAY |
| Orientation where sensor labels are facing away. | |
| #define | GO_WEB_SCAN_Y_ORIENTATION_TOWARD |
| Orientation where sensor labels are facing towards. | |
GoWebScanCalStatus | |
| #define | GO_WEB_SCAN_CAL_STATUS_OK |
| Calibration is successful. | |
| #define | GO_WEB_SCAN_CAL_STATUS_WARNING |
| Generic warning. The results may be marginal. | |
| #define | GO_WEB_SCAN_CAL_STATUS_ERROR |
| Generic error. | |
| #define | GO_WEB_SCAN_CAL_STATUS_ERROR_COLLECTION |
| Data collection error. | |
| #define | GO_WEB_SCAN_CAL_STATUS_ERROR_PROCESSING |
| Data processing error. | |
| #define | GO_WEB_SCAN_CAL_STATUS_ERROR_REPLAY |
| Data replay error. | |
GoWebScanCalActivity | |
| #define | GO_WEB_SCAN_CAL_ACTIVITY_PROFILE |
| Profile calibration. | |
| #define | GO_WEB_SCAN_CAL_ACTIVITY_PROFILE_Y |
| Profile Y-calibration. | |
| #define | GO_WEB_SCAN_CAL_ACTIVITY_PROFILE_Z |
| Profile Z-calibration. | |
| #define | GO_WEB_SCAN_CAL_ACTIVITY_VISION |
| Vision calibration. | |
| #define | GO_WEB_SCAN_CAL_ACTIVITY_VISION_X |
| Vision X-calibration. | |
| #define | GO_WEB_SCAN_CAL_ACTIVITY_VISION_Y |
| Vision Y-calibration. | |
| #define | GO_WEB_SCAN_CAL_ACTIVITY_VISION_GAIN |
| Vision gain calibration. | |
GoWebScanCalNodeStatus | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_WARNING |
| Calibration warning. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_FRAME_LOSS |
| Camera data lost during capture. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_INSUFFICIENT_DATA |
| Insufficient data for processing. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_HIGH_INTENSITY |
| Intensity too high. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_X_COVERAGE |
| Insufficient X coverage. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_ERROR |
| Calibration error. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_PREREQUISITE |
| Calibration not attempted. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_ALGORITHM |
| Algorithm encountered unexpected condition. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_FRAME_LOSS |
| Camera data lost during capture. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_INSUFFICIENT_DATA |
| Insufficient data for processing. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_FEATURE |
| Feature could not be located in data. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_NOISE |
| Noisy data. | |
| #define | GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_LOW_INTENSITY |
| Intensity too low. | |