ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/pmapdump.1
Revision: 1.1
Committed: Tue Feb 24 19:39:26 2015 UTC (10 years, 2 months ago) by greg
Branch: MAIN
CVS Tags: rad5R2, rad5R0, rad5R1
Log Message:
Initial check-in of photon map addition by Roland Schregle

File Contents

# User Rev Content
1 greg 1.1 .\" RCSid "$Id: pmapdump.1,v 1.6 2015/01/13 17:29:13 taschreg Exp taschreg $"
2     .TH PMAPDUMP 1 "$Date: 2015/01/13 17:29:13 $ $Revision: 1.6 $" RADIANCE
3    
4     .SH NAME
5     pmapdump - generate RADIANCE scene description of photon map distribution
6    
7     .SH SYNOPSIS
8     pmapdump [\fB-n\fR \fInspheres1\fR] [\fB-r\fR \fIradscale1\fR] \fIpmap1\fR
9     [\fB-n\fR \fInspheres2\fR] [\fB-r\fR \fIradscale2\fR] \fIpmap2\fR ...
10    
11     .SH DESCRIPTION
12     \fIpmapdump\fR takes one or more photon map files generated with
13     \fImkpmap(1)\fR as input and sends a RADIANCE scene description of their
14     photon distributions to the standard output. This can be visualised with
15     e.g. \fIobjview(1)\fR, \fIrpict(1)\fR, or \fIrvu(1)\fR to assess the
16     location and local density of photons in relation to the scene geometry.
17     .PP
18     An arbitrary number of photon maps can be specified on the command line and
19     the respective photon type is determined automagically. The different
20     photon types are visualised as colour coded spheres according to the
21     following schema:
22     .IP
23     \fIBlue\fR: global photons
24     .br
25     \fICyan\fR: precomputed global photons
26     .br
27     \fIRed\fR: caustic photons
28     .br
29     \fIGreen\fR: volume photons
30     .br
31     \fIMagenta\fR: direct photons
32     .br
33     \fIYellow\fR: contribution photons
34    
35     .SH OPTIONS
36     Options are effective for the photon map file immediately following on the
37     command line, and are reset to their defaults after completion of each dump.
38     As such they may be set individually for each photon map.
39    
40     .IP "\fB-n \fInspheres\fR"
41     Specifies the number of spheres to dump for the next photon map. The dump
42     is performed by random sampling with \fInspheres\fR as target count, hence
43     the number actually output will be approximate. \fINspheres\fR may be
44     followed by a multiplier suffix for convenience, where \fIk\fR = 10^3 and
45     \fIm\fR = 10^6, although the latter may lead to problems when processing the
46     output geometry with \fIoconv(1)\fR. The default number of spheres is 10k.
47    
48     .IP "\fB-r \fIradscale\fR"
49     Specifies a relative scale factor \fIradscale\fR for the sphere radius. The
50     sphere radius is determined automatically from an estimated average distance
51     between spheres so as to reduce clustering, assuming a uniform distribution.
52     In cases where the distribution is substantially nonuniform (e.g. highly
53     localised caustics) the radius can be manually corrected with this option.
54     The default value is 1.0.
55    
56     .SH NOTES
57     The output may contain many overlapping spheres in areas with high photon
58     density, particularly in caustics. This results in inefficient and slow
59     octree generation with \fIoconv(1)\fR. Generally this can be improved by
60     reducing \fInspheres\fR and/or \fIradscale\fR.
61    
62     .SH EXAMPLES
63     To visualise the distribution of global and caustic photons superimposed
64     on the scene geometry with 5000 and 10000 spheres, respectively:
65     .IP
66     pmapdump -n 5k global.pm -n 10k caustic.pm |
67     oconv - scene.rad > scene_pmdump.oct
68     .PP
69     Alternatively, the dump may be viewed on its own by piping the output of
70     \fIpmapdump\fR directly into \fIobjview(1)\fR (using the default number of
71     spheres in this example):
72     .IP
73     pmapdump zombo.pm | objview
74    
75     .SH AUTHOR
76     Roland Schregle (roland.schregle@{hslu.ch,gmail.com})
77    
78     .SH COPYRIGHT
79     (c) Fraunhofer Institute for Solar Energy Systems, Lucerne University of
80     Applied Sciences and Arts.
81    
82     .SH ACKNOWLEDGEMENT
83     Development of the RADIANCE photon mapping extension was sponsored by the
84     German Research Foundation (DFG) and the Swiss National Science Foundation
85     (SNF).
86    
87     .SH "SEE ALSO"
88     mkpmap(1), objview(1), oconv(1), rpict(1), rvu(1),
89     \fIThe RADIANCE Photon Map Manual\fR
90