GoWebScanConfig.h

Go to the documentation of this file.

/**
* @file    GoWebScanConfig.h
* @brief   Declares a GoWebScanConfig object.
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_CONFIG_H
#define GO_WEB_SCAN_CONFIG_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanSettings.h>
#include <GoWebScanSdk/GoWebScanCal.h>
#include <GoWebScanSdk/GoWebScanCalTarget.h>
#include <GoSdk/GoSdk.h>

/**
* @class   GoWebScanConfig
* @extends kObject
* @ingroup GoWebScanSdk-Config
* @brief   Represents a container for system-level parameters which are translated from user 
*          parameters set in GoWebScanSettings. This class maps the orientation of the system
*          to a standard orientation, performs the X-axis layout of sensors, determines 
*          algorithm parameters based on constants and user parameters, and determines other
*          various system parameters.
*          
*          In standard orientation, the X-axis increases from left to right, the Y-axis
*          increases away from the observer, and the Z-axis increases towards the sensor
*          plane. Each sensor X-axis is aligned to the system X-axis, the sensor Y-axis is 
*          opposite to the system Y-axis, and the sensor Z-axis is opposite to the system Z-axis. 
*          Vision lags profile; vision Y-values are offset by a value derived from the sensors 
*          GoGeoCal file for coarse alignment.
*          
*          X-axis layout consists of using the values in the user settings (GoWebScanSettings),
*          the system calibration (GoWebScanCal), and the sensor's GoGeoCal file to 
*          map the profile, vision, and tracheid data from each node (single camera) into 
*          system X-coordinates. The mapping uses the node's X center (calculated by the 
*          system), node X-offset (from the system calibration), vision X-center (from 
*          GoGeoCal), sensor X-center (provided by the user if GoWebScanSettings_UseXCenters()
*          is enabled or calculated by the system), and the server X-adjustment if using
*          multiple servers.
*          
*          After the X-centres of each node are determined, the start and end boundaries of 
*          each node are determined.  These boundaries define the region in system space in 
*          which the node can make a contribution to the final result. If the user has selected
*          a non-zero overlap amount, then the fields of view of adjacent nodes can overlap by 
*          this amount. The overlapping regions are later blended together. 
*          
*          Algorithm parameters provided by the user in GoWebScanSettings are broken down into 
*          lower level parameters.
*          
*          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.
*/
typedef kObject GoWebScanConfig;

// Forward declarations
typedef kObject GoWebScanConfigGroup;
typedef kObject GoWebScanConfigSensor;
typedef kObject GoWebScanConfigNode;

/**
* @struct  GoWebScanConfigSensorInfo
* @extends kValue
* @ingroup GoWebScanSdk-Config
* @brief   Represents information from each sensor in the system, collected and provided by the
*          user application.
*/
typedef struct GoWebScanConfigSensorInfo
{
    k32u profileId;                             ///< Profile serial number
    kBool enabled;                              ///< Is the sensor enabled?
    k32s nominalFov;                            ///< Full X FOV of sensor (mils)
    kSize viewSpotCount;                        ///< Width of camera profile messages (same as spot count per camera)
    k32s maxZ;                                  ///< Max expected Z data (mils)
    kSize visionWidth;                          ///< Width of vision camera configuration (pixels)
    kSize visionHeight;                         ///< Height of vision camera configuration (pixels)
    k32u profileTransmitLimit;                  ///< Data transmit rate limit of profile sensor (% of link speed)
    k32u visionTransmitLimit;                   ///< Data transmit rate limit of vision sensor (% of link speed)
    GoGeoCal profileGeoCal;                     ///< Profile sensor GoGeoCal file, downloaded from device. Set to kNULL if vision is not used.
    GoGeoCal visionGeoCal;                      ///< Associated vision sensor GoGeoCal file, downloaded from device. Set to kNULL if vision is not used.
} GoWebScanConfigSensorInfo;

/**
 * Constructs a GoWebScanConfig object.
 * 
 * @public              @memberof GoWebScanConfig
 * @param   config      Receives the constructed GoWebScanConfig object.
 * @param   settings    User settings for the system.
 * @param   calTarget   Calibration target information. Set to kNULL if not running system
 *                      calibration.
 * @param   calibration System calibration. Set to kNULL if running system uncalibrated or if
 *                      running system calibration.
 * @param   sensorInfo  List of GoWebScanConfigSensorInfo structs representing information from
 *                      each sensor in the system.
 * @param   mode        System processing mode.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanConfig_Construct(GoWebScanConfig* config, GoWebScanSettings settings, GoWebScanCalTarget calTarget, GoWebScanCal calibration,
                                                kArrayList sensorInfo, GoWebScanMode mode, kAlloc allocator);

/**
 * Gets the number of groups in the system.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Number of groups.
 */
GoWebScanFx(kSSize) GoWebScanConfig_GroupCount(GoWebScanConfig config);

/**
 * Gets the group configuration at a specified index in the system.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   index   Group index.
 * @return          GoWebScanConfigGroup object representing the group config.
 */
GoWebScanFx(GoWebScanConfigGroup) GoWebScanConfig_GroupAt(GoWebScanConfig config, kSSize index);

/**
 * Finds the group configuration for a given system plane.
 * 
 * @public              @memberof GoWebScanConfig
 * @param   config      GoWebScanConfig object.
 * @param   plane       System plane.
 * @param   configGroup Receives the group config object.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanConfig_FindGroupByPlane(GoWebScanConfig config, GoWebScanSystemPlane plane, GoWebScanConfigGroup* configGroup);

/**
 * Gets the number of nodes (cameras) in the system.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Number of nodes.
 */
GoWebScanFx(kSSize) GoWebScanConfig_NodeCount(GoWebScanConfig config);

/**
 * Gets the node configuration at a specified index in the system.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   index   Node index.
 * @return          GoWebScanConfigNode object representing the group config.
 */
GoWebScanFx(GoWebScanConfigNode) GoWebScanConfig_NodeAt(GoWebScanConfig config, kSSize index);

/**
* Gets the number of sensors in the system.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Number of sensors.
*/
GoWebScanFx(kSSize) GoWebScanConfig_SensorCount(GoWebScanConfig config);

/**
* Gets the sensor configuration at a specified index in the system.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @param   index   Sensor index.
* @return          GoWebScanConfigSensor object representing the sensor config.
*/
GoWebScanFx(GoWebScanConfigSensor) GoWebScanConfig_SensorAt(GoWebScanConfig config, kSSize index);

/**
* Gets the number of threads being used by the system.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Number of sensors.
*/
GoWebScanFx(kSSize) GoWebScanConfig_ThreadCount(GoWebScanConfig config);

/**
 * Gets a flag for whether board detection is enabled.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Boolean for whether board detection is enabled.
 */
GoWebScanFx(kBool) GoWebScanConfig_DetectionEnabled(GoWebScanConfig config);

/**
 * Gets a flag for whether data from a particular source is enabled.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   source  Data source.
 * @return          Boolean for whether a source is enabled.
 */
GoWebScanFx(kBool) GoWebScanConfig_SourceEnabled(GoWebScanConfig config, GoWebScanDataSource source);

/**
 * If the encoder simulator is enabled via GoWebScanSettings_SetEncoderSimulated(), this function
 * returns the simulated encoder value formed from an input time and ignores the sensor
 * message's actual encoder value. Otherwise, the sensor message's actual encoder value is
 * returned.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   encoder Encoder value from message stamp.
 * @param   time    Timestamp from message stamp.
 * @return          Encoder value (ticks).
 * @see             GoWebScanEncoderSim
 */
GoWebScanFx(k64s) GoWebScanConfig_DomainToEncoder(GoWebScanConfig config, k64s encoder, k64s time);

/**
 * Converts an encoder value to a Y position in mils using the encoder resolution and system Y
 * offset.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   encoder Encoder value from message stamp (ticks).
 * @return          Y position (mils).
 */
GoWebScanFx(k64s) GoWebScanConfig_EncoderToY(GoWebScanConfig config, k64s encoder);

/**
 * Converts Y position in mils to an encoder value.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   y       Y-axis position (mils).
 * @return          Encoder value.
 */
GoWebScanFx(k64s) GoWebScanConfig_YToEncoder(GoWebScanConfig config, k64s y);

/**
 * Converts a simulated encoder value to a Y position in mils if encoder simulation
 * is enabled, otherwise converts the actual encoder value to a Y position.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   encoder Encoder value from message stamp (ticks).
 * @param   time    Timestamp from message stamp. Simulated encoder value is formed from this.
 * @return          Y position (mils).
 */
GoWebScanFx(k64s) GoWebScanConfig_DomainToY(GoWebScanConfig config, k64s encoder, k64s time);

/**
 * Gets the direction of conveyor movement.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Direction of conveyor movement.
 * @see             GoWebScanSettings_TravelOrientation                 
 */
GoWebScanFx(GoWebScanYOrientation) GoWebScanConfig_TravelOrientation(GoWebScanConfig config);

/**
 * Gets the direction of the X-axis.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          X-axis direction.
 * @see             GoWebScanSettings_XOrientation
 */
GoWebScanFx(GoWebScanXOrientation) GoWebScanConfig_XOrientation(GoWebScanConfig config);

/**
 * Gets the X-resolution of a specified data source in mils/pixel.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   source  Data source.
 * @return          X-resolution (mils/pixel).
 */
GoWebScanFx(k32s) GoWebScanConfig_XRes(GoWebScanConfig config, GoWebScanDataSource source);

/**
* Gets the Y-resolution of a specified data source in mils/pixel.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @param   source  Data source.
* @return          Y-resolution (mils/pixel).
*/
GoWebScanFx(k32s) GoWebScanConfig_YRes(GoWebScanConfig config, GoWebScanDataSource source);

/**
 * Gets the X-resolution for resampling profile data so that it is suitable for the vision
 * resampler. This resampled profile data is referred to as terrain data.
 * 
 * @public          @memberof GoWebScanConfig     
 * @param   config  GoWebScanConfig object.
 * @return          Terrain X-resolution (mils/pixel).
 */
GoWebScanFx(k32s) GoWebScanConfig_VisionTerrainXRes(GoWebScanConfig config);

/**
 * Gets the subsampling factor for determining the X-resolution for terrain data. Terrain 
 * X-resolution is determined by bit shifting the vision X-resolution right by this value.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Terrain X subsampling factor.
 * @see             GoWebScanConfig_VisionTerrainXRes
 */
GoWebScanFx(k32s) GoWebScanConfig_VisionTerrainXSubsampling(GoWebScanConfig config);

/**
 * Gets the Y-extent of all output tiles (mils).
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Y-extent (mils).
 *          
 */
GoWebScanFx(k32s) GoWebScanConfig_TileYExtent(GoWebScanConfig config);

/**
 * Gets the Y-extent of tiles for each data source (pixels).
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   source  Data source.
 * @return          Y-extent (pixels).
 */
GoWebScanFx(kSSize) GoWebScanConfig_TileYPix(GoWebScanConfig config, GoWebScanDataSource source);

/**
 * Gets the maximum data X-gap to be filled in (mils).
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Maximum data x-gap (mils).
 */
GoWebScanFx(k32s) GoWebScanConfig_GapFill(GoWebScanConfig config);

/**
* Gets the amount of X-overlap to be blended (mils).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Amount of X-overlap to be blended (mils).
*/
GoWebScanFx(k32s) GoWebScanConfig_OverlapBlend(GoWebScanConfig config);

/**
* Gets the profile sampling style (linear interpolation or nearest neighbor).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Profile sampling style.
*/
GoWebScanFx(GoWebScanInterpolation) GoWebScanConfig_ProfileInterpolation(GoWebScanConfig config);

/**
* Gets the flag for whether the obstruction filter is enabled. If enabled, obstruction masks
* are applied to input data.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Obstruction filter enabled flag.
*/
GoWebScanFx(kBool) GoWebScanConfig_ObstructionFilter(GoWebScanConfig config);

/**
* Gets the start of the system output space, in system coordinates (mils).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          X start (mils).
*/
GoWebScanFx(k32s) GoWebScanConfig_XStart(GoWebScanConfig config);

/**
* Gets the end of the system output space, in system coordinates (mils).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          X end (mils).
*/
GoWebScanFx(k32s) GoWebScanConfig_XEnd(GoWebScanConfig config);

/**
 * Gets the start of output space for each data source, in system coordinates (pixels).
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   source  Data source.
 * @return          X start (pixels).
 */
GoWebScanFx(kSSize) GoWebScanConfig_XStartPix(GoWebScanConfig config, GoWebScanDataSource source);

/**
* Gets the end of output space for each data source, in system coordinates (pixels).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @param   source  Data source.
* @return          X end (pixels).
*/
GoWebScanFx(kSSize) GoWebScanConfig_XEndPix(GoWebScanConfig config, GoWebScanDataSource source);

/**
* Gets the count of output space for each data source (pixels).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @param   source  Data source.
* @return          X count (pixels).
*/
GoWebScanFx(kSSize) GoWebScanConfig_XCountPix(GoWebScanConfig config, GoWebScanDataSource source);

/**
* Gets the minimum Y-distance between data from different nodes before forcing drop (mils).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Sync coherency distance (mils).
*/
GoWebScanFx(k32s) GoWebScanConfig_SyncCoherencyDistance(GoWebScanConfig config);

/**
* Gets the minimum time between data from different nodes before forcing drop (microseconds).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Sync coherency time (microseconds).
*/
GoWebScanFx(k32s) GoWebScanConfig_SyncCoherencyTime(GoWebScanConfig config);

/**
 * Gets the minimum Y-distance from the current position to drop all data (mils).
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Sync break distance (mils).
 */
GoWebScanFx(k32s) GoWebScanConfig_SyncBreakDistance(GoWebScanConfig config);

/**
* Gets the maximum supported system speed (mils per second).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Max system speed (mils/s).
*/
GoWebScanFx(k64f) GoWebScanConfig_MaxTravelRate(GoWebScanConfig config);

/**
 * Gets the approximate maximum amount of time to buffer data at input to each pipe task
 * (seconds).
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Max buffer time for tasks (s).
 */
GoWebScanFx(k64f) GoWebScanConfig_TaskBufferTime(GoWebScanConfig config);

/**
 * Gets the detection triggering style. 
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Detection triggering style.
 * @see             GoWebScanSettings_SetDetectTriggerStyle               
 */
GoWebScanFx(GoWebScanDetectionStyle) GoWebScanConfig_DetectTriggerStyle(GoWebScanConfig config);

/**
 * Gets the detection triggering threshold.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Detection triggering threshold.
 * @see             GoWebScanSettings_SetDetectTriggerLength                   
 */
GoWebScanFx(kSSize) GoWebScanConfig_DetectTriggerColumns(GoWebScanConfig config);

/**
* Gets the detection Y-margin row count, which are extra data included in output.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Detection margin row count.
*/
GoWebScanFx(kSSize) GoWebScanConfig_DetectMarginRows(GoWebScanConfig config);

/**
* Gets the detection minimum Y-extent (presence pixels)
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Detection minimum rows.
*/
GoWebScanFx(kSSize) GoWebScanConfig_DetectMinRows(GoWebScanConfig config);

/**
* Gets the detection maximum Y-extent, excluding margins (presence pixels).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Detection maximum rows.
*/
GoWebScanFx(kSSize) GoWebScanConfig_DetectMaxRows(GoWebScanConfig config);

/**
* Gets the detection minimum inter-object Y-gap (presence pixels).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Detection minimum Y-gap in rows.
*/
GoWebScanFx(kSSize) GoWebScanConfig_DetectMinGapRows(GoWebScanConfig config);

/**
 * Gets a flag for whether a particular data source be subjected to post-detection data clean-up.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @param   source  Data source.
 * @return          Boolean for whether data source is filtered after detection.
 */
GoWebScanFx(kBool) GoWebScanConfig_DetectFilterSource(GoWebScanConfig config, GoWebScanDataSource source);

/**
 * Gets a flag for whether extending the board side edge to correct for distortions is enabled.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Boolean for whether board side extension is enabled.
 */
GoWebScanFx(kBool) GoWebScanConfig_DetectSideExtensionEnabled(GoWebScanConfig config);

/**
* Gets the detection maximum number of tiles for one detected object.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Detection maximum tiles.
*/
GoWebScanFx(kSSize) GoWebScanConfig_DetectMaxTiles(GoWebScanConfig config);

/**
 * Gets the minimum number of non-null profile dots for system calibration bar detection.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Trigger threshold for calibration bar detection.
 */
GoWebScanFx(k64f) GoWebScanConfig_CalTriggerThreshold(GoWebScanConfig config);

/**
* Gets the tile length in Y-axis for internal system calibration calculations (mils).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Tile Y-extent for calibration (mils).
*/
GoWebScanFx(k32s) GoWebScanConfig_CalTileYExtent(GoWebScanConfig config);

/**
* Gets the leading edge data capture margin in Y for calibration (tiles).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Leading Y edge capture margin (tiles).
*/
GoWebScanFx(k32s) GoWebScanConfig_CalLeadMarginTiles(GoWebScanConfig config);

/**
* Gets the trailing edge data capture margin in Y for calibration (tiles).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Trailing Y edge capture margin (tiles).
*/
GoWebScanFx(k32s) GoWebScanConfig_CalTrailMarginTiles(GoWebScanConfig config);

/**
* Gets the minimum count of tiles needed for detection of the calibration bar.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Minimum count of tiles for calibration detection.
*/
GoWebScanFx(k32s) GoWebScanConfig_CalMinTiles(GoWebScanConfig config);

/**
* Gets the maximum count of tiles needed for detection of the calibration bar.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Maximum count of tiles for calibration detection.
*/
GoWebScanFx(k32s) GoWebScanConfig_CalMaxTiles(GoWebScanConfig config);

/**
* Gets the minimum Y-axis gap between successive objects for calibration object detection (tiles).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Minimum Y-axis gap during calibration detection (tiles).
*/
GoWebScanFx(k32s) GoWebScanConfig_CalMinGapTiles(GoWebScanConfig config);

/**
* Gets the Y-resolution to use when resampling during calibration processing (mils/pixel).
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @param   source  Data source.
* @return          Calibration Y-resolution (mils/pixel).
*/
GoWebScanFx(k32s) GoWebScanConfig_CalYRes(GoWebScanConfig config, GoWebScanDataSource source);

/**
 * Gets a flag for whether GoWebScan should attempt to detect calibration reference holes (1),
 * or assume that sensors are mounted at their nominal locations along the X-axis (0).
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Boolean representing whether detection of locators on calibration bar is enabled.
 */
GoWebScanFx(kBool) GoWebScanConfig_CalDetectLocators(GoWebScanConfig config);

/**
* Gets a flag for whether the use of target intensities for each color channel during vision
* system calibration is enabled.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Boolean for whether target vision intensities are enabled.
*/
GoWebScanFx(kBool) GoWebScanConfig_CalUseVisionIntensity(GoWebScanConfig config);

/**
* Gets the target intensity level for all color channels during vision system calibration.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Target intensity for vision calibration.
*/
GoWebScanFx(kRgb) GoWebScanConfig_CalVisionIntensity(GoWebScanConfig config);

/**
 * Gets the divisor to use when calculating minimum Y-interval for retained data during
 * calibration data collection.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Divisor in Y-axis for retaining data during calibration.
 */
GoWebScanFx(k64f) GoWebScanConfig_CalYIntervalDivisor(GoWebScanConfig config);

/**
 * Gets a flag for whether user-defined obstructions are used instead of automatic chain
 * detection during calibration processing.
 * 
 * @public          @memberof GoWebScanConfig
 * @param   config  GoWebScanConfig object.
 * @return          Boolean for whether user-defined obstructions are used during calibration.
 */
GoWebScanFx(kBool) GoWebScanConfig_CalUseObstructions(GoWebScanConfig config);

/**
* Gets the width of the calibration target (Y-axis extent) in mils.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Calibration bar width (mils).
*/
GoWebScanFx(kSize) GoWebScanConfig_CalTargetFaceYExtent(GoWebScanConfig config);

/**
* Gets the height of the calibration target (Z-axis extent) in mils.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Calibration bar height (mils).
*/
GoWebScanFx(kSize) GoWebScanConfig_CalTargetEdgeZExtent(GoWebScanConfig config);

/**
* Gets the total Y-axis extent of the off-axis calibration target in mils.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Effective Y-axis extent (mils).
*/
GoWebScanFx(k32s) GoWebScanConfig_CalTargetTotalYExtent(GoWebScanConfig config);

/**
* Gets the effective thickness of the off-axis calibration target in mils.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Effective thickness (mils).
*/
GoWebScanFx(k32s) GoWebScanConfig_CalTargetEffectiveThickness(GoWebScanConfig config);

/**
* Gets the system angle in degrees.
* 
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          Angle (degrees).
*/
GoWebScanFx(k64f) GoWebScanConfig_SystemAngle(GoWebScanConfig config);

/**
* Update the system processing mode.
*
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @param   mode    System processing mode.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanConfig_UpdateMode(GoWebScanConfig config, GoWebScanMode mode);

/**
* Gets the system processing mode.
*
* @public          @memberof GoWebScanConfig
* @param   config  GoWebScanConfig object.
* @return          System processing mode.
*/
GoWebScanFx(GoWebScanMode) GoWebScanConfig_Mode(GoWebScanConfig config);

/**
* Update the system calibration.
*
* @public                  @memberof GoWebScanConfig
* @param   config          GoWebScanConfig object.
* @param   calibration     System calibration. Set to kNULL if running system uncalibrated or if running system calibration.
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanConfig_UpdateCalibration(GoWebScanConfig config, GoWebScanCal calibration);

/** 
* Stores the sensor info to a specified path, excluding the GoGeoCal instances.
*
* @public                  @memberof GoWebScanConfig
* @param   sensorInfo      Pointer to the GoWebScanConfigSensorInfo struct representing information of a single profile and vision sensor pair.
* @param   filePath        Path to save to.
* @param   allocator       Memory allocator (or kNULL for default).
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanConfigSensorInfo_Save(const GoWebScanConfigSensorInfo* sensorInfo, const kChar* filePath, kAlloc allocator);

/** 
* Loads the sensor info from a specified path, excluding the GoGeoCal instances.
*
* @public                  @memberof GoWebScanConfig
* @param   sensorInfo      Pointer to the GoWebScanConfigSensorInfo struct representing information of a single profile and vision sensor pair.
* @param   filePath        Path to load from.
* @param   allocator       Memory allocator (or kNULL for default).
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanConfigSensorInfo_Load(GoWebScanConfigSensorInfo* sensorInfo, const kChar* filePath, kAlloc allocator);

/**
 * Determine the sensor node column given the sensor index and bank id.
 *
 * @public                 @memberof GoWebScanConfig
 * @param   config         GoWebScanConfig object.
 * @param   settings       GoWebScanSettings settings.
 * @param   plane          Plane of sensor.
 * @param   sensorIndex    Sensor index.
 * @param   bankId         Node bank id.
 * @param   column         Pointer receiving sensor node column.
 * @return                 Operation status.
 */
GoWebScanFx(kStatus) GoWebScanConfig_NodeIndexToColumn(GoWebScanConfig config, GoWebScanSettings settings, GoWebScanSystemPlane plane, kSize sensorIndex, kSSize bankId, kSSize* column);

/**
 * Determine the sensor index and bank id given the node column.
 *
 * @public                 @memberof GoWebScanConfig
 * @param   config         GoWebScanConfig object.
 * @param   settings       GoWebScanSettings settings.
 * @param   plane          Plane of sensor.
 * @param   column         Node column.
 * @param   sensorIndex    Pointer receiving sensor index.
 * @param   bankId         Pointer receiving node bank id.
 * @return                 Operation status.
 */
GoWebScanFx(kStatus) GoWebScanConfig_NodeColumnToIndex(GoWebScanConfig config, GoWebScanSettings settings, GoWebScanSystemPlane plane, kSSize column, kSize* sensorIndex, kSize* bankId);

#include <GoWebScanSdk/GoWebScanConfig.x.h>

#endif