NAME

encode - Methods to Write Image Formats


SYNOPSIS

status=WriteAVSImage(image_info,image)

status=WriteBMPImage(image_info,image)

status=WriteCMYKImage(image_info,image)

status=WriteEPTImage(image_info,image)

status=WriteFAXImage(image_info,image)

status=WriteFITSImage(image_info,image)

status=WriteFPXImage(image_info,image)

status=WriteGIFImage(image_info,image)

status=WriteGRAYImage(image_info,image)

status=WriteHDFImage(image_info,image)

status=WriteHISTOGRAMImage(image_info,image)

status=WriteHTMLImage(image_info,image)

status=WriteICCImage(image_info,image)

status=WriteIPTCImage(image_info,image)

status=WriteImage(image_info,image)

status=WriteJBIGImage(image_info,image)

status=WriteJPEGImage(image_info,image)

status=WriteLOGOImage(image_info,image)

status=WriteMAPImage(image_info,image)

status=WriteMATTEImage(image_info,image)

status=WriteMIFFImage(image_info,image)

status=WriteMONOImage(image_info,image)

status=WriteMTVImage(image_info,image)

status=WritePCDImage(image_info,image)

status=WritePCLImage(image_info,image)

status=WritePCXImage(image_info,image)

status=WritePDFImage(image_info,image)

status=WritePICTImage(image_info,image)

status=WritePNGImage(image_info,image)

status=WritePNMImage(image_info,image)

status=WritePREVIEWImage(image_info,image)

status=WritePS2Image(image_info,image)

status=WritePSDImage(image_info,image)

status=WritePSImage(image_info,image)

status=WriteRGBImage(image_info,image)

status=WriteSGIImage(image_info,image)

status=WriteSUNImage(image_info,image)

status=WriteTGAImage(image_info,image)

status=WriteTIFFImage(image_info,image)

status=WriteTXTImage(image_info,image)

status=WriteUILImage(image_info,image)

status=WriteUYVYImage(image_info,image)

status=WriteVICARImage(image_info,image)

status=WriteVIFFImage(image_info,image)

status=WriteXBMImage(image_info,image)

status=WriteXImage(image_info,image)

status=WriteXPMImage(image_info,image)

status=WriteXWDImage(image_info,image)

status=WriteYUVImage(image_info,image)


FUNCTION DESCRIPTIONS


WriteAVSImage

Method WriteAVSImage writes an image to a file in AVS X image format.

The format of the WriteAVSImage routine is:

        status=WriteAVSImage(image_info,image)

A description of each parameter follows.

status:

Method WriteAVSImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteBMPImage

Method WriteBMPImage writes an image in Microsoft Windows bitmap encoded image format.

The format of the WriteBMPImage routine is:

        status=WriteBMPImage(image_info,image)

A description of each parameter follows.

status:

Method WriteBMPImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteCMYKImage

Method WriteCMYKImage writes an image to a file in cyan, magenta, yellow, and black rasterfile format.

The format of the WriteCMYKImage routine is:

        status=WriteCMYKImage(image_info,image)

A description of each parameter follows.

status:

Method WriteCMYKImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteEPTImage

Method WriteEPTImage writes an image in the Adobe Encapsulated Postscript format with a TIFF preview.

The format of the WriteEPTImage routine is:

        status=WriteEPTImage(image_info,image)

A description of each parameter follows.

status:

Method WriteEPTImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteFAXImage

Procedure WriteFAXImage writes an image to a file in 1 dimensional Huffman encoded format.

The format of the WriteFAXImage routine is:

        status=WriteFAXImage(image_info,image)

A description of each parameter follows.

status:

Method WriteFAXImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteFITSImage

Method WriteFITSImage writes a Flexible Image Transport System image to a file as gray scale intensities [0..255].

The format of the WriteFITSImage routine is:

        status=WriteFITSImage(image_info,image)

A description of each parameter follows.

status:

Method WriteFITSImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteFPXImage

Method WriteFPXImage writes an image in the FlashPix image format. This routine was contributed by BillR@corbis.com.

The format of the WriteFPXImage routine is:

        status=WriteFPXImage(image_info,image)

A description of each parameter follows.

status:

Method WriteFPXImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteGIFImage

Method WriteGIFImage writes an image to a file in the Compuserve Graphics image format.

The format of the WriteGIFImage routine is:

        status=WriteGIFImage(image_info,image)

A description of each parameter follows.

status:

Method WriteGIFImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteGRAYImage

Method WriteGRAYImage writes an image to a file as gray scale intensity values.

The format of the WriteGRAYImage routine is:

        status=WriteGRAYImage(image_info,image)

A description of each parameter follows.

status:

Method WriteGRAYImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteHDFImage

Method WriteHDFImage writes an image in the Hierarchial Data Format image format.

The format of the WriteHDFImage routine is:

        status=WriteHDFImage(image_info,image)

A description of each parameter follows.

status:

Method WriteHDFImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteHISTOGRAMImage

Method WriteHISTOGRAMImage writes an image to a file in HISTOGRAM format. The image shows a histogram of the color (or gray) values in the image. The image consists of three overlaid histograms: a red one for the red channel, a green one for the green channel, and a blue one for the blue channel. The image comment contains a list of unique pixel values and the number of times each occurs in the image.

This routine is strongly based on a similiar one written by muquit@warm.semcor.com which in turn is based on ppmhistmap of netpbm.

The format of the WriteHISTOGRAMImage routine is:

        status=WriteHISTOGRAMImage(image_info,image)

A description of each parameter follows.

status:

Method WriteHISTOGRAMImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteHTMLImage

Method WriteHTMLImage writes an image in the HTML encoded image format.

The format of the WriteHTMLImage routine is:

        status=WriteHTMLImage(image_info,image)

A description of each parameter follows.

status:

Method WriteHTMLImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteJBIGImage

Method WriteJBIGImage writes an image in the JBIG encoded image format.

The format of the WriteJBIGImage routine is:

        status=WriteJBIGImage(image_info,image)

A description of each parameter follows.

status:

Method WriteJBIGImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteJPEGImage

Method WriteJPEGImage writes a JPEG image file and returns it. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the WriteJPEGImage routine is:

        status=WriteJPEGImage(image_info,image)

A description of each parameter follows:

status:

Method WriteJPEGImage return True if the image is written. False is returned is there is of a memory shortage or if the image file cannot be opened for writing.

image_info:

Specifies a pointer to an ImageInfo structure.

jpeg_image:

A pointer to a Image structure.


WriteICCImage

Method WriteICCImage writes an image in the ICC format.

The format of the WriteICCImage routine is:

        status=WriteICCImage(image_info,image)

A description of each parameter follows.

status:

Method WriteICCImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteIPTCImage

Method WriteIPTCImage writes an image in the IPTC format.

The format of the WriteIPTCImage routine is:

        status=WriteIPTCImage(image_info,image)

A description of each parameter follows.

status:

Method WriteIPTCImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteLOGOImage

Method WriteLOGOImage writes an image in the LOGO encoded image format. We use GIF because it is the only format that is compressed without requiring addition optional delegates (TIFF, ZIP, etc).

The format of the WriteLOGOImage routine is:

        status=WriteLOGOImage(image_info,image)

A description of each parameter follows.

status:

Method WriteLOGOImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteMAPImage

Method WriteMAPImage writes an image to a file as red, green, and blue colormap bytes followed by the colormap indexes.

The format of the WriteMAPImage routine is:

        status=WriteMAPImage(image_info,image)

A description of each parameter follows.

status:

Method WriteMAPImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteMATTEImage

Function WriteMATTEImage writes an image of matte bytes to a file. It consists of data from the matte component of the image [0..255].

The format of the WriteMATTEImage routine is:

        status=WriteMATTEImage(image_info,image)

A description of each parameter follows.

status:

Function WriteMATTEImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteMIFFImage

Method WriteMIFFImage writes an image to a file.

The format of the WriteMIFFImage routine is:

        status=WriteMIFFImage(image_info,image)

A description of each parameter follows:

status:

Method WriteMIFFImage return True if the image is written. False is returned if there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteMONOImage

Method WriteMONOImage writes an image of raw bits in LSB order to a file.

The format of the WriteMONOImage routine is:

        status=WriteMONOImage(image_info,image)

A description of each parameter follows.

status:

Method WriteMONOImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteMTVImage

Method WriteMTVImage writes an image to a file in red, green, and blue MTV rasterfile format.

The format of the WriteMTVImage routine is:

        status=WriteMTVImage(image_info,image)

A description of each parameter follows.

status:

Method WriteMTVImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePCDImage

Method WritePCDImage writes an image in the Photo CD encoded image format.

The format of the WritePCDImage routine is:

        status=WritePCDImage(image_info,image)

A description of each parameter follows.

status:

Method WritePCDImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePCLImage

Method WritePCLImage writes an image in the Page Control Language encoded image format.

The format of the WritePCLImage routine is:

        status=WritePCLImage(image_info,image)

A description of each parameter follows.

status:

Method WritePCLImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePCXImage

Method WritePCXImage writes an image in the ZSoft IBM PC Paintbrush file format.

The format of the WritePCXImage routine is:

        status=WritePCXImage(image_info,image)

A description of each parameter follows.

status:

Method WritePCXImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePDFImage

Method WritePDFImage writes an image in the Portable Document image format.

The format of the WritePDFImage routine is:

        status=WritePDFImage(image_info,image)

A description of each parameter follows.

status:

Method WritePDFImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePICTImage

Method WritePICTImage writes an image to a file in the Apple Macintosh QuickDraw/PICT image format.

The format of the WritePICTImage routine is:

        status=WritePICTImage(image_info,image)

A description of each parameter follows.

status:

Method WritePICTImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePNGImage

Method WritePNGImage writes an image in the Portable Network Graphics encoded image format.

The format of the WritePNGImage routine is:

        status=WritePNGImage(image_info,image)

A description of each parameter follows.

status:

Method WritePNGImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePNMImage

Procedure WritePNMImage writes an image to a file in the PNM rasterfile format.

The format of the WritePNMImage routine is:

        status=WritePNMImage(image_info,image)

A description of each parameter follows.

status:

Method WritePNMImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePREVIEWImage

Method WritePREVIEWImage creates several tiles each with a varying stength of an image enhancement function (e.g. gamma). The image is written in the MIFF format.

The format of the WritePREVIEWImage routine is:

        status=WritePREVIEWImage(image_info,image)

A description of each parameter follows.

status:

Method WritePREVIEWImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePSImage

Method WritePSImage translates an image to encapsulated Postscript Level I for printing. If the supplied geometry is null, the image is centered on the Postscript page. Otherwise, the image is positioned as specified by the geometry.

The format of the WritePSImage routine is:

        status=WritePSImage(image_info,image)

A description of each parameter follows:

status:

Method WritePSImage return True if the image is printed. False is returned if the image file cannot be opened for printing.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

The address of a structure of type Image; returned from ReadImage.


WritePSDImage

Method WritePSDImage writes an image in the Adobe Photoshop encoded image format.

The format of the WritePSDImage routine is:

        status=WritePSDImage(image_info,image)

A description of each parameter follows.

status:

Method WritePSDImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WritePS2Image

Method WritePS2Image translates an image to encapsulated Postscript Level II for printing. If the supplied geometry is null, the image is centered on the Postscript page. Otherwise, the image is positioned as specified by the geometry.

The format of the WritePS2Image routine is:

        status=WritePS2Image(image_info,image)

A description of each parameter follows:

status:

Method WritePS2Image return True if the image is printed. False is returned if the image file cannot be opened for printing.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

The address of a structure of type Image; returned from ReadImage.


WriteRGBImage

Method WriteRGBImage writes an image to a file in red, green, and blue rasterfile format.

The format of the WriteRGBImage routine is:

        status=WriteRGBImage(image_info,image)

A description of each parameter follows.

status:

Method WriteRGBImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteSGIImage

Method WriteSGIImage writes an image in SGI RGB encoded image format.

The format of the WriteSGIImage routine is:

        status=WriteSGIImage(image_info,image)

A description of each parameter follows.

status:

Method WriteSGIImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteSUNImage

Method WriteSUNImage writes an image in the SUN rasterfile format.

The format of the WriteSUNImage routine is:

        status=WriteSUNImage(image_info,image)

A description of each parameter follows.

status:

Method WriteSUNImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteTGAImage

Method WriteTGAImage writes a image in the Truevision Targa rasterfile format.

The format of the WriteTGAImage routine is:

        status=WriteTGAImage(image_info,image)

A description of each parameter follows.

status:

Method WriteTGAImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteTIFFImage

Method WriteTIFFImage writes an image in the Tagged image file format.

The format of the WriteTIFFImage routine is:

        status=WriteTIFFImage(image_info,image)

A description of each parameter follows:

status:

Method WriteTIFFImage return True if the image is written. False is returned is there is of a memory shortage or if the image file cannot be opened for writing.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteTXTImage

Method WriteTXTImage writes the pixel values as text numbers.

The format of the WriteTXTImage routine is:

        status=WriteTXTImage(image_info,image)

A description of each parameter follows.

status:

Method WriteTXTImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteUILImage

Procedure WriteUILImage writes an image to a file in the X-Motif UIL table format.

The format of the WriteUILImage routine is:

        status=WriteUILImage(image_info,image)

A description of each parameter follows.

status:

Method WriteUILImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteUYVYImage

Method WriteUYVYImage writes an image to a file in the digital UYVY (16bit/pixel) format. This format, used by AccomWSD, is not dramatically higher quality than the 12bit/pixel YUV format, but has better locality.

The format of the WriteUYVYImage routine is:

        status=WriteUYVYImage(image_info,image)

A description of each parameter follows.

status:

Method WriteUYVYImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure. Implicit assumption: number of columns is even.


WriteVICARImage

Method WriteVICARImage writes an image in the VICAR rasterfile format. Vicar files contain a text header, followed by one or more planes of binary grayscale image data. Vicar files are designed to allow many planes to be stacked together to form image cubes. This routine only writes a single grayscale plane.

Method WriteVICARImage was written contributed by gorelick@esther.la.asu.edu.

The format of the WriteVICARImage routine is:

        status=WriteVICARImage(image_info,image)

A description of each parameter follows.

status:

Method WriteVICARImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteVIFFImage

Method WriteVIFFImage writes an image to a file in the VIFF image format.

The format of the WriteVIFFImage routine is:

        status=WriteVIFFImage(image_info,image)

A description of each parameter follows.

status:

Method WriteVIFFImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteXImage

Method WriteXImage writes an image to an X server.

The format of the WriteXImage routine is:

        status=WriteXImage(image_info,image)

A description of each parameter follows.

status:

Method WriteXImage return True if the image is displayed on the X server. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteXBMImage

Procedure WriteXBMImage writes an image to a file in the X bitmap format.

The format of the WriteXBMImage routine is:

        status=WriteXBMImage(image_info,image)

A description of each parameter follows.

status:

Method WriteXBMImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteXPMImage

Procedure WriteXPMImage writes an image to a file in the X pixmap format.

The format of the WriteXPMImage routine is:

        status=WriteXPMImage(image_info,image)

A description of each parameter follows.

status:

Method WriteXPMImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteYUVImage

Method WriteYUVImage writes an image to a file in the digital YUV (CCIR 601 4:1:1) format.

The format of the WriteYUVImage routine is:

        status=WriteYUVImage(image_info,image)

A description of each parameter follows.

status:

Method WriteYUVImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteXWDImage

Method WriteXWDImage writes an image to a file in X window dump rasterfile format.

The format of the WriteXWDImage routine is:

        status=WriteXWDImage(image_info,image)

A description of each parameter follows.

status:

Method WriteXWDImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.


WriteImage

Method WriteImage writes an image to a file. You can specify a particular image format by prefixing the file with the image type and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps).

The format of the WriteImage routine is:

        status=WriteImage(image_info,image)

A description of each parameter follows:

status:

Method WriteImage return True if the image is written. False is returned is there is a memory shortage or if the image file fails to write.

image_info:

Specifies a pointer to an ImageInfo structure.

image:

A pointer to a Image structure.