ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/dctimestep.1
Revision: 1.4
Committed: Fri Jan 11 05:07:47 2013 UTC (12 years, 3 months ago) by greg
Branch: MAIN
Changes since 1.3: +39 -8 lines
Log Message:
Added -n and -o options to dctimestep

File Contents

# User Rev Content
1 greg 1.4 .\" RCSid $Id: dctimestep.1,v 1.3 2012/06/14 22:42:21 greg Exp $"
2 greg 1.1 .TH DCTIMESTEP 1 12/09/09 RADIANCE
3     .SH NAME
4 greg 1.4 dctimestep - compute annual simulation time-step(s) via matrix multiplication
5 greg 1.1 .SH SYNOPSIS
6     .B dctimestep
7 greg 1.4 [
8     .B "\-n nsteps"
9     ][
10     .B "\-o ospec"
11     ]
12 greg 1.2 .B DCspec
13     [
14 greg 1.4 .B skyf
15 greg 1.2 ]
16     .br
17     .B dctimestep
18 greg 1.4 [
19     .B "\-n nsteps"
20     ][
21     .B "\-o ospec"
22     ]
23 greg 1.1 .B Vspec
24     .B Tbsdf.xml
25     .B Dmat.dat
26     [
27 greg 1.4 .B skyf
28 greg 1.1 ]
29     .SH DESCRIPTION
30     .I Dctimestep
31 greg 1.2 has two invocation forms.
32     In the first form,
33     .I dctimestep
34     is given a daylight coefficient specification and an optional sky
35 greg 1.4 vector or matrix, which may be read from the standard input if unspecified.
36     The daylight coefficients are multiplied against these sky values
37     and the results are written to the standard output.
38 greg 1.2 This may be a list of color values or a combined Radiance image,
39     as explained below.
40     .PP
41     In the second form,
42     .I dctimestep
43 greg 1.1 takes four input files, forming a matrix expression.
44     The first argument is the View matrix file that specifies how window output
45     directions are related to some set of measured values, such as an array of
46     illuminance points or images.
47     This matrix is usually computed by
48 greg 1.3 .I rcontrib(1)
49 greg 1.1 for a particular set of windows or skylight openings.
50     The second argument is the window transmission matrix, or BSDF, given as
51     a standard XML description.
52     The third argument is the Daylight matrix file that defines how sky patches
53     relate to input directions on the same opening.
54     This is usually computed using
55     .I genklemsamp(1)
56     with
57 greg 1.3 .I rcontrib
58 greg 1.1 in a separate run for each window or skylight orientation.
59 greg 1.4 The final input is the sky contribution vector or matrix,
60 greg 1.1 usually computed by
61     .I genskyvec(1),
62     which may be passed on the standard input.
63     This data must be in ASCII format, whereas the View and Daylight matrices
64     are more efficiently represented as binary float data if machine
65     byte-order is not an issue.
66     .PP
67     Sent to the standard output of
68     .I dctimestep
69     is either an ASCII color vector with as many RGB triplets
70     as there are rows in the View matrix, or a combined
71     .I Radiance
72     picture.
73 greg 1.2 Which output is produced depends on the first argument.
74 greg 1.1 A regular file name will be loaded and interpreted as a matrix to
75     generate a color results vector.
76     A file specification containing a '%d' format string will be
77     interpreted as a list of
78     .I Radiance
79     component pictures, which will be summed according to the computed
80     vector.
81 greg 1.4 .PP
82     The
83     .I \-n
84     option may be used to compute multiple time steps in a
85     single invocation.
86     The sky input file must contain the number of
87     columns specified in each sky patch row, whether it is read
88     from the standard input or from an ASCII file.
89     The columns do not need to be given on the same
90     line, so long as the number of values totals 3*Nsteps*Npatches.
91     Input starts from the first patch at the first time step, then the
92     first patch at the second time step, and so on.
93     .PP
94     The
95     .I \-o
96     option may be used to specify a file or a set of output files
97     to use rather than the standard output.
98     If the given specification contains a '%d' format string, this
99     will be replaced by the time step index, starting from 1.
100     In this way, multiple output pictures may be produced,
101     or separate results vector (one per time step).
102 greg 1.1 .SH EXAMPLES
103 greg 1.2 To compute workplane illuminances at 3:30pm on Feb 10th:
104     .IP "" .2i
105     gensky 2 10 15:30 | genskyvec | dctimestep workplaneDC.dmx > Ill_02-10-1530.dat
106     .PP
107     To compute an image at 10am on the equinox from a set of component images:
108     .IP "" .2i
109     gensky 3 21 10 | genskyvec | dctimestep viewc%03d.hdr > view_03-21-10.hdr
110     .PP
111 greg 1.1 To compute a set of illuminance contributions for Window 1 on
112     the Winter solstice at 2pm:
113     .IP "" .2i
114     gensky 12 21 14 | genskyvec | dctimestep IllPts.vmx Blinds20.xml Window1.dmx > Ill_12-21-14.dat
115     .PP
116     To compute Window2's contribution to an interior view at 12 noon on the Summer solstice:
117     .IP "" .2i
118     gensky 6 21 12 | genskyvec | dctimestep view%03d.hdr Blinds30.xml Window2.dmx > view_6-21-12.hdr
119     .SH AUTHOR
120     Greg Ward
121     .SH "SEE ALSO"
122 greg 1.3 genklemsamp(1), genskyvec(1), mkillum(1), rcontrib(1), rtrace(1), vwrays(1)