home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / video / render / radiance.lzh / ray / doc / cat1 / mkillum.doc < prev    next >
Encoding:
Text File  |  1991-11-24  |  6.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. MKILLUM(1)               USER COMMANDS                 MKILLUM(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      mkillum - compute illum sources for a RADIANCE scene
  10.  
  11. SYNOPSIS
  12.      mkillum [ rtrace options ] octree [ < file .. ]
  13.      mkillum [ rtrace options ] -defaults
  14.  
  15. DESCRIPTION
  16.      Mkillum takes a prepared RADIANCE scene description  and  an
  17.      octree and computes light source distributions for each sur-
  18.      face, replacing them with secondary sources whose  contribu-
  19.      tions  can  be  computed  more  efficiently  by rpict(1) and
  20.      rview(1). This type of optimization is most useful for  win-
  21.      dows  and  skylights which represent concentrated sources of
  22.      indirect illumination.  Mkillum is not appropriate for  very
  23.      large  sources  or sources with highly directional distribu-
  24.      tions.  These are best handled respectively by  the  ambient
  25.      calculation and the secondary source types in RADIANCE.
  26.  
  27.      The arguments to mkillum are passed directly  to  rtrace(1),
  28.      which  is  used  to  compute the light distributions for the
  29.      input surfaces.  These surfaces can be  any  combination  of
  30.      polygons,   spheres   and  rings.   Other  surfaces  may  be
  31.      included, but mkillum cannot compute their distributions.
  32.  
  33.      By default, mkillum reads from its standard input and writes
  34.      to  its standard output.  It is possible to specify multiple
  35.      input files in a somewhat unconventional fashion by  placing
  36.      a  lesser-than  symbol  ('<')  before the file names.  (Note
  37.      that this character must be escaped from most shells.)  This
  38.      is  necessary  so  mkillum  can  tell where the arguments to
  39.      rtrace(1) end and its own input files begin.
  40.  
  41. VARIABLES
  42.      Mkillum has a number of parameters that can  be  changed  by
  43.      comments in the input file of the form:
  44.  
  45.           #@mkillum variable=value option switch{+|-} ..
  46.  
  47.      String or integer variables are separated from their  values
  48.      by  the  equals  sign  ('=').  Options appear by themselves.
  49.      Switches are followed either by a plus sign to turn them  on
  50.      or a minus sign to turn them off.
  51.  
  52.      Parameters are usually changed many times  within  the  same
  53.      input  file  to  tailor  the  calculation, specify different
  54.      labels and so on.  The parameters  and  their  meanings  are
  55.      described below.
  56.  
  57.      o=string  Set the output  file  to  string.  All  subsequent
  58.                scene  data  will  be  sent to this file.  If this
  59.                appears in the first comment in the input, nothing
  60.  
  61.  
  62.  
  63. Sun Release 4.1           Last change:                          1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MKILLUM(1)               USER COMMANDS                 MKILLUM(1)
  71.  
  72.  
  73.  
  74.                will be sent to the standard output.
  75.  
  76.      m=string  Set the material identifier to string.  This  name
  77.                will be used not only as the new surface modifier,
  78.                but it will also be used to name the  distribution
  79.                pattern and the data files.  The distribution name
  80.                will be string plus the suffix ".dist".  The  data
  81.                file will be named string plus possibly an integer
  82.                plus a ".dat" suffix.   The  integer  is  used  to
  83.                avoid  accidently  writing  over an existing file.
  84.                If overwriting the file  is  desired,  use  the  f
  85.                variable below.
  86.  
  87.      f=string  Set the data file name to string.  The  next  data
  88.                file will be given this name plus a ".dat" suffix.
  89.                Subsequent files will  be  named  string  plus  an
  90.                integer  plus the ".dat" suffix.  An existing file
  91.                with the same name will be clobbered.  This  vari-
  92.                able  may be unset by leaving off the value.  (See
  93.                also the m variable above.)
  94.  
  95.      a         Produce secondary sources for all of the  surfaces
  96.                in the input.  This is the default.
  97.  
  98.      e=string  Produce secondary sources for all surfaces  except
  99.                those  modified  by  string.  Surfaces modified by
  100.                string will be passed to the output unchanged.
  101.  
  102.      i=string  Only produce secondary sources for surfaces  modi-
  103.                fied by string.
  104.  
  105.      n         Do not produce any secondary sources.   All  input
  106.                will be passed to the output unaffected.
  107.  
  108.      b=real    Do not produce a secondary source for a surface if
  109.                its average brightness (radiance) is less than the
  110.                value real.
  111.  
  112.      c={d|a|n} Use color information according to the given char-
  113.                acter.  If the character is d, then color informa-
  114.                tion will be used in three separate data files and
  115.                the  distribution  will  be fully characterized in
  116.                terms of color.  If the character is a, then  only
  117.                the average color is computed and the distribution
  118.                will not contain color information.  If the  char-
  119.                acter  is  n,  even the average distribution color
  120.                will be thrown away, producing  secondary  sources
  121.                that are completely uncolored.  This may be desir-
  122.                able from a color-balancing point of view.
  123.  
  124.      d=integer Set the number of direction samples per  projected
  125.                steradian  to  integer.  The  number of directions
  126.  
  127.  
  128.  
  129. Sun Release 4.1           Last change:                          2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MKILLUM(1)               USER COMMANDS                 MKILLUM(1)
  137.  
  138.  
  139.  
  140.                stored in the associated data file will be approx-
  141.                imately  this number multiplied by pi for polygons
  142.                and rings, and by 4pi for spheres.  If integer  is
  143.                zero, then a diffuse source is assumed and no dis-
  144.                tribution is created.
  145.  
  146.      s=integer Set the number of ray  samples  per  direction  to
  147.                integer. This variable affects the accuracy of the
  148.                distribution value for each direction as  well  as
  149.                the computation time for mkillum.
  150.  
  151.      l{+|-}    Switch between light sources  and  illum  sources.
  152.                If  this  switch is enabled (l+), mkillum will use
  153.                the material type "light" to  represent  surfaces.
  154.                If  disabled  (l-),  mkillum will use the material
  155.                type "illum" with the input  surface  modifier  as
  156.                its alternate material.  The default is l-.
  157.  
  158. AUTHOR
  159.      Greg Ward
  160.  
  161. ACKNOWLEDGEMENT
  162.      Work on this program was initiated and sponsored by the LESO
  163.      group at EPFL in Switzerland.
  164.  
  165. SEE ALSO
  166.      oconv(1), rpict(1), rtrace(1), rview(1)
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Sun Release 4.1           Last change:                          3
  196.  
  197.  
  198.  
  199.