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