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.11 by greg, Mon May 4 20:53:21 2015 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
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 rtcontrib(1)
60 > .I rcontrib(1)
61   for a particular set of windows or skylight openings.
62   The second argument is the window transmission matrix, or BSDF, given as
63   a standard XML description.
# Line 44 | Line 66 | relate to input directions on the same opening.
66   This is usually computed using
67   .I genklemsamp(1)
68   with
69 < .I rtcontrib
69 > .I rcontrib
70   in a separate run for each window or skylight orientation.
71 < The final input is the sky contribution vector,
72 < usually computed by
73 < .I genskyvec(1),
74 < which may be passed on the standard input.
75 < This data must be in ASCII format, whereas the View and Daylight matrices
76 < are more efficiently represented as binary float data if machine
77 < byte-order is not an issue.
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.
80   .PP
81 < Sent to the standard output of
81 > If the input sky data lacks a header, the
82 > .I \-n
83 > option may be used to indicate the number of time steps, which
84 > will be 1 for a sky vector.
85 > The sky input file must contain the number of
86 > columns specified in each sky patch row, whether it is read
87 > from the standard input or from a file.
88 > Input starts from the first patch at the first time step, then the
89 > first patch at the second time step, and so on.
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 in the when the sky
97 > input has a header.
98 > .PP
99 > Any of the matrix or vector files may be read from a command
100 > instead of a file by
101 > using quotes and a beginning exclamation point ('!').
102 > .PP
103 > The standard output of
104   .I dctimestep
105 < is either an ASCII color vector with as many RGB triplets
105 > is either a color vector with as many RGB triplets
106   as there are rows in the View matrix, or a combined
107   .I Radiance
108   picture.
# Line 68 | Line 114 | interpreted as a list of
114   .I Radiance
115   component pictures, which will be summed according to the computed
116   vector.
117 + .PP
118 + The
119 + .I \-o
120 + option may be used to specify a file or a set of output files
121 + to use rather than the standard output.
122 + If the given specification contains a '%d' format string, this
123 + will be replaced by the time step index, starting from 1.
124 + In this way, multiple output pictures may be produced,
125 + or separate result vectors (one per time step).
126 + .PP
127 + A header will normally be produced on the output, unless the
128 + .I \-h
129 + option is specified.
130 + The
131 + .I \-of
132 + or
133 + .I \-od
134 + option may be used to specify IEEE float or double binary output
135 + data, respectively.
136   .SH EXAMPLES
137   To compute workplane illuminances at 3:30pm on Feb 10th:
138   .IP "" .2i
# Line 75 | Line 140 | gensky 2 10 15:30 | genskyvec | dctimestep workplaneDC
140   .PP
141   To compute an image at 10am on the equinox from a set of component images:
142   .IP "" .2i
143 < gensky 3 21 10 | genskyvec | dctimestep viewc%03d.hdr > view_03-21-10.hdr
143 > gensky 3 21 10 | genskyvec | dctimestep dcomp%03d.hdr > view_03-21-10.hdr
144   .PP
145   To compute a set of illuminance contributions for Window 1 on
146   the Winter solstice at 2pm:
# Line 84 | Line 149 | gensky 12 21 14 | genskyvec | dctimestep IllPts.vmx Bl
149   .PP
150   To compute Window2's contribution to an interior view at 12 noon on the Summer solstice:
151   .IP "" .2i
152 < gensky 6 21 12 | genskyvec | dctimestep view%03d.hdr Blinds30.xml Window2.dmx > view_6-21-12.hdr
152 > gensky 6 21 12 | genskyvec | dctimestep view%03d.hdr Blinds30.xml
153 > Window2.dmx > view_6-21-12.hdr
154 > .PP
155 > To generate an hourly matrix of sensor value contributions from Skylight3
156 > using a 3-phase calculation, where output columns are time steps:
157 > .IP "" .2i
158 > gendaymtx -of Tampa.wea | dctimestep WPpts.vmx
159 > shade3.xml Skylight3.dmx > wp_win3.dat
160 > .IP "" .2i
161 > .PP
162 > Generate a series of pictures corresponding to timesteps
163 > in an annual simulation:
164 > .IP "" .2i
165 > gendaymtx NYCity.wea | dctimestep -o tstep%04d.hdr dcomp%03d.hdr
166 > .PP
167 > To multiply two matrices into a IEEE-float result with header:
168 > .IP "" .2i
169 > dctimestep -of Inp1.fmx Inp2.fmx > Inp1xInp2.fmx
170   .SH AUTHOR
171   Greg Ward
172   .SH "SEE ALSO"
173 < genklemsamp(1), genskyvec(1), mkillum(1), rtcontrib(1), rtrace(1), vwrays(1)
173 > gendaymtx(1), genklemsamp(1), genskyvec(1), getinfo(1),
174 > mkillum(1), rcollate(1), rcontrib(1), rmtxop(1), rtrace(1), vwrays(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines