Name

---

    READPPM

Purpose

---

    This function serves to read a Netpbm format portable pixmap
    format (PPM) image.

Category

---

    Image Processing.

Calling Sequence

---

    Result = READPPM( filename )

Inputs

---

Filename

---

      The PPM image filename to be read.

Keyword Parameters

---

    SWAP
      This keyword will cause the function to change endian
      on the image data read from the file. This will only
      effect 16-bit per pixel (UINT) images.

Return Value

---

    An array containing the image data. This array will be of the
    correct data type for the provided image (BYTE or UINT) and will
    appear in BIP interleave order (bands, samples, lines). If the
    filename specified does not contain a valid PPM format image, the
    function will report this to the console and terminate execution.
   

Side Effects

---

    None

Modification History

---

    Written by: Carl Salvaggio
    November, 2009 Original code
   

Disclaimer

---

    This source code is provided "as is" and without warranties as to performance
    or merchantability. The author and/or distributors of this source code may
    have made statements about this source code. Any such statements do not
    constitute warranties and shall not be relied on by the user in deciding
    whether to use this source code.
    This source code is provided without any express or implied warranties
    whatsoever. Because of the diversity of conditions and hardware under which
    this source code may be used, no warranty of fitness for a particular purpose
    is offered. The user is advised to test the source code thoroughly before
    relying on it. The user must assume the entire risk of using the source code.