man/man1/wrapBSDF.1

.\" RCSid $Id: wrapBSDF.1,v 1.5 2016/02/02 22:34:00 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 \-U
][
.B "\-C comm"
][
.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 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.
.PP
The
.I \-C
option may be used to specify a comment to be inserted near the
head of the output.
Up to 30 comment strings may be given, and they will appear one
after the other in the prologue surrounded by the XML comment syntax.
.PP
The
.I \-U
option tells
.I wrapBSDF
to unlink (remove) input data files following successful completion.
These files are often temporary, existing solely for the purposes
of data transfer.
If given as
.I \-UU,
then the MGF geometry file given by the
.I \-g
option (if any) will also be unlinked.
.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.6
Committed:	Wed Feb 3 00:22:55 2016 UTC (9 years, 3 months ago) by greg
Branch:	MAIN
Changes since 1.5:	+6 -1 lines
Log Message:	Added -UU option to wrapBSDF to remove geometry file as well
#	User	Rev	Content
1	greg	1.6	.\" RCSid $Id: wrapBSDF.1,v 1.5 2016/02/02 22:34:00 greg Exp $
2	greg	1.1	.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	greg	1.5	.B \-U
31			][
32	greg	1.3	.B "\-C comm"
33			][
34	greg	1.1	.B "input.xml"
35			]
36			.SH DESCRIPTION
37			.I WrapBSDF
38			takes ASCII matrix or tensor tree data given in one or more
39			.I "\-tf, \-tb, \-rf,"
40			and
41			.I \-rb
42			options and adds them to the given
43			.I input.xml
44			file or to a standard template suitable for
45			.I Radiance
46			and
47			.I WINDOW6.
48			The
49			.I \-W
50			option may be given to ensure adherence to the
51			.I WINDOW6
52			requirements, which draws from a standard template
53			and warns the user if the required additional fields are not
54			provided.
55			.PP
56			Fields may be set by one or more
57			.I \-f
58			options, which take pairs of XML tag names and values, such as
59			.I "\-f Manufacturer=ACME".
60			A number of shorthand names are provided corresponding to the
61			following tags (asterisk tags are required with -W):
62			.sp
63			.nf
64			m Manufacturer(*)
65			n Name(*)
66			c ThermalConductivity
67			ef EmissivityFront
68			eb EmissivityBack
69			eo EffectiveOpennessFraction
70			t Thickness(*)
71			h Height
72			w Width
73			.fi
74			.PP
75			If any dimensions are given, thier units will correspond to
76			meters by default, or the
77			.I \-u
78			option may be used to specify one of:
79			meter, foot, inch, centimeter, or millimeter.
80			Any other unit specification will result in an error, and
81			only one set of units may be selected.
82			A "Materials and Geometry Format" file may be provided with the
83			.I \-g
84			option, and will also be in the indicated units.
85			.PP
86			The spectrum corresponding to a particular set of data may be given
87			before the data option using a
88			.I \-s
89			specification, whose argument is either the name of a spectral
90			sensitivity file or one of the standard spectra:
91			Visible, Solar, NIR, CIE-u, CIE-v, CIE-X, or CIE-Z.
92			Different spectra may be given for different distribution data,
93			and the default spectrum is Visible (CIE-Y).
94			.PP
95			The
96			.I \-a
97			option specifies the angular sampling basis for all the data
98			provided, and must be set if any data is given.
99			Legal arguments for this option are:
100			.sp
101			.nf
102			kf Klems full sampling (145x145 matrix)
103			kh Klems half sampling (73x73 matrix)
104			kq Klems quarter sampling (41x41 matrix)
105			t3 Tensor tree isotropic sampling
106			t4 Tensor tree anisotropic sampling
107			.fi
108			.sp
109			In the case of Klems data, the
110			.I \-c
111			option may be specified to include a correction for solid
112			angle, which is necessary to convert flux form factors into
113			BSDF data.
114	greg	1.4	Since flux factors rather than BSDF values are computed by
115	greg	1.1	.I rfluxmtx(1)
116			and similar sources, this is often necessary for proper conversion.
117			.PP
118			Most options that accept file names
119			can take data from the standard input by using a hyphen ('-')
120			in place of the file, but only one option at most may read from stdin.
121	greg	1.2	Data input may be read from another program by beginning the input
122			specification with a quoted exclamation point ('!') followed by the command.
123	greg	1.3	.PP
124			The
125			.I \-C
126			option may be used to specify a comment to be inserted near the
127			head of the output.
128			Up to 30 comment strings may be given, and they will appear one
129			after the other in the prologue surrounded by the XML comment syntax.
130	greg	1.5	.PP
131			The
132			.I \-U
133			option tells
134			.I wrapBSDF
135			to unlink (remove) input data files following successful completion.
136			These files are often temporary, existing solely for the purposes
137			of data transfer.
138	greg	1.6	If given as
139			.I \-UU,
140			then the MGF geometry file given by the
141			.I \-g
142			option (if any) will also be unlinked.
143	greg	1.1	.SH EXAMPLE
144			Create an WINDOW6 BSDF from computed transmission matrix:
145			.IP "" .2i
146			rfluxmtx -fa ... \| wrapBSDF -W -u millimeter -f 't=5;m=3M;n=Trans30' -c -tb - > Trans30.xml
147			.PP
148			Add a name and MGF geometry to an XML file:
149			Add a name and MGF geometry to an XML file:
150			.IP "" .2i
151			wrapBSDF -f 'Name=My Device' -g MyDevice.mgf orig.xml > revised.xml
152			.SH AUTHOR
153			Greg Ward
154			.SH "SEE ALSO"
155			bsdf2klems(1), bsdf2ttree(1), genBSDF(1), mgf2rad(1),
156			pkgBSDF(1), rad2mgf(1), rfluxmtx(1)