GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanVisionMergeTask.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanVisionMergeTask.h
3 * @brief Declares a GoWebScanVisionMergeTask 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_VISION_MERGE_TASK_H
12 #define GO_WEB_SCAN_VISION_MERGE_TASK_H
13 
18 
19 kBeginHeader()
20 
21 /**
22 * @class GoWebScanVisionMergeTask
23 * @extends kObject
24 * @ingroup GoWebScanSdk-Control
25 * @brief Represents a task for merging vision tiles along X-axis from the cameras in a top
26 * or bottom group. Specifically, the task accepts a list of vision 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 GoWebScanVisionTileMsg
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.
40 * -# Fill gaps between tiles. Gaps are processed by searching for the last valid left
41 * element and first valid right element witin the gap search window. If these
42 * elements are closer than the gap threshold, any null elements in between are
43 * filled in (nearest neighbour).
44 */
46 
47 // Forward declaration
49 
50 /**
51 * Constructs a GoWebScanVisionMergeTask object.
52 *
53 * @public @memberof GoWebScanVisionMergeTask
54 * @param task Receives the constructed GoWebScanVisionMergeTask object.
55 * @param process Associated GoWebScanProcess object.
56 * @param configGroup Group configuration.
57 * @param allocator Memory allocator (or kNULL for default).
58 * @return Operation status.
59 */
60 GoWebScanFx(kStatus) GoWebScanVisionMergeTask_Construct(GoWebScanVisionMergeTask* task, GoWebScanProcess process, GoWebScanConfigGroup configGroup, kAlloc allocator);
61 
62 /**
63 * Sets the handler for receiving merged system vision tiles.
64 *
65 * @public @memberof GoWebScanVisionMergeTask
66 * @param task GoWebScanVisionMergeTask object.
67 * @param send Callback function
68 * @param context Receiver argument for callback.
69 * @return Operation status.
70 */
71 GoWebScanFx(kStatus) GoWebScanVisionMergeTask_SetReceiver(GoWebScanVisionMergeTask task, GoWebScanPipeSendFx send, kPointer context);
72 
73 /**
74 * Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
75 * to the pipe for scheduling if no other job is currently pending.
76 *
77 * @public @memberof GoWebScanVisionMergeTask
78 * @param task GoWebScanVisionMergeTask object.
79 * @param msg Tile list message to enqueue.
80 * @return Operation status.
81 */
82 GoWebScanFx(kStatus) GoWebScanVisionMergeTask_Send(GoWebScanVisionMergeTask task, GoWebScanPipeMsg msg);
83 
84 kEndHeader()
85 #include <GoWebScanSdk/GoWebScanVisionMergeTask.x.h>
86 
87 #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
Essential GoWebScan declarations.
kStatus GoWebScanVisionMergeTask_SetReceiver(GoWebScanVisionMergeTask task, GoWebScanPipeSendFx send, kPointer context)
Sets the handler for receiving merged system vision tiles.
Represents a container for group-level parameters which are translated from user parameters set in Go...
kStatus GoWebScanVisionMergeTask_Send(GoWebScanVisionMergeTask task, GoWebScanPipeMsg msg)
Adds a message to the processing queue.
Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPip...
kStatus GoWebScanVisionMergeTask_Construct(GoWebScanVisionMergeTask *task, GoWebScanProcess process, GoWebScanConfigGroup configGroup, kAlloc allocator)
Constructs a GoWebScanVisionMergeTask object.
Represents a task for merging vision tiles along X-axis from the cameras in a top or bottom group...
Declares a GoWebScanConfig object.