# coyote: CHECKERBOARD

- coyote/Image Processing
- [Source code]

NAME

      Checkerboard

PURPOSE

      This function returns a 2D image, with boxes of alternating colors.
      Checkerboard images are useful in certain types of image processing
      procedures and for making blended image masks.

AUTHOR

      FANNING SOFTWARE CONSULTING
      David Fanning, Ph.D.
      1645 Sheely Drive
      Fort Collins, CO 80526 USA
      Phone: 970-221-0438
      E-mail: david@idlcoyote.com
      Coyote's Guide to IDL Programming: http://www.idlcoyote.com

CATEGORY

      Image Processing

CALLING SEQUENCE

      board = Checkerboard()

RETURN VALUE

      board:      A 2D long array of alternating colored boxes.

ARGUMENTS

      boxes:      The number of boxes of alternating colors on each side
                  of the resulting image. Must be an even integer greater
                  than or equal to two. Optional. Default is 8 (normal
                  checkerboard).

INPUT KEYWORDS

      BLACK:           The value of the "black" boxes. By default, 0.
      WHITE:           The value of the "white" boxes. By default, 255.
      XSIZE:           The X size of the returned image. By default, 400.
      YSIZE:           The Y size of the returned image. By default, 400.

COMMON BLOCKS

      None.

EXAMPLE

      IDL> cgImage, Checkerboard()

MODIFICATION HISTORY

      Written by David W. Fanning, 26 September 2007, based on suggestions
      of JD Smith on IDL newsgroup 25-26 Septermber 2007.