Name

---

      IMG_ILLUMINATE

Purpose

---

      Apply color illumination to an image (24 bit color).

Category

---

Calling Sequence

---

      out = img_illuminate(base, ill)

Inputs

---

      base = Base image. in
      ill = Color illumination. in

Keyword Parameters

---

Keywords

---

        WT=wt illumination weight, 0 to 1 (def=1).
          Smaller values give weaker illumination.
        /DESAT means allow desaturation (def=do not).
          With desaturation on any overflow in a color
          channel will flow into the other 2 channels. This
          will make the pixel brighter, but less saturated.
        ERROR=err Error flag: 0=ok, 1=error.

Outputs

---

      out = illuminated image. out.

Common Blocks

---

Notes

---

      Note: The illumination image is a color image.
        This is a color image used as illumination. This works
        as if projecting a slide of the illumination image
        onto the base image (both must be the same size).
        This is an additive process. Pure black is no
        illumination, pure white is complete illumantion and
        will give saturation in all 3 channels, R,G,B.

Modification History

---

      R. Sterner, 2001 Sep 20
      R. Sterner, 2005 Jul 20 --- Used temporary() to reduce memory.
      R. Sterner, 2010 May 12 --- Converted arrays from () to [].
  Copyright (C) 2001, Johns Hopkins University/Applied Physics Laboratory
  This software may be used, copied, or redistributed as long as it is not
  sold and this copyright notice is reproduced on each copy made. This
  routine is provided as is without any express or implied warranties
  whatsoever. Other limitations apply as described in the file disclaimer.txt.