GoWebScanEdgeFilter.h

Go to the documentation of this file.

/**
* @file    GoWebScanEdgeFilter.h
* @brief   Declares a GoWebScanEdgeFilter 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_EDGE_FILTER_H
#define GO_WEB_SCAN_EDGE_FILTER_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @struct  GoWebScanEdgeFilterParams
* @extends kValue
* @ingroup GoWebScanSdk-Algorithms
* @brief   Represents parameters of the edge filtering algorithm.
*/
typedef struct GoWebScanEdgeFilterParams
{
    k32s profileXRes;      ///< X-resolution of input profile data (mils/pixel)
    k32s profileYRes;      ///< Y-resolution of input profile data (mils/pixel)
    k32s visionXRes;       ///< X-resolution of input vision data (mils/pixel)
    k32s visionYRes;       ///< Y-resolution of input vision data (mils/pixel)
    k32s tracheidXRes;     ///< X-resolution of input tracheid data (mils/pixel)
    k32s tracheidYRes;     ///< Y-resolution of input tracheid data (mils/pixel)

} GoWebScanEdgeFilterParams;

/**
* @class   GoWebScanEdgeFilter
* @extends kObject
* @ingroup GoWebScanSdk-Algorithms
* @brief   Represents an algorithm for filtering spikes and discontinuities along the edges of detected
*          boards, and for removing the background from vision and tracheid board data.
*/
typedef kObject GoWebScanEdgeFilter;

/**
* Constructs a GoWebScanEdgeFilter object.
*
* @public                   @memberof GoWebScanEdgeFilter
* @param  filter            Receives the constructed GoWebScanEdgeFilter object. 
* @param  args              Edge filter algorithm parameters.
* @param  allocator         Memory allocator (or kNULL for default). 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanEdgeFilter_Construct(GoWebScanEdgeFilter* filter, const GoWebScanEdgeFilterParams* args, kAlloc allocator);

/**
* Executes the edge filtering algorithm on an array containing Z range data from a detected board.
* Discontinuous data (disconnected from the rest of the board) and spikes (optional) are removed
* from the edges of the board.
*
* @public                   @memberof GoWebScanEdgeFilter
* @param  filter            GoWebScanEdgeFilter object. 
* @param  profile           Array containing profile data from a detected board. Type k16s.
* @param  edgeFilter        If enabled, edge spikes are removed.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanEdgeFilter_ExecuteProfile(GoWebScanEdgeFilter filter, kArray2 profile, kBool edgeFilter);

/**
* Executes the edge filtering algorithm on an array containing vision data from a detected board.
* Vision data that does not overlap in X and Y with non-null profile data is removed.
*
* @public                   @memberof GoWebScanEdgeFilter
* @param  filter            GoWebScanEdgeFilter object. 
* @param  profile           Array containing profile data from a detected board. Type k16s.
* @param  vision            Array containing vision data from a detected board. Type kRgb.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanEdgeFilter_ExecuteVision(GoWebScanEdgeFilter filter, kArray2 profile, kArray2 vision);

/**
* Executes the edge filtering algorithm on an array containing tracheid data from a detected board.
* Tracheid data that does not overlap in X and Y with non-null profile data is removed.
*
* @public                   @memberof GoWebScanEdgeFilter
* @param  filter            GoWebScanEdgeFilter object. 
* @param  profile           Array containing profile data from a detected board. Type k16s.
* @param  tracheid          Array containing tracheid data from a detected board. Type GoWebScanTracheidValue.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanEdgeFilter_ExecuteTracheid(GoWebScanEdgeFilter filter, kArray2 profile, kArray2 tracheid);

#include <GoWebScanSdk/GoWebScanEdgeFilter.x.h>

#endif