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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines