GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanTracheidMergeTask.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanTracheidMergeTask.h
3 * @brief Declares a GoWebScanTracheidMergeTask 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_TRACHEID_MERGE_TASK_H
12 #define GO_WEB_SCAN_TRACHEID_MERGE_TASK_H
13 
18 
19 kBeginHeader()
20 
21 /**
22 * @class GoWebScanTracheidMergeTask
23 * @extends kObject
24 * @ingroup GoWebScanSdk-Control
25 * @brief Represents a task for merging tracheid tiles along X-axis from the cameras in a top
26  or bottom group. Specifically, the task accepts a list of tracheid tiles that
27 * correspond to the same Y-position, and merges them into a single group-wide tile
28 * according to their respective source locations along the X-axis. Gaps and overlaps
29 * between adjacent tiles are processed according to configuration options.
30 * The task accepts GoWebScanTileListMsg objects and produces GoWebScanTracheidTileMsg
31 * objects.
32 *
33 * Processing steps:
34 * -# Clear the background of the output system tile.
35 * -# Add GoWebScanTileListMsg input tiles to the processing queue
36 * -# Blend the overlap between tiles. Overlaps are processed by searcing for the last
37 * valid left element and first valid right element within the overlapping region
38 * between two tiles. If overlap exists, the overlapping elements are blended by
39 * weighted average. The angle requires special handling with respect to overlap
40 * blending because of the circular/continuous nature of angle measurements.
41 * -# Fill gaps between tiles. Gaps are processed by searching for the last valid left
42 * element and first valid right element witin the gap search window. If these
43 * elements are closer than the gap threshold, any null elements in between are
44 * filled in (nearest neighbour).
45 */
47 
48 // Forward declaration
50 
51 /**
52 * Constructs a GoWebScanTracheidMergeTask object.
53 *
54 * @public @memberof GoWebScanTracheidMergeTask
55 * @param task Receives the constructed GoWebScanTracheidMergeTask object.
56 * @param process Associated GoWebScanProcess object.
57 * @param configGroup Group configuration.
58 * @param allocator Memory allocator (or kNULL for default).
59 * @return Operation status.
60 */
61 GoWebScanFx(kStatus) GoWebScanTracheidMergeTask_Construct(GoWebScanTracheidMergeTask* task, GoWebScanProcess process, GoWebScanConfigGroup configGroup, kAlloc allocator);
62 
63 /**
64 * Sets the handler for receiving merged system trahceid tiles.
65 *
66 * @public @memberof GoWebScanTracheidMergeTask
67 * @param task GoWebScanTracheidMergeTask object.
68 * @param send Callback function
69 * @param context Receiver argument for callback.
70 * @return Operation status.
71 */
72 GoWebScanFx(kStatus) GoWebScanTracheidMergeTask_SetReceiver(GoWebScanTracheidMergeTask task, GoWebScanPipeSendFx send, kPointer context);
73 
74 /**
75 * Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
76 * to the pipe for scheduling if no other job is currently pending.
77 *
78 * @public @memberof GoWebScanTracheidMergeTask
79 * @param task GoWebScanTracheidMergeTask object.
80 * @param msg Tile list message to enqueue.
81 * @return Operation status.
82 */
83 GoWebScanFx(kStatus) GoWebScanTracheidMergeTask_Send(GoWebScanTracheidMergeTask task, GoWebScanPipeMsg msg);
84 
85 kEndHeader()
86 #include <GoWebScanSdk/GoWebScanTracheidMergeTask.x.h>
87 
88 #endif
Declares the GoWebScanPipeTask class.
Represents a task for processing raw sensor data to produce system web tiles (Web mode) or detected o...
Declares a GoWebScanPipe object.
kStatus(kCall * GoWebScanPipeSendFx)(kPointer context, GoWebScanPipeMsg msg)
Defines the signature of the handler used by tasks to receive a message from the pipe.
Definition: GoWebScanPipe.h:35
Represents a task for merging tracheid tiles along X-axis from the cameras in a top or bottom group...
Essential GoWebScan declarations.
Represents a container for group-level parameters which are translated from user parameters set in Go...
kStatus GoWebScanTracheidMergeTask_SetReceiver(GoWebScanTracheidMergeTask task, GoWebScanPipeSendFx send, kPointer context)
Sets the handler for receiving merged system trahceid tiles.
kStatus GoWebScanTracheidMergeTask_Construct(GoWebScanTracheidMergeTask *task, GoWebScanProcess process, GoWebScanConfigGroup configGroup, kAlloc allocator)
Constructs a GoWebScanTracheidMergeTask object.
Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPip...
kStatus GoWebScanTracheidMergeTask_Send(GoWebScanTracheidMergeTask task, GoWebScanPipeMsg msg)
Adds a message to the processing queue.
Declares a GoWebScanConfig object.