man/man1/bsdfview.1

.\" RCSid "$Id: bsdfview.1,v 1.6 2018/07/20 00:50:40 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}"
][
.B \-t
|
rad options
][
.B "\-r min max"
]
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 renders the scene interactively or calls the
.I trad(1)
graphical user interface if the
.I \-t
option is given.
.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.
.PP
This input file may also be re-used directly from the command line using
.I rad
or
.I trad(1).
This may be useful for generating RADIANCE pictures corresponding
to the above standard views.
If no interactive run is desired, start
.I bsdfview
with the
.I "-v 0"
option.
.PP
If an optional plotting range is given with the
.I \-r
option, this will override automatic settings from the BSDF input.
This may be useful for comparing different BSDF sources.
.SH AUTHOR
Greg Ward
.SH "SEE ALSO"
bsdf2klems(1), bsdf2rad(1), bsdf2ttree(1), genBSDF(1),
objview(1), oconv(1), pabopto2bsdf(1), pabopto2xyz(1), rad(1), rvu(1), trad(1)
Revision:	1.7
Committed:	Thu Feb 25 04:48:19 2021 UTC (4 years, 2 months ago) by greg
Branch:	MAIN
CVS Tags:	rad5R4, HEAD
Changes since 1.6:	+2 -2 lines
Log Message:	docs: added man page for pabopto2bsdf
#	Content
1	.\" RCSid "$Id: bsdfview.1,v 1.6 2018/07/20 00:50:40 greg Exp $"
2	.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	.B \-t
11	\|
12	rad options
13	][
14	.B "\-r min max"
15	]
16	input ..
17	.br
18	.SH DESCRIPTION
19	.I Bsdfview
20	renders a BSDF description interactively.
21	This is a script that creates a
22	.I rad(1)
23	input file (RIF),
24	which builds an octree via
25	.I bsdf2rad(1),
26	then renders the scene interactively or calls the
27	.I trad(1)
28	graphical user interface if the
29	.I \-t
30	option is given.
31	.PP
32	The input is either a single XML file, such as might be produced by
33	.I genBSDF(1),
34	.I bsdf2klems(1),
35	or
36	.I bsdf2ttree(1),
37	or up to four scattering interpolation representation (SIR) files, as
38	might be produced by
39	pabopto2bsdf(1).
40	.PP
41	A
42	.I rad
43	input file will be produced, whose name matches the root of
44	the first input file but with any leading path removed (i.e., in
45	the current directory).
46	This RIF may be reused for subsequent viewing and rendering via
47	.I rad
48	without incurring the cost of another call to
49	.I bsdf2rad.
50	.PP
51	The quality preference may be set via the
52	.I \-q
53	option.
54	The number of processors to use may be specified with the
55	.I \-n
56	option.
57	.PP
58	The program creates a number of views accessible via the
59	.I rvu(1)
60	"L" command:
61	.TP 10n
62	.BR def
63	The default view, showing the back and front BRDFs.
64	.TP
65	.BR fr
66	A view of the front reflection hemisphere.
67	.TP
68	.BR br
69	A view of the back reflection hemisphere.
70	.TP
71	.BR ft
72	A fisheye view of the front transmission hemisphere (from underneath).
73	.TP
74	.BR bt
75	A fisheye view of the back transmission hemisphere.
76	.TP
77	.BR pr
78	A parallel view of both reflection hemispheres from directly overhead.
79	.TP
80	.BR pt
81	A parallel view of both transmission hemispheres from directly underneath.
82	.PP
83	Additionally, all the standard views that
84	.I rvu
85	defines will be available (e.g., "xZ", "zl", etc.).
86	.PP
87	Since a
88	.I rad
89	input file is created by the script, it may be used
90	in subsequent runs as long as the temporary files remain.
91	These are typically kept until the next reboot of the operating
92	system, so re-running
93	.I bsdfview
94	with the same arguments will not require re-running
95	.I bsdf2rad
96	or
97	.I oconv.
98	Thus, start-up will be much quicker, unless the temporary files have
99	been removed.
100	In this case, the script may exit with an error indicating that the
101	.I rad
102	input file needs to be removed.
103	.PP
104	This input file may also be re-used directly from the command line using
105	.I rad
106	or
107	.I trad(1).
108	This may be useful for generating RADIANCE pictures corresponding
109	to the above standard views.
110	If no interactive run is desired, start
111	.I bsdfview
112	with the
113	.I "-v 0"
114	option.
115	.PP
116	If an optional plotting range is given with the
117	.I \-r
118	option, this will override automatic settings from the BSDF input.
119	This may be useful for comparing different BSDF sources.
120	.SH AUTHOR
121	Greg Ward
122	.SH "SEE ALSO"
123	bsdf2klems(1), bsdf2rad(1), bsdf2ttree(1), genBSDF(1),
124	objview(1), oconv(1), pabopto2bsdf(1), pabopto2xyz(1), rad(1), rvu(1), trad(1)