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.2 by greg, Thu Sep 5 18:50:30 2013 UTC vs.
Revision 1.12 by greg, Mon Nov 11 18:38:41 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 \-f[afdb][N]]
10 > .B \-w
11   ][
12 + .B \-f[afdb][N]
13 + ][
14   .B \-t
15   ][
16   .B "\-ic in_col"
# Line 18 | 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 28 | 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.
46 + For example, "3x10X7x2" would order output data with a 3x10 super-array of
47 + 7x2 subblocks.
48 + This type of block hierarchy is convenient for visualizing tensor data.
49 + .PP
50   By default, the file is assumed to include an information header, which
51 < is copied to the standard output along with the command name, but the
51 > is copied to the standard output along with the command name.
52 > The
53 > .I \-hi
54 > option may be used to turn off the expectation of a header on input.
55 > The
56 > .I \-ho
57 > option turns off header output, and
58   .I \-h
59 < option may be used to turn this behavior off.
59 > by itself turns off both input and output headers.
60 > The
61 > .I \-w
62 > option turns off non-fatal warning messages, such as unexpected EOD.
63   .PP
64   The input format is assumed to be ASCII, with three white-space separated words
65   (typically numbers) in each record.
# Line 64 | Line 92 | Note that the lack of row separators in binary files m
92   does not actually do anything for binary files unless the transpose
93   option is given, also.
94   .PP
95 + If an input header is present, it may contain the format, number of components
96 + and matrix dimensions.
97 + In such cases, the
98 + .I \-ic,
99 + .I \-ir
100 + and
101 + .I \-f
102 + options are not required, but will be checked against the header
103 + information if provided.
104 + .PP
105   The transpose option,
106   .I \-t
107   swaps rows and columns on the input.
# Line 83 | Line 121 | For large transpose operations on Unix systems, it is
121   to specify the input file on the command line, rather than reading
122   from the standard input, since
123   .I rcollate
124 < can map the file directly into memory.
125 < .SH EXAMPLE
124 > can map the file directly into virtual memory.
125 > If the
126 > .I \-o
127 > option is also given with multiple block levels, the transpose operation
128 > will logically precede the reblocking operation, regardless of the order
129 > they are given on the command line.
130 > .SH EXAMPLES
131   To change put 8760 color triplets per row in a matrix with no header:
132   .IP "" .2i
133   rcollate -h \-oc 8760 input.dat > col8760.dat
# Line 92 | Line 135 | rcollate -h \-oc 8760 input.dat > col8760.dat
135   To transpose a binary file with 145 float triplets per input row:
136   .IP "" .2i
137   rcollate -ff3 -ic 145 -t orig.flt > transpose.flt
138 + .PP
139 + To create an appropriate header for a binary float matrix as required by
140 + .I rmtxop(1)\:
141 + .IP "" .2i
142 + rcollate -hi -ff3 -or 145 -oc 8760 input.smx | rmtxop dcoef.dmx - > res.txt
143 + .PP
144 + To visualize a Shirley-Chiu BTDF matrix where the interior resolution is
145 + 64x64 and the exterior resolution is 32x32:
146 + .IP "" .2i
147 + rcollate -o 64x64X32x32 s-c_bsdf.mtx | rmtxop -fc - > s-c_bsdf.hdr
148   .SH AUTHOR
149   Greg Ward
150   .SH NOTES
# Line 109 | Line 162 | without a transpose,
162   .I rcollate
163   issues a warning and simply copies its input to its standard output.
164   .SH "SEE ALSO"
165 < cnt(1), histo(1), neaten(1), rcalc(1), rlam(1), tabfunc(1), total(1)
165 > cnt(1), histo(1), neaten(1), rcalc(1), rlam(1), rmtxop(1),
166 > rsplit(1), tabfunc(1), total(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines