GoWebScanProfileSampleTask.h

Go to the documentation of this file.

/**
* @file    GoWebScanProfileSampleTask.h
* @brief   Declares a GoWebScanProfileSampleTask 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_SAMPLE_TASK_H
#define GO_WEB_SCAN_PROFILE_SAMPLE_TASK_H

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

/**
* @class   GoWebScanProfileSampleTask
* @extends kObject
* @ingroup GoWebScanSdk-Control
* @brief   Represents a task for resampling raw profile points from a single camera to 
*          generate profile tiles or presence tiles (for object detection). The task accepts 
*          GoWebScanProfileInputMsg objects and produces GoWebScanProfileTileMsg objects.
*          When profile input messages are received, each input row is processed and then 
*          added to a GoWebScanProfileYResampler object.  When the GoWebScanProfileYResampler 
*          completes a row, the row is passed back to the GoWebScanProfileSampleTask,
*          processed, and added to an output tile. 
*          
*          The processing steps for each row of input data is:  
*          -# Apply profile mask (as defined by the obstructions in GoWebScanSettings).
*          -# Reorient the input to match standard system orientation.
*          -# Apply Z-offsets as calculated from system calibration.
*          -# Resample the row in X.
*          -# Run the GoWebScanProfileYResampler algorithm.
*/
typedef kObject GoWebScanProfileSampleTask;

// Forward declaration
typedef kObject GoWebScanProcess;

/**
 * Constructs a GoWebScanProfileSampleTask object.
 * 
 * @public              @memberof GoWebScanProfileSampleTask
 * @param   task        Receives the constructed GoWebScanProfileSampleTask object.
 * @param   process     Associated GoWebScanProcess object.
 * @param   configNode  Node configuration.
 * @param   outputType  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) GoWebScanProfileSampleTask_Construct(GoWebScanProfileSampleTask* task, GoWebScanProcess process, GoWebScanConfigNode configNode, GoWebScanNodeTileId outputType, kAlloc allocator);

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

/**
 * Dispatches a processing job (task + message) to the pipe. Sends the message to a task's
 * message queue. The task will submit the message to the pipe for processing if no other job is
 * pending.
 * 
 * @public          @memberof GoWebScanProfileSampleTask
 * @param   task    GoWebScanProfileSampleTask object.
 * @param   msg     Message to dispatch.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanProfileSampleTask_Dispatch(GoWebScanProfileSampleTask task, GoWebScanPipeMsg msg);

/**
* 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 GoWebScanProfileSampleTask
* @param   task    GoWebScanProfileSampleTask object.
* @param   msg     Profile input message to enqueue.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileSampleTask_Send(GoWebScanProfileSampleTask task, GoWebScanPipeMsg msg);

/**
* Clears Y-resampler algorithm and resets internal variables.
* 
* @public          @memberof GoWebScanProfileSampleTask
* @param   task    GoWebScanProfileSampleTask object.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileSampleTask_Clear(GoWebScanProfileSampleTask task);

/**
 * Gets the node configuration for the node associated with this task.
 * 
 * @public          @memberof GoWebScanProfileSampleTask
 * @param   task    GoWebScanProfileSampleTask object.
 * @return          Node configuration.
 */
GoWebScanFx(GoWebScanConfigNode) GoWebScanProfileSampleTask_ConfigNode(GoWebScanProfileSampleTask task);

#include <GoWebScanSdk/GoWebScanProfileSampleTask.x.h>

#endif