GoWebScanProfileYResampler.h

Go to the documentation of this file.

/**
* @file    GoWebScanProfileYResampler.h
* @brief   Declares a GoWebScanProfileYResampler 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_PROFILE_Y_RESAMPLER_H
#define GO_WEB_SCAN_PROFILE_Y_RESAMPLER_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @struct  GoWebScanProfileYResamplerParams
* @extends kValue
* @ingroup GoWebScanSdk-Algorithms
* @brief   Represents parameters of the profile Y-resampler algorithm.
*/
typedef struct GoWebScanProfileYResamplerParams
{
    k32s yResolution;                              ///< Expected Y-resolution of resampled output data (mils/pixel)
    k32s fillDistance;                             ///< Maximum distance to nearest input row to fill with valid data (mils)
    k32s breakDistance;                            ///< Profile messages with a Y position greater than this threshold from the current message will be cleared and recycled (mils).
    kSSize pointCount;                             ///< Expected count of input raw profile data.
    kSSize pointFields;                            ///< Size of each profile point in bytes.
} GoWebScanProfileYResamplerParams;

/**
* @class   GoWebScanProfileYResampler
* @extends kObject
* @ingroup GoWebScanSdk-Algorithms
* @brief   Represents an algorithm for resampling raw sensor geometric data in the Y-axis and
*          applying calibration Y-offsets. The algorithm maintains a circular row buffer that covers 
*          enough distance in the Y-axis to account for the difference between the minimum and maximum 
*          calibration Y-offsets.  The Y-resampler considers two input rows at a time, and for each column, 
*          selects the nearest input to fill in cells up to the Y-location of the second input row. 
*/
typedef kObject GoWebScanProfileYResampler;

/** Defines the signature for the handler for accepting the output resampled dataset. */
typedef kStatus(kCall *GoWebScanProfileYResamplerDataFx)(kPointer context, k64s rowIndex, const GoWebScanInputAttr* attributes, const void* points, kSSize pointCount);

/**
* Constructs a GoWebScanProfileYResampler object.
*
* @public                   @memberof GoWebScanProfileYResampler
* @param  resampler         Receives the constructed GoWebScanProfileYResampler object. 
* @param  args              Algorithm parameters.
* @param  offsets           Y-offsets, in mils, for each spot. Calculated during system calibration.
* @param  allocator         Memory allocator (or kNULL for default). 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileYResampler_Construct(GoWebScanProfileYResampler* resampler, const GoWebScanProfileYResamplerParams* args, const k32s* offsets, kAlloc allocator);

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

/**
* Adds a raw sensor profile message to the algorithm's processing queue.
*
* @public                   @memberof GoWebScanProfileYResampler
* @param  resampler         GoWebScanProfileYResampler object. 
* @param  attributes        Attributes of profile message.
* @param  points            Pointer to buffer containing raw sensor profile points. 
* @param  pointCount        Count of profile points.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileYResampler_AddData(GoWebScanProfileYResampler resampler, const GoWebScanInputAttr* attributes, const kPoint16s* points, kSSize pointCount);

/**
* Clears and relinquishes input queue.
*
* @public                   @memberof GoWebScanProfileYResampler
* @param  resampler         GoWebScanProfileYResampler object. 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileYResampler_Clear(GoWebScanProfileYResampler resampler);

#include <GoWebScanSdk/GoWebScanProfileYResampler.x.h>

#endif