GoWebScanSdkDef.h

Go to the documentation of this file.

/**
* @file    GoWebScanSdkDef.h
* @brief   Essential GoWebScan declarations.
*
* @internal
* Copyright (C) 2017-2021 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/
#ifndef GO_WEB_SCAN_SDK_DEF_H
#define GO_WEB_SCAN_SDK_DEF_H

#include <kApi/kApiDef.h>

#if defined (GO_WEB_SCAN_EMIT)
#    define GoWebScanFx(TYPE)   kExportFx(TYPE)            ///< GoWebScanSdk function declaration helper.
#    define GoWebScanCx(TYPE)   kExportCx(TYPE)            ///< GoWebScanSdk dynamic function declaration helper.
#    define GoWebScanDx(TYPE)   kExportDx(TYPE)            ///< GoWebScanSdk data declaration helper.
#elif defined (GO_WEB_SCAN_STATIC)
#    define GoWebScanFx(TYPE)    kInFx(TYPE)
#    define GoWebScanCx(TYPE)    kInCx(TYPE)
#    define GoWebScanDx(TYPE)    kInDx(TYPE)
#else
#    define GoWebScanFx(TYPE)    kImportFx(TYPE)
#    define GoWebScanCx(TYPE)    kImportCx(TYPE)
#    define GoWebScanDx(TYPE)    kImportDx(TYPE)
#endif


#define GO_WEB_SCAN_PROFILE_CAMERA_COUNT                        (2)         ///< Count of profile cameras per sensor.
#define GO_WEB_SCAN_VISION_CAMERA_COUNT                         (2)         ///< Count of vision cameras per sensor.
#define GO_WEB_SCAN_MAX_TRACHEID_ANGLE                          (179)       ///< Maximum tracheid angle (degrees).
#define GO_WEB_SCAN_NULL_TRACHEID_ANGLE                         (k8U_MAX)   ///< Null tracheid angle.
#define GO_WEB_SCAN_NULL_TRACHEID_SCATTER                       (0)         ///< Null tracheid scatter.
#define GO_WEB_SCAN_NULL_TRACHEID_AREA                          (0)         ///< Null tracheid area.
#define GO_WEB_SCAN_TRACHEID_AREA_EXPORT_DIV                    (1.5)       ///< Tracheid area is divided before sending to user application.
#define GO_WEB_SCAN_CONCURRENCY_DEFAULT                         (-2)        ///< Concurrency is not specified in settings.xml.
#define GO_WEB_SCAN_CONCURRENCY_OPTIMIZE                        (-1)        ///< Concurrency should be optimized for the number of CPU cores.
#define GO_WEB_SCAN_VISION_TERRAIN_TARGET_X_RES                 (200)       ///< Desired X resolution of profile data used for vision resampling (aka terrains) (mils).
#define GO_WEB_SCAN_MIN_OBJECT_Y_EXTENT                         (1000)      ///< Minimum detection mode object width (mils).
#define GO_WEB_SCAN_MIN_OBJECT_GAP                              (500)       ///< Minimum detection mode object gap (mils). 
#define GO_WEB_SCAN_TASK_BUFFER_TIME                            (1000000)   ///< Approximate maximum amount of time to buffer data at input to each pipe task. 
#define GO_WEB_SCAN_SYNC_COHERENCY_DISTANCE                     (12000)     ///< Data from different nodes should be at least this far apart before forcing drop (mils). 
#define GO_WEB_SCAN_SYNC_COHERENCY_TIME                         (400000)    ///< Data from different nodes should be at least this far apart before forcing drop (microseconds). 
#define GO_WEB_SCAN_SYNC_BREAK_DISTANCE                         (24000)     ///< Drop all data further than this amount from the current position (mils). 
#define GO_WEB_SCAN_MAX_SYSTEM_SPEED                            (70000)     ///< Maximum supported system speed (mils per second). 
#define GO_WEB_SCAN_EXTENSION_WINDOW                            (2)         ///< Maximum number of null range spot data before or after board edge along X axis.
#define GO_WEB_SCAN_FLATFIELD_RES_BITS                          (10)        ///< Vision flatfield gain fractional bits preserved in integer calculations. 
#define GO_WEB_SCAN_CAMERA_MARGIN                               (2000)      ///< Amount of extra camera FOV (beyond nominal FOV) that can be included in results. 
#define GO_WEB_SCAN_X_TILE_LCM                                  (1000)      ///< Least common multiple for every supported x-resolution. 

#define GO_WEB_SCAN_CAL_GAIN_WIDTH                              (64)        ///< Width of gain images stored in calibration files. 
#define GO_WEB_SCAN_CAL_GAIN_HEIGHT                             (8)         ///< Height of gain images stored in calibration files.  
#define GO_WEB_SCAN_CAL_VISION_Y_OFFSET_COUNT                   (2)         ///< Width of y-offset array stored in calibration files. 
#define GO_WEB_SCAN_CAL_TRIGGER_THRESHOLD                       (0.5)       ///< At least this proportion profile dots must be valid for object detection.
#define GO_WEB_SCAN_CAL_TILE_Y_EXTENT                           (400)       ///< Tile size for internal calibration calculations.
#define GO_WEB_SCAN_CAL_LEAD_Y_MARGIN                           (4000)      ///< Leading edge data capture margin (mils).
#define GO_WEB_SCAN_CAL_TRAIL_Y_MARGIN                          (4000)      ///< Trailing edge data capture margin (mils).
#define GO_WEB_SCAN_CAL_Y_MIN_GAP                               (1000)      ///< Minimum gap between successive objects for calibration object detection (mils).

#define GO_WEB_SCAN_UNASSIGNED_SERIAL_NUMBER                    (-1)        ///< Serial number of unassigned node.

#define GO_WEB_SCAN_TRACHEID_TO_PROFILE_MULTIPLIER_SEPERATE     (3)         ///< Seperate tracheid exposure mode.
#define GO_WEB_SCAN_TRACHEID_TO_PROFILE_MULTIPLIER_COMBINED     (2)         ///< Combined profile/tracheid exposure mode.

#define GO_WEB_SCAN_VISION_FRAME_RATE_DIVISOR                   (24)        ///< 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 (32)       ///< Vision frame rate divisor for when separate tracheid exposure is enabled. 32 profile periods contain 24 profile messages.
/**
* @struct  GoWebScanMode
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a scan mode.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_MODE_UNKNOWN
* - #GO_WEB_SCAN_MODE_CALIBRATION
* - #GO_WEB_SCAN_MODE_DETECTION
* - #GO_WEB_SCAN_MODE_WEB
*/
typedef k32s GoWebScanMode;
/** @name    GoWebScanMode
*@{*/ 
#define GO_WEB_SCAN_MODE_UNKNOWN            (0)              ///< Mode of system is unknown.
#define GO_WEB_SCAN_MODE_CALIBRATION        (1)              ///< Mode for running and generating system calibration.
#define GO_WEB_SCAN_MODE_DETECTION          (2)              ///< Mode for detecting discrete objects.
#define GO_WEB_SCAN_MODE_WEB                (3)              ///< Mode for producing uniform resolution tiles.
/**@}*/ 

/**
* @struct  GoWebScanDataSource
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a type of sensor data.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_DATA_SOURCE_PROFILE
* - #GO_WEB_SCAN_DATA_SOURCE_VISION
* - #GO_WEB_SCAN_DATA_SOURCE_TRACHEID
*/
typedef k32s GoWebScanDataSource;
/** @name    GoWebScanDataSource
*@{*/ 
#define GO_WEB_SCAN_DATA_SOURCE_PROFILE     (0)             ///< Geometric data consisting of X and Z measurements.
#define GO_WEB_SCAN_DATA_SOURCE_VISION      (1)             ///< Raw bayer video images.
#define GO_WEB_SCAN_DATA_SOURCE_TRACHEID    (2)             ///< Spot shape information. Consists of scatter (minor to major ratio), angle, and area.
/**@}*/ 

#define GO_WEB_SCAN_DATA_SOURCE_COUNT       (3)             ///< Number of data sources.

/**
* @struct  GoWebScanDetectionStyle
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a style of triggering the start of an object when in detection mode. 
*          The start of an object is triggered by a minimum number of non-null profiles. The 
*          detection style can either be global, meaning the non-null profiles can be 
*          disconnected, or local, which imposes the condition than the non-null profiles 
*          are contiguous.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_DETECTION_STYLE_GLOBAL
* - #GO_WEB_SCAN_DETECTION_STYLE_LOCAL
*/
typedef k32s GoWebScanDetectionStyle;
/** @name    GoWebScanDetectionStyle
*@{*/ 
#define GO_WEB_SCAN_DETECTION_STYLE_GLOBAL     (0)          ///< Global detection triggering.
#define GO_WEB_SCAN_DETECTION_STYLE_LOCAL      (1)          ///< Local detection triggering.
/**@}*/ 

/**
* @struct  GoWebScanInterpolation
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a style of interpolation used during profile resampling.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_INTERPOLATION_NEAREST
* - #GO_WEB_SCAN_INTERPOLATION_LINEAR  
*/
typedef k32s GoWebScanInterpolation;
/** @name    GoWebScanInterpolation
*@{*/ 
#define GO_WEB_SCAN_INTERPOLATION_NEAREST      (0)         ///< Nearest neighbour.
#define GO_WEB_SCAN_INTERPOLATION_LINEAR       (1)         ///< Linear interpolation.
/**@}*/ 

/**
* @struct  GoWebScanStage
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a stage in the processing pipeline.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_STAGE_SAMPLE
* - #GO_WEB_SCAN_STAGE_SYNC
* - #GO_WEB_SCAN_STAGE_MERGE  
* - #GO_WEB_SCAN_STAGE_WEB  
* - #GO_WEB_SCAN_STAGE_DETECTION
*/
typedef k32s GoWebScanStage;
/** @name    GoWebScanStage
*@{*/ 
#define GO_WEB_SCAN_STAGE_SAMPLE            (0)         ///< Resampling stage.
#define GO_WEB_SCAN_STAGE_SYNC              (1)         ///< Synchronization and matching of resampled tiles.
#define GO_WEB_SCAN_STAGE_MERGE             (2)         ///< Merging stage.
#define GO_WEB_SCAN_STAGE_WEB               (3)         ///< Web mode output stage.
#define GO_WEB_SCAN_STAGE_DETECTION         (4)         ///< Board detection stage.
/**@}*/ 

#define GO_WEB_SCAN_STAGE_COUNT             (5)         ///< Number of processing stages.

/**
* @struct  GoWebScanMsgId
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents an ID for GoWebScan message objects.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_MSG_ID_INPUT
* - #GO_WEB_SCAN_MSG_ID_NODE_TILE
* - #GO_WEB_SCAN_MSG_ID_SYNC_LIST  
* - #GO_WEB_SCAN_MSG_ID_PLANE_TILE  
* - #GO_WEB_SCAN_MSG_ID_WEB_SET  
* - #GO_WEB_SCAN_MSG_ID_DETECTION_SET  
*/
typedef k32s GoWebScanMsgId;
/** @name    GoWebScanMsgId
*@{*/ 
#define GO_WEB_SCAN_MSG_ID_INPUT                (0)         ///< Message containing raw sensor data.
#define GO_WEB_SCAN_MSG_ID_NODE_TILE            (1)         ///< Message containing resampled tiles for a node.
#define GO_WEB_SCAN_MSG_ID_SYNC_LIST            (2)         ///< Message containing list of Y-matched tiles for the system.
#define GO_WEB_SCAN_MSG_ID_PLANE_TILE           (3)         ///< Message containing resampled and merged tiles for the system
#define GO_WEB_SCAN_MSG_ID_WEB_SET              (4)         ///< Message containing set of plane tiles
#define GO_WEB_SCAN_MSG_ID_DETECTION_SET        (5)         ///< Message containing a detected board.
/**@}*/

#define GO_WEB_SCAN_MSG_ID_COUNT                (6)         ///< Number of message IDs.

/**
* @struct  GoWebScanInputId
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents an ID for types of input messages.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_INPUT_ID_PROFILE
* - #GO_WEB_SCAN_INPUT_ID_VISION
* - #GO_WEB_SCAN_INPUT_ID_TRACHEID  
*/
typedef k32s GoWebScanInputId;
/** @name    GoWebScanInputId
*@{*/ 
#define GO_WEB_SCAN_INPUT_ID_PROFILE            (0)         ///< Message containing raw profile data.
#define GO_WEB_SCAN_INPUT_ID_VISION             (1)         ///< Message containing raw vision data.
#define GO_WEB_SCAN_INPUT_ID_TRACHEID           (2)         ///< Message containing raw tracheid data.
/**@}*/

#define GO_WEB_SCAN_INPUT_ID_COUNT              (3)         ///< Number of input message IDs.

/**
* @struct  GoWebScanNodeTileId
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents an ID for types of tile messages.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_NODE_TILE_ID_PRESENCE
* - #GO_WEB_SCAN_NODE_TILE_ID_PROFILE
* - #GO_WEB_SCAN_NODE_TILE_ID_TERRAIN    
* - #GO_WEB_SCAN_NODE_TILE_ID_VISION    
* - #GO_WEB_SCAN_NODE_TILE_ID_TRACHEID  
*/
typedef k32s GoWebScanNodeTileId;
/** @name    GoWebScanNodeTileId  
*@{*/ 
#define GO_WEB_SCAN_NODE_TILE_ID_PRESENCE       (0)         ///< Message containing presence tiles (used for object detection).
#define GO_WEB_SCAN_NODE_TILE_ID_PROFILE        (1)         ///< Message containing profile tiles.
#define GO_WEB_SCAN_NODE_TILE_ID_TERRAIN        (2)         ///< Message containing terrain tiles (used for vision resampling).
#define GO_WEB_SCAN_NODE_TILE_ID_VISION         (3)         ///< Message containing vision tiles.
#define GO_WEB_SCAN_NODE_TILE_ID_TRACHEID       (4)         ///< Message containing tracheid tiles.
/**@}*/

#define GO_WEB_SCAN_NODE_TILE_ID_COUNT          (5)         ///< Number of tile message IDs.

/**
* @struct  GoWebScanSyncId
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents an ID for types of sync list messages.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_SYNC_ID_PRESENCE
* - #GO_WEB_SCAN_SYNC_ID_PROFILE
* - #GO_WEB_SCAN_SYNC_ID_VISION    
* - #GO_WEB_SCAN_SYNC_ID_TRACHEID    
*/
typedef k32s GoWebScanSyncId;
/** @name    GoWebScanSyncId  
*@{*/ 
#define GO_WEB_SCAN_SYNC_ID_PRESENCE            (0)         ///< Message containing presence list.
#define GO_WEB_SCAN_SYNC_ID_PROFILE             (1)         ///< Message containing profile list.
#define GO_WEB_SCAN_SYNC_ID_VISION              (2)         ///< Message containing vision list.
#define GO_WEB_SCAN_SYNC_ID_TRACHEID            (3)         ///< Message containing tracheid list.
/**@}*/

#define GO_WEB_SCAN_SYNC_ID_COUNT               (4)         ///< Number of sync message IDs.

/**
* @struct  GoWebScanPlaneTileId
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents an ID for types of plane tile messages.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_PLANE_TILE_ID_PRESENCE
* - #GO_WEB_SCAN_PLANE_TILE_ID_PROFILE
* - #GO_WEB_SCAN_PLANE_TILE_ID_VISION    
* - #GO_WEB_SCAN_PLANE_TILE_ID_TRACHEID    
*/
typedef k32s GoWebScanPlaneTileId;
/** @name    GoWebScanPlaneTileId  
*@{*/ 
#define GO_WEB_SCAN_PLANE_TILE_ID_PRESENCE      (0)         ///< Message containing presence plane tile.
#define GO_WEB_SCAN_PLANE_TILE_ID_PROFILE       (1)         ///< Message containing profile plane tile.
#define GO_WEB_SCAN_PLANE_TILE_ID_VISION        (2)         ///< Message containing vision plane tile.
#define GO_WEB_SCAN_PLANE_TILE_ID_TRACHEID      (3)         ///< Message containing tracheid plane tile
/**@}*/

#define GO_WEB_SCAN_PLANE_TILE_ID_COUNT         (4)         ///< Number of plane tile message IDs.

/**
* @struct  GoWebScanMsgType
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a type of GoWebScan message.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_MSG_TYPE_PROFILE_INPUT
* - #GO_WEB_SCAN_MSG_TYPE_TRACHEID_INPUT
* - #GO_WEB_SCAN_MSG_TYPE_VISION_INPUT    
* - #GO_WEB_SCAN_MSG_TYPE_PROFILE_TILE      
* - #GO_WEB_SCAN_MSG_TYPE_TRACHEID_TILE        
* - #GO_WEB_SCAN_MSG_TYPE_VISION_TILE        
* - #GO_WEB_SCAN_MSG_TYPE_TILE_LIST        
* - #GO_WEB_SCAN_MSG_TYPE_SYSTEM         
*/
typedef k32s GoWebScanMsgType;
/** @name    GoWebScanMsgType  
*@{*/ 
#define GO_WEB_SCAN_MSG_TYPE_PROFILE_INPUT      (0)         ///< Message containing raw profile data.
#define GO_WEB_SCAN_MSG_TYPE_TRACHEID_INPUT     (1)         ///< Message containing raw tracheid data.
#define GO_WEB_SCAN_MSG_TYPE_VISION_INPUT       (2)         ///< Message containing raw vision data.
#define GO_WEB_SCAN_MSG_TYPE_PROFILE_TILE       (3)         ///< Message containing profile tiles.
#define GO_WEB_SCAN_MSG_TYPE_TRACHEID_TILE      (4)         ///< Message containing tracheid tiles.
#define GO_WEB_SCAN_MSG_TYPE_VISION_TILE        (5)         ///< Message containing vision tiles.
#define GO_WEB_SCAN_MSG_TYPE_TILE_LIST          (6)         ///< Message containing a list of tiles.
#define GO_WEB_SCAN_MSG_TYPE_SYSTEM             (7)         ///< Message containing tiles for the whole system.
/**@}*/

/**
* @struct  GoWebScanSystemPlane
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents the top or bottom plane of the system.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_SYSTEM_PLANE_TOP
* - #GO_WEB_SCAN_SYSTEM_PLANE_BOTTOM  
*/
typedef k32s GoWebScanSystemPlane;
/** @name    GoWebScanSystemPlane  
*@{*/ 
#define GO_WEB_SCAN_SYSTEM_PLANE_TOP            (0)         ///< Top plane of the system.
#define GO_WEB_SCAN_SYSTEM_PLANE_BOTTOM         (1)         ///< Bottom plane of the system.
/**@}*/

#define  GO_WEB_SCAN_SYSTEM_PLANE_COUNT         (2)         ///< Number of system planes.

/**
* @struct  GoWebScanXOrientation
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents the direction of the X orientation. In a left-to-right system 
*          (as viewed from the front), the zero reference is on the left and sensor 
*          indices (defined by the sensor "Name" property) increase left-to-right. 
*          In a right-to-left system, the zero reference is on the right and sensor 
*          indices increase right-to-left.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_X_ORIENTATION_RIGHT_TO_LEFT
* - #GO_WEB_SCAN_X_ORIENTATION_LEFT_TO_RIGHT       
*/
typedef k32s GoWebScanXOrientation;
/** @name    GoWebScanXOrientation  
*@{*/ 
#define GO_WEB_SCAN_X_ORIENTATION_RIGHT_TO_LEFT         (0)         ///< Right-to-left orientation
#define GO_WEB_SCAN_X_ORIENTATION_LEFT_TO_RIGHT         (1)         ///< Left-to-right orientation
/**@}*/

/**
* @struct  GoWebScanYOrientation
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents the Y-orientation of the sensors: Facing Toward (1) or Facing 
*          Away (0). The sensor logo and labels are visible when sensors are facing 
*          toward.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_Y_ORIENTATION_AWAY
* - #GO_WEB_SCAN_Y_ORIENTATION_TOWARD       
*/
typedef k32s GoWebScanYOrientation;
/** @name    GoWebScanYOrientation  
*@{*/ 
#define GO_WEB_SCAN_Y_ORIENTATION_AWAY                  (0)         ///< Orientation where sensor labels are facing away.
#define GO_WEB_SCAN_Y_ORIENTATION_TOWARD                (1)         ///< Orientation where sensor labels are facing towards.
/**@}*/

/**
* @struct  GoWebScanCalStatus
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents the status of calibration processing for the system.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_CAL_STATUS_OK
* - #GO_WEB_SCAN_CAL_STATUS_WARNING
* - #GO_WEB_SCAN_CAL_STATUS_ERROR    
* - #GO_WEB_SCAN_CAL_STATUS_ERROR_COLLECTION      
* - #GO_WEB_SCAN_CAL_STATUS_ERROR_PROCESSING        
* - #GO_WEB_SCAN_CAL_STATUS_ERROR_REPLAY             
*/
typedef k32s GoWebScanCalStatus;
/** @name    GoWebScanCalStatus  
*@{*/
#define GO_WEB_SCAN_CAL_STATUS_OK                       (1)         ///< Calibration is successful.
#define GO_WEB_SCAN_CAL_STATUS_WARNING                  (1000)      ///< Generic warning. The results may be marginal.
#define GO_WEB_SCAN_CAL_STATUS_ERROR                    (2000)      ///< Generic error.
#define GO_WEB_SCAN_CAL_STATUS_ERROR_COLLECTION         (2001)      ///< Data collection error.
#define GO_WEB_SCAN_CAL_STATUS_ERROR_PROCESSING         (2002)      ///< Data processing error.
#define GO_WEB_SCAN_CAL_STATUS_ERROR_REPLAY             (2003)      ///< Data replay error.
/**@}*/

/**
* @struct  GoWebScanCalActivity
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a stage or activity in the system calibration processing
*          pipeline.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_CAL_ACTIVITY_PROFILE
* - #GO_WEB_SCAN_CAL_ACTIVITY_PROFILE_Y
* - #GO_WEB_SCAN_CAL_ACTIVITY_PROFILE_Z    
* - #GO_WEB_SCAN_CAL_ACTIVITY_VISION      
* - #GO_WEB_SCAN_CAL_ACTIVITY_VISION_X        
* - #GO_WEB_SCAN_CAL_ACTIVITY_VISION_Y        
* - #GO_WEB_SCAN_CAL_ACTIVITY_VISION_GAIN             
*/
typedef k32s GoWebScanCalActivity;
/** @name    GoWebScanCalActivity  
*@{*/
#define GO_WEB_SCAN_CAL_ACTIVITY_PROFILE                (0)         ///< Profile calibration.
#define GO_WEB_SCAN_CAL_ACTIVITY_PROFILE_Y              (1)         ///< Profile Y-calibration.
#define GO_WEB_SCAN_CAL_ACTIVITY_PROFILE_Z              (2)         ///< Profile Z-calibration.
#define GO_WEB_SCAN_CAL_ACTIVITY_VISION                 (1000)      ///< Vision calibration.
#define GO_WEB_SCAN_CAL_ACTIVITY_VISION_X               (1001)      ///< Vision X-calibration.
#define GO_WEB_SCAN_CAL_ACTIVITY_VISION_Y               (1002)      ///< Vision Y-calibration.
#define GO_WEB_SCAN_CAL_ACTIVITY_VISION_GAIN            (1003)      ///< Vision gain calibration.
/**@}*/

/**
* @struct  GoWebScanCalNodeStatus
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a type of error or warning that occurred during system
*          calibration processing of a node.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_CAL_NODE_STATUS_WARNING
* - #GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_FRAME_LOSS
* - #GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_INSUFFICIENT_DATA    
* - #GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_INTENSITY      
* - #GO_WEB_SCAN_CAL_NODE_STATUS_ERROR        
* - #GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_PREREQUISITE        
* - #GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_ALGORITHM             
* - #GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_FRAME_LOSS  
* - #GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_INSUFFICIENT_DATA  
* - #GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_FEATURE  
* - #GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_NOISE  
* - #GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_INTENSITY  
*/
typedef k32s GoWebScanCalNodeStatus;
/** @name    GoWebScanCalNodeStatus  
*@{*/
#define GO_WEB_SCAN_CAL_NODE_STATUS_WARNING                    (1000)       ///< Calibration warning.
#define GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_FRAME_LOSS         (1003)       ///< Camera data lost during capture.
#define GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_INSUFFICIENT_DATA  (1004)       ///< Insufficient data for processing.
#define GO_WEB_SCAN_CAL_NODE_STATUS_WARNING_INTENSITY          (1007)       ///< Intensity too high or too low.
#define GO_WEB_SCAN_CAL_NODE_STATUS_ERROR                      (2000)       ///< Calibration error.
#define GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_PREREQUISITE         (2001)       ///< Calibration not attempted.
#define GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_ALGORITHM            (2002)       ///< Algorithm encountered unexpected condition.
#define GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_FRAME_LOSS           (2003)       ///< Camera data lost during capture.
#define GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_INSUFFICIENT_DATA    (2004)       ///< Insufficient data for processing.
#define GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_FEATURE              (2005)       ///< Feature could not be located in data.
#define GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_NOISE                (2006)       ///< Noisy data.
#define GO_WEB_SCAN_CAL_NODE_STATUS_ERROR_INTENSITY            (2007)       ///< Intensity too high or too low.
/**@}*/

/**
* @struct  GoWebScanMsgStamp
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a message stamp containing properties of a message.
*/
typedef struct GoWebScanMsgStamp
{
    k32s id[4];                 ///< Message ID. This ID can be formed from the message source node's position in the system.
    k64s time;                  ///< Message timestamp. In internal units approximating microseconds where the true time in us = timestamp value / 1.024. 
    k64s encoder;               ///< Message encoder value (ticks).
    k64s position;              ///< Message Y-axis position (mils) calculated from encoder value and user-specified encoder resolution.
} GoWebScanMsgStamp;

/**
* @struct  GoWebScanSection
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a section of output system data. This can be defined by the user
*          to allow for routing data to seperate client destinations. 
*/
typedef struct GoWebScanSection
{
    k32s id;                    ///< User-defined identifier for this section.
    GoWebScanDataSource type;   ///< Data type of section.
    k32s x0;                    ///< Start of section along the X-axis (length), in system coordinates (mils).
    k32s x1;                    ///< End of section along the X-axis (length), in system coordinates (mils). Should be greater than X0.
} GoWebScanSection;

/**
* @struct  GoWebScanLinearFunction
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents coefficients of a linear fit. The fit can be applied as follows:
*          y(x) = c1*x + c0.
*/
typedef struct GoWebScanLinearFunction
{
    k64f c0;                   ///< First coefficient of fit.
    k64f c1;                   ///< Second coefficient of fit.
} GoWebScanLinearFunction;

/**
* @struct  GoWebScanInputAttr
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents the attributes of an input GoWebScan message object. These values are
*          copied from the raw sensor message stamp. Refer to GoStamp in GoSdk for more details.
*/
typedef struct GoWebScanInputAttr
{
    k64s time;                  ///< Message timestamp. In internal units approximating microseconds where the true time in us = timestamp value / 1.024. 
    k64s encoder;               ///< Message encoder value (ticks).
    k64s position;              ///< Message Y-axis position (mils) calculated from encoder value and user-specified encoder resolution.
    k64s inputs;                ///< Status of the message. Bit mask containing frame information. Refer to GoStamp.
} GoWebScanInputAttr;

/**
* @struct  GoWebScanTracheidValue
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents integer values of the spot tracheid data. These values are calculated
*          from the spot shape.
*/
typedef struct GoWebScanTracheidValue
{
    k16s angle;                 ///< Angle of the spot (degrees).
    k16s scatter;               ///< Minor to major ratio of the spot, scaled to [0, 255].
    k16s area;                  ///< Area of the spot (pixels).
} GoWebScanTracheidValue;

#define GO_WEB_SCAN_TRACHEID_VALUE_SET_NULL(X)              ((X)->angle = k16S_NULL, (X)->scatter = k16S_NULL, (X)->area = k16S_NULL)       ///< Sets the GoWebScanTracheidValue struct to null.

/**
* @struct  GoWebScanTracheidPoint
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a tracheid point, which is the integer tracheid data for a spot with 
*          the X position (mils) taken from the matching profile data.
*/
typedef struct GoWebScanTracheidPoint
{
    k16s x;                     ///< X range (mils).
    k16s angle;                 ///< Angle of the spot (degrees).
    k16s scatter;               ///< Minor to major ratio of the spot, scaled to [0, 255].
    k16s area;                  ///< Area of the spot (pixels).
} GoWebScanTracheidPoint;

#define GO_WEB_SCAN_TRACHEID_POINT_SET_NULL(X)              ((X)->x = k16S_NULL, (X)->angle = k16S_NULL, (X)->scatter = k16S_NULL, (X)->area = k16S_NULL)       ///< Sets the GoWebScanTracheidPoint struct to null.

/**
* @struct  GoWebScanGenericPoint16s
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a generic 16s point.
*/
typedef struct GoWebScanGenericPoint16s
{
    k16s x;                     ///< Generic X value
} GoWebScanGenericPoint16s;

/**
* @struct  GoWebScanGenericPoint16s
* @extends kValue
* @ingroup GoWebScanSdk
* @brief   Represents a user-defined obstruction to ignore a zone in X and Z in the input 
*          profile data. If there are any objects that regularly appear within the field of 
*          view of the sensors, such as chain runners, the zones in which those objects 
*          appear must be identified before the system will operate correctly in Calibration, 
*          Web, or Detection modes.
*/
typedef struct GoWebScanObstruction
{
    k32s x0;                    ///< Start of obstruction zone along the X-axis (length), in sensor coordinates (mils).
    k32s x1;                    ///< End of obstruction zone along the X-axis (length), in sensor coordinates (mils).
    k32s z0;                    ///< Start of obstruction zone along the z-axis (height), in sensor coordinates (mils).
    k32s z1;                    ///< End of obstruction zone along the z-axis (length), in sensor coordinates (mils).
} GoWebScanObstruction;

#include <GoWebScanSdk/GoWebScanSdkDef.x.h>

#endif