GoWebScanTracheidSampleTask.h

Go to the documentation of this file.

/**
* @file    GoWebScanTracheidSampleTask.h
* @brief   Declares a GoWebScanTracheidSampleTask 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_TRACHEID_SAMPLE_TASK_H
#define GO_WEB_SCAN_TRACHEID_SAMPLE_TASK_H

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

/**
* @class   GoWebScanTracheidSampleTask
* @extends kObject
* @ingroup GoWebScanSdk-Control
* @brief   Represents a task for resampling raw tracheid points from a single camera to 
*          generate tracheid tiles. The task accepts GoWebScanTracheidInputMsg objects and 
*          produces GoWebScanTracheidTileMsg objects. When tracheid input messages are 
*          received, each input row is processed and then added to a 
*          GoWebScanProfileYResampler object (same class as used for profile resampling).  
*          When the GoWebScanProfileYResampler completes a row, the row is passed back
*          to the GoWebScanTracheidSampleTask, processed, and added to an output tile. 
*          
*          The processing steps for each row of input data is:  
*          -# Reorient the input to match standard system orientation.   
*          -# Resample the row in X.
*          -# Run the GoWebScanProfileYResampler algorithm.
*/
typedef kObject GoWebScanTracheidSampleTask;

// Forward declaration
typedef kObject GoWebScanProcess;

/**
* Constructs a GoWebScanTracheidSampleTask object.
* 
* @public              @memberof GoWebScanTracheidSampleTask
* @param   task        Receives the constructed GoWebScanTracheidSampleTask object.
* @param   process     Associated GoWebScanProcess object.
* @param   configNode  Node configuration.
* @param   allocator   Memory allocator (or kNULL for default).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_Construct(GoWebScanTracheidSampleTask* task, GoWebScanProcess process, GoWebScanConfigNode configNode, kAlloc allocator);

/**
* Sets the handler for receiving resampled tracheid tiles.
*
* @public           @memberof GoWebScanTracheidSampleTask
* @param  task      GoWebScanTracheidSampleTask object. 
* @param  send      Callback function
* @param  context   Receiver argument for callback.
* @return           Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_SetReceiver(GoWebScanTracheidSampleTask 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 GoWebScanTracheidSampleTask
* @param   task    GoWebScanTracheidSampleTask object.
* @param   msg     Message to dispatch.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_Dispatch(GoWebScanTracheidSampleTask 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 GoWebScanTracheidSampleTask
* @param   task    GoWebScanTracheidSampleTask object.
* @param   msg     Profile input message to enqueue.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_Send(GoWebScanTracheidSampleTask task, GoWebScanPipeMsg msg);

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

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

#include <GoWebScanSdk/GoWebScanTracheidSampleTask.x.h>

#endif