initial commit
This commit is contained in:
Mauro Torrez
115
doc/man/ale.1
Normal file
115
doc/man/ale.1
Normal file
@@ -0,0 +1,115 @@
|
||||
.\" Title: ale
|
||||
.\" Author:
|
||||
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
|
||||
.\" Date: 03/31/2009
|
||||
.\" Manual:
|
||||
.\" Source:
|
||||
.\"
|
||||
.TH "ALE" "1" "03/31/2009" "" ""
|
||||
.\" disable hyphenation
|
||||
.nh
|
||||
.\" disable justification (adjust text to left margin only)
|
||||
.ad l
|
||||
.SH "NAME"
|
||||
ale \- a synthetic capture engine and renderer
|
||||
.SH "SYNOPSIS"
|
||||
\fBale\fR [\fIOPTIONS\fR] \fIoriginal\-frame\fR [\fIsupplemental\-frames\fR \&...] \fIoutput\-file\fR
|
||||
.sp
|
||||
\fBale\fR [\fIHELP OPTIONS\fR]
|
||||
.sp
|
||||
\fBale \-\-version\fR
|
||||
.sp
|
||||
.SH "DESCRIPTION"
|
||||
\fBALE\fR is a free software synthetic capture engine and renderer accepting, as input, a sequence of image frames, and producing, as output, rendered images, registration data, and 3D models (currently experimental)\&.
|
||||
.sp
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
\fBale \-\-hu\fR
|
||||
.RS 4
|
||||
Print the help page on program usage\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBale 001\&.ppm 002\&.ppm 003\&.ppm out\&.ppm\fR
|
||||
.RS 4
|
||||
Render output file
|
||||
\fBout\&.ppm\fR
|
||||
from inputs
|
||||
\fB001\&.ppm\fR,
|
||||
\fB002\&.ppm\fR, and
|
||||
\fB003\&.ppm\fR\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBale \-\-scale 2 001\&.ppm 002\&.ppm 003\&.ppm out\&.png\fR
|
||||
.RS 4
|
||||
Render output file
|
||||
\fBout\&.png\fR
|
||||
at 2x scale\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBale \-\-perturb\-upper=0 \-\-trans\-load=a\&.t \-\-projective frame*\&.png out\&.png\fR
|
||||
.RS 4
|
||||
Render output file
|
||||
\fBout\&.png\fR
|
||||
from inputs
|
||||
\fBframe*\&.png\fR, using projective transformations as described in the file
|
||||
\fBa\&.t\fR\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBale \-\-3dv 0 out\&.png \-\-projective frame*\&.png null:\fR
|
||||
.RS 4
|
||||
Render output file
|
||||
\fBout\&.png\fR
|
||||
from inputs
|
||||
\fBframe*\&.png\fR, using a 3D scene model to determine transformations\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBale \-\-visp last:sinc*lanc:6 sf:0 out/ \&.jpg in/*\&.jpg null:\fR
|
||||
.RS 4
|
||||
Render a video stream from files
|
||||
\fBin/*\&.jpg\fR
|
||||
to the directory
|
||||
\fBout/\fR, stabilizing to the first frame, with a lanczos\-windowed sinc filter\&.
|
||||
.RE
|
||||
.SH "USAGE"
|
||||
\fBale\fR is a wrapper script that calls the executable \fBale\-bin\fR after extracting exposure EXIF information from image files (when the \fBexiftool\fR utility is available) and converting from raw formats (when the \fBdcraw\fR utility is available)\&.
|
||||
.sp
|
||||
When \fBale\-bin\fR has been linked with ImageMagick, input and output files may be of any kind supported by ImageMagick\&. Otherwise, only PPM files can be read and written by \fBale\-bin\fR\&.
|
||||
.sp
|
||||
.SH "OPTIONS"
|
||||
\fIOPTIONS\fR are summarized via built\-in help pages (see \fBHELP OPTIONS\fR below)\&. More detailed manuals describing options and internal algorithms are available for certain versions of ALE\&. See \fBSEE ALSO\fR below for more details on other manuals\&.
|
||||
.sp
|
||||
.SH "HELP OPTIONS"
|
||||
A listing of available help options can be obtained by invoking \fBale \-\-hu\fR\&.
|
||||
.sp
|
||||
.SH "ENVIRONMENT"
|
||||
The wrapper script \fBale\fR recognizes the following environment variables:
|
||||
.PP
|
||||
\fBALE_BIN\fR
|
||||
.RS 4
|
||||
ALE executable to use\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBDCRAW\fR
|
||||
.RS 4
|
||||
dcraw raw extraction tool to use\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBEXIF_UTILITY\fR
|
||||
.RS 4
|
||||
EXIF extraction utility to use\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBALE_COUNT_THREADS\fR
|
||||
.RS 4
|
||||
Displays statistics on thread counts when set to a non\-zero value\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBPAGER\fR
|
||||
.RS 4
|
||||
Text pager to use (e\&.g\&., for displaying help pages)\&.
|
||||
.RE
|
||||
.SH "SEE ALSO"
|
||||
More detailed manuals for certain versions of ALE are distributed with source packages, and may also be available from:
|
||||
.sp
|
||||
http://auricle\&.dyndns\&.org/ALE/manuals/
|
||||
.sp
|
||||
93
doc/man/ale.1.txt
Normal file
93
doc/man/ale.1.txt
Normal file
@@ -0,0 +1,93 @@
|
||||
ALE(1)
|
||||
======
|
||||
David Hilvert <dhilvert@gmail.com>
|
||||
|
||||
NAME
|
||||
----
|
||||
ale - a synthetic capture engine and renderer
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
*ale* ['OPTIONS'] 'original-frame' ['supplemental-frames' ...] 'output-file'
|
||||
|
||||
*ale* ['HELP OPTIONS']
|
||||
|
||||
*ale --version*
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
*ALE* is a free software synthetic capture engine and renderer accepting, as
|
||||
input, a sequence of image frames, and producing, as output, rendered images,
|
||||
registration data, and 3D models (currently experimental).
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
*ale --hu*::
|
||||
Print the help page on program usage.
|
||||
|
||||
*ale 001.ppm 002.ppm 003.ppm out.ppm*::
|
||||
Render output file *out.ppm* from inputs *001.ppm*, *002.ppm*, and
|
||||
*003.ppm*.
|
||||
|
||||
**ale --scale 2 001.ppm 002.ppm 003.ppm out.png**::
|
||||
Render output file *out.png* at 2x scale.
|
||||
|
||||
**ale --perturb-upper=0 --trans-load=a.t --projective frame*.png out.png**::
|
||||
Render output file *out.png* from inputs **frame*.png**, using
|
||||
projective transformations as described in the file *a.t*.
|
||||
|
||||
**ale --3dv 0 out.png --projective frame*.png null:**::
|
||||
Render output file *out.png* from inputs **frame*.png**, using a
|
||||
3D scene model to determine transformations.
|
||||
|
||||
**ale --visp last:sinc*lanc:6 sf:0 out/ .jpg in/*.jpg null:**::
|
||||
Render a video stream from files **in/\*.jpg** to the directory **out/**,
|
||||
stabilizing to the first frame, with a lanczos-windowed sinc filter.
|
||||
|
||||
USAGE
|
||||
-----
|
||||
*ale* is a wrapper script that calls the executable *ale-bin* after extracting
|
||||
exposure EXIF information from image files (when the *exiftool* utility is
|
||||
available) and converting from raw formats (when the *dcraw* utility is
|
||||
available).
|
||||
|
||||
When *ale-bin* has been linked with ImageMagick, input and output files may be
|
||||
of any kind supported by ImageMagick. Otherwise, only PPM files can be read
|
||||
and written by *ale-bin*.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
'OPTIONS' are summarized via built-in help pages (see *HELP OPTIONS* below).
|
||||
More detailed manuals describing options and internal algorithms are available
|
||||
for certain versions of ALE. See *SEE ALSO* below for more details on other
|
||||
manuals.
|
||||
|
||||
HELP OPTIONS
|
||||
------------
|
||||
A listing of available help options can be obtained by invoking *ale --hu*.
|
||||
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
The wrapper script *ale* recognizes the following environment variables:
|
||||
|
||||
*ALE_BIN*::
|
||||
ALE executable to use.
|
||||
|
||||
*DCRAW*::
|
||||
dcraw raw extraction tool to use.
|
||||
|
||||
*EXIF_UTILITY*::
|
||||
EXIF extraction utility to use.
|
||||
|
||||
*ALE_COUNT_THREADS*::
|
||||
Displays statistics on thread counts when set to a non-zero value.
|
||||
|
||||
*PAGER*::
|
||||
Text pager to use (e.g., for displaying help pages).
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
More detailed manuals for certain versions of ALE are distributed with source
|
||||
packages, and may also be available from:
|
||||
|
||||
http://auricle.dyndns.org/ALE/manuals/[]
|
||||
186
doc/man/ale.1.xml
Normal file
186
doc/man/ale.1.xml
Normal file
@@ -0,0 +1,186 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
<refentry lang="en">
|
||||
<refmeta>
|
||||
<refentrytitle>ale</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>ale</refname>
|
||||
<refpurpose>a synthetic capture engine and renderer</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
<simpara><emphasis role="strong">ale</emphasis> [<emphasis>OPTIONS</emphasis>] <emphasis>original-frame</emphasis> [<emphasis>supplemental-frames</emphasis> …] <emphasis>output-file</emphasis></simpara>
|
||||
|
||||
<simpara><emphasis role="strong">ale</emphasis> [<emphasis>HELP OPTIONS</emphasis>]</simpara>
|
||||
|
||||
<simpara><emphasis role="strong">ale --version</emphasis></simpara>
|
||||
|
||||
</refsynopsisdiv>
|
||||
<refsect1 id="_description">
|
||||
<title>DESCRIPTION</title>
|
||||
<simpara><emphasis role="strong">ALE</emphasis> is a free software synthetic capture engine and renderer accepting, as
|
||||
input, a sequence of image frames, and producing, as output, rendered images,
|
||||
registration data, and 3D models (currently experimental).</simpara>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 id="_examples">
|
||||
<title>EXAMPLES</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">ale --hu</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Print the help page on program usage.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">ale 001.ppm 002.ppm 003.ppm out.ppm</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Render output file <emphasis role="strong">out.ppm</emphasis> from inputs <emphasis role="strong">001.ppm</emphasis>, <emphasis role="strong">002.ppm</emphasis>, and
|
||||
<emphasis role="strong">003.ppm</emphasis>.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">ale --scale 2 001.ppm 002.ppm 003.ppm out.png</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Render output file <emphasis role="strong">out.png</emphasis> at 2x scale.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">ale --perturb-upper=0 --trans-load=a.t --projective frame*.png out.png</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Render output file <emphasis role="strong">out.png</emphasis> from inputs <emphasis role="strong">frame*.png</emphasis>, using
|
||||
projective transformations as described in the file <emphasis role="strong">a.t</emphasis>.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">ale --3dv 0 out.png --projective frame*.png null:</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Render output file <emphasis role="strong">out.png</emphasis> from inputs <emphasis role="strong">frame*.png</emphasis>, using a
|
||||
3D scene model to determine transformations.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">ale --visp last:sinc*lanc:6 sf:0 out/ .jpg in/*.jpg null:</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Render a video stream from files <emphasis role="strong">in/*.jpg</emphasis> to the directory <emphasis role="strong">out/</emphasis>,
|
||||
stabilizing to the first frame, with a lanczos-windowed sinc filter.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1 id="_usage">
|
||||
<title>USAGE</title>
|
||||
<simpara><emphasis role="strong">ale</emphasis> is a wrapper script that calls the executable <emphasis role="strong">ale-bin</emphasis> after extracting
|
||||
exposure EXIF information from image files (when the <emphasis role="strong">exiftool</emphasis> utility is
|
||||
available) and converting from raw formats (when the <emphasis role="strong">dcraw</emphasis> utility is
|
||||
available).</simpara>
|
||||
|
||||
<simpara>When <emphasis role="strong">ale-bin</emphasis> has been linked with ImageMagick, input and output files may be
|
||||
of any kind supported by ImageMagick. Otherwise, only PPM files can be read
|
||||
and written by <emphasis role="strong">ale-bin</emphasis>.</simpara>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 id="_options">
|
||||
<title>OPTIONS</title>
|
||||
<simpara><emphasis>OPTIONS</emphasis> are summarized via built-in help pages (see <emphasis role="strong">HELP OPTIONS</emphasis> below).
|
||||
More detailed manuals describing options and internal algorithms are available
|
||||
for certain versions of ALE. See <emphasis role="strong">SEE ALSO</emphasis> below for more details on other
|
||||
manuals.</simpara>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 id="_help_options">
|
||||
<title>HELP OPTIONS</title>
|
||||
<simpara>A listing of available help options can be obtained by invoking <emphasis role="strong">ale --hu</emphasis>.</simpara>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 id="_environment">
|
||||
<title>ENVIRONMENT</title>
|
||||
<simpara>The wrapper script <emphasis role="strong">ale</emphasis> recognizes the following environment variables:</simpara>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">ALE_BIN</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
ALE executable to use.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">DCRAW</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
dcraw raw extraction tool to use.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">EXIF_UTILITY</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
EXIF extraction utility to use.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">ALE_COUNT_THREADS</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Displays statistics on thread counts when set to a non-zero value.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<emphasis role="strong">PAGER</emphasis>
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Text pager to use (e.g., for displaying help pages).
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1 id="_see_also">
|
||||
<title>SEE ALSO</title>
|
||||
<simpara>More detailed manuals for certain versions of ALE are distributed with source
|
||||
packages, and may also be available from:</simpara>
|
||||
|
||||
<simpara><ulink url="http://auricle.dyndns.org/ALE/manuals/">http://auricle.dyndns.org/ALE/manuals/</ulink></simpara>
|
||||
|
||||
</refsect1>
|
||||
</refentry>
|
||||
Reference in New Issue
Block a user