aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/3rdparty/lipi-toolkit/src/include/LTKPreprocessorInterface.h
blob: fb9131004b2b3c9e1eb6512e796cad939cb31fff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/******************************************************************************
* Copyright (c) 2007 Hewlett-Packard Development Company, L.P.
* Permission is hereby granted, free of charge, to any person obtaining a copy 
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights 
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
* copies of the Software, and to permit persons to whom the Software is 
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or 
* substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
* SOFTWARE
******************************************************************************/
/************************************************************************
 * SVN MACROS
 *
 * $LastChangedDate: 2008-07-10 15:23:21 +0530 (Thu, 10 Jul 2008) $
 * $Revision: 556 $
 * $Author: sharmnid $
 *
 ************************************************************************/
#ifndef __LTKPREPROCESSORINTERFACE_H
#define __LTKPREPROCESSORINTERFACE_H

#include "LTKTraceGroup.h"

class LTKPreprocessorInterface;

typedef int (LTKPreprocessorInterface::*FN_PTR_PREPROCESSOR)(const LTKTraceGroup& inTraceGroup, LTKTraceGroup& outTraceGroup);

class LTKPreprocessorInterface
{

public:

	/**
	 * This function normalizes the size for a trace group.
	 * <p> If the width of the stroke set is more than the threshold,
	 * they are normalised by width and scale; otherwise they are traslated to the
	 * center if bounding box determined by scale. </p>
	 *
	 * @param traceGroup Object of LTKTraceGroup
	 *
	 * @return void
	 */

	/**
	 * @name Getter Functions
	 */
	// @{

	/**
	 * The function get the function name as the argument and return the address of the
	 * function.
	 * @param funName
	 *
	 * @return address of the function.
	 */

    virtual FN_PTR_PREPROCESSOR getPreprocptr(const string &funName) = 0;

	/**
	 * @name Setter Functions
	 */
	// @{


	virtual int normalizeSize(const LTKTraceGroup& inTraceGroup, LTKTraceGroup& outTraceGroup) = 0;

	/**
	 * This function is called on a trace group to normalize its orientation
	 *
	 * @param inTraceGroup input trace group that must be normalized.
	 * @param outTraceGroup The trace group whose traces are normalized.
	 *
	 * @return void
	 *
	 */

	virtual int normalizeOrientation(const LTKTraceGroup& inTraceGroup, LTKTraceGroup& outTraceGroup) = 0;

	/**
	 * @param traceGroup Object of LTKTracegroup
	 * @param traceDimension     Average number of points expected in a trace
	 *
	 * @return void
	 */

	virtual int duplicatePoints(const LTKTraceGroup& traceGroup, int traceDimension) = 0;

	/**
	 * This function shifts the origin of eack stroke to the centroid of the stroke
	 *
	 * @param inTraceGroup  Trace group input, whose traces have to be centered.
	 * @param outTraceGroup The output trace group that whose traces are centered.
	 *
	 * @return void
	 */

	virtual int centerTraces(const LTKTraceGroup& inTraceGroup, LTKTraceGroup& outTraceGroup) = 0;

	/**
	 * This function dehooks the given tracegroup
	 *
	 * @param inTraceGroup Tracegroup which has to be dehooked
	 * @param outTraceGroup The dehooked tracegroup
	 *
	 * @return void
	 */

	virtual int dehookTraces(const LTKTraceGroup& inTraceGroup, LTKTraceGroup& outTraceGroup) = 0;

	/**
	 * This function removes consecutively repeating x, y coordinates (thinning)
	 *
	 * @param inTraceGroup trace group to be thinned
	 * @param outTraceGroup thinned trace group
	 *
	 * @return SUCCESS on successful thinning operation
	 */

	virtual int removeDuplicatePoints(const LTKTraceGroup& inTraceGroup, LTKTraceGroup& outTraceGroup) = 0;

	/**
	 * This function calculates the slopes of the strokes w.r.t maximum and minimum coordinates
	 * and reorders the strokes.
	 *
	 * @param inTraceGroup Object of LTKTraceGroup, whose traces have to be ordered.
	 * @param outTraceGroup The output trace group, whose traces are ordered.
	 *
	 * @return void
	 */

	virtual int orderTraces(const LTKTraceGroup& inTraceGroup, LTKTraceGroup& outTraceGroup) = 0;

	/**
	 * This function reorients the given stroke
	 *
	 * @param inTrace Trace which has to be reversed
	 * @param outTrace The reversed trace
	 *
	 * @return void
	 */

	virtual int reverseTrace(const LTKTrace& inTrace, LTKTrace& outTrace) = 0;

	/**
	 * This function takes trace by trace from a trace group and resamples the points in them
	 * according to the trace dimension.
	 *
	 * @param inTrace The input trace from trace group
	 * @param resamplePoints The ideal number of points to which the trace must be resampled.
	 * @param outTrace The output trace that has resampled points.
	 *
	 * @return void
	 */

	virtual int resampleTrace(const LTKTrace& inTrace, int resamplePoint, LTKTrace& outTrace) = 0;


	/**
	 * This function smoothens the incoming tracegroup using moving average technique
	 *
	 * @param inTraceGroup The input trace group
	 * @param filterLength is the number of points used for smoothening a single point
	 * @param outTraceGrouo The output tracegroup that has smoothened points.
	 *
	 * @return SUCCESS
	 */

	virtual int smoothenTraceGroup(const LTKTraceGroup& inTraceGroup, LTKTraceGroup& outTraceGroup) = 0;

	virtual int resampleTraceGroup(const LTKTraceGroup& inTraceGroup,
											 LTKTraceGroup& outTraceGroup)=0;
	virtual int getQuantisedSlope(const LTKTrace& trace, vector<int>& qSlopeVector) = 0;

    virtual int determineDominantPoints(const vector<int>& qSlopeVector, int flexibilityIndex, vector<int>& dominantPts) = 0;

	virtual void setCaptureDevice(const LTKCaptureDevice& captureDevice) = 0;

	virtual void setScreenContext(const LTKScreenContext& screenContext) = 0;

	virtual bool getPreserveAspectRatio()const = 0 ;

	virtual float getAspectRatioThreshold()const= 0 ;

	virtual bool getPreserveRealtiveYPosition()const = 0 ;

	virtual float getSizeThreshold()const =0 ;

	virtual	float getDotThreshold()const = 0 ;

	virtual string getResamplingMethod()const = 0 ;

	virtual const int getTraceDimension()const = 0 ;

	virtual const int getFilterLength()const = 0 ;
		
	virtual ~LTKPreprocessorInterface(){};


};

#endif