ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/mkpmap.1
(Generate patch)

Comparing ray/doc/man/man1/mkpmap.1 (file contents):
Revision 1.2 by rschregle, Fri Jun 5 08:48:09 2015 UTC vs.
Revision 1.13 by rschregle, Fri Aug 7 01:22:59 2020 UTC

# Line 57 | Line 57 | photons, and output to file \fIfile\fR. This only acco
57   illumination and is intended for debugging and validation of photon emission
58   from the light sources, as the quality is too low for actual rendering.
59  
60 < .IP "\fB\-apC \fIfile nphotons \fB(EXPERIMENTAL)\fR"
60 > .IP "\fB\-apC \fIfile nphotons\fR"
61   Generate a contribution photon map containing approximately
62   \fInphotons\fR photons, and output to file \fIfile\fR. This may then be
63 < used by \fIrcontrib(1)\fR to compute light source contributions.
63 > used by \fIrcontrib(1)\fR to compute light source contributions. When used
64 > with \fIrtrace(1)\fR or \fIrpict(1)\fR, contribution photon maps behave as
65 > regular global photon maps and yield cumulative contributions from all light
66 > sources.
67   .IP
68   With this option, \fImkpmap\fR uses a modified photon distribution
69   algorithm that ensures all light sources contribute approximately the
# Line 81 | Line 84 | the photon positions using \fIbwidth\fR nearest photon
84   photon flux; the remaining photons are discarded as their contributions
85   have been accounted for.
86   .IP
87 < This obviates the explicit irradiance
88 < evaluation by \fIrpict(1), rtrace(1)\fR and \fIrvu(1)\fR, thus providing
89 < a speedup at the expense of accuracy. The resulting error is tolerable
90 < if the indirect illumination has a low gradient, as is usually the case
88 < with diffuse illumination.
87 > This obviates the explicit irradiance evaluation by \fIrpict(1),
88 > rtrace(1)\fR and \fIrvu(1)\fR, thus providing a speedup at the expense of
89 > accuracy.  The resulting error is tolerable if the indirect illumination has
90 > a low gradient, as is usually the case with diffuse illumination.
91  
92   .IP "\fB\-apD \fIpredistrib\fR"
93   Photon predistribution factor; this is the fraction of \fInphotons\fR
# Line 93 | Line 95 | which are emitted in a distribution prepass in order t
95   remaining number of photons to emit in the main pass to approximately
96   yield a photon map of size \fInphotons\fR.
97   .IP
98 < Setting this too high may
99 < yield more than \fInphotons\fR in the initial pass with highly
100 < reflective geometry. Note that this value may exceed 1, which may be
99 < useful if the resulting photon map size greatly deviates from
98 > Setting this too high may yield more than \fInphotons\fR in the initial pass
99 > with highly reflective geometry.  Note that this value may exceed 1, which
100 > may be useful if the resulting photon map size greatly deviates from
101   \fInphotons\fR with a very low average reflectance.
102  
103 < .IP "\fB\-apP \fIprecomp\fR"
104 < Fraction of global photons to precompute in the range ]0,1] when using the
105 < \fB\-app\fR option.
103 > .IP "\fB\-api \fIxmin ymin zmin xmax ymax zmax\fR"
104 > Define a region of interest within which to store photons exclusively;
105 > photons will only be stored within the volume bounded by the given minimum
106 > and maximum coordinates.  Multiple instances of this option may be specified
107 > with cumulative effect to define compound regions of interest.  This is
108 > useful for constraining photons to only the relevant regions of a scene, but
109 > may increase the photon distribution time.
110 > .IP
111 > \fBWARNING: this is an optimisation option for advanced users (an elite
112 > group collectively known as \fIZe Ekspertz\fB) and may yield biased results.
113 > Use with caution!\fR
114  
115   .IP "\fB\-apm \fImaxbounce\fR"
116 < Maximum number of bounces (scattering events) along a photon path before
117 < being considered "runaway" and terminated. Photons paths are normally
109 < terminated via \fIRussian Roulette\fR, depending on their albedo. With
110 < unrealistically high albedos, this is not guaranteed, and this options
111 < imposes a hard limit to avoid an infinite loop.
116 > Synonymous with \fB\-lr\fR for backwards compatibility. May be removed in
117 > future releases.
118  
119   .IP "\fB\-apM \fImaxprepass\fR"
120   Maximum number of iterations of the distribution prepass before terminating
121 < if some photon maps are still empty. This option is rarely needed as a
122 < an aborted prepass indicates an anomaly in the geometry or an
121 > if some photon maps are still empty. This option is rarely needed as
122 > an aborted prepass may indicate an anomaly in the geometry or an
123   incompatibility with the specified photon map types (see \fBNOTES\fR below).
124  
125 < .IP "\fB\-apo \fImod\fR"
125 > .IP "\fB\-apo\fR[\fB+\fR|\fB-\fR|\fB0\fR] \fImod\fR"
126   Specifies a modifier \fImod\fR to act as a \fIphoton port\fR. All
127   objects using this modifier will emit photons directly in lieu of any
128   light sources defined with the \fIsource\fR material. This greatly
129   accelerates photon distribution in scenes where photons have to enter a
130   space which separates them from the emitting light source via an
131 < opening, or port.
131 > aperture (e.g. fenestration, skylight) acting as a port.
132   .IP
133 < A typical application is daylight simulation, where a
134 < fenestration acts as port to admit photons into an interior after
135 < emission from an external light source. Multiple instances of this
130 < option may be specified.
133 > In a typical daylight simulation scenario, a fenestration acts as a port to
134 > admit photons into an interior after emission from sky and solar sources.
135 > Multiple instances of this option may be specified.
136   .IP
137 < Note that port objects must be defined with their surface normals
138 < pointing \fIinside\fR as per \fImkillum\fR convention.
139 <
137 > By default, ports are oriented to emit in the halfspace defined
138 > by their associated surface normal. This can be overridden by
139 > specifying a trivalent suffix as follows:
140 > .RS
141 > .IP \fB+\fR:
142 > Forward emission; this is equivalent to the abovementioned default behaviour.
143 > .IP \fB-\fR:
144 > Backward emission; the port is reversed and photons are emitted into the
145 > halfspace facing away from the surface normal.
146 > .IP \fB0\fR:
147 > Bidirectional emission; photons are emitted from both sides of the port.
148 > .RE
149 > .IP
150 > Situations that call for a reversed photon port include, for
151 > example, using fenestrations as ports that were (for whatever
152 > reason) defined with outward facing normals, or using a \fBmist\fR
153 > primitive as a port, since this requires outward facing normals in order to
154 > register the photons as having entered the volume.
155 >  
156   .IP "\fB\-apO \fImodfile\fR"
157   Read photon port modifiers from the file \fImodfile\fR as a more convenient
158   alternative to multiple instances of \fB\-apo\fR.
159  
160 + .IP "\fB\-apP \fIprecomp\fR"
161 + Fraction of global photons to precompute in the range ]0,1] when using the
162 + \fB\-app\fR option.
163 +
164   .IP "\fB\-apr \fIseed\fR"
165 < Seed for the random number generator. This is necessary for generating
166 < different photon distributions for the same octree and photon map size.
165 > Seed for the random number generator. This is useful for generating
166 > different photon distributions for the same octree and photon map size,
167 > notably in progressive applications.
168  
169   .IP "\fB\-aps \fImod\fR"
170   Specifies a modifier \fImod\fR defined as \fIantimatter\fR material to act
# Line 148 | Line 174 | be transferred through the surface without undergoing
174   surface therefore does not affect the light transport and simply acts as an
175   invisible photon receiver.  This is useful when photon irradiance is to be
176   evaluated at points which do not lie on regular geometry, e.g.  at workplane
177 < height with \firtrace\fR's \fB-I\fR option.  Without this workaround,
177 > height with \fIrtrace\fR's \fB-I\fR option.  Without this workaround,
178   photons would be collected from parallel but distant planes, leading to
179   underestimation.  Note that photons are only deposited when incident from
180   the front side of the sensor surface, i.e.  when entering the
# Line 159 | Line 185 | an error if the specified modifier is not an \fIantima
185   Read virtual receiver surface modifiers from the file \fImodfile\fR as a more
186   convenient alternative to multiple instances of \fB\-aps\fR.
187  
188 + .IP "\fB\-ae \fImod\fR"
189 + Add \fImod\fR to the ambient exclude list, so that it will be ignored by the
190 + photon map.  Objects having \fImod\fR as their modifier will not have
191 + photons deposited on them.  Multiple modifiers may be given, each as separate
192 + instances of this option.
193 + .IP
194 + \fBWARNING: this is an optimisation option for advanced users and may yield
195 + biased results. It may also significantly increase photon distribution
196 + times. Use with caution!\fR
197 +
198 + .IP "\fB\-aE \fIfile\fR"
199 + Same as \fI-ae\fR, except modifiers to be exluded are read from \fIfile\fR,
200 + separated by whitespace.  The RAYPATH environment variable determines which
201 + directories are searched for this file.
202 +
203 + .IP "\fB\-ai \fImod\fR"
204 + Add \fImod\fR to the ambient include list, so that it will contribute to the
205 + photon map. Only objects having \fImod\fR as their modifier will have
206 + photons deposited on them. Multiple modifiers may be given, each as separate
207 + instances of this option. Note that the ambient include and exclude options
208 + are mutually exclusive.
209 + .IP
210 + \fBWARNING: this is an optimisation option for advanced users and may yield
211 + biased results. It may also significantly increase photon distribution
212 + times. Use with caution!\fR
213 +
214 + .IP "\fB\-aI \fIfile\fR"
215 + Same as \fI-ai\fR, except modifiers to be included are read from \fIfile\fR,
216 + separated by whitespace. The RAYPATH environment variable determines which
217 + directories are searched for this file.
218 +
219   .IP "\fB\-bv\fR[\fB+\fR|\fB-\fR]"
220   Toggles backface visibility; enabling this causes photons to be stored and
221   possibly scattered if they strike the back of a surface, otherwise they
# Line 190 | Line 247 | overwrite an already existing photon map file. This is
247   inadvertently destroying the results of potentially lengthy photon
248   mapping runs.
249  
250 < .IP "\fB\-i \fIinc\fR"
251 < Photon heap size increment; the photon heap is enlarged by this amount
252 < when storage overflows during photon distribution. No need to fiddle
253 < with this under ordinary circumstances.
250 > .IP "\fB\-ld \fImaxdist\fR"
251 > Limit cumulative distance travelled by a photon along its path to
252 > \fImaxdist\fR.  Photon hits within this distance will be stored, and the
253 > photon is terminated once its path length exceeds this limit.  This is
254 > useful for setting radial regions of interest around emitting/reflecting
255 > geometry, but may increase the photon distribution time.  
256 > .IP
257 > \fBWARNING: this is an optimisation option for advanced users (an elite
258 > group collectively known as \fIZe Ekspertz\fB) and may yield biased results.
259 > Use with caution!\fR
260  
261 + .IP "\fB\-lr \fImaxbounce\fR"
262 + Limit number of bounces (scattering events) along a photon path to
263 + \fImaxbounce\fR before being considered "runaway" and terminated.  Photons
264 + paths are normally terminated via \fIRussian Roulette\fR, depending on their
265 + albedo.  With unrealistically high albedos, this is not guaranteed, and this
266 + option imposes a hard limit to avoid an infinite loop.
267 + .IP
268 + \fBWARNING: this is an optimisation option for advanced users (an elite
269 + group collectively known as \fIZe Ekspertz\fB) and may yield biased results.
270 + Use with caution!\fR
271 +
272   .IP "\fB\-ma \fIralb galb balb\fR"
273   Set the global scattering albedo for participating media in conjunction
274   with the \fB\-apv\fR option. See \fIrpict(1)\fR for details.
# Line 207 | Line 281 | with the \fB\-apv\fR option. See \fIrpict(1)\fR for de
281   Set the global scattering eccentricity for participating media in conjunction
282   with the \fB\-apv\fR option. See \fIrpict(1)\fR for details.
283  
284 + .IP "\fB\-n \fInproc\fR"
285 + Use \fInproc\fR processes for parallel photon distribution. There is no
286 + benefit in specifying more than the number of physical CPU cores available.
287 + This option is currently not available on Windows.
288 +
289   .IP "\fB\-t \fIinterval\fR"
290   Output a progress report every \fIinterval\fR seconds. This includes
291   statistics about the currently emitting light source (including number of
# Line 243 | Line 322 | attempts before terminating with an error. This can be
322   \fB\-apM\fR option.
323  
324   .SS Material Support
325 < The \fIplasfunc\fR, \fImetfunc\fR, \fItransfunc\fR, \fIbrtdfunc\fR,
326 < \fIplasdata\fR, \fImetdata\fR and \fItransdata\fR materials are not
327 < supported by the photon mapping extension. Use the newer \fIbsdf\fR material
325 > Not all materials are fully supported by the photon map extension.  The
326 > \fIplasfunc\fR, \fImetfunc\fR, \fItransfunc\fR, \fIplasdata\fR,
327 > \fImetdata\fR and \fItransdata\fR materials currently only scatter photons
328 > diffusely, and will not produce caustics.  The \fIbrtdfunc\fR material only
329 > produces caustics via ideal (mirror) specular reflection and transmission.
330 > For more realistic scattering behaviour, use the newer \fIbsdf\fR material
331   instead.
332   .PP
333   Virtual light sources (normally enabled with the \fImirror\fR material) are
# Line 274 | Line 356 | mkpmap \-app bonzo-precomp.gpm 80k 40 \-apP 0.25 bonzo
356   .PP
357   Generate 1 million global photons by emitting them from external light
358   sources of type \fIsource\fR into a reference room via a fenestration
359 < with modifier \fIglazingMat\fR:
359 > with modifier \fIglazingMat\fR acting as photon port, with inward-facing
360 > normal:
361   .IP
362   mkpmap \-apg refRoom.gpm 1m \-apo glazingMat refRoom.oct
363   .PP
364 < Generate a contribution photon map containing 200000 photons suitable for
365 < obtaining light source contributions with \fIrcontrib(1)\fR:
364 > Generate a contribution photon map containing 10 million photons to bin
365 > light source contributions with \fIrcontrib(1)\fR:
366   .IP
367 < mkpmap \-apl bonzo-contrib.gpm 200k bonzo.oct
367 > mkpmap \-apC bonzo-contrib.gpm 10m bonzo.oct
368  
369   .SH BUGS
370   The focus of a spotlight source, as defined by the length of its direction
# Line 295 | Line 378 | Light sources simply absorb incoming photons.
378   Roland Schregle (roland.schregle@{hslu.ch,gmail.com})
379  
380   .SH COPYRIGHT
381 < (c) Fraunhofer Institute for Solar Energy Systems, Lucerne University of
382 < Applied Sciences and Arts.
381 > (c) Fraunhofer Institute for Solar Energy Systems,
382 > .br
383 > (c) Lucerne University of Applied Sciences and Arts,
384 > .br
385 > (c) Tokyo University of Science.
386  
387 < .SH ACKNOWLEDGEMENT
388 < Development of the RADIANCE photon mapping extension was sponsored by the
303 < German Research Foundation (DFG) and the Swiss National Science Foundation
304 < (SNF).
387 > .SH ACKNOWLEDGEMENTS
388 > Development of the RADIANCE photon mapping extension was supported by:
389  
390 + .RS
391 + \fIFraunhofer Institute for Solar Energy Systems\fR funded by
392 + the German Research Foundation (\fIDFG LU204/10-2\fR, "Fassadenintegrierte
393 + Regelsysteme (FARESYS)"),
394 +
395 + \fILucerne University of Applied Sciences and Arts\fR funded by
396 + the Swiss National Science Foundation (\fISNSF 147053\fR, "Daylight redirecting components"),
397 +
398 + \fITokyo University of Science\fR funded by the JSPS Grants-in-Aid for Scientific
399 + Research Programme (\fIKAKENHI JP19KK0115\fR, "Three-dimensional light flow").
400 + .RE
401 +
402 + Many thanks also to the many individuals who tested the code and provided
403 + valuable feedback. Special greetz to Don Gregorio, PAB and Capt.\~B!
404 +
405   .SH "SEE ALSO"
406   rpict(1), rtrace(1), rvu(1), rcontrib(1),
407 < \fIThe RADIANCE Photon Map Manual\fR
407 > .br
408 > \fIThe RADIANCE Photon Map Manual\fR,
409 > .br
410 > \fIDevelopment and Integration of the RADIANCE Photon Map Extension:
411 > Technical Report\fR,
412 > .br
413 > \fIThe RADIANCE Out-of-Core Photon Map: Technical Report\fR,
414 > .br
415 > \fIBonzo Daylighting Tool a.k.a. EvilDRC [TM]\fR
416  

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines