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

Comparing ray/doc/man/man1/rcalc.1 (file contents):
Revision 1.3 by greg, Thu Nov 6 05:39:32 2003 UTC vs.
Revision 1.14 by greg, Mon Jun 10 13:56:52 2019 UTC

# Line 1 | Line 1
1 < .\" RCSid "$Id"
1 > .\" RCSid "$Id$"
2   .TH RCALC 1 4/6/99 RADIANCE
3   .SH NAME
4   rcalc - record calculator
# Line 9 | Line 9 | rcalc - record calculator
9   ][
10   .B \-l
11   ][
12 + .B \-p
13 + ][
14   .B \-n
15   ][
16   .B \-w
# Line 21 | Line 23 | rcalc - record calculator
23   ][
24   .B "\-o format"
25   ][
26 + .B "\-in M"
27 + ][
28 + .B "\-on M"
29 + ][
30   .B "\-f source"
31   ][
32   .B "\-e expr"
# Line 54 | Line 60 | A special form of the
60   option may be followed immediately by a 'd' or an 'f' and an optional
61   count, which defaults to 1, indicating the number of double or float
62   binary values to read per record on the input file.
63 + If the input is byte-swapped, the
64 + .I \-iD
65 + or
66 + .I \-iF
67 + options may be substituted.
68   If binary input is specified, no format string or file is needed.
69   .PP
70   A
# Line 66 | Line 77 | or
77   .I \-of
78   options do not require a count, as this will be determined by the
79   number of output channels in the given expressions.
80 + If byte-swapped output is desired, the
81 + .I \-oD
82 + or
83 + .I \-oF
84 + options may be substituted.
85   .PP
86 + The
87 + .I \-p
88 + option specifies "passive mode," where characters that do not
89 + match the input format are passed unaltered to the output.
90 + This option has no effect unless
91 + .I \-i
92 + is also specified, and does not make much sense unless
93 + .I \-o
94 + is also given.
95 + With both input and output formats, the passive mode can
96 + effectively substitute information in the middle of a file
97 + or stream without affecting the rest of the data.
98 + .PP
99 + If a
100 + .I \-in
101 + option is given with a positive integer argument,
102 + .I rcalc
103 + will stop processing input once it has loaded this number of records.
104 + Similarly, if a
105 + .I \-on
106 + option is present,
107 + .I rcalc
108 + will stop after producing this many records, which may be a smaller
109 + number if the
110 + .I cond
111 + variable is used.
112 + If multiple input files are given, these counts are continuous over
113 + the input and do not reset on each file.
114 + .PP
115   The variable and function definitions in each
116   .I \-f source
117 < file are read and compiled.
117 > file are read and compiled from the RADIANCE library where it is found.
118   The
119   .I \-e expr
120   option can be used to define variables on the command line.
# Line 177 | Line 222 | and the following operators:
222   .PP
223          +  -  *  /  ^
224   .PP
225 < Operators are evaluated left to right.
225 > Operators are evaluated left to right, except '^',
226 > which is right associative.
227   Powers have the highest precedence; multiplication and
228   division are evaluated before addition and subtraction.
229   Expressions can be grouped with parentheses.
# Line 209 | Line 255 | are evaluated.
255   This provides a convenient method for avoiding inappropriate calculations.
256   The following library of pre-defined functions and variables is provided:
257   .TP 10n
258 + .BR $N
259 + Return the value for input column
260 + .I N.
261 + If an input format is given, using a channel number generates an error.
262 + .TP
263   .BR "in(n)"
264   Return the value for input column
265   .I n,
# Line 234 | Line 285 | is zero, the number of available arguments is returned
285   .BR "rand(x)"
286   compute a random number between 0 and 1 based on x.
287   .TP
288 + .BR "min(a1, a2, ..)"
289 + return the minimum value from a list of arguments.
290 + .TP
291 + .BR "max(a1, a2, ..)"
292 + return the maximum value from a list of arguments.
293 + .TP
294   .BR "floor(x)"
295   return largest integer not greater than x.
296   .TP
# Line 268 | Line 325 | trigonometric functions.
325   inverse trigonometric functions.
326   .TP
327   .BR "atan2(y, x)"
328 < inverse tangent of y/x (range -pi to pi).
328 > inverse tangent of y/x (range \-pi to pi).
329   .SH EXAMPLE
330   To print the square root of column two in column one,
331   and column one times column three in column two:
332   .IP "" .2i
333 < rcalc -e '$1=sqrt($2);$2=$1*$3' inputfile > outputfile
333 > rcalc \-e '$1=sqrt($2);$2=$1*$3' inputfile > outputfile
334 > .SH ENVIRONMENT
335 > RAYPATH         the directories to check for auxiliary files.
336   .SH AUTHOR
337   Greg Ward
338   .SH BUGS
# Line 283 | Line 342 | options, not in definitions.
342   .PP
343   Tabs count as single spaces inside fields.
344   .SH "SEE ALSO"
345 < calc(1), cnt(1), ev(1), getinfo(1), lam(1), tabfunc(1), total(1)
345 > cnt(1), ev(1), getinfo(1), icalc(1), rcollate(1), rlam(1), tabfunc(1), total(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines