<?php $isip_window_title = "ISIP Homepage"; ?>
<?php include("/data/isip/www/templates/documentation/header/header.html"); ?>

<!--#set var="isip_page_title" value="isip_recognize" -->
<!--#include virtual="/hse/ies/templates/documentation/body/index_utility.html" -->
<?php include("/data/isip/www/templates/documentation/body/bar.html"); ?>

<a name="name">
<b>
name:
<a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/isip_recognize.cc">isip_recognize</a>
</b>

<br><br>

<a name="synopsis">
<b>synopsis:</b>
<br><br>

<blockquote>
<pre>
isip_recognize -p param.sof [options] [files]
</pre>
</blockquote>

<a name="quick_start">
<b>quick start:</b>
<br><br>

<blockquote>
<pre>
isip_recognize -help;
isip_recognize -p param.sof
isip_recognize -p param.sof file1.raw file2.raw file3.sof ...
isip_recognize -p param.sof -list raw_list.sof
</pre>
</blockquote>

<a name="description"> 
<b>description:</b>
<br><br>

<ul>
  This is the decoder utility, core component of the speech recognition
system.
</ul>

<a name="options">
<b>options:</b>
<br><br>

<ul>
  <li> -help: displays a help message
  <li> -verify: run the decoder without actual decoding (verification mode)
  <li> -verbose: log verbosity level
       <ul>
	 <li> NONE: output the number of files processed 
	 <li> BRIEF: output also names of the files processed
	 <li> DETAILED: output also hypotheses, scores and frames number 
       </ul>
  <li> -debug_level: debugging information level (default NONE)

       <br><br>

  <li> -param: set the parameter file for the decoder
  <li> -list: file containing input file list in Sof format (signal database)

       <br><br>
  <li> -stream: process input from stdin rather than from file

  <li> -base: identifier for hypotheses. Required if -stream is specified, and no -list is provided.

  <li> -output_mode: output mode specification
      
<ul>
	 <li> FILE: output hypotheses to single output file, specified by "-output_file" option
	 <li> LIST: output hypotheses to files, output file list is
specified by "-output_list" option
	 <li> TRANSFORM: output hypotheses to the existing directory specified by "-output_dir" while preserving N directories of the input file names (N is specified by "-dir_pres_level" option)
       </ul>
  <li> -output_format: output file format
       <ul>
	 <li> NIST_SCORE: format compatible with NIST scoring tool "sclite"
	 <li> SOF: not implemented
       </ul>

       <br><br>
       
  <li> -output_file: output file name in FILE mode
  <li> -output_list: output files list in LIST mode
  <li> -output_dir: output directory in TRANSFORM mode
  <li> -dir_pres_level: number of directories to preserve in TRANSFORM mode

       <br><br>
  <li> -log_file: log file used instead of stdout
</ul>       

<a name="operands">
<b>operands:</b>

<ul>
  <li> file1.raw file2.sof ... : speech files (raw audio or Sof format feature files)
</ul>

<a name="examples">
<b>examples:</b>
<br><br>

<ul>
  <li> This example shows how to decode files specified in the input list "raw_list.sof", while output options are specified in the parameter file "param.sof":

<pre>
isip_recognize -p <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/param.sof">param.sof</a> -list <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/raw_list.sof">raw_list.sof</a></pre>

  <li> This example shows how to decode files specified in the input list, while output files are specified in the output list:

<pre>
isip_recognize -p <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/param.sof">param.sof</a> -list <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/raw_list.sof">raw_list.sof</a> -output_mode LIST -output_list <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/out_list.sof">out_list.sof</a></pre>

  <li> This example shows how to decode files specified in the input list, while output files are determined by the input file names transformation:

<pre>
isip_recognize -p <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/param.sof">param.sof</a> -list <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/raw_list.sof">raw_list.sof</a> -output_mode TRANSFORM -output_dir ./output -dir_pres 2</pre>

</ul>
       
<a name="manuals">
<b>manuals:</b>
<br><br>

<ul>
  None.
</ul>
       
<a name="languages">
<b>languages:</b>
<br><br>

<ul>
  This utility is written entirely in C++.
</ul>
       
<a name="variables">
<b>environment variables:</b>
<br><br>

<ul>
  None.
</ul>

<a name="files">
<b>files:</b>
<br><br>

<ul>
  <li> <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/isip_recognize.h">./isip_recognize.h</a>: header file

       <br><br>

  <li> <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/usage_message.text">./usage_message.text</a>: ussage message

       <br><br>

  <li> <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_recognize/help_message.text">./help_message.text</a>: help message
</ul>
       
<a name="see_also">
<b>see also:</b>
<br><br>

<ul>
  <a href="../isip_transform/index.html">isip_transform</a>
</ul>

<a name="notes">
<b>notes:</b>
<br><br>

<ul>
Command line options always override parameter file values.
</ul>

<!--#include virtual="/hse/ies/templates/documentation/footer/footer.html" -->
