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.5 by rschregle, Thu Mar 30 11:58:17 2017 UTC vs.
Revision 1.11 by rschregle, Thu Dec 6 20:13:13 2018 UTC

# Line 60 | Line 60 | from the light sources, as the quality is too low for
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
# Line 124 | Line 130 | accelerates photon distribution in scenes where photon
130   space which separates them from the emitting light source via an
131   opening, or 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 > 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.
136   .IP
137   Note that port objects must be defined with their surface normals
138   pointing \fIinside\fR as per \fImkillum\fR convention.
# Line 136 | Line 141 | pointing \fIinside\fR as per \fImkillum\fR convention.
141   Read photon port modifiers from the file \fImodfile\fR as a more convenient
142   alternative to multiple instances of \fB\-apo\fR.
143  
144 + .IP "\fB\-apP \fIprecomp\fR"
145 + Fraction of global photons to precompute in the range ]0,1] when using the
146 + \fB\-app\fR option.
147 +
148   .IP "\fB\-apr \fIseed\fR"
149 < Seed for the random number generator. This is necessary for generating
150 < different photon distributions for the same octree and photon map size.
149 > Seed for the random number generator. This is useful for generating
150 > different photon distributions for the same octree and photon map size,
151 > notably in progressive applications.
152  
153   .IP "\fB\-aps \fImod\fR"
154   Specifies a modifier \fImod\fR defined as \fIantimatter\fR material to act
# Line 148 | Line 158 | be transferred through the surface without undergoing
158   surface therefore does not affect the light transport and simply acts as an
159   invisible photon receiver.  This is useful when photon irradiance is to be
160   evaluated at points which do not lie on regular geometry, e.g.  at workplane
161 < height with \firtrace\fR's \fB-I\fR option.  Without this workaround,
161 > height with \fIrtrace\fR's \fB-I\fR option.  Without this workaround,
162   photons would be collected from parallel but distant planes, leading to
163   underestimation.  Note that photons are only deposited when incident from
164   the front side of the sensor surface, i.e.  when entering the
# Line 159 | Line 169 | an error if the specified modifier is not an \fIantima
169   Read virtual receiver surface modifiers from the file \fImodfile\fR as a more
170   convenient alternative to multiple instances of \fB\-aps\fR.
171  
172 + .IP "\fB\-ae \fImod\fR"
173 + Add \fImod\fR to the ambient exclude list, so that it will be ignored by the
174 + photon map.  Objects having \fImod\fR as their modifier will not have
175 + photons deposited on them.  Multiple modifiers may be given, each as separate
176 + instances of this option.
177 + .IP
178 + \fBWARNING: this is an optimisation option for advanced users and may yield
179 + biased results. It may also significantly increase photon distribution
180 + times. Use with caution!\fR
181 +
182 + .IP "\fB\-aE \fIfile\fR"
183 + Same as \fI-ae\fR, except modifiers to be exluded are read from \fIfile\fR,
184 + separated by whitespace.  The RAYPATH environment variable determines which
185 + directories are searched for this file.
186 +
187 + .IP "\fB\-ai \fImod\fR"
188 + Add \fImod\fR to the ambient include list, so that it will contribute to the
189 + photon map. Only objects having \fImod\fR as their modifier will have
190 + photons deposited on them. Multiple modifiers may be given, each as separate
191 + instances of this option. Note that the ambient include and exclude options
192 + are mutually exclusive.
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\-aI \fIfile\fR"
199 + Same as \fI-ai\fR, except modifiers to be included 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\-bv\fR[\fB+\fR|\fB-\fR]"
204   Toggles backface visibility; enabling this causes photons to be stored and
205   possibly scattered if they strike the back of a surface, otherwise they
# Line 190 | Line 231 | overwrite an already existing photon map file. This is
231   inadvertently destroying the results of potentially lengthy photon
232   mapping runs.
233  
234 < .IP "\fB\-i \fIinc\fR"
235 < Photon heap size increment; the photon heap is enlarged by this amount
236 < when storage overflows during photon distribution. No need to fiddle
237 < with this under ordinary circumstances.
234 > .IP "\fB\-ld \fImaxdist\fR"
235 > Limit cumulative distance travelled by a photon along its path to
236 > \fImaxdist\fR.  Photon hits within this distance will be stored, and the
237 > photon is terminated once its path length exceeds this limit.  This is
238 > useful for setting radial regions of interest around emitting/reflecting
239 > geometry, but may increase the photon distribution time.  
240 > .IP
241 > \fBWARNING: this is an optimisation option for advanced users (an elite
242 > group collectively known as \fIZe Ekspertz\fB) and may yield biased results.
243 > Use with caution!\fR
244  
245 + .IP "\fB\-lr \fImaxbounce\fR"
246 + Limit number of bounces (scattering events) along a photon path to
247 + \fImaxbounce\fR before being considered "runaway" and terminated.  Photons
248 + paths are normally terminated via \fIRussian Roulette\fR, depending on their
249 + albedo.  With unrealistically high albedos, this is not guaranteed, and this
250 + option imposes a hard limit to avoid an infinite loop.
251 + .IP
252 + \fBWARNING: this is an optimisation option for advanced users (an elite
253 + group collectively known as \fIZe Ekspertz\fB) and may yield biased results.
254 + Use with caution!\fR
255 +
256   .IP "\fB\-ma \fIralb galb balb\fR"
257   Set the global scattering albedo for participating media in conjunction
258   with the \fB\-apv\fR option. See \fIrpict(1)\fR for details.
# Line 248 | Line 306 | attempts before terminating with an error. This can be
306   \fB\-apM\fR option.
307  
308   .SS Material Support
309 < The \fIplasfunc\fR, \fImetfunc\fR, \fItransfunc\fR, \fIbrtdfunc\fR,
310 < \fIplasdata\fR, \fImetdata\fR and \fItransdata\fR materials are not
311 < supported by the photon mapping extension. Use the newer \fIbsdf\fR material
309 > Not all materials are fully supported by the photon map extension.  The
310 > \fIplasfunc\fR, \fImetfunc\fR, \fItransfunc\fR, \fIplasdata\fR,
311 > \fImetdata\fR and \fItransdata\fR materials currently only scatter photons
312 > diffusely, and will not produce caustics.  The \fIbrtdfunc\fR material only
313 > produces caustics via ideal (mirror) specular reflection and transmission.
314 > For more realistic scattering behaviour, use the newer \fIbsdf\fR material
315   instead.
316   .PP
317   Virtual light sources (normally enabled with the \fImirror\fR material) are
# Line 309 | Line 370 | German Research Foundation (DFG) and the Swiss Nationa
370   (SNF).
371  
372   .SH "SEE ALSO"
373 < rpict(1), rtrace(1), rvu(1), rcontrib(1),
374 < \fIThe RADIANCE Photon Map Manual\fR
375 <
373 > rpict(1), rtrace(1), rvu(1), rcontrib(1), \fIThe RADIANCE Photon Map
374 > Manual\fR, \fIDevelopment and Integration of the RADIANCE Photon Map
375 > Extension: Technical Report\fR

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines