man/man1/wrapBSDF.1

.\" RCSid $Id: wrapBSDF.1,v 1.1 2015/02/20 18:26:09 greg Exp $
.TH WRAPBSDF 1 2/20/2015 RADIANCE
.SH NAME
wrapBSDF - put XML wrapper around WINDOW6 BSDF data
.SH SYNOPSIS
.B wrapBSDF
[
.B \-W
][
.B \-c
][
.B "\-a {kf|kh|kq|t3|t4}"
][
.B "\-u unit"
][
.B "\-g geom.mgf"
][
.B "\-f 'x=string;y=string'"
][
.B "\-s spectr"
][
.B "\-tb inp"
][
.B "\-tf inp"
][
.B "\-rb inp"
][
.B "\-rf inp"
][
.B "input.xml"
]
.SH DESCRIPTION
.I WrapBSDF
takes ASCII matrix or tensor tree data given in one or more
.I "\-tf, \-tb, \-rf,"
and
.I \-rb
options and adds them to the given
.I input.xml
file or to a standard template suitable for
.I Radiance
and
.I WINDOW6.
The
.I \-W
option may be given to ensure adherence to the
.I WINDOW6
requirements, which draws from a standard template
and warns the user if the required additional fields are not
provided.
.PP
Fields may be set by one or more
.I \-f
options, which take pairs of XML tag names and values, such as
.I "\-f Manufacturer=ACME".
A number of shorthand names are provided corresponding to the
following tags (asterisk tags are required with -W):
.sp
.nf
        m       Manufacturer(*)
        n       Name(*)
        c       ThermalConductivity
        ef      EmissivityFront
        eb      EmissivityBack
        eo      EffectiveOpennessFraction
        t       Thickness(*)
        h       Height
        w       Width
.fi
.PP
If any dimensions are given, thier units will correspond to
meters by default, or the
.I \-u
option may be used to specify one of:
meter, foot, inch, centimeter, or millimeter.
Any other unit specification will result in an error, and
only one set of units may be selected.
A "Materials and Geometry Format" file may be provided with the
.I \-g
option, and will also be in the indicated units.
.PP
The spectrum corresponding to a particular set of data may be given
before the data option using a
.I \-s
specification, whose argument is either the name of a spectral
sensitivity file or one of the standard spectra:
Visible, Solar, NIR, CIE-u, CIE-v, CIE-X, or CIE-Z.
Different spectra may be given for different distribution data,
and the default spectrum is Visible (CIE-Y).
.PP
The
.I \-a
option specifies the angular sampling basis for all the data
provided, and must be set if any data is given.
Legal arguments for this option are:
.sp
.nf
        kf      Klems full sampling (145x145 matrix)
        kh      Klems half sampling (73x73 matrix)
        kq      Klems quarter sampling (41x41 matrix)
        t3      Tensor tree isotropic sampling
        t4      Tensor tree anisotropic sampling
.fi
.sp
In the case of Klems data, the
.I \-c
option may be specified to include a correction for solid
angle, which is necessary to convert flux form factors into
BSDF data.
Since it flux factors rather than BSDF values are computed by
.I rfluxmtx(1)
and similar sources, this is often necessary for proper conversion.
.PP
Most options that accept file names
can take data from the standard input by using a hyphen ('-')
in place of the file, but only one option at most may read from stdin.
Data input may be read from another program by beginning the input
specification with a quoted exclamation point ('!') followed by the command.
.SH EXAMPLE
Create an WINDOW6 BSDF from computed transmission matrix:
.IP "" .2i
rfluxmtx -fa ... | wrapBSDF -W -u millimeter -f 't=5;m=3M;n=Trans30' -c -tb - > Trans30.xml
.PP
Add a name and MGF geometry to an XML file:
Add a name and MGF geometry to an XML file:
.IP "" .2i
wrapBSDF -f 'Name=My Device' -g MyDevice.mgf orig.xml > revised.xml
.SH AUTHOR
Greg Ward
.SH "SEE ALSO"
bsdf2klems(1), bsdf2ttree(1), genBSDF(1), mgf2rad(1),
pkgBSDF(1), rad2mgf(1), rfluxmtx(1)
Revision:	1.2
Committed:	Wed May 20 08:40:48 2015 UTC (10 years ago) by greg
Branch:	MAIN
Changes since 1.1:	+3 -1 lines
Log Message:	Added mention of reading input from command
#	Content
1	.\" RCSid $Id: wrapBSDF.1,v 1.1 2015/02/20 18:26:09 greg Exp $
2	.TH WRAPBSDF 1 2/20/2015 RADIANCE
3	.SH NAME
4	wrapBSDF - put XML wrapper around WINDOW6 BSDF data
5	.SH SYNOPSIS
6	.B wrapBSDF
7	[
8	.B \-W
9	][
10	.B \-c
11	][
12	.B "\-a {kf\|kh\|kq\|t3\|t4}"
13	][
14	.B "\-u unit"
15	][
16	.B "\-g geom.mgf"
17	][
18	.B "\-f 'x=string;y=string'"
19	][
20	.B "\-s spectr"
21	][
22	.B "\-tb inp"
23	][
24	.B "\-tf inp"
25	][
26	.B "\-rb inp"
27	][
28	.B "\-rf inp"
29	][
30	.B "input.xml"
31	]
32	.SH DESCRIPTION
33	.I WrapBSDF
34	takes ASCII matrix or tensor tree data given in one or more
35	.I "\-tf, \-tb, \-rf,"
36	and
37	.I \-rb
38	options and adds them to the given
39	.I input.xml
40	file or to a standard template suitable for
41	.I Radiance
42	and
43	.I WINDOW6.
44	The
45	.I \-W
46	option may be given to ensure adherence to the
47	.I WINDOW6
48	requirements, which draws from a standard template
49	and warns the user if the required additional fields are not
50	provided.
51	.PP
52	Fields may be set by one or more
53	.I \-f
54	options, which take pairs of XML tag names and values, such as
55	.I "\-f Manufacturer=ACME".
56	A number of shorthand names are provided corresponding to the
57	following tags (asterisk tags are required with -W):
58	.sp
59	.nf
60	m Manufacturer(*)
61	n Name(*)
62	c ThermalConductivity
63	ef EmissivityFront
64	eb EmissivityBack
65	eo EffectiveOpennessFraction
66	t Thickness(*)
67	h Height
68	w Width
69	.fi
70	.PP
71	If any dimensions are given, thier units will correspond to
72	meters by default, or the
73	.I \-u
74	option may be used to specify one of:
75	meter, foot, inch, centimeter, or millimeter.
76	Any other unit specification will result in an error, and
77	only one set of units may be selected.
78	A "Materials and Geometry Format" file may be provided with the
79	.I \-g
80	option, and will also be in the indicated units.
81	.PP
82	The spectrum corresponding to a particular set of data may be given
83	before the data option using a
84	.I \-s
85	specification, whose argument is either the name of a spectral
86	sensitivity file or one of the standard spectra:
87	Visible, Solar, NIR, CIE-u, CIE-v, CIE-X, or CIE-Z.
88	Different spectra may be given for different distribution data,
89	and the default spectrum is Visible (CIE-Y).
90	.PP
91	The
92	.I \-a
93	option specifies the angular sampling basis for all the data
94	provided, and must be set if any data is given.
95	Legal arguments for this option are:
96	.sp
97	.nf
98	kf Klems full sampling (145x145 matrix)
99	kh Klems half sampling (73x73 matrix)
100	kq Klems quarter sampling (41x41 matrix)
101	t3 Tensor tree isotropic sampling
102	t4 Tensor tree anisotropic sampling
103	.fi
104	.sp
105	In the case of Klems data, the
106	.I \-c
107	option may be specified to include a correction for solid
108	angle, which is necessary to convert flux form factors into
109	BSDF data.
110	Since it flux factors rather than BSDF values are computed by
111	.I rfluxmtx(1)
112	and similar sources, this is often necessary for proper conversion.
113	.PP
114	Most options that accept file names
115	can take data from the standard input by using a hyphen ('-')
116	in place of the file, but only one option at most may read from stdin.
117	Data input may be read from another program by beginning the input
118	specification with a quoted exclamation point ('!') followed by the command.
119	.SH EXAMPLE
120	Create an WINDOW6 BSDF from computed transmission matrix:
121	.IP "" .2i
122	rfluxmtx -fa ... \| wrapBSDF -W -u millimeter -f 't=5;m=3M;n=Trans30' -c -tb - > Trans30.xml
123	.PP
124	Add a name and MGF geometry to an XML file:
125	Add a name and MGF geometry to an XML file:
126	.IP "" .2i
127	wrapBSDF -f 'Name=My Device' -g MyDevice.mgf orig.xml > revised.xml
128	.SH AUTHOR
129	Greg Ward
130	.SH "SEE ALSO"
131	bsdf2klems(1), bsdf2ttree(1), genBSDF(1), mgf2rad(1),
132	pkgBSDF(1), rad2mgf(1), rfluxmtx(1)