?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Change --gs-mo default to 67%.
[Ale.git] / ui / help.h
blobf23b45d1b02b15864637e758994de8f121f690bf
1 // Copyright 2002, 2003, 2004 David Hilvert <dhilvert@auricle.dyndns.org>,
2 // <dhilvert@ugcs.caltech.edu>
3
4 /* This file is part of the Anti-Lamenessing Engine.
5
6 The Anti-Lamenessing Engine is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 The Anti-Lamenessing Engine is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with the Anti-Lamenessing Engine; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21 /*
22 * Help messages
23 */
24
25 #define BETWEEN_SECTIONS "\n"
26 #define HEADER_SPACE ""
27
28 class help {
29 private:
30 const char *package;
31 const char *version;
32 const char *invocation;
33 FILE *help_stream;
34
35 /*
36 * Stars
37 *
38 * This function produces a line of stars for banner output.
39 */
40 void stars(unsigned int n) {
41 for (unsigned int i = 0; i < n; i++) {
42 fprintf(help_stream, "*");
43 }
44 fprintf(help_stream, "\n");
45 }
46
47
48 /*
49 * Banner
50 *
51 * This function aids in locating the start of help output.
52 */
53 void banner(const char *name) {
54 const char *package_banner = " Help Text, version ";
55 const char *section_banner = "Section: ";
56
57 int plen = strlen(package) + strlen(package_banner) + strlen(version);
58 int slen = strlen(section_banner) + strlen(name);
59 int len = (plen > slen) ? plen : slen;
60
61 fprintf(help_stream, BETWEEN_SECTIONS);
62 stars(len);
63 fprintf(help_stream, "%s%s%s\n", package, package_banner, version);
64 fprintf(help_stream, "%s%s\n", section_banner, name);
65 stars(len);
66 }
67
68 public:
69 help(const char *package, const char *invocation, const char *version) {
70 this->invocation = invocation;
71 this->package = package;
72 this->version = version;
73 this->help_stream = stdout;
74 }
75
76 /*
77 * Describe how to use this program
78 */
79 void usage() {
80 banner("Usage");
81 fprintf(help_stream,
82 BETWEEN_SECTIONS
83 "Usage: %s [<options>] <original-frame> [<supplemental-frame> ...] <output-file>\n"
84 " or: %s [<help option> ...]\n"
85 " or: %s --version\n"
86 BETWEEN_SECTIONS
87 "Help options:\n"
88 HEADER_SPACE
89 "--hu Usage (this message).\n"
90 "--hq Default settings.\n"
91 "--hf Image files.\n"
92 "--he Exclusion regions.\n"
93 "--ha Alignment (not exposure-related).\n"
94 "--hr Rendering (not exposure-related).\n"
95 "--hx Exposure.\n"
96 "--ht Transformation data files.\n"
97 "--hc Control points.\n"
98 "--hl Filtering (PSFs, rendering chains).\n"
99 "--hd Devices.\n"
100 "--hi User Interfaces.\n"
101 "--hp Process details.\n"
102 "--hs Argument scope (Experimental).\n"
103 "--hv Video stream processing (Experimental).\n"
104 "--h3 3D Modeling (Experimental).\n"
105 "--hz Undocumented options.\n"
106 "--hA Concatenate all help pages.\n"
107 "\n",
108 invocation, invocation, invocation);
109 }
110
111 void defaults() {
112 banner("Defaults");
113 fprintf(help_stream,
114 BETWEEN_SECTIONS
115 "Default settings:\n"
116 HEADER_SPACE
117 "--q0 Low quality, high speed.\n"
118 "--q1 Moderate quality and speed.\n"
119 "--q2 High quality, low speed. [default]\n"
120 "--qn Low noise, moderate speed.\n"
121 BETWEEN_SECTIONS
122 "q0 defaults:\n"
123 HEADER_SPACE
124 " --dchain fine:triangle:2,triangle:2\n"
125 " --achain triangle:2\n"
126 " --ips 0\n"
127 " --3d-chain fine:triangle:2,triangle:2\n"
128 BETWEEN_SECTIONS
129 "q1 defaults:\n"
130 HEADER_SPACE
131 " --dchain fine:triangle:2,fine:gauss:0.75,triangle:2\n"
132 " --achain triangle:2\n"
133 " --ips 0\n"
134 " --3d-chain fine:triangle:2,fine:gauss:0.75,triangle:2\n"
135 BETWEEN_SECTIONS
136 "q2 defaults:\n"
137 HEADER_SPACE
138 " --dchain triangle:2\n"
139 " --achain triangle:2\n"
140 " --ips 4\n"
141 " --3d-chain fine:triangle:2,fine:gauss:0.75,triangle:2\n"
142 BETWEEN_SECTIONS
143 "Low noise defaults:\n"
144 HEADER_SPACE
145 " --dchain sinc*lanc:6\n"
146 " --achain sinc*lanc:6\n"
147 " --ips 0\n"
148 " --3d-chain sinc*lanc:6\n"
149 "\n"
150 );
151 }
152
153 void file() {
154 banner("File");
155 fprintf(help_stream,
156 BETWEEN_SECTIONS
157 "Bit depth options:\n"
158 HEADER_SPACE
159 "--8bpc Write 8 bit per channel output [default]\n"
160 "--16bpc Write 16 bit per channel output\n"
161 BETWEEN_SECTIONS
162 "Output format options:\n"
163 HEADER_SPACE
164 #ifdef USE_MAGICK
165 "--auto Determine output file type automatically [default]\n"
166 "--raw Write raw PPM output\n"
167 "--plain Write plain PPM output\n"
168 #else
169 "--raw Write raw PPM output [default]\n"
170 "--plain Write plain PPM output\n"
171 #endif
172 BETWEEN_SECTIONS
173 "Incremental output:\n"
174 HEADER_SPACE
175 "--inc Produce incremental output. [default]\n"
176 "--no-inc Don't produce incremental output.\n"
177
178 BETWEEN_SECTIONS
179 "Undefined values:\n"
180 HEADER_SPACE
181 "--def-nn <R> Use nearest-neighbor defined values within\n"
182 " radius <R>, zero outside. Default radius is 0.\n"
183 "\n"
184 );
185 }
186 void alignment() {
187 banner("Alignment");
188 fprintf(help_stream,
189 BETWEEN_SECTIONS
190 "Alignment channel options:\n"
191 HEADER_SPACE
192 "--align-all Align images using all color channels\n"
193 "--align-green Align images using the green channel\n"
194 "--align-sum Align images using a sum of channels [default]\n"
195 BETWEEN_SECTIONS
196 "Transformation options:\n"
197 HEADER_SPACE
198 "--translation Only adjust the position of images\n"
199 "--euclidean Adjust the position and orientation of images [default]\n"
200 "--projective Use projective transformations. Best quality, but slow.\n"
201 BETWEEN_SECTIONS
202 "Alignment following:\n"
203 HEADER_SPACE
204 "--follow Frames align closely with their predecessor. [default]\n"
205 "--identity Frames align closely with the original frame.\n"
206 BETWEEN_SECTIONS
207 "Alignment failure:\n"
208 HEADER_SPACE
209 "--fail-optimal Frames beneath threshold are aligned optimally. [default]\n"
210 "--fail-default Frames beneath threshold keep their default alignment.\n"
211 BETWEEN_SECTIONS
212 "Transformation file operations:\n"
213 HEADER_SPACE
214 "--trans-load <x> Load initial transformation settings from file <x>\n"
215 "--trans-save <x> Save final transformation data in file <x>\n"
216 BETWEEN_SECTIONS
217 "Monte Carlo alignment:\n"
218 HEADER_SPACE
219 "--mc <x> Statically sample ~x%% of available pixels (0 < x < 100)\n"
220 "--no-mc Statically sample all pixels.\n"
221 "--mcd Dynamically sample with robustness checks. [default]\n"
222 "--mcd-removal <x> Check robustness against removing x pixels. (100 is default)\n"
223 BETWEEN_SECTIONS
224 "Tunable parameters:\n"
225 HEADER_SPACE
226 "--metric=x Set the alignment error metric exponent. (2 is default)\n"
227 "--threshold=x Min. match threshold; a perfect match is 100. (0 is default)\n"
228 "--perturb-upper=x Perturbation upper bound pixels/arclength (14%% is default)\n"
229 " ('x%%' uses a fraction of the smallest image dimension.)\n"
230 "--perturb-lower=x Perturbation lower bound pixels/arclength (.125 is default)\n"
231 " ('x%%' uses a fraction of the smallest image dimension.)\n"
232 "--rot-upper=x Rotation-specific upper bound in degrees (32.0 is default)\n"
233 "--bda-mult=x Barrel distortion adjustment multiplier (2.0 is default)\n"
234 "--bda-rate=x Barrel distortion rate of change maximum (8.0 is default)\n"
235 "--lod-max=x LOD scale factor is max(1, (2^floor(x))/perturb) (1 is def.)\n"
236 BETWEEN_SECTIONS
237 "Certainty-weighted alignment:\n"
238 HEADER_SPACE
239 "--cw Weight alignment error by certainty.\n"
240 "--no-cw Don't weight alignment error by certainty. [default]\n"
241 BETWEEN_SECTIONS
242 "Alignment weight maps:\n"
243 HEADER_SPACE
244 "--wm <f> <x> <y> Use weight map image <f> at offset (<x>, <y>)\n"
245 BETWEEN_SECTIONS
246 "Frequency-weighted alignment:\n"
247 HEADER_SPACE
248 "--fl <h> <v> <a> High-pass filters: horizontal <h>, vertical <v>, average <a>.\n"
249 " Values should fall between 0 (pass all) and 1 (pass none).\n"
250 #ifndef USE_FFTW
251 "\n"
252 " NOTE: since this build of ALE does not link with FFTW,\n"
253 " this option is not supported. To use this option,\n"
254 " first re-build with FFTW support.\n"
255 "\n"
256 #endif
257 "--flshow <o> Write high-pass filtered data to file <o>.\n"
258 BETWEEN_SECTIONS
259 "Algorithmic alignment weighting:\n"
260 HEADER_SPACE
261 "--wmx <e> <r> <d> Write reference <r>, definition <d>, execute `<e> <f> <d>`,\n"
262 " read weights <r> back.\n"
263 #ifndef USE_UNIX
264 "\n"
265 " NOTE: since this build was not configured with\n"
266 " support for --wmx, this option is not supported.\n"
267 " To use this option, re-build with support for --wmx.\n"
268 #endif
269 BETWEEN_SECTIONS
270 "Perturbation Type [experimental]:\n"
271 HEADER_SPACE
272 "--perturb-output Apply perturbations in output image coordinates. [default]\n"
273 "--perturb-source Apply perturbations in source image coordinates.\n"
274 BETWEEN_SECTIONS
275 "Global searching:\n"
276 HEADER_SPACE
277 "--gs <type> Set global search to <type>, one of:\n"
278 " local Local alignment only\n"
279 " inner Alignment reference image inner region\n"
280 " outer Alignment reference image outer region\n"
281 " all Union of inner and outer [default]\n"
282 " central inner if below threshold or better; else, outer.\n"
283 " points Align by control points. Ignores gs-mo.\n"
284 "--gs-mo <x> Set <x> pixel min. overlap for global search. (67%% default)\n"
285 " ('x%%' uses a fraction of the smallest image dimension.)\n"
286 BETWEEN_SECTIONS
287 "Multi-alignment:\n"
288 HEADER_SPACE
289 "--ma-card <x> Maximum number of multi-alignment elements. (1 is default)\n"
290 "--ma-cont <x> Minimum contiguous area of each MA region. (100 is default)\n"
291 "\n"
292 );
293 }
294
295 void rendering() {
296 banner("Rendering");
297 fprintf(help_stream,
298 BETWEEN_SECTIONS
299 "Mimicking ALE 0.6.0 merging and drizzling (see --hl for details):\n"
300 HEADER_SPACE
301 " --dchain triangle:2 approximates merging.\n"
302 " --dchain fine:box:1 approximates drizzling.\n"
303 BETWEEN_SECTIONS
304 "Image extents:\n"
305 HEADER_SPACE
306 "--extend Increase image extents to accommodate all pixel data.\n"
307 "--no-extend Don't increase extents; crop to original frame. [default]\n"
308 BETWEEN_SECTIONS
309 "Tunable parameters:\n"
310 HEADER_SPACE
311 "--scale=x Scale images by the factor x, where x > 0. (1 is default)\n"
312 "--threshold=x Min. match threshold; a perfect match is 100. (0 is default)\n"
313 BETWEEN_SECTIONS
314 "Irani-Peleg iterative solver (see --hq for --ips defaults):\n"
315 HEADER_SPACE
316 "--ips <i> Run <i> iterations. (see also --hx, --hl and --hd)\n"
317 "--ip-mean Use the mean correction [default]\n"
318 "--ip-median Use the median correction\n"
319 "--ip-wl <x> Use weight limit <x>\n"
320 "--ip-nowl Use no weight limit [default]\n"
321 #if 0
322 BETWEEN_SECTIONS
323 "Unsharp Mask (was 'High-frequency Enhancement'):\n"
324 HEADER_SPACE
325 "--usm <m> Apply an unsharp mask with multiplier <m>.\n"
326 " (See also --device, --nlpsf, and --lpsf.)\n"
327 #endif
328 BETWEEN_SECTIONS
329 "Bayer pattern:\n"
330 HEADER_SPACE
331 "--bayer <b> Set the Bayer pattern to <b>, one of:\n"
332 " (clockwise from top left pixel)\n"
333 " rgbg Red-green-blue-green\n"
334 " gbgr Green-blue-green-red\n"
335 " grgb Green-red-green-blue\n"
336 " bgrg Blue-green-red-green\n"
337 " none RGB-RGB-RGB-RGB\n"
338 " Default is none or device-specific.\n"
339 BETWEEN_SECTIONS
340 "Color adjustment:\n"
341 HEADER_SPACE
342 "--exp-mult=c,r,b Adjust all channels by <c>, red by <r>, and blue by <b>.\n"
343 "\n"
344 );
345 }
346 void filtering() {
347 banner("Filtering");
348 fprintf(help_stream,
349 BETWEEN_SECTIONS
350 "Point-spread functions (used with --ips; see --hr):\n"
351 HEADER_SPACE
352 "--lpsf <p> Set linear colorspace point-spread function to <p>\n"
353 "--nlpsf <p> Set non-linear colorspace point-spread function to <p>\n"
354 " Available point-spread functions:\n"
355 " box=<diameter>\n"
356 " circle=<diameter>\n"
357 " gauss=<diameter of one std. deviation>\n"
358 " stdin\n"
359 " stdin_vg\n"
360 " <p>+<p> (summation)\n"
361 " <p>^<p> (convolution)\n"
362 " <n>*<p> (multiplication by a scalar <n>)\n"
363 " Default lpsf is either 'box=1.0' or device-specific.\n"
364 " Default nlpsf is either disabled or device-specific.\n"
365 BETWEEN_SECTIONS
366 "Incremental rendering chains:\n"
367 HEADER_SPACE
368 "--wt <w> Set weight threshold for defined pixels (default is 0.0001).\n"
369 "--dchain <g> Use chain <g> to render the default output.\n"
370 "--ochain <g> <o> Use chain <g> to render output file <o>.\n"
371 "--achain <g> Use chain <g> to render the alignment reference image.\n"
372 "--afilter <s> Use SSF <s> to interpolate points in alignment.\n"
373 "--3d-chain <g> Use chain <g> by default to render 3d output.\n"
374 " Example chains:\n"
375 " triangle:2 ALE 0.6.0 merging (roughly)\n"
376 " fine:box:1 Drizzling (roughly)\n"
377 " fine:sinc*lanc:8 High-frequency preservation\n"
378 " last:nex:sinc*lanc:8 Useful for video stabilization\n"
379 " fine:box:1,triangle:2 Multi-resolution rendering\n"
380 " fine:sinc*lanc:8,sinc*lanc:8 Multi-resolution rendering\n"
381 " More precisely, chains <g> are one of:\n"
382 " <g1>,<g2> Chain <g1> where defined; <g2> elsewhere.\n"
383 " <i> Use rendering invariant <i>.\n"
384 " Rendering invariants <i> are:\n"
385 " avg:<e> Avg. (mean) value using SSFE <e>.\n"
386 " avgf:<x>:<e> Avg. first up to weight <x> using SSFE <e>.\n"
387 " first:<e> First defined value using SSFE <e>.\n"
388 " last:<e> Last defined value using SSFE <e>.\n"
389 " max:<e> Maximum defined value using SSFE <e>.\n"
390 " min:<e> Minimum defined value using SSFE <e>.\n"
391 " median:<e> Median value using SSFE <e>.\n"
392 " <e> Same as avg:<e>.\n"
393 " Scaled sampling filters with exclusion (SSFE) <e> are:\n"
394 " ex:<s> Use SSF <s>; honor exclusion regions.\n"
395 " nex:<s> Use SSF <s>; don't honor exclusion regions.\n"
396 " <s> Same as ex:<s>\n"
397 " Scaled sampling filters (SSF) <s> are:\n"
398 " fine:<f> filter <f> at output image resolution.\n"
399 " coarse:<f> filter <f> at resolution MIN(in, out).\n"
400 " <f> Same as coarse:<f>.\n"
401 " Sampling filters <f> are:\n"
402 " sinc Sinc filter. (very large diameter)\n"
403 " lanc:<x> Lanczos, diameter <x>.\n"
404 " triangle:<x> Triangle, diameter <x>.\n"
405 " box:<x> Box, diameter <x>.\n"
406 " gauss:<x> Gaussian, standard deviation <x>.\n"
407 " zero Zero function.\n"
408 " <f>*<f> Pointwise multiplication (windowing).\n"
409 " Defaults:\n"
410 " dchain (see --hq)\n"
411 " achain (see --hq)\n"
412 " afilter internal (approximates triangle:2)\n"
413 "\n"
414 );
415 }
416 void device() {
417 banner("Device");
418 fprintf(help_stream,
419 BETWEEN_SECTIONS
420 "Device (may set PSF, Bayer pattern, exposure, and view angle):\n"
421 HEADER_SPACE
422 "--device <d> Set the capture device to <d>.\n"
423 " Available devices (* expect linear inputs):\n"
424 " canon_300d *\n"
425 " canon_300d+50mm_1.4 *\n"
426 " canon_300d+50mm_1.4@1.4 *\n"
427 " canon_300d+50mm_1.8 *\n"
428 " canon_300d+85mm_1.8 *\n"
429 " nikon_d50 *\n"
430 " ov7620 *\n"
431 " xvp610_320x240\n"
432 " xvp610_640x480\n"
433 "\n"
434 );
435 }
436 void exclusion() {
437 banner("Exclusion");
438 fprintf(help_stream,
439 BETWEEN_SECTIONS
440 "Rendering-coordinate exclusion regions:\n"
441 HEADER_SPACE
442 "--ex <args> Exclude a specified volume.\n"
443 " <args> are space-delimited horizontal,\n"
444 " vertical, and frame limits:\n"
445 " <xmin> <xmax> <ymin> <ymax> <fmin> <fmax>\n"
446 " using unscaled rendering spatial coordinates.\n"
447 "--crop <args> Exclude the spatial complement of an area over a\n"
448 " specified set of frames. <args> are:\n"
449 " <xmin> <xmax> <ymin> <ymax> <fmin> <fmax>\n"
450 " using unscaled rendering spatial coordinates.\n"
451 BETWEEN_SECTIONS
452 "Frame-coordinate exclusion regions:\n"
453 HEADER_SPACE
454 "--fex <args> Exclude a specified volume.\n"
455 " <args> are space-delimited horizontal,\n"
456 " vertical, and frame limits:\n"
457 " <xmin> <xmax> <ymin> <ymax> <fmin> <fmax>\n"
458 " using unscaled frame spatial coordinates.\n"
459 "--fcrop <args> Exclude the spatial complement of an area over a\n"
460 " specified set of frames. <args> are:\n"
461 " <xmin> <xmax> <ymin> <ymax> <fmin> <fmax>\n"
462 " using unscaled frame spatial coordinates.\n"
463 "\n"
464 );
465 }
466 void exposure() {
467 banner("Exposure");
468 fprintf(help_stream,
469 BETWEEN_SECTIONS
470 "Certainty-weighted rendering:\n"
471 HEADER_SPACE
472 "--cx <x> Render with certainty exponent <x>. (default is 1)\n"
473 "--no-cx Render with uniform certainty.\n"
474 BETWEEN_SECTIONS
475 "Exposure registration:\n"
476 HEADER_SPACE
477 "--exp-register Register exposure between frames. [default]\n"
478 "--exp-noregister Assume uniform exposure across all frames.\n"
479 "--exp-meta-only Use only meta-data for registering exposure.\n"
480 BETWEEN_SECTIONS
481 "Range extension:\n"
482 HEADER_SPACE
483 "--exp-extend Extend to include all calculated values.\n"
484 "--exp-noextend Restrict to the original frame's range. [default]\n"
485 BETWEEN_SECTIONS
486 "Exposure value meta-data:\n"
487 HEADER_SPACE
488 "--ev <x> Set ISO 100 equivalent EV <x>. (default is 0)\n"
489 "--black <x> Set black level <x> as a fraction of saturation. (default 0)\n"
490 "\n"
491 );
492 }
493 void tdf() {
494 banner("Transformation data files");
495 fprintf(help_stream,
496 BETWEEN_SECTIONS
497 "Version 2 syntax overview:\n"
498 HEADER_SPACE
499 "{version string}\n"
500 "{supplemental frame 1 transformation}\n"
501 "{supplemental frame 2 transformation}\n"
502 "...\n"
503 BETWEEN_SECTIONS
504 "Version 3 syntax overview:\n"
505 HEADER_SPACE
506 "{version string}\n"
507 "{original frame transformation}\n"
508 "{supplemental frame 1 transformation}\n"
509 "{supplemental frame 2 transformation}\n"
510 "...\n"
511 BETWEEN_SECTIONS
512 "Version string:\n"
513 HEADER_SPACE
514 "V <x> Transformation data file version <x>.\n"
515 BETWEEN_SECTIONS
516 "Transformation overview:\n"
517 HEADER_SPACE
518 "{barrel/pincushion distortion command (optional; version 3 only)}\n"
519 "{projective, euclidean, or default command}\n"
520 BETWEEN_SECTIONS
521 "Barrel/pincushion distortion (version 3 only):\n"
522 HEADER_SPACE
523 "B <n> <coeff2> <coeff3> ... <coeff(n+1)>\n"
524 BETWEEN_SECTIONS
525 "Projective command:\n"
526 HEADER_SPACE
527 "P <xmax> <ymax> <tlx> <tly> <blx> <bly> <brx> <bry> <trx> <try>\n"
528 BETWEEN_SECTIONS
529 "Euclidean command:\n"
530 HEADER_SPACE
531 "E <xmax> <ymax> <xoffset> <yoffset> <angle>\n"
532 "\n"
533 BETWEEN_SECTIONS
534 "Comments:\n"
535 HEADER_SPACE
536 "# Lines beginning with '#' are comments.\n"
537 BETWEEN_SECTIONS
538 "Example:\n"
539 HEADER_SPACE
540 "# Version 3 transformation data file.\n"
541 "V 3\n"
542 "# Original frame, with barrel/pincushion distortion correction\n"
543 "B 3 0.1 0 -0.1\n"
544 "D\n"
545 "# Supplemental frame 1: shift a 640x480 image right by 100 pixels\n"
546 "E 640 480 100 0 0\n"
547 "\n"
548 );
549 }
550 void visp() {
551 banner("Video stream processing");
552 fprintf(help_stream,
553 BETWEEN_SECTIONS
554 "Video stream processing [Experimental]:\n"
555 HEADER_SPACE
556 "--visp <args> Process a video sequence.\n"
557 " <args> are:\n"
558 " <chain> <stabilization-type> <prefix> <suffix>\n"
559 " <chain> is an incremental rendering chain. (see --hl)\n"
560 " <stabilization-type> is one of:\n"
561 " ma:<x> Moving average over 2*<x> + 1 frames\n"
562 " sf:<x> Stabilize to single frame number <x>\n"
563 " identity Same as ma:0\n"
564 " <prefix> is an output file prefix\n"
565 " <suffix> is an output file suffix\n"
566 "--visp-scale=<x> Use scale <x> for VISP output. (default is 1.0)\n"
567 "--exshow For single-invariant chains, show --ex regions dimmed.\n"
568 "\n");
569 }
570 void interface() {
571 banner("User Interface");
572 fprintf(help_stream,
573 BETWEEN_SECTIONS
574 "User Interfaces:\n"
575 HEADER_SPACE
576 "--ui=<type> Set user interface to <type>, one of:\n"
577 " quiet\n"
578 " stream\n"
579 " tty [default]\n"
580 " log\n"
581 #ifndef USE_IOCTL
582 "\n"
583 " NOTE: since ALE was compiled without terminal size check,\n"
584 " --ui=tty will behave identically to --ui=stream.\n"
585 " For additional output, recompile with terminal size check.\n"
586 #endif
587 "\n");
588 }
589 void cp() {
590 banner("Control Points");
591 fprintf(help_stream,
592 BETWEEN_SECTIONS
593 "Control point files:\n"
594 HEADER_SPACE
595 "--cpf-load=<f> Load control point data from file <f>\n"
596 "\n");
597 }
598 void d3() {
599 banner("3D Modeling [Experimental]");
600 fprintf(help_stream,
601 BETWEEN_SECTIONS
602 "Rendering:\n"
603 HEADER_SPACE
604 "--3dv <n> <o> Render, to file <o>, colors as viewed from frame <n>.\n"
605 "--3dd <n> <o> Render, to file <o>, depths as viewed from frame <n>.\n"
606 "--3dvp <args> <o> Render, to file <o>, colors viewed with projective <args>.\n"
607 "--3ddp <args> <o> Render, to file <o>, depths viewed with projective <args>.\n"
608 " <args> are W H V x y z P Y R:\n"
609 " W image width.\n"
610 " H image height.\n"
611 " V camera view angle.\n"
612 " x translation x component.\n"
613 " y translation y component.\n"
614 " z translation z component.\n"
615 " P rotation around x-axis.\n"
616 " Y rotation around y-axis.\n"
617 " R rotation around z-axis.\n"
618 "--occ-norm Normalize output with accumulated occupancy. [default]\n"
619 "--occ-nonorm Don't normalize output with accumulated occupancy.\n"
620 "--et <x> Set encounter threshold <x> for defined pixels.[default is 0]\n"
621 "--3dpx <args> Exclude a specified spatial volume following full-scene\n"
622 " reconstruction. <args> are:\n"
623 " <xmin> <xmax> <ymin> <ymax> <zmin> <zmax>\n"
624 "--3d-filter Use filtering for 3D color output. [default]\n"
625 "--3d-nofilter Don't use filtering for 3D color output.\n"
626 "--3d-dmr <x> Set radius for filtering median depth to <x> [default 0]\n"
627 "--3d-fmr <x> Set radius for filtering median diff to <x> [default 0]\n"
628 "--focus <ft> <op> Create focus region with type <ft> and options <op>:\n"
629 " Focus type:\n"
630 " d <d> focus at distance <d>\n"
631 " p <x> <y> focus at point (x, y)\n"
632 " Space-separated options may include zero or more of:\n"
633 " ci=<ci> camera index [default 0]\n"
634 " fr=<fr> focal range [default 0]\n"
635 " ht=<ht> horizontal tilt gradient [default 0]\n"
636 " vt=<vt> vertical tilt gradient [default 0]\n"
637 " ap=<ap> aperture diameter [default 3]\n"
638 " sc=<sc> sample count [default 3]\n"
639 " sx=<sx> start x coordinate [default -Inf]\n"
640 " ex=<ex> end x coordinate [default Inf]\n"
641 " sy=<sy> start y coordinate [default -Inf]\n"
642 " ey=<ey> end y coordinate [default Inf]\n"
643 " sd=<sd> start depth [default 0]\n"
644 " ed=<ed> end depth [default Inf]\n"
645 " sr=<sr> view sample randomization:\n"
646 " aperture per aperture [default]\n"
647 " pixel per pixel\n"
648 " fs=<fs> focal statistic, one of:\n"
649 " mean mean of views [default]\n"
650 " median median of views\n"
651 "\n"
652 BETWEEN_SECTIONS
653 "Camera parameters:\n"
654 HEADER_SPACE
655 "--view-angle <x> Set the initial diagonal view angle to <x> degrees.\n"
656 " (Default is 43.7 degrees or device-specific.)\n"
657 "--cpp-upper=<x> Set upper bound <x> for camera parameter perturbation,\n"
658 " in pixels or degrees [default is 32]\n"
659 "--cpp-lower=<x> Set lower bound <x> for camera parameter perturbation,\n"
660 " in pixels or degrees [default is 0.125]\n"
661 "--cpp-err-mean Use RMS error to determine camera parameters. [default]\n"
662 "--cpp-err-median Use median error to determine camera parameters. \n"
663 "--va-upper=<x> View-angle perturbation upper bound in degrees [default 32]\n"
664 "--st <x> Set stereo threshold to <x> pixels. [default is 4]\n"
665 "--vp-adjust Adjust the view point [default]\n"
666 "--vp-noadjust Do not adjust the view point\n"
667 "--vo-adjust Adjust the view orientation [default]\n"
668 "--vo-noadjust Do not adjust the view orientation\n"
669 BETWEEN_SECTIONS
670 "Transformation file operations:\n"
671 HEADER_SPACE
672 "--3d-trans-load=x Load initial transformation settings from file x\n"
673 "--3d-trans-save=x Save final transformation data in file x\n"
674 BETWEEN_SECTIONS
675 "Model rules:\n"
676 HEADER_SPACE
677 "--di-upper <x> Decimate primary input resolution by at most 2^x [default 0]\n"
678 "--di-lower <x> Decimate input resolutions by at least 2^x [default is 0]\n"
679 "--do-try <x> Decimate output resolution by 2^x if possible [default is 0]\n"
680 "--oc Clip scene to output regions.\n"
681 "--no-oc Do not clip scene to output regions. [default]\n"
682 "--fc <x> Set front-clip to <x> (0 < x < 1) [default is 0]\n"
683 "--rc <x> Set rear-clip to <x> (1 < x < inf) [default is inf]\n"
684 "--fx <x> Set falloff exponent to <x> [default is 1]\n"
685 "--tcem <x> Set third-camera error multiplier to <x> [default is 0]\n"
686 "--oui <x> Set occupancy update iterations to <x> [default is 10]\n"
687 "--pa <x> Set pairwise ambiguity to <x> [default is 3]\n"
688 "--pc <type> Set the type of pairwise comparisons:\n"
689 " auto Determine comparisons automatically. [default]\n"
690 " all Perform all comparisons.\n"
691 "\n");
692 }
693 void scope() {
694 banner("Argument scope [experimental]");
695 fprintf(help_stream,
696 BETWEEN_SECTIONS
697 "List of arguments admitting scoping:\n"
698 HEADER_SPACE
699 "--mc (see --ha for more details)\n"
700 "--mcd-removal (see --ha for more details)\n"
701 "--gs (see --ha for more details)\n"
702 "--gs-mo (see --ha for more details)\n"
703 "--threads (see --hp for more details)\n"
704 "--per-cpu (see --hp for more details)\n"
705 "--perturb-upper (see --ha for more details)\n"
706 "--ev (see --hx for more details)\n"
707 "--black (see --hx for more details)\n"
708 BETWEEN_SECTIONS
709 "Implicit file scope (implementation may be buggy):\n"
710 HEADER_SPACE
711 "arg1 file1 arg2 <arg2> applies only to files later than <file1>.\n"
712 " Example:\n"
713 "\n"
714 " --mc 10 file1 --mc 20 file2\n"
715 "\n"
716 " (file1 has monte-carlo argument 10; file2 has --mc 20.)\n"
717 "\n"
718 BETWEEN_SECTIONS
719 "Hidden scope (implementation may be buggy):\n"
720 HEADER_SPACE
721 "[ args ] Hide the effects of <args> options within [ ... ] scope\n"
722 " Example:\n"
723 "\n"
724 " file1 [ --mc 20 file2 ] file3\n"
725 "\n"
726 " (The monte-carlo argument is limited to file2.)\n"
727 "\n"
728 BETWEEN_SECTIONS
729 "Exposed scope (implementation may be buggy):\n"
730 HEADER_SPACE
731 "[ arg1 < arg2 > ] Expose the effects of <arg2> outside of [ ... ] scope\n"
732 BETWEEN_SECTIONS
733 "Fully-exposed scope (implementation may be buggy):\n"
734 HEADER_SPACE
735 "{ arg1 } Same as [ < arg1 > ].\n"
736 "\n");
737 }
738 void process() {
739 banner("Process details");
740 fprintf(help_stream,
741 BETWEEN_SECTIONS
742 "Profiling:\n"
743 HEADER_SPACE
744 "--profile Output performance data\n"
745 BETWEEN_SECTIONS
746 "Thread count:\n"
747 "\n"
748 " If the CPU count cannot be determined, the default thread count\n"
749 " is 4. Otherwise, the default is one thread per CPU.\n"
750 "\n"
751 HEADER_SPACE
752 "--threads <n> Use <n> threads.\n"
753 #ifndef USE_PTHREAD
754 "\n"
755 " NOTE: since this build of ALE does not link with a\n"
756 " threading library, this option is not supported.\n"
757 " To use this option, first rebuild with support\n"
758 " for threads.\n"
759 "\n"
760 #endif
761 "--per-cpu <n> Use <n> threads for each detected CPU.\n"
762 #ifndef USE_PTHREAD
763 "\n"
764 " NOTE: since this build of ALE does not link with a\n"
765 " threading library, this option is not supported.\n"
766 " To use this option, first rebuild with support\n"
767 " for threads.\n"
768 "\n"
769 #endif
770 "\n");
771 }
772 void undocumented() {
773 banner("Undocumented");
774 fprintf(help_stream,
775 BETWEEN_SECTIONS
776 "Point-spread functions:\n"
777 HEADER_SPACE
778 "--psf-match <args> Can be used to evaluate PSFs. [details are undocumented]\n"
779 " <args> are:\n"
780 " <mr> <mg> <mb> <ar> <ag> <ab>\n"
781 " where:\n"
782 " r[calibrated] = r[input] * <mr> + <ar>\n"
783 BETWEEN_SECTIONS
784 "Projective transformation calculator:\n"
785 HEADER_SPACE
786 "--ptcalc\n"
787 BETWEEN_SECTIONS
788 "Traverse subspaces for 3D candidate selection:\n"
789 HEADER_SPACE
790 "--subspace-traverse\n"
791 "\n"
792 );
793 }
794 };
795
796 #undef BETWEEN_SECTIONS
797 #undef HEADER_SPACE
synthetic capture engine and renderer