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

Comparing ray/doc/man/man1/rcollate.1 (file contents):
Revision 1.3 by greg, Fri Sep 6 21:34:38 2013 UTC vs.
Revision 1.9 by greg, Fri Nov 8 02:10:38 2019 UTC

# Line 5 | Line 5 | rcollate - resize or transpose matrix data
5   .SH SYNOPSIS
6   .B rcollate
7   [
8 < .B \-h
8 > .B \-h[io]
9   ][
10   .B \-w
11   ][
12 < .B \-f[afdb][N]]
12 > .B \-f[afdb][N]
13   ][
14   .B \-t
15   ][
# Line 20 | Line 20 | rcollate - resize or transpose matrix data
20   .B "\-oc out_col"
21   ][
22   .B "\-or out_row"
23 + ][
24 + .B "\-o RxC[xR1xC2..]"
25   ]
26   [
27   .B input.dat
# Line 30 | Line 32 | reads in a single matrix file (table) and reshapes it
32   the number of columns specified by the
33   .I \-oc
34   option.
35 + The number of rows may be specified with a
36 + .I \-or
37 + option, or may be determined automatically from the size of the input if
38 + it is an even multiple of the number of columns (as it should be).
39 + Alternatively, both may be specified using a
40 + .I \-o
41 + option with the number of rows and columns separated by an 'x', as in "30x14"
42 + for 30 rows by 14 columns.
43 + .I Rcollate
44 + can also reorder the input into nested blocks by continuing the output size
45 + string, "3x10X7x2" would order output data with a 3x10 super-array of 7x2
46 + subblocks.
47 + This is a convenient way to visualize tensor data.
48 + .PP
49   By default, the file is assumed to include an information header, which
50 < is copied to the standard output along with the command name, but the
50 > is copied to the standard output along with the command name.
51 > The
52 > .I \-hi
53 > option may be used to turn off the expectation of a header on input.
54 > The
55 > .I \-ho
56 > option turns off header output, and
57   .I \-h
58 < option may be used to turn this behavior off.
58 > by itself turns off both input and output headers.
59   The
60   .I \-w
61   option turns off non-fatal warning messages, such as unexpected EOD.
# Line 69 | Line 91 | Note that the lack of row separators in binary files m
91   does not actually do anything for binary files unless the transpose
92   option is given, also.
93   .PP
94 + If an input header is present, it may contain the format, number of components
95 + and matrix dimensions.
96 + In such cases, the
97 + .I \-ic,
98 + .I \-ir
99 + and
100 + .I \-f
101 + options are not required, but will be checked against the header
102 + information if provided.
103 + .PP
104   The transpose option,
105   .I \-t
106   swaps rows and columns on the input.
# Line 88 | Line 120 | For large transpose operations on Unix systems, it is
120   to specify the input file on the command line, rather than reading
121   from the standard input, since
122   .I rcollate
123 < can map the file directly into memory.
124 < .SH EXAMPLE
123 > can map the file directly into virtual memory.
124 > .SH EXAMPLES
125   To change put 8760 color triplets per row in a matrix with no header:
126   .IP "" .2i
127   rcollate -h \-oc 8760 input.dat > col8760.dat
# Line 97 | Line 129 | rcollate -h \-oc 8760 input.dat > col8760.dat
129   To transpose a binary file with 145 float triplets per input row:
130   .IP "" .2i
131   rcollate -ff3 -ic 145 -t orig.flt > transpose.flt
132 + .PP
133 + To create an appropriate header for a binary float matrix as required by
134 + .I rmtxop(1)\:
135 + .IP "" .2i
136 + rcollate -hi -ff3 -or 145 -oc 8760 input.smx | rmtxop dcoef.dmx - > res.txt
137 + .PP
138 + To visualize a Shirley-Chiu BTDF matrix where the interior resolution is
139 + 64x64 and the exterior resolution is 32x32:
140 + .IP "" .2i
141 + rcollate -o 64x64X32x32 s-c_bsdf.mtx | rmtxop -fc - > s-c_bsdf.hdr
142   .SH AUTHOR
143   Greg Ward
144   .SH NOTES
# Line 114 | Line 156 | without a transpose,
156   .I rcollate
157   issues a warning and simply copies its input to its standard output.
158   .SH "SEE ALSO"
159 < cnt(1), histo(1), neaten(1), rcalc(1), rlam(1), tabfunc(1), total(1)
159 > cnt(1), histo(1), neaten(1), rcalc(1), rlam(1), rmtxop(1),
160 > rsplit(1), tabfunc(1), total(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines