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.12 by rschregle, Mon Jun 3 17:08:23 2019 UTC vs.
Revision 1.15 by rschregle, Tue Mar 23 21:42:47 2021 UTC

# Line 122 | Line 122 | if some photon maps are still empty. This option is ra
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 fenestration acts as
134 < port to admit photons into an interior after emission from an external light
135 < source.  Multiple instances of this 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 > Some typical situations that call for a reversed photon port include, for
151 > example:
152 > .RS
153 > .IP (a)
154 > Using fenestrations as ports that were (for whatever
155 > reason) defined with outward facing normals,
156 > .IP (b)
157 > Using a \fBmist\fR
158 > primitive as a port, since this requires outward facing normals in order to
159 > register the photons as having entered the volume,
160 > .IP (c)
161 > Reorienting a port associated with a \fBbsdf\fR modifier, since inverting
162 > its normal would also reorient the BSDF and alter its behaviour.
163 > .RE
164 > .IP
165 > Other oddball scenarios are conceivable. If in doubt, specify a
166 > bidirectional port orientation for a slight performance penalty,
167 > as photon emission is attempted from both sides. For well-defined
168 > port geometry with inward-facing normals, just use the default;
169 > doan' mess with da normalz.
170 > .IP
171 > Photon port geometry is discretised according to the
172 > \fB\-dp\fR and \fB\-ds\fR options. These parameters aid in resolving
173 > spatially and directionally varying illuminance received by the port
174 > from distant light sources, e.g due to partial occlusion
175 > or when using climate-based sky models.
176 >  
177   .IP "\fB\-apO \fImodfile\fR"
178   Read photon port modifiers from the file \fImodfile\fR as a more convenient
179   alternative to multiple instances of \fB\-apo\fR.
# Line 206 | Line 243 | possibly scattered if they strike the back of a surfac
243   are unconditionally absorbed and discarded.
244  
245   .IP "\fB\-dp \fIsampleres\fR"
246 < Resolution for sampling the spatial emission distribution of a modified
247 < light source (e.g. via \fIbrightfunc\fR), in samples per steradian. This
248 < is required for numerically integrating the flux emitted by the light
249 < source and for constructing a probability density function for photon
250 < emission. The accuracy of photon emission from modified sources
251 < therefore depends on this parameter. This parameter may need increasing
246 > Angular resolution for sampling the spatial emission distribution of a
247 > modified light source or photon port (e.g. via \fIbrightfunc\fR), in samples
248 > per steradian.
249 > This is required to numerically integrate the flux emitted by the light
250 > source and construct a probability density function for photon emission.
251 > The accuracy of photon emission from a modified source or port
252 > therefore depends on this parameter. The resolution may need to be increased
253   with complex emission distributions in combination with caustics.
254  
255   .IP "\fB\-ds \fIpartsize\fR"
256 < Light source partition size ratio; a light source object is spatially
257 < partitioned to distribute the photon emission over its surface. This
258 < parameter specifies the ratio of the size (per dimension) of each
259 < partition to the scene cube, and may need increasing for modified light
260 < sources (e.g. via \fIbrightfunc\fR) with high spatial variation.
256 > Light source partition size ratio; a local light source object (or photon
257 > port in case of a distant source) is spatially partitioned to distribute the
258 > photon emission over its surface. This parameter specifies the ratio of the
259 > size (per dimension) of each partition to the scene cube, and may need
260 > to be reduced for modified light sources (e.g. via \fIbrightfunc\fR) with
261 > high spatial variance, or for partially occluded photon ports.
262  
263   .IP "\fB\-e \fIfile\fR"
264   Redirect diagnostics and progress reports to \fIfile\fR instead of the
# Line 267 | Line 306 | with the \fB\-apv\fR option. See \fIrpict(1)\fR for de
306  
307   .IP "\fB\-n \fInproc\fR"
308   Use \fInproc\fR processes for parallel photon distribution. There is no
309 < benefit in specifying more than the number of physical CPU cores available.
310 < This option is currently not available on Windows.
309 > benefit in specifying more than the number of physical CPU cores available
310 > (so doan' even try). This option is currently not available on Windows --
311 > so there, tuff luck.
312  
313   .IP "\fB\-t \fIinterval\fR"
314   Output a progress report every \fIinterval\fR seconds. This includes
# Line 340 | Line 380 | mkpmap \-app bonzo-precomp.gpm 80k 40 \-apP 0.25 bonzo
380   .PP
381   Generate 1 million global photons by emitting them from external light
382   sources of type \fIsource\fR into a reference room via a fenestration
383 < with modifier \fIglazingMat\fR:
383 > with modifier \fIglazingMat\fR acting as photon port, with inward-facing
384 > normal:
385   .IP
386   mkpmap \-apg refRoom.gpm 1m \-apo glazingMat refRoom.oct
387   .PP
388 < Generate a contribution photon map containing 200000 photons suitable for
389 < obtaining light source contributions with \fIrcontrib(1)\fR:
388 > Generate a contribution photon map containing 10 million photons to bin
389 > light source contributions with \fIrcontrib(1)\fR:
390   .IP
391 < mkpmap \-apC bonzo-contrib.gpm 200k bonzo.oct
391 > mkpmap \-apC bonzo-contrib.gpm 10m bonzo.oct
392  
393   .SH BUGS
394   The focus of a spotlight source, as defined by the length of its direction
# Line 361 | Line 402 | Light sources simply absorb incoming photons.
402   Roland Schregle (roland.schregle@{hslu.ch,gmail.com})
403  
404   .SH COPYRIGHT
405 < (c) Fraunhofer Institute for Solar Energy Systems, Lucerne University of
406 < Applied Sciences and Arts.
405 > (c) Fraunhofer Institute for Solar Energy Systems,
406 > .br
407 > (c) Lucerne University of Applied Sciences and Arts,
408 > .br
409 > (c) Tokyo University of Science.
410  
411 < .SH ACKNOWLEDGEMENT
412 < Development of the RADIANCE photon mapping extension was sponsored by the
369 < German Research Foundation (DFG) and the Swiss National Science Foundation
370 < (SNF).
411 > .SH ACKNOWLEDGEMENTS
412 > Development of the RADIANCE photon mapping extension was supported by:
413  
414 + .RS
415 + \fIFraunhofer Institute for Solar Energy Systems\fR funded by
416 + the German Research Foundation (\fIDFG LU-204/10-2\fR, "Fassadenintegrierte
417 + Regelsysteme (FARESYS)"),
418 +
419 + \fILucerne University of Applied Sciences and Arts\fR funded by
420 + the Swiss National Science Foundation (\fISNSF 147053\fR, "Daylight redirecting components"),
421 +
422 + \fITokyo University of Science\fR funded by the JSPS Grants-in-Aid for Scientific
423 + Research Programme (\fIKAKENHI JP19KK0115\fR, "Three-dimensional light flow").
424 + .RE
425 +
426 + Many thanks also to the many individuals who tested the code and provided
427 + valuable feedback. Special greetz to Don Gregorio, PAB and Capt.\~B!
428 +
429   .SH "SEE ALSO"
430 < rpict(1), rtrace(1), rvu(1), rcontrib(1), \fIThe RADIANCE Photon Map
431 < Manual\fR, \fIDevelopment and Integration of the RADIANCE Photon Map
432 < Extension: Technical Report\fR
430 > rpict(1), rtrace(1), rvu(1), rcontrib(1),
431 > .br
432 > \fIThe RADIANCE Photon Map Manual\fR,
433 > .br
434 > \fIDevelopment and Integration of the RADIANCE Photon Map Extension:
435 > Technical Report\fR,
436 > .br
437 > \fIThe RADIANCE Out-of-Core Photon Map: Technical Report\fR,
438 > .br
439 > \fIBonzo Daylighting Tool a.k.a. EvilDRC [TM]\fR
440 >

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines