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

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

<br><br>

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

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

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

<blockquote>
<pre>
isip_transform -help;
isip_transform -param param.sof
isip_transform -param param.sof file1.sof file2.sof file3.sof ...
isip_transform -param param.sof -list list.sof
</pre>
</blockquote>

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

<ul>
  The primary use of this utility is to transform a speech signal into a
  a sequence of vectors. These vectors can be used as input to a

  <a href="../../../class/asr/SpeechRecognizer/index.html">
  speech recognizer</a>.

  In fact, the speech recognizer embeds this transformation capability
  in the recognizer, so audio data as well as features can be supplied
  as input to the recognizer. Both interfaces are controlled by a

  <a href="../../../class/sp/Recipe/index.html">recipe</a>

  that describes signal processing algorithms via a block diagram
  representation. Recipes can be created and modified using

  <a href="../isip_transform_builder/index.html">isip_transform_builder</a>.

  <br><br>

  This utility is capable of much more than feature generation.
  Recipes can be configured to generate signals, mix signals,
  and process data through multiple passes of algorithms.
  This utility is based on the

  <a href="../../../class/sp/FrontEnd/index.html">FrontEnd</a>

  class, and simply provides a command line interface to a large
  variety of DSP capabilities implented in our signal processing
  libraries. An extended tutorial on using this utility can be
  found in

  <a href="/projects/speech/software/tutorials/production/fundamentals/current/section_03"
  target="_top">Section 3</a>

  of our on-line

  <a href="/projects/speech/software/tutorials/production/fundamentals/current/"
  target="_top">speech recognition tutorial</a>.

  <br><br>

  <i>Isip_transform</i> is best viewed as a utility that implements
  a user-specified transformation on an input, and outputs 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 parameter file can be either a single recipe (created
  by isip_transform_builder) or a list of recipes. For the latter
  case, the parameter file is actually an
  
  <a href="../../../class/shell/Sdb/index.html">Sdb</a>

  file containing a sequence of recipes. Each input file
  is processing through this list of recipes. This feature is
  extremely useful for algorithms that require multi-pass processing
  (e.g., removal of bias from a signal).
</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> type: text or binary (default = text)

       <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>
  An extended tutorial on using this utility can be
  found in

  <a href="/projects/speech/software/tutorials/production/fundamentals/current/section_03"
  target="_top">Section 3</a>

  of our on-line

  <a href="/projects/speech/software/tutorials/production/fundamentals/current/"
  target="_top">speech recognition tutorial</a>.

  Below we provide a couple of simple examples to demonstrate
  the command line interface.
</ul>

<ul>
  <li> This example shows how to generate features using a list of
       files as input:

<pre>
isip_transform -param params.sof -list list.sof</pre>

       The parameter file can be created and modified using

       <a href="../isip_transform_builder/index.html">
       isip_transform_builder</a>.

       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_transform -param params.sof -directory tmp -list list.sof</pre>

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

<pre>
isip_transform -param params.sof -directory tmp -suffix "_new" -extension "sofx" -type text foo.sof</pre>

       In this case, a file "$PWD/tmp/foo_new.sofx" will be created.
       Because the "-type" option is used, the output file will be
       a text Sof file (and can be read as a text file).
</ul>
       
<a name="manuals">
<b>manuals:</b>
<br><br>

<ul>
  <a href="/projects/speech/software/tutorials/production/fundamentals/current/"
  target="_top">
  Feature Extraction</a>:

  an extended tutorial on how to use this utility
  in conjunction with <i>isip_transform_builder</i> to create
  standard and customized front ends.
</ul>
       
<a name="languages">
<b>languages:</b>
<br><br>

<ul>
  This utility is written entirely in C++.
  The configuration tool,

    <a href="../isip_transform_builder/index.html">isip_transform_builder</a>

  is written in Java.
</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_transform/isip_transform.h">./isip_transform.h</a>: header file

       <br><br>

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

       <br><br>

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