aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/lipi-toolkit/3rdparty/lipi-toolkit/src/include/LTKShapeRecoEngine.h
blob: c33b727b2bbd6357bd2cfa35d18ad3652811df12 (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
/*****************************************************************************************
* 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-18 15:00:39 +0530 (Fri, 18 Jul 2008) $
 * $Revision: 561 $
 * $Author: sharmnid $
 *
 ************************************************************************/

/************************************************************************
 * FILE DESCR: Definition of LTKShapeRecoEngine which has the interface to the shape recognition engine
 *
 * CONTENTS:   
 *
 * AUTHOR:     Balaji R.
 *
 * DATE:       December 23, 2004
 * CHANGE HISTORY:
 * Author		Date			Description of change
 ************************************************************************/

#ifndef __LTKShapeRecoEngine_H
#define __LTKShapeRecoEngine_H

#include "LTKShapeRecognizer.h"

#include "LTKTraceGroup.h"

#include "LTKShapeRecoResult.h"

#include "LTKScreenContext.h"

#include "LTKCaptureDevice.h"

/**
 * @class LTKShapeRecoEngine
 * <p> This class provides the interface to the Shape Recognition Engine.
 * The required shape recognizer is instantiated dynamically and its corresponding 
 * recognize functions are called</p>
 */

class LTKShapeRecoEngine
{

private:

	LTKShapeRecognizer* m_shapeRecognizer;		//	a pointer to a derived class of LTKShapeRecognizer


public:

	/**
	 * @name Constructors and Destructor
	 */
	// @{

	/**
	 * Default Constructor
	 */

	LTKShapeRecoEngine();

	/**
	 * Destructor
	 */

	~LTKShapeRecoEngine();

	// @}


	/**
	 * @name Methods
	 */

	// @{

	/**
	 * This method loads a shape recognizer with a particular profile for a particular 
	 * recognition problem by using the information in the configuration file and the lipi tool
	 * kit root path passed to it as arguments
	 * @param configFileName The configuration file to load a shape recognizer
	 * @param lipiRoot root path of the lipi tool kit
	 */

	int initializeShapeRecoEngine(const string& configFileName, string lipiRoot = "");

	/**
	* This method calls the loadTrainingData method of the instantiated shape recognizer.
	*/

	int loadTrainingData();

	/**
	* This method calls the recognize method of the instantiated shape recognizer.
	*
	* @param traceGroupObj The co-ordinates of the shape which is to be recognized
	* @param uiParams Contains information about the input field like whether it is boxed input
	*                 or continuous writing
	* @param deviceParams Contains information about the device like its sampling rate
	* @param shapeSubSet A subset of the entire set of shapes which is to be used for 
	*                        recognizing the input shape.
	* @param confThreshold A threshold on confidence value of the recognized shape. This is
	*                      used as Rejection Criteria
	* @param numOfChoices Number of top choices to be returned in the result structure
	* @param results The result of recognition
	*/

	int recognize(const LTKTraceGroup& traceGroup, const LTKScreenContext& screenContext,
		const LTKCaptureDevice& captureDevice, const vector<bool>& shapeSubSet, float confThreshold,
		int numChoices, vector<LTKShapeRecoResult>& results);

	/**
	* This method calls the recognize method of the derived shape recognizer.
	*
	* @param traceGroup The co-ordinates of the shape which is to be recognized
	* @param screenContext Contains information about the input field like whether it is boxed input
	*                 or continuous writing
	* @param captureDevice Contains information about the device like its sampling rate
	* @param shapeIds A subset of the entire shape space for which shape recongizer confidences
	*                 need to be computed
	* @param shapeRecoConfidences the confidence values calculated by the recognizer
	*/

	int getShapeRecoConfidences(const LTKTraceGroup& traceGroup, 
		const LTKScreenContext& screenContext,const LTKCaptureDevice& captureDevice, 
		const vector<int>& shapeIds, vector<float>& shapeRecoConfidences);

	/**
	* This method calls the learn method of the instantiated shape recognizer.
	*
	* @param prototype The sample to be used for adaptation
	* @param shapeId The shape id of the added prototype
	* @param uiParams Contains information about the input field like whether it is boxed input
	*                 or continuous writing
	* @param deviceParams Contains information about the device like its sampling rate
	*/

	int learn(const LTKTraceGroup& prototype, int shapeId, const LTKScreenContext& screenContext, 
		      const LTKCaptureDevice& captureDevice);

	/**
	* This method calls the train method of the instantiated shape recognizer.
	* @param trainingList The name of the file containing the listing of files to be used for
	*                    training each of the shapes.
	*/
	
	int train(const string& trainingList);

	// @}

};

#endif

//#ifndef __LTKShapeRecoEngine_H
//#define __LTKShapeRecoEngine_H