GoWebScanCalDetector.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalDetector.h
* @brief   Declares a GoWebScanCalDetector 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_CAL_DETECTOR_H
#define GO_WEB_SCAN_CAL_DETECTOR_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanCalInputTileSet.h>
#include <GoWebScanSdk/GoWebScanConfig.h>

/**
* @struct  GoWebScanCalDetectorState
* @extends kValue
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents states of calibration bar detection state machine.
*
* The following enumerators are defined:
* - #GO_WEB_SCAN_CAL_DETECTOR_STATE_SEARCHING
* - #GO_WEB_SCAN_CAL_DETECTOR_STATE_SCANNING
* - #GO_WEB_SCAN_CAL_DETECTOR_STATE_ENDING
*/
typedef k32s GoWebScanCalDetectorState;
/** @name    GoWebScanCalDetectorState
*@{*/ 
#define     GO_WEB_SCAN_CAL_DETECTOR_STATE_SEARCHING        (0)             ///< Detector is searching for the start of the object.
#define     GO_WEB_SCAN_CAL_DETECTOR_STATE_SCANNING         (1)             ///< Detector has found the object and is scanning.
#define     GO_WEB_SCAN_CAL_DETECTOR_STATE_ENDING           (2)             ///< Detector has found the end of the object.
/**@}*/ 

/**
* @struct  GoWebScanCalDetectorParams
* @extends kValue
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents parameters of the calibration detector algorithm.
*/
typedef struct GoWebScanCalDetectorParams
{
    k32s minTiles;                      ///< Minimum count of tiles needed for detection of the calibration bar.
    k32s maxTiles;                      ///< Maximum count of tiles needed for detection of the calibration bar.
    k32s leadMarginTiles;               ///< Leading edge data capture margin in Y for calibration (mils).
    k32s trailMarginTiles;              ///< Trailing edge data capture margin in Y for calibration (mils).
    k32s minGapTiles;                   ///< Minimum Y-axis gap between successive objects for calibration object detection (mils).
    k64f detectionThreshold;            ///< Minimum number of non-null profile spots for system calibration bar detection.
} GoWebScanCalDetectorParams; 

/**
* @class   GoWebScanCalDetector
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents an algorithm for detecting a calibration bar in Y-matched system tiles of raw sensor 
*          messages. This algorithm is similar to GoWebScanDetector but is designed to run with raw sensor 
*          messages. A simple state machine is used to determine when to emit objects. The detection method 
*          for the calibration bar is global; the number of non-null profile points must exceed the 
*          detection threshold, but no condition of contiguity is imposed.
*/
typedef kObject GoWebScanCalDetector;

/** Defines the signature for the handler for accepting the output dataset. */
typedef kStatus (kCall *GoWebScanCalDetectorDataFunction)(kPointer context, k64s startTile, GoWebScanCalInputTileSet* tilesSets, kSize count);  

/**
 * Constructs a GoWebScanCalDetector object.
 * 
 * @public              @memberof GoWebScanCalDetector
 * @param   detector    Receives the constructed GoWebScanCalDetector object.
 * @param   args        Algorithm parameters.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalDetector_Construct(GoWebScanCalDetector* detector, const GoWebScanCalDetectorParams* args, kAlloc allocator);

/**
* Sets the handler for accepting the output data from the algorithm.
*
* @public                   @memberof GoWebScanCalDetector
* @param  detector          GoWebScanCalDetector object. 
* @param  data              Callback function
* @param  context           Receiver argument for callback.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanCalDetector_SetDataHandler(GoWebScanCalDetector detector, GoWebScanCalDetectorDataFunction data, kPointer context);

/**
 * Adds a set of input tiles to the detector. Each tiles contains Y-matched raw sensor messages.
 * 
 * @public              @memberof GoWebScanCalDetector
 * @param   detector    GoWebScanCalDetector object. 
 * @param   tileSet     Pointer to input tile sets.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalDetector_AddTileSet(GoWebScanCalDetector detector, GoWebScanCalInputTileSet* tileSet);

/**
 * Gets the current state of the detector.
 * 
 * @public              @memberof GoWebScanCalDetector
 * @param   detector    GoWebScanCalDetector object. 
 * @return              Detector state.
 */
GoWebScanFx(GoWebScanCalDetectorState) GoWebScanCalDetector_GetState(GoWebScanCalDetector detector);

/**
 * Clear all data from the detector. 
 *
 * @public              @memberof GoWebScanCalDetector
 * @param   detector    GoWebScanCalDetector object.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalDetector_Clear(GoWebScanCalDetector detector);

#include <GoWebScanSdk/GoWebScanCalDetector.x.h>

#endif