--- ray/doc/man/man1/rxfluxmtx.1 2025/10/23 23:34:59 1.1 +++ ray/doc/man/man1/rxfluxmtx.1 2025/11/14 23:51:42 1.4 @@ -1,4 +1,4 @@ -.\" RCSid "$Id: rxfluxmtx.1,v 1.1 2025/10/23 23:34:59 greg Exp $" +.\" RCSid "$Id: rxfluxmtx.1,v 1.4 2025/11/14 23:51:42 greg Exp $" .TH RXFLUXMTX 1 10/23/2025 RADIANCE .SH NAME rxfluxmtx - compute flux transfer matrix(es) for RADIANCE scene @@ -6,6 +6,8 @@ rxfluxmtx - compute flux transfer matrix(es) for RADIA .B rxfluxmtx [ .B \-W +][ +.B "-bj frac" ] [ .B "rcontrib options" ] @@ -62,6 +64,9 @@ option turns on verbose mode, and the .I \-t option sets the number of seconds between progress reports, similar to .I rcontrib(1). +Likewise, the +.I \-c +option specifies the number of times to repeat each sample. However, the .I rcontrib options @@ -75,6 +80,18 @@ options are controlled by .I rxfluxmtx and may not be set by the user. .PP +The +.I \-bj +option sets the amount of bin jittering, which blurs the boundaries of +receiver bins and is generally recommended when creating a view that may +include direct visibility of the receiver surface(s). +It is best used in combination with the +.I \-c +and +.I \-pj +options described above. +(The default jitter is 0, leaving sharp bin boundaries.)\0 +.PP The sample count, unless set by the .I \-c option, defaults to 10000 when a sender file is given, or to 1 for @@ -140,18 +157,27 @@ Orient the "up" direction for the hemisphere using the vector. .TP .BI o =output_spec -Send the matrix data for this receiver to the indicated file or command. -Single or double quotes may be used to contain strings with spaces. +Send the matrix data for this receiver to the indicated file specification. +Single or double quotes may be used to contain strings with spaces, and +the usual "%s" and "%d" formats incorporate the modifier name and/or +bin number, as with +.I rcontrib. Command (piped) output is not supported. -The file format will be determined by the command-line +.PP +If no output_spec directive is given, it must be specified by a +.I \-o +setting on the command-line, since output to stdout is not supported. +The input and output file formats are controlled by the .I \-fio -option, which may use a single letter for identical input and output formats. -The input file specification matters only in pass-through mode, for which +option, which may use a single letter for identical i/o formats. +The input format matters only in pass-through mode, for which ASCII input is supported. +The default setting is +.I \-faf. ASCII output is unsupported, since it interferes with -efficient recovery in the +efficient recovery when using the .I \-r -mode. +option. .PP In normal execution, only a single sender surface is sampled, but it may be comprised of any number of subsurfaces, as in a triangle mesh or similar. @@ -188,11 +214,11 @@ calculation and the resulting matrices will concatenat To generate a flux transfer matrix connecting input and output apertures on a light pipe: .IP "" .2i -rxfluxmtx int_aperture.rad ext_aperture.rad lpipe.rad > lpipe.mtx +rxfluxmtx -o lpipe.mtx int_aperture.rad ext_aperture.rad lpipe.rad .PP -To generate a set of DC view component pictures with 9 samples/pixel: +To generate a set of DC view component pictures with 9 jittered samples/pixel: .IP "" .2i -rxfluxmtx -vf v1.vf -x 512 -y 512 -c 9 -fc reinhart_M4.rad -i scene1.oct +rxfluxmtx -vf v1.vf -x 512 -y 512 -c 9 -pj .8 -fc reinhart_M4.rad -i scene1.oct .PP To compute a workplane irradiance matrix for each window in a space: .IP "" .2i @@ -209,7 +235,7 @@ Instead, it relies on a unix-only C++ class definition control over i/o. This allows an unlimited number of receivers, a .I \-r -recovery option, and simplifies internal operations. +recovery option, and streamlines operations. .SH AUTHOR Greg Ward .SH "SEE ALSO"