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

<!--#set var="isip_page_title" value="isip_signal_detect" -->
<!--#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_signal_detect/isip_signal_detect.cc">isip_signal_detect</a>
</b>

<br><br>

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

<blockquote>
<pre>
isip_signal_detect -param param.sof -input_format wav [options] [files]
</pre>
</blockquote>

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

<blockquote>
<pre>
isip_signal_detect -help;
isip_signal_detect -param param.sof -input_format wav
isip_signal_detect -param param.sof -input_format wav file1.sof file2.sof file3.sof ...
isip_signal_detect -param param.sof -input_format wav -list list.sof
</pre>
</blockquote>

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

<ul>
 	Finds the endpoints for the input file and splits them into N output files based on the endpoints

  <a href="../../../class/sp/SignalDetector/index.html">
  signal detector</a>.

  The SignalDetector class performs endpoint detection and returns the
endpoints to the utility as a vector.

  <br><br>

  <i>isip_signal_detect</i> is best viewed as a utility that can be
  used to determine endpoints of a signal and chop it accordingly, and
  output data to a user-specified location. The command line arguments
  described below allow the user to control where the output data is written,
  and the amount of debugging information displayed.
  The parameters for this utility are specified in a parameter file.
  
</ul>

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

<ul>
  <li> directory: output directory (default = source directory)

       <br><br>

  <li> extension: new file extension (default = "sof")

       <br><br>

  <li> list: file containing input file list in Sdb format

       <br><br>

  <li> log_file: filename for console output (default is stdout).
       By default, status, debugging, and error messages
       are directed to stdout. However, this output can be redirected
       to a file by specifying this option with a filename.

       <br><br>

  <li> parameter_file: configures the data conversion. This parameter
       MUST be specified.

       <br><br>

  <li> preserve: number of levels from the old directory structure
       (from the bottom up) to preserve (default = 0)

       <br><br>

  <li> suffix: the suffix to be added to the existing filename
       (default = empty)

       <br><br>

  <li> input_type: text or binary (default = text)

       <br><br>

<li> output_type: text or binary (default = text)

       <br><br>

<li> input_format: raw, wav or sof (default = sof)

       <br><br>

<li> output_format: raw, wav or sof (default = sof)

       <br><br>

<li> segmentation_mode: signal_only, all (default = signal_only)

       <br><br>

  <li> verbosity: controls how much status information is displayed
       to the console
</ul>       

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

<ul>
  <li> file1.raw file2.raw ... : speech files (raw audio)
</ul>

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


<ul>
  <li> This example shows how to generate endpointed and chopped data
       using a list of wav files as input:

<pre>
isip_signal_detect -param params.sof -input_format wav -list list.sof</pre>
       
       The output files will be generated in the current directory
       with the same name as each input file on the list.
       The output directory can be changed using the output option:

<pre>
isip_signal_detect -param params.sof -input_format wav -directory tmp -list list.sof</pre>

  <li> This example shows how to change the name and location of an
       output file:

<pre>
isip_signal_detect -param params.sof -input_format wav -directory tmp -suffix "_new" -extension "sofx" -output_format sof -output_type text foo.sof</pre>

       In this case, a file "$PWD/tmp/foo_new.sofx" will be created.
       Because the "-output_type" option is used, the output file will be
       a text and it is a Sof file because the "-output_format" option is used.
</ul>
       
<a name="manuals">
<b>manuals:</b>
<br><br>

<ul>

  More details about the algorithm can be found in the following paper by  A. Ganapathiraju, L. Webster, J. Trimble, K. Bush and P. Kornman:
  <a href="http://www.isip.msstate.edu/publications/conferences/ieee_secon/1996/endpointer/paper.pdf">Comparison of Energy-Based Endpoint Detectors for Speech Signal Processing</a>.
</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_signal_detect/isip_signal_detect.h">./isip_signal_detect.h</a>: header file

       <br><br>

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

       <br><br>

  <li> <a href="/perl/ifc_document.pl?file=$isip/util/speech/isip_signal_detect/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>,
  <a href="../isip_make_sof/index.html">isip_make_sof</a>
</ul>

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

<ul>
  The parameters have to be tuned depending on the type of data (like quality, noise, silence durations etc..)
</ul>

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