doc/tutorial/index.xml

   1 <?xml version="1.0"?>
   2
   3 <!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN"
   4         "file:///usr/local/share/docbook2X/dtd/Texi-XML">
   5
   6 <book xmlns:xi="http://www.w3.org/2001/XInclude">
   7 <bookinfo>
   8   <title>
   9     Tutorial
  10   </title>
  11 </bookinfo>
  12 <chapter><title>Introduction</title>
  13 <section><title>Purpose (foobar)</title>
  14
  15 <para>This page summarizes program operation and command-line usage for ALE
  16 versions 0.8.0 through 0.8.4.  Features specific to a particular version
  17 are annotated (e.g.  [ALE 0.8.1 and later]).</para>
  18
  19 <para>Manual pages linked from this section describe <a href="defaults/">default
  20 settings</a>, <a href="file/">file output</a>, <a
  21 href="alignment/">alignment</a>, <a href="rendering/">rendering</a>, <a
  22 href="exclusion/">exclusion regions</a>, <a href="cp/">control points</a>, <a href="ui/">user interfaces</a>, <a
  23 href="device/">devices</a>, and <a href="3d/">3D scene reconstruction</a>.</para>
  24
  25 <para>For more information on ALE, see the <a
  26 href="http://auricle.dyndns.org/ALE/">ALE Home Page</a>.</para>
  27
  28 </section>
  29 <section><title>Parameter Meta-syntax</title>
  30
  31 <table>
  32 <tr>
  33 <td><code>&lt;foo></code></td>
  34 <td>A required parameter called <i>foo</i>.</td>
  35 </tr>
  36 <tr>
  37 <td><code>[&lt;foo>]</code></td>
  38 <td>An optional parameter called <i>foo</i>.</td>
  39 </tr>
  40 <tr>
  41 <td><code>[&lt;foo>]*</code></td>
  42 <td>Zero or more parameters <i>foo</i>.</td>
  43 </tr>
  44 </table>
  45
  46 </section>
  47 <section><title>Command-line syntax for Image Processing</title>
  48
  49 <para>The following command-line invocation can be used to process a series of
  50 frames into an output file:</para>
  51
  52 <pre>ale [&lt;option>]* &lt;original-frame> [&lt;supplemental-frame>]* &lt;output-file></pre>
  53
  54 <h3>Option Arguments</h3>
  55
  56 <para>Certain basic modes of operation, emphasizing image quality, speed, or other
  57 rendering characteristics, are now established in the form of <a
  58 href="defaults/">default settings</a>.</para>
  59
  60 <para>Other options are outlined in the manual pages describing <a
  61 href="file/">file output</a>, <a href="rendering/">rendering</a>, <a
  62 href="alignment/">alignment</a>, <a href="exclusion/">exclusion
  63 regions</a>, <a href="device/">devices</a>, <a href="ui/">user interfaces</a>,
  64 and <a href="3d/">3D scene reconstruction</a>.</para>
  65
  66 <h3>Image Files</h3>
  67
  68 <para>ALE can be configured at compile time to use one of two different file
  69 handlers.  Execute 'ale --version' to determine which file handler is being
  70 used.  The table below outlines the supported formats for each file handler.</para>
  71
  72 <table class="inline">
  73 <td>
  74 <table border="1">
  75 <tr><th>Version Message</th><th>File Types Supported</th></tr>
  76 <tr><td valign="top">
  77 <pre>File handler:     ImageMagick</pre>
  78 </td>
  79
  80 <td>
  81 Input and output files can be any of the <a
  82 href="http://imagemagick.sourceforge.net/www/formats.html">formats</a> supported by
  83 ImageMagick.
  84 </td></tr>
  85
  86 <tr><td valign="top">
  87 <pre>File handler:     PPM</pre>
  88 </td><td>
  89 Input files must be PPM, and output files are written as PPM.
  90 </td></tr>
  91 </table>
  92 </td>
  93 </table>
  94
  95 <para>Note that many external programs, including ImageMagick's <a
  96 href="http://www.imagemagick.org/">command line utilities</a>, can be used to
  97 convert between PPM and other formats.</para>
  98
  99 <para>See the README included in the source distribution of ALE for more information about
 100 compile-time configuration of file handlers.</para>
 101
 102 </section>
 103 <section>
 104 <title>Command-line syntax for Version Information</title>
 105
 106 <para>The following command-line invocation can be used to print version
 107 information and build options:</para>
 108
 109 <pre>ale --version</pre>
 110
 111 <para>The following is sample output from this invocation:</para>
 112
 113 <pre>
 114 ALE Version:      0.8.4
 115 File handler:     ImageMagick
 116 Color data:       SINGLE
 117 Coordinate data:  SINGLE
 118 DFT:              FFTW3
 119 Assertions:       Enabled
 120 Optimizations:    Enabled
 121 </pre>
 122
 123 <para>The first line of output indicates the version of ALE source code being
 124 used; the remaining lines reflect the build options selected at compile
 125 time.</para>
 126
 127 <para>For more information about build options, see the README file included in
 128 the ALE source distribution.</para>
 129
 130 </section>
 131 <section>
 132 <title>Command-line syntax for Help Output</title>
 133
 134 <para>When invoked with no arguments, or an insufficient number of file arguments,
 135 ALE outputs a help message specifying command-line usage and available help
 136 topics.  The following is a sample invocation:</para>
 137
 138 <pre>ale</pre>
 139
 140 <h3>Help Topics</h3>
 141
 142 <para>More information about specific help topics can be obtained with an invocation
 143 of the following form:</para>
 144
 145 <pre>ale &lt;help option&gt;</pre>
 146
 147 <para>Available help options, and their corresponding help topics, are outlined
 148 below:</para>
 149
 150 <pre>
 151 --hu              Usage.
 152 --hq              Default settings.
 153 --hf              Image files.
 154 --he              Exclusion regions.
 155 --ha              Alignment (not exposure-related).
 156 --hr              Rendering (not exposure-related).
 157 --hx              Exposure.
 158 --ht              Transformation data files.
 159 --hc              Control points.  [0.8.1 and later]
 160 --hl              Filtering (PSFs, rendering chains).
 161 --hd              Devices.
 162 --hi              User Interfaces.
 163 --hv              Video stream processing (Experimental).
 164 --h3              3D Modeling.
 165 --hz              Undocumented options.
 166 --hA              Concatenate all help pages.
 167 </pre>
 168
 169 </section>
 170 <section>
 171 <title>Related Manual Pages</title>
 172 <ul>
 173 <li><a href="defaults/">Default Settings</a></li>
 174 <li><a href="file/">File Output</a></li>
 175 <li><a href="rendering/">Rendering</a></li>
 176 <li><a href="alignment/">Alignment</a></li>
 177 <li><a href="exclusion/">Exclusion Regions</a></li>
 178 <li><a href="cp/">Control Points (0.8.1 and later)</a></li>
 179 <li><a href="device/">Devices</a></li>
 180 <li><a href="ui/">User Interfaces</a></li>
 181 <li><a href="3d/">3D Scene Reconstruction</a></li>
 182 </ul>
 183
 184 </section>
 185
 186 <br/>
 187 <hr/>
 188 <i>Copyright 2003, 2004, 2005, 2006 <a href="mailto:dhilvert@auricle.dyndns.org">David Hilvert</a></i>
 189 <para class="footer">Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.</para>
 190 </chapter>
 191 </book>