man/man1/ltview.1

.\" RCSid $Id$
.TH "LTVIEW" "1" "08/04/14" "RADIANCE" ""
.SH "NAME"
ltview \- view photometry of a light source
.SH "SYNOPSIS"
.B ltview
[
.B \-i
][
.B "\-b boxsize"
][
.B "\-o output device"
]
input
.SH "DESCRIPTION"
.I ltview
renders a Radiance luminiare or IES photometry interactively using
.I rad(1)
.  This program is merely a shell script that calls
.I rad(1)
to make an octree and view the scene interactively.
.PP 
.I ltview
accepts exactly one Radiance object or IES photometry
file as input.  No input is taken from STDIN.  The
.I \-i
option tells it that the file name given is 
an IES photometry file rather then a Radiance description of a 
luminiare.  In this case, Radiance's
.I ies2rad(1)
is called with its default settings to convert the IES file into a 
Radiance object.
.PP 
Unlike
.I objpict(1)
or
.I objview(1)
, no additional light sources are added to the scene, since it is
assumed that the object is a luminaire.
.PP 
.I ltview
relies on Radiance's
.I rad(1)
command to compile an octree using 
.I oconv(1)
and to call
.I rvu(1)
to display an interactive preview of the luminaire.
The default behaviour for
.I ltview
is to scale the luminaire or output from 
.I ies2rad(1)
so that the largest dimension of the fitting is unity, centered at the origin.
This scaled representation of the original fitting is then placed inside a 
square box 10 units in length.  The \-y face of the box is left open so that 
the camera can look inside, facing +y.
If it is desirable to keep the original luminaire in both its original size,
and its original location, the
.I "\-r roomsize"
option may be used to fix the room size to a certain
.I roomsize.
In this case, the size and location of the fitting is not adjusted, and
it is up to the user to decide on appropriate room dimensions.  Note that
when
.I \-r
and
.I \-i
are combined, then the dimensions of the luminaire and intesity of its 
output are determined by
.I ies2rad(1)'s
default settings.  If this is not acceptable, then it is best to run
.I ies2rad(1)
manually, and to feed
.I ltview
the hand\-crafted fitting, rather than the IES photometry.
.PP 
The default
.I rvu(1)
output device is
.I x11
on all platforms except for Windows, where it is set to
.I qt.
This may be overwritten with the
.I "\-o output"
option.

.SH "EXAMPLES"
To query available output devices
.IP "" .2i
rvu \-devices
.PP 
To visualise an IES file with the qt driver
.IP "" .2i
ltview \-o qt ABC123.ies
.PP 
To look at a typical fluorescent fitting that is modelled in millimeters
.IP "" .2i
ltview \-r 5000 XYZ_batten.rad
.SH "AUTHOR"
Axel Jacobs
.SH "SEE ALSO"
ltpict(1), ies2rad(1), oconv(1), rad(1), rvu(1)
Revision:	1.1
Committed:	Tue Apr 15 22:36:25 2014 UTC (11 years ago) by greg
Branch:	MAIN
Log Message:	Added ltview and ltpict scripts
#	User	Rev	Content
1	greg	1.1	.\" RCSid $Id$
2			.TH "LTVIEW" "1" "08/04/14" "RADIANCE" ""
3			.SH "NAME"
4			ltview \- view photometry of a light source
5			.SH "SYNOPSIS"
6			.B ltview
7			[
8			.B \-i
9			][
10			.B "\-b boxsize"
11			][
12			.B "\-o output device"
13			]
14			input
15			.SH "DESCRIPTION"
16			.I ltview
17			renders a Radiance luminiare or IES photometry interactively using
18			.I rad(1)
19			. This program is merely a shell script that calls
20			.I rad(1)
21			to make an octree and view the scene interactively.
22			.PP
23			.I ltview
24			accepts exactly one Radiance object or IES photometry
25			file as input. No input is taken from STDIN. The
26			.I \-i
27			option tells it that the file name given is
28			an IES photometry file rather then a Radiance description of a
29			luminiare. In this case, Radiance's
30			.I ies2rad(1)
31			is called with its default settings to convert the IES file into a
32			Radiance object.
33			.PP
34			Unlike
35			.I objpict(1)
36			or
37			.I objview(1)
38			, no additional light sources are added to the scene, since it is
39			assumed that the object is a luminaire.
40			.PP
41			.I ltview
42			relies on Radiance's
43			.I rad(1)
44			command to compile an octree using
45			.I oconv(1)
46			and to call
47			.I rvu(1)
48			to display an interactive preview of the luminaire.
49			The default behaviour for
50			.I ltview
51			is to scale the luminaire or output from
52			.I ies2rad(1)
53			so that the largest dimension of the fitting is unity, centered at the origin.
54			This scaled representation of the original fitting is then placed inside a
55			square box 10 units in length. The \-y face of the box is left open so that
56			the camera can look inside, facing +y.
57			If it is desirable to keep the original luminaire in both its original size,
58			and its original location, the
59			.I "\-r roomsize"
60			option may be used to fix the room size to a certain
61			.I roomsize.
62			In this case, the size and location of the fitting is not adjusted, and
63			it is up to the user to decide on appropriate room dimensions. Note that
64			when
65			.I \-r
66			and
67			.I \-i
68			are combined, then the dimensions of the luminaire and intesity of its
69			output are determined by
70			.I ies2rad(1)'s
71			default settings. If this is not acceptable, then it is best to run
72			.I ies2rad(1)
73			manually, and to feed
74			.I ltview
75			the hand\-crafted fitting, rather than the IES photometry.
76			.PP
77			The default
78			.I rvu(1)
79			output device is
80			.I x11
81			on all platforms except for Windows, where it is set to
82			.I qt.
83			This may be overwritten with the
84			.I "\-o output"
85			option.
86
87			.SH "EXAMPLES"
88			To query available output devices
89			.IP "" .2i
90			rvu \-devices
91			.PP
92			To visualise an IES file with the qt driver
93			.IP "" .2i
94			ltview \-o qt ABC123.ies
95			.PP
96			To look at a typical fluorescent fitting that is modelled in millimeters
97			.IP "" .2i
98			ltview \-r 5000 XYZ_batten.rad
99			.SH "AUTHOR"
100			Axel Jacobs
101			.SH "SEE ALSO"
102			ltpict(1), ies2rad(1), oconv(1), rad(1), rvu(1)