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.9 by greg, Fri May 30 00:00:54 2014 UTC vs.
Revision 1.14 by greg, Tue Aug 30 14:47:20 2016 UTC

# Line 7 | Line 7 | dctimestep - compute annual simulation time-step(s) vi
7   [
8   .B "\-n nsteps"
9   ][
10 + .B "\-h"
11 + ][
12   .B "\-o ospec"
13   ][
14 < .B "\-i{f|d|h}
14 > .B "\-i{f|d}
15   ][
16   .B "\-o{f|d}
17   ]
# Line 22 | Line 24 | dctimestep - compute annual simulation time-step(s) vi
24   [
25   .B "\-n nsteps"
26   ][
27 + .B "\-h"
28 + ][
29   .B "\-o ospec"
30   ][
31 < .B "\-i{f|d|h}
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 skyf
# Line 53 | 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
65 < .I rcontrib
66 < in a separate run for each window or skylight orientation.
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 < This data is assumed by default to be in ASCII format, whereas the
78 < formats of the View and Daylight matrices
79 < are detected automatically if given as binary data.
77 > .PP
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 < The
83 < .I \-ih
84 < option says to check the header to determine the data type.
85 < (Note that binary double data may not be read from stdin without a header.)\0
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 a color vector with as many RGB triplets
# Line 100 | Line 115 | component pictures, which will be summed according to
115   vector.
116   .PP
117   The
103 – .I \-n
104 – option may be used to compute multiple time steps in a
105 – single invocation.
106 – The sky input file must contain the number of
107 – columns specified in each sky patch row, whether it is read
108 – from the standard input or from a file.
109 – The columns do not need to be given on the same
110 – line, so long as the number of values totals 3*Nsteps*Npatches.
111 – Input starts from the first patch at the first time step, then the
112 – first patch at the second time step, and so on.
113 – If the input matrix has a header, then you may use
114 – .I \-n 0
115 – to get the number of columns from the header rather than specifying it.
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.
# Line 122 | Line 122 | If the given specification contains a '%d' format stri
122   will be replaced by the time step index, starting from 1.
123   In this way, multiple output pictures may be produced,
124   or separate result vectors (one per time step).
125 – If the standard output is used or the
126 – .I \-o
127 – option specifies a single output file, then an information header
128 – will precede the output.
129 – This can be removed if desired using the
130 – .I getinfo\(1\)
131 – command with a single hyphen ('-') argument.
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.
139 – This enables
140 – .I dctimestep
141 – to be used as a pure matrix multiplier, as the output file with
142 – header specifying the format is suitable for subsequent calls.
135   .SH EXAMPLES
136   To compute workplane illuminances at 3:30pm on Feb 10th:
137   .IP "" .2i
# Line 162 | Line 154 | Window2.dmx > view_6-21-12.hdr
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 -if -n 8760 WPpts.vmx
157 > gendaymtx -of Tampa.wea | dctimestep WPpts.vmx
158   shade3.xml Skylight3.dmx > wp_win3.dat
167 – .IP "" .2i
159   .PP
160   Generate a series of pictures corresponding to timesteps
161   in an annual simulation:
162   .IP "" .2i
163 < gendaymtx NYCity.wea | dctimestep -n 8760 -o tstep%04d.hdr dcomp%03d.hdr
163 > gendaymtx NYCity.wea | dctimestep -o tstep%04d.hdr dcomp%03d.hdr
164   .PP
165 < To multiply two color matrices (second matrix is IEEE-float with
166 < 145 RGB columns) into a IEEE-double result (also 145 RGB columns):
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 < getinfo - < Inp2.fmx | dctimestep -n 145 -if -od Inp1.fmx > Inp1xInp2.dmx
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 < gendaymtx(1), genklemsamp(1), genskyvec(1), getinfo(1),
177 < mkillum(1), rcollate(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