# HG changeset patch
# User Axel Jacobs <axel@jaloxa.eu>
# Date 1394497702 0
# Node ID 626ea3bad930a4c52a747c71f5fbe4ffab9aed2d
# Parent  e4892d4ef0264036f9dd962209fdb6f39709e654
man pages for ltpict and ltview

diff -r e4892d4ef026 -r 626ea3bad930 man/man1/ltpict.1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/man/man1/ltpict.1	Tue Mar 11 00:28:22 2014 +0000
@@ -0,0 +1,50 @@
+.TH "LTPICT" "1" "11/03/14" "RADIANCE" ""
+.SH "NAME"
+ltpict \- render a four\-view image of light source
+.SH "SYNOPSIS"
+.B ltpict
+[
+.B \-i
+][
+.B "\-d dimensions"
+]
+input
+.SH "DESCRIPTION"
+.I ltpict
+is a script that renders a four\-view HDR image of a Radiance luminaire
+or IES photometric file.  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 
+The four projections presented are the lower hemisphere
+(displayed in the upper left quadrant), the upper hemisphere
+(upper right), at the C0\-C180 plane (lower left) and at the
+C90\-C270 plane (lower right).
+.PP 
+Only one Radiance luminaire description or IES photometry file
+may be given.  No input is accepted on STDIN.
+.PP 
+The output image in HDR format is produced on STDOUT with
+the default dimensions of 1024 by 1024 pixels.  The dimensions
+may be overwritten with the 
+.I "\-d dimensions
+options which takes an integer that is divisible by two.
+.SH "EXAMPLES"
+To render a four\-view image of photometry file ABC123.ies
+and save the result to luminaire.hdr
+.IP "" .2i
+ltpict \-i ABC123.ies > luminaire.hdr
+.PP 
+To render a small four\-view HDR image of the 
+RADIANCE luminaire XYZ456.rad to STDOUT, and display it with ximage
+.IP "" .2i
+ltpict \-d 400 XYZ456.rad | ximage
+.SH "AUTHOR"
+Axel Jacobs
+.SH "SEE ALSO"
+objline(1), objview(1), objpict(1), ies2rad(1), ltview(1)
diff -r e4892d4ef026 -r 626ea3bad930 man/man1/ltview.1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/man/man1/ltview.1	Tue Mar 11 00:28:22 2014 +0000
@@ -0,0 +1,100 @@
+.\" 
+.TH "LTVIEW" "1" "11/03/14" "RADIANCE" ""
+.SH "NAME"
+ltview \- view a light source
+.SH "SYNOPSIS"
+.B ltview
+[
+.B \-i
+][
+.B "\-r roomsize"
+][
+.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 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 size.  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 T5 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)