GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanProfileMergeTask.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanProfileMergeTask.h
3 * @brief Declares a GoWebScanProfileMergeTask 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_PROFILE_MERGE_TASK_H
12 #define GO_WEB_SCAN_PROFILE_MERGE_TASK_H
13 
18 
19 kBeginHeader()
20 
21 /**
22 * @class GoWebScanProfileMergeTask
23 * @extends kObject
24 * @ingroup GoWebScanSdk-Control
25 * @brief Represents a task for merging profile tiles along X-axis from the cameras in a top
26 * or bottom group. Specifically, the task accepts a list of profile 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 GoWebScanProfileTileMsg
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 GoWebScanProfileMergeTask object.
52  *
53  * @public @memberof GoWebScanProfileMergeTask
54  * @param task Receives the constructed GoWebScanProfileMergeTask object.
55  * @param process Associated GoWebScanProcess object.
56  * @param configGroup Group configuration.
57  * @param presenceDetection Whether the task is merging profile tiles intended for presence
58  * detection or is just merging standard profile tiles.
59  * @param allocator Memory allocator (or kNULL for default).
60  * @return Operation status.
61  */
62 GoWebScanFx(kStatus) GoWebScanProfileMergeTask_Construct(GoWebScanProfileMergeTask* task, GoWebScanProcess process, GoWebScanConfigGroup configGroup, kBool presenceDetection, kAlloc allocator);
63 
64 /**
65 * Sets the handler for receiving merged system profile tiles.
66 *
67 * @public @memberof GoWebScanProfileMergeTask
68 * @param task GoWebScanProfileMergeTask object.
69 * @param send Callback function
70 * @param context Receiver argument for callback.
71 * @return Operation status.
72 */
73 GoWebScanFx(kStatus) GoWebScanProfileMergeTask_SetReceiver(GoWebScanProfileMergeTask task, GoWebScanPipeSendFx send, kPointer context);
74 
75 /**
76 * Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
77 * to the pipe for scheduling if no other job is currently pending.
78 *
79 * @public @memberof GoWebScanProfileMergeTask
80 * @param task GoWebScanProfileMergeTask object.
81 * @param msg Tile list message to enqueue.
82 * @return Operation status.
83 */
84 GoWebScanFx(kStatus) GoWebScanProfileMergeTask_Send(GoWebScanProfileMergeTask task, GoWebScanPipeMsg msg);
85 
86 kEndHeader()
87 #include <GoWebScanSdk/GoWebScanProfileMergeTask.x.h>
88 
89 #endif
Declares the GoWebScanPipeTask class.
kStatus GoWebScanProfileMergeTask_Construct(GoWebScanProfileMergeTask *task, GoWebScanProcess process, GoWebScanConfigGroup configGroup, kBool presenceDetection, kAlloc allocator)
Constructs a GoWebScanProfileMergeTask object.
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
kStatus GoWebScanProfileMergeTask_SetReceiver(GoWebScanProfileMergeTask task, GoWebScanPipeSendFx send, kPointer context)
Sets the handler for receiving merged system profile tiles.
kStatus GoWebScanProfileMergeTask_Send(GoWebScanProfileMergeTask task, GoWebScanPipeMsg msg)
Adds a message to the processing queue.
Essential GoWebScan declarations.
Represents a container for group-level parameters which are translated from user parameters set in Go...
Represents a task for merging profile tiles along X-axis from the cameras in a top or bottom group...
Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPip...
Declares a GoWebScanConfig object.