man/man1/bsdfview.1

.\" RCSid "$Id: bsdfview.1,v 1.2 2017/08/11 23:00:10 greg Exp $"
.TH BSDFVIEW 1 8/11/2017 RADIANCE
.SH NAME
bsdfview - view a BSDF representation
.SH SYNOPSIS
.B bsdfview
[
.B "\-q {Hi|Med|Lo}"
][
rad options
]
input ..
.br
.SH DESCRIPTION
.I Bsdfview
renders a BSDF description interactively.
This is a script that creates a
.I rad(1)
input file (RIF),
which builds an octree via
.I bsdf2rad(1),
then views the scene interactively.
.PP
The input is either a single XML file, such as might be produced by
.I genBSDF(1),
.I bsdf2klems(1),
or
.I bsdf2ttree(1),
or up to four scattering interpolation representation (SIR) files, as
might be produced by
pabopto2bsdf(1).
.PP
A
.I rad
input file will be produced, whose name matches the root of
the first input file but with any leading path removed (i.e., in
the current directory).
This RIF may be reused for subsequent viewing and rendering via
.I rad
without incurring the cost of another call to
.I bsdf2rad.
.PP
The quality preference may be set via the
.I \-q
option.
The number of processors to use may be specified with the 
.I \-n
option.
.PP
The program creates a number of views accessible via the
.I rvu(1)
"L" command:
.TP 10n
.BR def
The default view, showing the back and front BRDFs.
.TP
.BR fr
A view of the front reflection hemisphere.
.TP
.BR br
A view of the back reflection hemisphere.
.TP
.BR ft
A fisheye view of the front transmission hemisphere (from underneath).
.TP
.BR bt
A fisheye view of the back transmission hemisphere.
.TP
.BR pr
A parallel view of both reflection hemispheres from directly overhead.
.TP
.BR pt
A parallel view of both transmission hemispheres from directly underneath.
.PP
Additionally, all the standard views that
.I rvu
defines will be available (e.g., "xZ", "zl", etc.).
.PP
Since a
.I rad
input file is created by the script, it may be used
in subsequent runs as long as the temporary files remain.
These are typically kept until the next reboot of the operating
system, so re-running
.I bsdfview
with the same arguments will not require re-running
.I bsdf2rad
or
.I oconv.
Thus, start-up will be much quicker, unless the temporary files have
been removed.
In this case, the script may exit with an error indicating that the
.I rad
input file needs to be removed.
.I Rad
may also be run using the input file directly from the command line
or via
.I trad(1).
This may be useful for generating RADIANCE pictures corresponding
to the above standard views.
.SH AUTHOR
Greg Ward
.SH "SEE ALSO"
bsdf2klems(1), bsdf2rad(1), bsdf2ttree(1), genBSDF(1),
objview(1), oconv(1), pabopto2bsdf(1), rad(1), rvu(1), trad(1)
Revision:	1.3
Committed:	Sun Aug 13 20:11:04 2017 UTC (7 years, 9 months ago) by greg
Branch:	MAIN
Changes since 1.2:	+31 -6 lines
Log Message:	Added information about re-using the rad input file
#	User	Rev	Content
1	greg	1.3	.\" RCSid "$Id: bsdfview.1,v 1.2 2017/08/11 23:00:10 greg Exp $"
2	greg	1.1	.TH BSDFVIEW 1 8/11/2017 RADIANCE
3			.SH NAME
4			bsdfview - view a BSDF representation
5			.SH SYNOPSIS
6			.B bsdfview
7			[
8			.B "\-q {Hi\|Med\|Lo}"
9			][
10			rad options
11			]
12			input ..
13			.br
14			.SH DESCRIPTION
15			.I Bsdfview
16			renders a BSDF description interactively.
17	greg	1.3	This is a script that creates a
18	greg	1.1	.I rad(1)
19	greg	1.3	input file (RIF),
20			which builds an octree via
21	greg	1.2	.I bsdf2rad(1),
22			then views the scene interactively.
23	greg	1.1	.PP
24			The input is either a single XML file, such as might be produced by
25			.I genBSDF(1),
26			.I bsdf2klems(1),
27			or
28			.I bsdf2ttree(1),
29	greg	1.2	or up to four scattering interpolation representation (SIR) files, as
30	greg	1.1	might be produced by
31			pabopto2bsdf(1).
32			.PP
33	greg	1.3	A
34			.I rad
35			input file will be produced, whose name matches the root of
36	greg	1.1	the first input file but with any leading path removed (i.e., in
37			the current directory).
38			This RIF may be reused for subsequent viewing and rendering via
39			.I rad
40			without incurring the cost of another call to
41			.I bsdf2rad.
42			.PP
43			The quality preference may be set via the
44			.I \-q
45			option.
46			The number of processors to use may be specified with the
47			.I \-n
48			option.
49			.PP
50			The program creates a number of views accessible via the
51			.I rvu(1)
52			"L" command:
53			.TP 10n
54			.BR def
55			The default view, showing the back and front BRDFs.
56			.TP
57			.BR fr
58			A view of the front reflection hemisphere.
59			.TP
60			.BR br
61			A view of the back reflection hemisphere.
62			.TP
63			.BR ft
64			A fisheye view of the front transmission hemisphere (from underneath).
65			.TP
66			.BR bt
67			A fisheye view of the back transmission hemisphere.
68			.TP
69			.BR pr
70			A parallel view of both reflection hemispheres from directly overhead.
71			.TP
72			.BR pt
73			A parallel view of both transmission hemispheres from directly underneath.
74			.PP
75			Additionally, all the standard views that
76			.I rvu
77			defines will be available (e.g., "xZ", "zl", etc.).
78	greg	1.3	.PP
79			Since a
80			.I rad
81			input file is created by the script, it may be used
82			in subsequent runs as long as the temporary files remain.
83			These are typically kept until the next reboot of the operating
84			system, so re-running
85			.I bsdfview
86			with the same arguments will not require re-running
87			.I bsdf2rad
88			or
89			.I oconv.
90			Thus, start-up will be much quicker, unless the temporary files have
91			been removed.
92			In this case, the script may exit with an error indicating that the
93			.I rad
94			input file needs to be removed.
95			.I Rad
96			may also be run using the input file directly from the command line
97			or via
98			.I trad(1).
99			This may be useful for generating RADIANCE pictures corresponding
100			to the above standard views.
101	greg	1.1	.SH AUTHOR
102			Greg Ward
103			.SH "SEE ALSO"
104			bsdf2klems(1), bsdf2rad(1), bsdf2ttree(1), genBSDF(1),
105	greg	1.3	objview(1), oconv(1), pabopto2bsdf(1), rad(1), rvu(1), trad(1)