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

Comparing ray/doc/man/man1/rcomb.1 (file contents):
Revision 1.1 by greg, Tue Dec 12 16:31:45 2023 UTC vs.
Revision 1.8 by greg, Mon May 20 23:21:28 2024 UTC

# Line 11 | Line 11 | rcomb - combine and convert matrices a row at a time
11   ][
12   .B \-f[afdc]
13   ][
14 + .B "\-n nproc"
15 + ][
16   .B "\-f file"
17   ][
18   .B "\-e expr"
# Line 53 | Line 55 | or
55   .I \-s
56   options follow the last input matrix, output results will be transformed
57   and/or scaled accordingly.
58 < These operations are discussed in greater detail further on.
58 > These operations are discussed in greater detail below.
59   A single concatenation matrix may be applied after element operations
60   using the
61   .I \-m
# Line 71 | Line 73 | FORMAT={ascii|float|double|32-bit_rle_rgbe|32-bit_rle_
73   .fi
74   .sp
75   The number of components indicates that each matrix element is actually
76 < composed of multiple elements, most commonly an RGB triple.
76 > composed of multiple channels, most commonly an RGB triple.
77   This is essentially dividing the matrix into planes, where each component
78   participates in a separate calculation.
79   If an appropriate header is not present, it may be added with a call to
# Line 94 | Line 96 | will be undone, similar to the
96   option.
97   Radiance spectral pictures with more than 3 components are also supported.
98   These are typically produced by
99 < .I rtrace(1)
99 > .I rtpict(1)
100   or
101   .I rfluxmtx(1).
102   .PP
# Line 144 | Line 146 | option is given, the output will be written as a RGBE
146   Note that conversion from a float or RGBE color space applies a conversion
147   of 179 lumens/watt (for CIE or melanopic output) or 412 (for scotopic output),
148   and the reverse happens for conversion from XYZE input to RGB or RGBE output.
149 + Lower case versions of all these components are also supported, the only
150 + difference is that the aforementioned efficacy factors
151 + will be left out of the conversion.
152   .PP
153   If a matrix or picture file path is given to the
154   .I \-c
# Line 185 | Line 190 | If the
190   or
191   .I \-f
192   options are used to define a "co" variable or "co(p)" function,
193 < this will be evaluated at each output
194 < component for the current element.
193 > which will be evaluated for each output
194 > component from the current element.
195   The "co" variable defines identical operations for all components,
196   whereas "co(p)" may specify different operations for each component.
197   The element position is defined
# Line 195 | Line 200 | by the "r" and "c" variables, where
200   goes from 0 to "nrows" minus one, and
201   .I c
202   goes from 0 to "ncols" minus one.
203 + (Note that "nrows" may be zero if unspecified in inputs, and this
204 + is a unique capability of
205 + .I rcomb
206 + to handle these.)\0
207   Component p from input i is accessed with the "ci(i,p)" function,
208   and the number of components is defined by the "ncomp" constant.
209   If given as "ci(i)", the function returns the current component
210   being evaluated by
211   .I rcomb.
212 < A different component may be referenced using th second argument.
212 > A different component may be referenced using the second argument.
213   For example, "ci(1,2)" accesses
214   the second component from the first input.
215   If the input is a picture, the the constants "R", "G", and "B"
# Line 215 | Line 224 | For convenience and compatibility with
224   the functions "ri(i)", "gi(i)", and "bi(i)" are predefined as
225   "ci(i,R)", "ci(i,G)", and "ci(i,B)", respectively.
226   Accordingly, the "ro", "go", and "bo"
227 < variables may be used in place of "co(R)", "co(G)", and "co(B)".
227 > variables may be used in place of "co(R)", "co(G)", and "co(B)",
228 > but all three must be defined for this substitution to take place.
229   Finally, the total number of input files is set in the constant "nfiles".
230   .PP
231   Results are sent to the standard output.
# Line 242 | Line 252 | The
252   .I \-w
253   option turns off warnings about divide-by-zero and other non-fatal
254   calculation errors.
255 + .PP
256 + The
257 + .I \-n
258 + option specifies how many execution processes to employ,
259 + which may improve performance on multi-core architectures,
260 + especially for matrix multiplication
261 + and complex operations on long input rows.
262   .SH EXAMPLES
263   To convert two hyperspectral inputs to RGB color space,
264   average them together, and write them out as a RADIANCE picture:
# Line 273 | Line 290 | and
290   .I pcomb,
291   whose capabilities somewhat overlap.
292   The former loads each matrix into memory before operations,
293 < and element components take 8 bytes apiece, adding up quickly.
293 > and element components are stored as double-precision.
294   Very large matrices therefore present a problem with that tool.
295   Furthermore,
296   .I rmtxop
# Line 306 | Line 323 | Generally speaking,
323   .I rcomb
324   should be preferred over
325   .I rmtxop
326 < for any operations in can handle, which is everything except
326 > for any operations it can handle, which is everything except
327   multiple matrix concatenations and transpose
328 < operations, which are handled more efficiently by
329 < .I rcollate(1)
330 < in any case.
328 > operations.
329 > The latter may be handled more efficiently by
330 > .I rcollate(1).
331   That said, there is no significant difference for
332 < simple operations on smallish matrices, and note that only
332 > simple operations on small matrices, and only
333   .I rmtxop
334   and
335   .I dctimestep(1)
336 < currently accept XML files as inputs.
337 < Also, the resizing function of
336 > accept XML files as inputs.
337 > Also note that the resizing function of
338   .I pcomb
339   is not supported in
340   .I rcomb,
341   and should instead be handled by
342   .I pfilt(1).
343 + .SH BUGS
344 + The
345 + .I rcomb
346 + command currently ignores the "PRIMARIES" setting in input
347 + headers, and does not produce any on output, even in
348 + circumstances where it would make sense to.
349   .SH AUTHOR
350   Greg Ward
351   .SH "SEE ALSO"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines