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

Comparing ray/doc/man/man1/dctimestep.1 (file contents):
Revision 1.2 by greg, Thu Jul 1 21:54:55 2010 UTC vs.
Revision 1.17 by greg, Fri Mar 11 02:27:02 2022 UTC

# Line 1 | Line 1
1   .\" RCSid $Id$"
2   .TH DCTIMESTEP 1 12/09/09 RADIANCE
3   .SH NAME
4 < dctimestep - compute annual simulation time-step via matrix multiplication
4 > dctimestep - compute annual simulation time-step(s) via matrix multiplication
5   .SH SYNOPSIS
6   .B dctimestep
7 + [
8 + .B "\-n nsteps"
9 + ][
10 + .B "\-h"
11 + ][
12 + .B "\-o ospec"
13 + ][
14 + .B "\-x xres"
15 + ][
16 + .B "\-y yres"
17 + ][
18 + .B "\-i{f|d}
19 + ][
20 + .B "\-o{f|d|c}
21 + ]
22   .B DCspec
23   [
24 < .B skyvec
24 > .B skyf
25   ]
26   .br
27   .B dctimestep
28 + [
29 + .B "\-n nsteps"
30 + ][
31 + .B "\-h"
32 + ][
33 + .B "\-o ospec"
34 + ][
35 + .B "\-i{f|d}
36 + ][
37 + .B "\-o{f|d}
38 + ]
39   .B Vspec
40 < .B Tbsdf.xml
40 > .B Tbsdf
41   .B Dmat.dat
42   [
43 < .B skyvec
43 > .B skyf
44   ]
45   .SH DESCRIPTION
46   .I Dctimestep
# Line 22 | Line 48 | has two invocation forms.
48   In the first form,
49   .I dctimestep
50   is given a daylight coefficient specification and an optional sky
51 < vector, which may be read from the standard input if unspecified.
52 < The daylight coefficients are multiplied against this vector and the results
53 < are written to the standard output.
51 > vector or matrix, which may be read from the standard input if unspecified.
52 > The daylight coefficients are multiplied against these sky values
53 > and the results are written to the standard output.
54   This may be a list of color values or a combined Radiance image,
55   as explained below.
56   .PP
# Line 35 | Line 61 | The first argument is the View matrix file that specif
61   directions are related to some set of measured values, such as an array of
62   illuminance points or images.
63   This matrix is usually computed by
64 < .I rtcontrib(1)
64 > .I rfluxmtx(1)
65 > or
66 > .I rcontrib(1)
67   for a particular set of windows or skylight openings.
68   The second argument is the window transmission matrix, or BSDF, given as
69 < a standard XML description.
69 > a matrix or a standard XML description.
70   The third argument is the Daylight matrix file that defines how sky patches
71   relate to input directions on the same opening.
72   This is usually computed using
73 < .I genklemsamp(1)
74 < with
75 < .I rtcontrib
76 < in a separate run for each window or skylight orientation.
77 < The final input is the sky contribution vector,
78 < usually computed by
79 < .I genskyvec(1),
80 < which may be passed on the standard input.
53 < This data must be in ASCII format, whereas the View and Daylight matrices
54 < are more efficiently represented as binary float data if machine
55 < byte-order is not an issue.
73 > .I rfluxmtx
74 > with separate runs for each window or skylight orientation.
75 > The last file is the sky contribution vector or matrix,
76 > typically computed by
77 > .I genskyvec(1)
78 > or
79 > .I gendaymtx(1),
80 > and may be passed on the standard input.
81   .PP
82 < Sent to the standard output of
82 > If the input sky data lacks a header, the
83 > .I \-n
84 > option may be used to indicate the number of time steps, which
85 > will be 1 for a sky vector.
86 > The sky input file must otherwise contain the number of
87 > columns (time steps) specified in each sky patch row,
88 > whether it is read from the standard input or from a file.
89 > Input starts from the first patch at the first time step, then the
90 > first patch at the second time step, and so on.
91 > Note that all matrix elements are RGB triplets, so the actual size
92 > of the sky vector or matrix is three times the number of steps times
93 > the number of sky patches.
94 > The
95 > .I \-if
96 > or
97 > .I \-id
98 > option may be used to specify that sky data is in float or double
99 > format, respectively, which is more efficient for large matrices.
100 > These options are unnecessary when the sky input includes a header.
101 > .PP
102 > Any of the matrix or vector files may be read from a command
103 > instead of a file by
104 > using quotes and a beginning exclamation point ('!').
105 > .PP
106 > The standard output of
107   .I dctimestep
108 < is either an ASCII color vector with as many RGB triplets
108 > is either a color vector with as many RGB triplets
109   as there are rows in the View matrix, or a combined
110   .I Radiance
111   picture.
# Line 68 | Line 117 | interpreted as a list of
117   .I Radiance
118   component pictures, which will be summed according to the computed
119   vector.
120 + .PP
121 + The
122 + .I \-o
123 + option may be used to specify a file or a set of output files
124 + to use rather than the standard output.
125 + If the given specification contains a '%d' format string, this
126 + will be replaced by the time step index, starting from 0.
127 + In this way, multiple output pictures may be produced,
128 + or separate result vectors (one per time step).
129 + If input is a matrix rather than a set of images, the
130 + .I \-x
131 + and/or
132 + .I \-y
133 + options may be necessary to set the output image size.
134 + If only one dimension is specified, the other is computed based
135 + on the number of rows in the result vectors.
136 + .PP
137 + A header will normally be produced on the output, unless the
138 + .I \-h
139 + option is specified.
140 + The
141 + .I \-of,
142 + .I \-od,
143 + or
144 + .I \-oc
145 + option may be used to specify IEEE float, double, or RGBE (picture) output
146 + data, respectively.
147   .SH EXAMPLES
148   To compute workplane illuminances at 3:30pm on Feb 10th:
149   .IP "" .2i
# Line 75 | Line 151 | gensky 2 10 15:30 | genskyvec | dctimestep workplaneDC
151   .PP
152   To compute an image at 10am on the equinox from a set of component images:
153   .IP "" .2i
154 < gensky 3 21 10 | genskyvec | dctimestep viewc%03d.hdr > view_03-21-10.hdr
154 > gensky 3 21 10 | genskyvec | dctimestep dcomp%03d.hdr > view_03-21-10.hdr
155   .PP
156   To compute a set of illuminance contributions for Window 1 on
157   the Winter solstice at 2pm:
# Line 84 | Line 160 | gensky 12 21 14 | genskyvec | dctimestep IllPts.vmx Bl
160   .PP
161   To compute Window2's contribution to an interior view at 12 noon on the Summer solstice:
162   .IP "" .2i
163 < gensky 6 21 12 | genskyvec | dctimestep view%03d.hdr Blinds30.xml Window2.dmx > view_6-21-12.hdr
163 > gensky 6 21 12 | genskyvec | dctimestep view%03d.hdr Blinds30.xml
164 > Window2.dmx > view_6-21-12.hdr
165 > .PP
166 > To generate an hourly matrix of sensor value contributions from Skylight3
167 > using a 3-phase calculation, where output columns are time steps:
168 > .IP "" .2i
169 > gendaymtx -of Tampa.wea | dctimestep WPpts.vmx
170 > shade3.xml Skylight3.dmx > wp_win3.dat
171 > .PP
172 > Generate a series of pictures corresponding to timesteps
173 > in an annual simulation:
174 > .IP "" .2i
175 > gendaymtx NYCity.wea | dctimestep -o tstep%04d.hdr dcomp%03d.hdr
176 > .PP
177 > To multiply an irradiance view matrix through a pair of XML window layers using
178 > a given exterior daylight matrix and sky vector:
179 > .IP "" .2i
180 > dctimestep Illum.vmx "!rmtxop -ff Blinds1.xml Windo1.xml" Exter.dmx Jan20.sky
181 > .PP
182 > To multiply two matrices into a IEEE-float result with header:
183 > .IP "" .2i
184 > dctimestep -of Inp1.fmx Inp2.fmx > Inp1xInp2.fmx
185   .SH AUTHOR
186   Greg Ward
187   .SH "SEE ALSO"
188 < genklemsamp(1), genskyvec(1), mkillum(1), rtcontrib(1), rtrace(1), vwrays(1)
188 > gendaymtx(1), genskyvec(1), getinfo(1),
189 > mkillum(1), rcollate(1), rcontrib(1),
190 > rfluxmtx(1), rmtxop(1), rtrace(1), vwrays(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines