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