GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanEdgeFilter.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanEdgeFilter.h
3 * @brief Declares a GoWebScanEdgeFilter object.
4 *
5 * @internal
6 * Copyright (C) 2017-2018 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 
11 #ifndef GO_WEB_SCAN_EDGE_FILTER_H
12 #define GO_WEB_SCAN_EDGE_FILTER_H
13 
15 
16 kBeginHeader()
17 
18 /**
19 * @struct GoWebScanEdgeFilterParams
20 * @extends kValue
21 * @ingroup GoWebScanSdk-Algorithms
22 * @brief Represents parameters of the edge filtering algorithm.
23 */
25 {
26  k32s profileXRes; ///< X-resolution of input profile data (mils/pixel)
27  k32s profileYRes; ///< Y-resolution of input profile data (mils/pixel)
28  k32s visionXRes; ///< X-resolution of input vision data (mils/pixel)
29  k32s visionYRes; ///< Y-resolution of input vision data (mils/pixel)
30  k32s tracheidXRes; ///< X-resolution of input tracheid data (mils/pixel)
31  k32s tracheidYRes; ///< Y-resolution of input tracheid data (mils/pixel)
32 
34 
35 /**
36 * @class GoWebScanEdgeFilter
37 * @extends kObject
38 * @ingroup GoWebScanSdk-Algorithms
39 * @brief Represents an algorithm for filtering spikes and discontinuities along the edges of detected
40 * boards, and for removing the background from vision and tracheid board data.
41 */
43 
44 /**
45 * Constructs a GoWebScanEdgeFilter object.
46 *
47 * @public @memberof GoWebScanEdgeFilter
48 * @param filter Receives the constructed GoWebScanEdgeFilter object.
49 * @param args Edge filter algorithm parameters.
50 * @param allocator Memory allocator (or kNULL for default).
51 * @return Operation status.
52 */
54 
55 /**
56 * Executes the edge filtering algorithm on an array containing Z range data from a detected board.
57 * Discontinuous data (disconnected from the rest of the board) and spikes (optional) are removed
58 * from the edges of the board.
59 *
60 * @public @memberof GoWebScanEdgeFilter
61 * @param filter GoWebScanEdgeFilter object.
62 * @param profile Array containing profile data from a detected board. Type k16s.
63 * @param edgeFilter If enabled, edge spikes are removed.
64 * @return Operation status.
65 */
66 GoWebScanFx(kStatus) GoWebScanEdgeFilter_ExecuteProfile(GoWebScanEdgeFilter filter, kArray2 profile, kBool edgeFilter);
67 
68 /**
69 * Executes the edge filtering algorithm on an array containing vision data from a detected board.
70 * Vision data that does not overlap in X and Y with non-null profile data is removed.
71 *
72 * @public @memberof GoWebScanEdgeFilter
73 * @param filter GoWebScanEdgeFilter object.
74 * @param profile Array containing profile data from a detected board. Type k16s.
75 * @param vision Array containing vision data from a detected board. Type kRgb.
76 * @return Operation status.
77 */
79 
80 /**
81 * Executes the edge filtering algorithm on an array containing tracheid data from a detected board.
82 * Tracheid data that does not overlap in X and Y with non-null profile data is removed.
83 *
84 * @public @memberof GoWebScanEdgeFilter
85 * @param filter GoWebScanEdgeFilter object.
86 * @param profile Array containing profile data from a detected board. Type k16s.
87 * @param tracheid Array containing tracheid data from a detected board. Type GoWebScanTracheidValue.
88 * @return Operation status.
89 */
90 GoWebScanFx(kStatus) GoWebScanEdgeFilter_ExecuteTracheid(GoWebScanEdgeFilter filter, kArray2 profile, kArray2 tracheid);
91 
92 kEndHeader()
93 #include <GoWebScanSdk/GoWebScanEdgeFilter.x.h>
94 
95 #endif
kStatus GoWebScanEdgeFilter_ExecuteVision(GoWebScanEdgeFilter filter, kArray2 profile, kArray2 vision)
Executes the edge filtering algorithm on an array containing vision data from a detected board...
k32s profileXRes
X-resolution of input profile data (mils/pixel)
Definition: GoWebScanEdgeFilter.h:26
Essential GoWebScan declarations.
k32s visionXRes
X-resolution of input vision data (mils/pixel)
Definition: GoWebScanEdgeFilter.h:28
kStatus GoWebScanEdgeFilter_ExecuteProfile(GoWebScanEdgeFilter filter, kArray2 profile, kBool edgeFilter)
Executes the edge filtering algorithm on an array containing Z range data from a detected board...
Represents parameters of the edge filtering algorithm.
Definition: GoWebScanEdgeFilter.h:24
kStatus GoWebScanEdgeFilter_Construct(GoWebScanEdgeFilter *filter, const GoWebScanEdgeFilterParams *args, kAlloc allocator)
Constructs a GoWebScanEdgeFilter object.
kStatus GoWebScanEdgeFilter_ExecuteTracheid(GoWebScanEdgeFilter filter, kArray2 profile, kArray2 tracheid)
Executes the edge filtering algorithm on an array containing tracheid data from a detected board...
k32s tracheidXRes
X-resolution of input tracheid data (mils/pixel)
Definition: GoWebScanEdgeFilter.h:30
k32s tracheidYRes
Y-resolution of input tracheid data (mils/pixel)
Definition: GoWebScanEdgeFilter.h:31
Represents an algorithm for filtering spikes and discontinuities along the edges of detected boards...
k32s visionYRes
Y-resolution of input vision data (mils/pixel)
Definition: GoWebScanEdgeFilter.h:29
k32s profileYRes
Y-resolution of input profile data (mils/pixel)
Definition: GoWebScanEdgeFilter.h:27