ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/pmapdump.1
Revision: 1.2
Committed: Wed Nov 21 19:31:40 2018 UTC (6 years, 5 months ago) by rschregle
Branch: MAIN
Changes since 1.1: +20 -8 lines
Log Message:
Documented new -c option for custom sphere colours

File Contents

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