<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tesseract: ccmain/tesseract_cube_combiner.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">tesseract
   &#160;<span id="projectnumber">3.05.02</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00167_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">tesseract_cube_combiner.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="a00167.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**********************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * File:        tesseract_cube_combiner.h</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Description: Declaration of the Tesseract &amp; Cube results combiner Class</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Author:    Ahmad Abdulkader</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Created:   2008</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * (C) Copyright 2008, Google Inc.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> ** Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> ** you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> ** You may obtain a copy of the License at</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> ** http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> ** Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> ** distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> ** See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> ** limitations under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> **********************************************************************/</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">// The TesseractCubeCombiner class provides the functionality of combining</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">// the recognition results of Tesseract and Cube at the word level</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#ifndef TESSERACT_CCMAIN_TESSERACT_CUBE_COMBINER_H</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#define TESSERACT_CCMAIN_TESSERACT_CUBE_COMBINER_H</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00338.html">pageres.h</a>&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">namespace </span><a class="code" href="a01738.html">tesseract</a> {</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">class </span>CubeObject;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">class </span>NeuralNet;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">class </span>CubeRecoContext;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">class </span>WordAltList;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="a02457.html">   37</a></span>&#160;<span class="keyword">class </span><a class="code" href="a02457.html">TesseractCubeCombiner</a> {</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  <span class="keyword">explicit</span> <a class="code" href="a02457.html#ae4632ce85e2828fc21a908638c362b80">TesseractCubeCombiner</a>(<a class="code" href="a02337.html">CubeRecoContext</a> *cube_cntxt);</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;  <span class="keyword">virtual</span> <a class="code" href="a02457.html#aaa055f1f3d7f072c6b59fdf1abf2b32d">~TesseractCubeCombiner</a>();</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  <span class="comment">// There are 2 public methods for combining the results of tesseract</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;  <span class="comment">// and cube. Both return the probability that the Tesseract result is</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  <span class="comment">// correct. The difference between the two interfaces is in how the</span></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  <span class="comment">// passed-in CubeObject is used.</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  <span class="comment">// The CubeObject parameter is used for 2 purposes: 1) to retrieve</span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="comment">// cube&#39;s alt list, and 2) to compute cube&#39;s word cost for the</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <span class="comment">// tesseract result. Both uses may modify the state of the</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <span class="comment">// CubeObject (including the BeamSearch state) with a call to</span></div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  <span class="comment">// RecognizeWord().</span></div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="keywordtype">float</span> <a class="code" href="a02457.html#ab1690445d6285ffc5d59740f964acd50">CombineResults</a>(<a class="code" href="a02645.html">WERD_RES</a> *tess_res, <a class="code" href="a04417.html">CubeObject</a> *cube_obj);</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  <span class="comment">// The alt_list parameter is expected to have been extracted from the</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  <span class="comment">// CubeObject that recognized the word to be combined. The cube_obj</span></div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  <span class="comment">// parameter passed in is a separate instance to be used only by</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <span class="comment">// the combiner.</span></div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <span class="keywordtype">float</span> <a class="code" href="a02457.html#ab1690445d6285ffc5d59740f964acd50">CombineResults</a>(<a class="code" href="a02645.html">WERD_RES</a> *tess_res, <a class="code" href="a04417.html">CubeObject</a> *cube_obj,</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;                       <a class="code" href="a04489.html">WordAltList</a> *alt_list);</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  <span class="comment">// Public method for computing the combiner features. The agreement</span></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  <span class="comment">// output parameter will be true if both answers are identical,</span></div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  <span class="comment">// false otherwise. Modifies the cube_alt_list, so no assumptions</span></div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="comment">// should be made about its state upon return.</span></div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  <span class="keywordtype">bool</span> <a class="code" href="a02457.html#a9a5b80221c0c47e3dce8ccd92afbbb0a">ComputeCombinerFeatures</a>(<span class="keyword">const</span> std::string &amp;tess_res,</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;                               <span class="keywordtype">int</span> tess_confidence,</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;                               <a class="code" href="a04417.html">CubeObject</a> *cube_obj,</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;                               <a class="code" href="a04489.html">WordAltList</a> *cube_alt_list,</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;                               std::vector&lt;double&gt; *features,</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;                               <span class="keywordtype">bool</span> *agreement);</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  <span class="comment">// Is the word valid according to Tesseract&#39;s language model</span></div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  <span class="keywordtype">bool</span> <a class="code" href="a02457.html#a0d5640a10d557e57402b6b05c6082be9">ValidWord</a>(<span class="keyword">const</span> std::string &amp;str);</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="comment">// Loads the combiner neural network from file, using cube_cntxt_</span></div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  <span class="comment">// to find path.</span></div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <span class="keywordtype">bool</span> <a class="code" href="a02457.html#a3de63e254e7fcb9b11368aae332b7cbd">LoadCombinerNet</a>();</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <span class="comment">// Normalize a UTF-8 string. Converts the UTF-8 string to UTF32 and optionally</span></div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  <span class="comment">// strips punc and/or normalizes case and then converts back</span></div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    std::string NormalizeString(<span class="keyword">const</span> std::string &amp;str, <span class="keywordtype">bool</span> remove_punc, <span class="keywordtype">bool</span> norm_case);</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;  <span class="comment">// Compares 2 strings after optionally normalizing them and or stripping</span></div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <span class="comment">// punctuation</span></div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  <span class="keywordtype">int</span> CompareStrings(<span class="keyword">const</span> std::string &amp;str1, <span class="keyword">const</span> std::string &amp;str2, <span class="keywordtype">bool</span> ignore_punc,</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;                     <span class="keywordtype">bool</span> norm_case);</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;  <a class="code" href="a04633.html">NeuralNet</a> *combiner_net_;  <span class="comment">// pointer to the combiner NeuralNet object</span></div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <a class="code" href="a02337.html">CubeRecoContext</a> *cube_cntxt_;  <span class="comment">// used for language ID and data paths</span></div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;};</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;}</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="preprocessor">#endif  // TESSERACT_CCMAIN_TESSERACT_CUBE_COMBINER_H</span></div><div class="ttc" id="a02457_html_ae4632ce85e2828fc21a908638c362b80"><div class="ttname"><a href="a02457.html#ae4632ce85e2828fc21a908638c362b80">tesseract::TesseractCubeCombiner::TesseractCubeCombiner</a></div><div class="ttdeci">TesseractCubeCombiner(CubeRecoContext *cube_cntxt)</div><div class="ttdef"><b>Definition:</b> <a href="a00164_source.html#l00037">tesseract_cube_combiner.cpp:37</a></div></div>
<div class="ttc" id="a00338_html"><div class="ttname"><a href="a00338.html">pageres.h</a></div></div>
<div class="ttc" id="a02457_html_aaa055f1f3d7f072c6b59fdf1abf2b32d"><div class="ttname"><a href="a02457.html#aaa055f1f3d7f072c6b59fdf1abf2b32d">tesseract::TesseractCubeCombiner::~TesseractCubeCombiner</a></div><div class="ttdeci">virtual ~TesseractCubeCombiner()</div><div class="ttdef"><b>Definition:</b> <a href="a00164_source.html#l00042">tesseract_cube_combiner.cpp:42</a></div></div>
<div class="ttc" id="a01738_html"><div class="ttname"><a href="a01738.html">tesseract</a></div><div class="ttdef"><b>Definition:</b> <a href="a00005_source.html#l00081">baseapi.cpp:81</a></div></div>
<div class="ttc" id="a04417_html"><div class="ttname"><a href="a04417.html">tesseract::CubeObject</a></div><div class="ttdef"><b>Definition:</b> <a href="a00956_source.html#l00090">cube_object.h:90</a></div></div>
<div class="ttc" id="a02457_html_a3de63e254e7fcb9b11368aae332b7cbd"><div class="ttname"><a href="a02457.html#a3de63e254e7fcb9b11368aae332b7cbd">tesseract::TesseractCubeCombiner::LoadCombinerNet</a></div><div class="ttdeci">bool LoadCombinerNet()</div><div class="ttdef"><b>Definition:</b> <a href="a00164_source.html#l00049">tesseract_cube_combiner.cpp:49</a></div></div>
<div class="ttc" id="a02457_html_ab1690445d6285ffc5d59740f964acd50"><div class="ttname"><a href="a02457.html#ab1690445d6285ffc5d59740f964acd50">tesseract::TesseractCubeCombiner::CombineResults</a></div><div class="ttdeci">float CombineResults(WERD_RES *tess_res, CubeObject *cube_obj)</div><div class="ttdef"><b>Definition:</b> <a href="a00164_source.html#l00240">tesseract_cube_combiner.cpp:240</a></div></div>
<div class="ttc" id="a02337_html"><div class="ttname"><a href="a02337.html">tesseract::CubeRecoContext</a></div><div class="ttdef"><b>Definition:</b> <a href="a00047_source.html#l00043">cube_reco_context.h:43</a></div></div>
<div class="ttc" id="a02457_html_a0d5640a10d557e57402b6b05c6082be9"><div class="ttname"><a href="a02457.html#a0d5640a10d557e57402b6b05c6082be9">tesseract::TesseractCubeCombiner::ValidWord</a></div><div class="ttdeci">bool ValidWord(const std::string &amp;str)</div><div class="ttdef"><b>Definition:</b> <a href="a00164_source.html#l00120">tesseract_cube_combiner.cpp:120</a></div></div>
<div class="ttc" id="a04633_html"><div class="ttname"><a href="a04633.html">tesseract::NeuralNet</a></div><div class="ttdef"><b>Definition:</b> <a href="a01223_source.html#l00031">neural_net.h:31</a></div></div>
<div class="ttc" id="a02457_html"><div class="ttname"><a href="a02457.html">tesseract::TesseractCubeCombiner</a></div><div class="ttdef"><b>Definition:</b> <a href="a00167_source.html#l00037">tesseract_cube_combiner.h:37</a></div></div>
<div class="ttc" id="a02457_html_a9a5b80221c0c47e3dce8ccd92afbbb0a"><div class="ttname"><a href="a02457.html#a9a5b80221c0c47e3dce8ccd92afbbb0a">tesseract::TesseractCubeCombiner::ComputeCombinerFeatures</a></div><div class="ttdeci">bool ComputeCombinerFeatures(const std::string &amp;tess_res, int tess_confidence, CubeObject *cube_obj, WordAltList *cube_alt_list, std::vector&lt; double &gt; *features, bool *agreement)</div><div class="ttdef"><b>Definition:</b> <a href="a00164_source.html#l00128">tesseract_cube_combiner.cpp:128</a></div></div>
<div class="ttc" id="a04489_html"><div class="ttname"><a href="a04489.html">tesseract::WordAltList</a></div><div class="ttdef"><b>Definition:</b> <a href="a01046_source.html#l00032">word_altlist.h:32</a></div></div>
<div class="ttc" id="a02645_html"><div class="ttname"><a href="a02645.html">WERD_RES</a></div><div class="ttdef"><b>Definition:</b> <a href="a00338_source.html#l00155">pageres.h:155</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_a1bed42364588c3c9f4f22437dc6089e.html">ccmain</a></li><li class="navelem"><a class="el" href="a00167.html">tesseract_cube_combiner.h</a></li>
    <li class="footer">Generated on Mon Oct 29 2018 11:27:45 for tesseract by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
  </ul>
</div>
</body>
</html>