Name

---

      IMG_CFILTER

Purpose

---

      Apply a color filter to an image (both 24 bit color).

Category

---

Calling Sequence

---

      out = img_cfilter(base, filt)

Inputs

---

      base = Base image. in
      filt = Color filter. in
        This is a color image used as a filter. This works
        as if viewing the base image through a color
        transparency of the same size on top of it.

Keyword Parameters

---

Keywords

---

        WT=wt Filter weight, 0 to 1 (def=1).
          Smaller values give weaker filters.
        ERROR=err Error flag: 0=ok, 1=error.

Outputs

---

      out = filtered image. out.

Common Blocks

---

Notes

---

      Note: The color filter is a color image. Its coloring
      is equivalent to viewing a white background through
      the transparent color filter. So pure white is completely
      transparent, pure black is completely opaque, yellow
      will block blue, and so on.

Modification History

---

      R. Sterner, 2001 Sep 20
      R. Sterner, 2010 Aug 27 --- Now allows B&W filters, byte or float.
  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.