GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanTracheidSampleTask.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanTracheidSampleTask.h
3 * @brief Declares a GoWebScanTracheidSampleTask 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_TRACHEID_SAMPLE_TASK_H
12 #define GO_WEB_SCAN_TRACHEID_SAMPLE_TASK_H
13 
18 
19 kBeginHeader()
20 
21 /**
22 * @class GoWebScanTracheidSampleTask
23 * @extends kObject
24 * @ingroup GoWebScanSdk-Control
25 * @brief Represents a task for resampling raw tracheid points from a single camera to
26 * generate tracheid tiles. The task accepts GoWebScanTracheidInputMsg objects and
27 * produces GoWebScanTracheidTileMsg objects. When tracheid input messages are
28 * received, each input row is processed and then added to a
29 * GoWebScanProfileYResampler object (same class as used for profile resampling).
30 * When the GoWebScanProfileYResampler completes a row, the row is passed back
31 * to the GoWebScanTracheidSampleTask, processed, and added to an output tile.
32 *
33 * The processing steps for each row of input data is:
34 * -# Reorient the input to match standard system orientation.
35 * -# Resample the row in X.
36 * -# Run the GoWebScanProfileYResampler algorithm.
37 */
39 
40 // Forward declaration
42 
43 /**
44 * Constructs a GoWebScanTracheidSampleTask object.
45 *
46 * @public @memberof GoWebScanTracheidSampleTask
47 * @param task Receives the constructed GoWebScanTracheidSampleTask object.
48 * @param process Associated GoWebScanProcess object.
49 * @param configNode Node configuration.
50 * @param allocator Memory allocator (or kNULL for default).
51 * @return Operation status.
52 */
53 GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_Construct(GoWebScanTracheidSampleTask* task, GoWebScanProcess process, GoWebScanConfigNode configNode, kAlloc allocator);
54 
55 /**
56 * Sets the handler for receiving resampled tracheid tiles.
57 *
58 * @public @memberof GoWebScanTracheidSampleTask
59 * @param task GoWebScanTracheidSampleTask object.
60 * @param send Callback function
61 * @param context Receiver argument for callback.
62 * @return Operation status.
63 */
64 GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_SetReceiver(GoWebScanTracheidSampleTask task, GoWebScanPipeSendFx send, kPointer context);
65 
66 /**
67 * Dispatches a processing job (task + message) to the pipe. Sends the message to a task's
68 * message queue. The task will submit the message to the pipe for processing if no other job is
69 * pending.
70 *
71 * @public @memberof GoWebScanTracheidSampleTask
72 * @param task GoWebScanTracheidSampleTask object.
73 * @param msg Message to dispatch.
74 * @return Operation status.
75 */
76 GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_Dispatch(GoWebScanTracheidSampleTask task, GoWebScanPipeMsg msg);
77 
78 /**
79 * Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
80 * to the pipe for scheduling if no other job is currently pending.
81 *
82 * @public @memberof GoWebScanTracheidSampleTask
83 * @param task GoWebScanTracheidSampleTask object.
84 * @param msg Profile input message to enqueue.
85 * @return Operation status.
86 */
87 GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_Send(GoWebScanTracheidSampleTask task, GoWebScanPipeMsg msg);
88 
89 /**
90 * Clears Y-resampler algorithm and resets internal variables.
91 *
92 * @public @memberof GoWebScanTracheidSampleTask
93 * @param task GoWebScanTracheidSampleTask object.
94 * @return Operation status.
95 */
96 GoWebScanFx(kStatus) GoWebScanTracheidSampleTask_Clear(GoWebScanTracheidSampleTask task);
97 
98 /**
99 * Gets the node configuration for the node associated with this task.
100 *
101 * @public @memberof GoWebScanTracheidSampleTask
102 * @param task GoWebScanTracheidSampleTask object.
103 * @return Node configuration.
104 */
105 GoWebScanFx(GoWebScanConfigNode) GoWebScanTracheidSampleTask_ConfigNode(GoWebScanTracheidSampleTask task);
106 
107 kEndHeader()
108 #include <GoWebScanSdk/GoWebScanTracheidSampleTask.x.h>
109 
110 #endif
Declares the GoWebScanPipeTask class.
Represents a task for processing raw sensor data to produce system web tiles (Web mode) or detected o...
Represents a container for node-level parameters which are translated from user parameters set in GoW...
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 GoWebScanTracheidSampleTask_Construct(GoWebScanTracheidSampleTask *task, GoWebScanProcess process, GoWebScanConfigNode configNode, kAlloc allocator)
Constructs a GoWebScanTracheidSampleTask object.
Essential GoWebScan declarations.
kStatus GoWebScanTracheidSampleTask_Send(GoWebScanTracheidSampleTask task, GoWebScanPipeMsg msg)
Adds a message to the processing queue.
GoWebScanConfigNode GoWebScanTracheidSampleTask_ConfigNode(GoWebScanTracheidSampleTask task)
Gets the node configuration for the node associated with this task.
kStatus GoWebScanTracheidSampleTask_SetReceiver(GoWebScanTracheidSampleTask task, GoWebScanPipeSendFx send, kPointer context)
Sets the handler for receiving resampled tracheid tiles.
Represents a task for resampling raw tracheid points from a single camera to generate tracheid tiles...
kStatus GoWebScanTracheidSampleTask_Dispatch(GoWebScanTracheidSampleTask task, GoWebScanPipeMsg msg)
Dispatches a processing job (task + message) to the pipe.
Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPip...
kStatus GoWebScanTracheidSampleTask_Clear(GoWebScanTracheidSampleTask task)
Clears Y-resampler algorithm and resets internal variables.
Declares a GoWebScanConfig object.