Update man page for ltview
authorAxel Jacobs <axel@jaloxa.eu>
Mon, 14 Apr 2014 22:20:45 +0100
changeset 729516e69e0be3
parent 71 3f218b9421f8
child 73 87fa3132a136
Update man page for ltview
man/man1/ltview.1
     1.1 --- a/man/man1/ltview.1	Mon Apr 14 22:20:17 2014 +0100
     1.2 +++ b/man/man1/ltview.1	Mon Apr 14 22:20:45 2014 +0100
     1.3 @@ -9,23 +9,20 @@
     1.4  ][
     1.5  .B "\-b boxsize"
     1.6  ][
     1.7 -.B "\-o output device"
     1.8 +.B "\-o device"
     1.9  ]
    1.10  input
    1.11  .SH "DESCRIPTION"
    1.12  .I ltview
    1.13  renders a Radiance luminiare or IES photometry interactively using
    1.14 -.I rad(1)
    1.15 -.  This program is merely a shell script that calls
    1.16 -.I rad(1)
    1.17 -to make an octree and view the scene interactively.
    1.18 +.I rad(1).
    1.19  .PP 
    1.20  .I ltview
    1.21  accepts exactly one Radiance object or IES photometry
    1.22  file as input.  No input is taken from STDIN.  The
    1.23  .I \-i
    1.24 -option tells it that the file name given is 
    1.25 -an IES photometry file rather then a Radiance description of a 
    1.26 +option tells it that the input file contains 
    1.27 +IES photometry rather then a Radiance description of a 
    1.28  luminiare.  In this case, Radiance's
    1.29  .I ies2rad(1)
    1.30  is called with its default settings to convert the IES file into a 
    1.31 @@ -34,8 +31,8 @@
    1.32  Unlike
    1.33  .I objpict(1)
    1.34  or
    1.35 -.I objview(1)
    1.36 -, no additional light sources are added to the scene, since it is
    1.37 +.I objview(1),
    1.38 +no additional light sources are added to the scene, since it is
    1.39  assumed that the object is a luminaire.
    1.40  .PP 
    1.41  .I ltview
    1.42 @@ -46,33 +43,36 @@
    1.43  and to call
    1.44  .I rvu(1)
    1.45  to display an interactive preview of the luminaire.
    1.46 -The default behaviour for
    1.47 +The luminaire, or output from 
    1.48 +.I ies2rad(1),
    1.49 +is moved so that its center is at world origin.
    1.50  .I ltview
    1.51 -is to scale the luminaire or output from 
    1.52 -.I ies2rad(1)
    1.53 -so that the largest dimension of the fitting is unity, centered at the origin.
    1.54 -This scaled representation of the original fitting is then placed inside a 
    1.55 -square box 10 units in length.  The \-y face of the box is left open so that 
    1.56 +then generates an open box around the fitting that is ten times
    1.57 +as big as the largest axis\-aligned dimension of the fitting.
    1.58 +The \-y face of the box is left open so that 
    1.59  the camera can look inside, facing +y.
    1.60 -If it is desirable to keep the original luminaire in both its original size,
    1.61 -and its original location, the
    1.62 -.I "\-r roomsize"
    1.63 -option may be used to fix the room size to a certain
    1.64 -.I roomsize.
    1.65 -In this case, the size and location of the fitting is not adjusted, and
    1.66 -it is up to the user to decide on appropriate room dimensions.  Note that
    1.67 -when
    1.68 -.I \-r
    1.69 -and
    1.70 +The overall dimensions of the enclosing box may be overwritten with the
    1.71 +.I "\-b boxsize"
    1.72 +option.  Note that both the fitting and the box are always centred at the
    1.73 +origin.
    1.74 +.PP 
    1.75 +When
    1.76 +.I ltview
    1.77 +is run with the
    1.78  .I \-i
    1.79 -are combined, then the dimensions of the luminaire and intesity of its 
    1.80 +option, i.e. the file is an IES photometry file,
    1.81 +then the dimensions of the luminaire and intesity of its 
    1.82  output are determined by
    1.83  .I ies2rad(1)'s
    1.84  default settings.  If this is not acceptable, then it is best to run
    1.85  .I ies2rad(1)
    1.86  manually, and to feed
    1.87  .I ltview
    1.88 -the hand\-crafted fitting, rather than the IES photometry.
    1.89 +the hand\-crafted fitting, rather than the IES photometry.  In any case,
    1.90 +it is likely that the initial exposure within the 
    1.91 +.I rvu(1)
    1.92 +window window needs to be adjusted before the distribution of the fitting
    1.93 +can be fully appreciated.
    1.94  .PP 
    1.95  The default
    1.96  .I rvu(1)
    1.97 @@ -95,7 +95,7 @@
    1.98  .PP 
    1.99  To look at a typical fluorescent fitting that is modelled in millimeters
   1.100  .IP "" .2i
   1.101 -ltview \-r 5000 XYZ_batten.rad
   1.102 +ltview \-b 5000 XYZ_batten.rad
   1.103  .SH "AUTHOR"
   1.104  Axel Jacobs
   1.105  .SH "SEE ALSO"