doc/localhost/ALE/download/ale-0.7.x-user/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4   <title>ALE 0.7.x User Manual</title>
   5   <style type="text/css">
   6   TABLE.ba { max-width: 678; text-align: center; padding-bottom: 15; padding-top: 5}
   7   TABLE.inline { padding-right: 300; clear: left}
   8   TD.text_table {padding-left: 2; padding-right: 2; border-width: 1}
   9   H2 {clear: left}
  10   P {max-width: none; padding-right: 300; clear: left}
  11   BLOCKQUOTE {padding-right: 400 }
  12   LI {max-width: 640; clear: left}
  13   P.footer {max-width: none; width: auto; padding-left: 0}
  14   P.header {max-width: none; width: auto; padding-left: 0}
  15   HR.main {max-width: 640; clear: left; padding-left: 0; margin-left: 0}
  16   HR.footer {clear: both}
  17 </style>
  18
  19 </head>
  20 <body>
  21
  22
  23
  24
  25
  26
  27 <table align=right valign=top width=160>
  28 <td valign=top height=600 width=160>
  29 <a href="http://auricle.dyndns.org/ALE/">
  30 <big>ALE</big>
  31 <br>
  32 Image Processing Software
  33 <br>
  34 <br>
  35 <small>Deblurring, Anti-aliasing, and Superresolution.</small></a>
  36 <br><br>
  37 <big>
  38 Local Operation
  39 </big>
  40 <hr>
  41 localhost<br>
  42 2684415918<br>
  43 </table>
  44
  45
  46
  47
  48 <p><b>[ <a href="../../user/">Up</a> ]</b></p>
  49 <h1>ALE 0.7.x User Manual</h1>
  50
  51 <h2>Purpose</h2>
  52
  53 <p>This page summarizes program operation and command-line usage for ALE
  54 versions 0.7.0, 0.7.0-patch1, 0.7.1, 0.7.1-patch1, 0.7.1-patch2, and 0.7.2.
  55 Features specific to a particular version are annotated (e.g. [ALE 0.7.1
  56 only]).
  57
  58 <p>Manual pages linked from this section describe <a href="defaults/">default
  59 settings</a>, <a href="file/">file output</a>, <a
  60 href="alignment/">alignment</a>, <a href="rendering/">rendering</a>, <a
  61 href="exclusion/">exclusion regions</a>, <a href="device/">devices</a>, and
  62 <a href="3d/">3D scene reconstruction</a> (Very experimental; ALE 0.7.2 and
  63 later).
  64
  65 <p>For more information on ALE, see the <a
  66 href="http://auricle.dyndns.org/ALE/">ALE Home Page</a>.
  67
  68 <h2>Parameter Meta-syntax</h2>
  69
  70 <table>
  71 <tr>
  72 <td><code>&nbsp;&lt;foo></code></td>
  73 <td>A required parameter called <i>foo</i>.</td>
  74 </tr>
  75 <tr>
  76 <td><code>[&lt;foo>]</code></td>
  77 <td>An optional parameter called <i>foo</i>.
  78 </tr>
  79 <tr>
  80 <td><code>[&lt;foo>]*</code></td>
  81 <td>Zero or more parameters <i>foo</i>.
  82 </tr>
  83 </table>
  84
  85 <h2>Command-line syntax for Image Processing</h2>
  86
  87 <p>The following command-line invocation can be used to process a series of
  88 frames into an output file:
  89
  90 <pre>ale [&lt;option>]* &lt;original-frame> [&lt;supplemental-frame>]* &lt;output-file></pre>
  91
  92 <h3>Option Arguments</h3>
  93
  94 <p>Certain basic modes of operation, emphasizing image quality, speed, or other
  95 rendering characteristics, are now established in the form of <a
  96 href="defaults/">default settings</a>.
  97
  98 <p>Other options are outlined in the manual pages describing <a
  99 href="file/">file output</a>, <a href="rendering/">rendering</a>, <a
 100 href="alignment/">alignment</a>, <a href="exclusion/">exclusion
 101 regions</a>, <a href="device/">devices</a>, and <a href="3d/">3D scene
 102 reconstruction</a> (Very experimental; ALE 0.7.2 and later).
 103
 104 <h3>Image Files</h3>
 105
 106 <p>ALE can be configured at compile time to use one of two different file
 107 handlers.  Execute 'ale --version' to determine which file handler is being
 108 used.  The table below outlines the supported formats for each file handler.</p>
 109
 110 <table class="inline">
 111 <td>
 112 <table border>
 113 <tr><th>Version Message</th><th>File Types Supported</th></tr>
 114 <tr><td valign=top>
 115 <pre>File handler:     ImageMagick</pre>
 116 </td>
 117
 118 <td>
 119 Input and output files can be any of the <a
 120 href="http://imagemagick.sourceforge.net/www/formats.html">formats</a> supported by
 121 ImageMagick.
 122 </td></tr>
 123
 124 <tr><td valign=top>
 125 <pre>File handler:     PPM</pre>
 126 <td>
 127 Input files must be PPM, and output files are written as PPM.
 128 </td></tr>
 129 </table>
 130 </table>
 131
 132 <p>Note that many external programs, including ImageMagick's <a
 133 href="http://www.imagemagick.org/">command line utilities</a>, can be used to
 134 convert between PPM and other formats.</p>
 135
 136 <p>See the README included in the source distribution of ALE for more information about
 137 compile-time configuration of file handlers.</p>
 138
 139 <h2>Command-line syntax for Version Information</h2>
 140
 141 <p>The following command-line invocation can be used to print version
 142 information and build options:
 143
 144 <pre>ale --version</pre>
 145
 146 The following is sample output from this invocation:
 147
 148 <pre>
 149 ALE Version:      0.7.2
 150 File handler:     ImageMagick
 151 Color data:       SINGLE
 152 Coordinate data:  SINGLE
 153 DFT:              Built-in
 154 Assertions:       Disabled
 155 </pre>
 156
 157 <p>The first line of output indicates the version of ALE source code being
 158 used; the remaining lines reflect the build options selected at compile
 159 time.
 160
 161 <p>For more information about build options, see the README file included in
 162 the ALE source distribution.
 163
 164 <h2>Command-line syntax for Help Output</h2>
 165
 166 <p>When invoked with no arguments, or an insufficient number of file arguments,
 167 ALE outputs a help message specifying command-line usage and available help
 168 topics.  The following is a sample invocation:
 169
 170 <pre>ale</pre>
 171
 172 <h3>Help Topics</h3>
 173
 174 More information about specific help topics can be obtained with an invocation
 175 of the following form:
 176
 177 <pre>ale &lt;help option&gt;</pre>
 178
 179 Available help options, and their corresponding help topics, are outlined
 180 below:
 181
 182 <pre>
 183 --hu              Usage.
 184 --hq              Default settings.
 185 --hf              Image files.
 186 --he              Exclusion regions.
 187 --ha              Alignment (not exposure-related).
 188 --hr              Rendering (not exposure-related).
 189 --hx              Exposure.
 190 --ht              Transformation data files.
 191 --hl              Filtering (PSFs, rendering chains).
 192 --hd              Devices.
 193 --hv              Video stream processing (Experimental).
 194 --h3              3D Modeling (Very Experimental).  [ALE 0.7.2 and later]
 195 --hz              Undocumented options.
 196 --hA              Concatenate all help pages.  [ALE 0.7.1 and later]
 197 </pre>
 198
 199 <h2>Related Manual Pages</h2>
 200
 201 <ul>
 202 <li><a href="defaults/">Default Settings</a>
 203 <li><a href="file/">File Output</a>
 204 <li><a href="rendering/">Rendering</a>
 205 <li><a href="alignment/">Alignment</a>
 206 <li><a href="exclusion/">Exclusion Regions</a>
 207 <li><a href="device/">Devices</a>
 208 <li><a href="3d/">3D Modeling</a> [ALE 0.7.2 and later]
 209 </ul>
 210
 211 <br>
 212 <hr>
 213 <i>Copyright 2003, 2004 <a href="mailto:dhilvert@auricle.dyndns.org">David Hilvert</a></i>
 214 <p class="footer">Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.
 215 </body>
 216 </html>