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

Comparing ray/doc/man/man1/mkpmap.1 (file contents):
Revision 1.9 by rschregle, Tue Feb 6 16:02:22 2018 UTC vs.
Revision 1.13 by rschregle, Fri Aug 7 01:22:59 2020 UTC

# Line 101 | Line 101 | may be useful if the resulting photon map size greatly
101   \fInphotons\fR with a very low average reflectance.
102  
103   .IP "\fB\-api \fIxmin ymin zmin xmax ymax zmax\fR"
104 < Define a region of interested within which to store photons exclusively;
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
# Line 118 | Line 118 | 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 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 > 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.
# Line 169 | 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 275 | 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 306 | 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 \-apC 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 327 | 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
335 < German Research Foundation (DFG) and the Swiss National Science Foundation
336 < (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), \fIThe RADIANCE Photon Map
407 < Manual\fR, \fIDevelopment and Integration of the RADIANCE Photon Map
408 < Extension: Technical Report\fR
406 > rpict(1), rtrace(1), rvu(1), rcontrib(1),
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 (old)
> Changed lines (new)