GoWebScanProfileMergeTask.h

Go to the documentation of this file.

/**
* @file    GoWebScanProfileMergeTask.h
* @brief   Declares a GoWebScanProfileMergeTask 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_PROFILE_MERGE_TASK_H
#define GO_WEB_SCAN_PROFILE_MERGE_TASK_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanPipe.h>
#include <GoWebScanSdk/GoWebScanPipeTask.h>
#include <GoWebScanSdk/GoWebScanConfig.h>

/**
* @class   GoWebScanProfileMergeTask
* @extends kObject
* @ingroup GoWebScanSdk-Control
* @brief   Represents a task for merging profile tiles along X-axis from the cameras in a top 
*          or bottom group. Specifically, the task accepts a list of profile tiles that 
*          correspond to the same Y-position, and merges them into a single group-wide tile 
*          according to their respective source locations along the X-axis. Gaps and overlaps 
*          between adjacent tiles are processed according to configuration options.
*          The task accepts GoWebScanTileListMsg objects and produces GoWebScanProfileTileMsg
*          objects. 
*          
*          Processing steps:
*          -# Clear the background of the output system tile.
*          -# Add GoWebScanTileListMsg input tiles to the processing queue
*          -# Blend the overlap between tiles. Overlaps are processed by searching for the last
*              valid left element and first valid right element within the overlapping region
*              between two tiles. If overlap exists, the overlapping elements are blended by
*              weighted average.
*          -# Fill gaps between tiles. Gaps are processed by searching for the last valid left
*              element and first valid right element within the gap search window. If these 
*              elements are closer than the gap threshold, any null elements in between are 
*              filled in (nearest neighbour).
*/
typedef kObject GoWebScanProfileMergeTask;

// Forward declaration
typedef kObject GoWebScanProcess;

/**
 * Constructs a GoWebScanProfileMergeTask object.
 * 
 * @public                      @memberof GoWebScanProfileMergeTask
 * @param   task                Receives the constructed GoWebScanProfileMergeTask object.
 * @param   process             Associated GoWebScanProcess object.
 * @param   configGroup         Group configuration.
 * @param   presenceDetection   Whether the task is merging profile tiles intended for presence
 *                              detection or is just merging standard profile tiles.
 * @param   allocator           Memory allocator (or kNULL for default).
 * @return                      Operation status.
 */
GoWebScanFx(kStatus) GoWebScanProfileMergeTask_Construct(GoWebScanProfileMergeTask* task, GoWebScanProcess process, GoWebScanConfigGroup configGroup, kBool presenceDetection, kAlloc allocator);

/**
* Sets the handler for receiving merged system profile tiles.
*
* @public           @memberof GoWebScanProfileMergeTask
* @param  task      GoWebScanProfileMergeTask object. 
* @param  send      Callback function
* @param  context   Receiver argument for callback.
* @return           Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileMergeTask_SetReceiver(GoWebScanProfileMergeTask task, GoWebScanPipeSendFx send, kPointer context);

/**
* Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
* to the pipe for scheduling if no other job is currently pending.
* 
* @public          @memberof GoWebScanProfileMergeTask
* @param   task    GoWebScanProfileMergeTask object.
* @param   msg     Tile list message to enqueue.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileMergeTask_Send(GoWebScanProfileMergeTask task, GoWebScanPipeMsg msg);

#include <GoWebScanSdk/GoWebScanProfileMergeTask.x.h>

#endif