[Home] [Mission Statement] [Development Process] [Download] [Installation] [CVS] [Mailing Lists] [FAQ] [Formats] [News ] [ChangeLog] [Report Bugs] [Utilities] [Programming] [Books] [Links] |
Search GraphicsMagick site

- NAME
- SYNOPSIS
- FUNCTION DESCRIPTIONS
  - CloneQuantizeInfo
  - CompressImageColormap
  - DestroyQuantizeInfo
  - GetImageQuantizeError
  - GetQuantizeInfo
  - MapImage
  - MapImages
  - OrderedDitherImage
  - QuantizeImage
  - QuantizeImages

## NAME

quantize - Methods to Reduce the Number of Unique Colors in an Image

## SYNOPSIS

QuantizeInfo * CloneQuantizeInfo( const QuantizeInfo *quantize_info );

void CompressImageColormap( Image *image );

DestroyQuantizeInfo( QuantizeInfo *quantize_info );

unsigned int GetImageQuantizeError( Image *image );

GetQuantizeInfo( QuantizeInfo *quantize_info );

unsigned int MapImage( Image *image, const Image *map_image, const unsigned int dither );

unsigned int MapImages( Image *images, Image *map_image, const unsigned int dither );

unsigned int OrderedDitherImage( Image *image );

unsigned int QuantizeImage( const QuantizeInfo *quantize_info, Image *image );

unsigned int QuantizeImages( const QuantizeInfo *quantize_info, Image *images );

## FUNCTION DESCRIPTIONS

### CloneQuantizeInfo

> CloneQuantizeInfo() makes a duplicate of the given quantize info structure, or if quantize info is NULL, a new one.

The format of the CloneQuantizeInfo method is:

> QuantizeInfo *CloneQuantizeInfo ( const QuantizeInfo *quantize_info );

A description of each parameter follows:

  clone_info:
    Method CloneQuantizeInfo returns a duplicate of the given quantize info, or if image info is NULL a new one.

  quantize_info:
    a structure of type info.

### CompressImageColormap

> CompressImageColormap() compresses an image colormap by removing any duplicate or unused color entries.

The format of the CompressImageColormap method is:

> void CompressImageColormap ( Image *image );

A description of each parameter follows:

  image:
    The image.

### DestroyQuantizeInfo

> DestroyQuantizeInfo() deallocates memory associated with an QuantizeInfo structure.

The format of the DestroyQuantizeInfo method is:

> DestroyQuantizeInfo ( QuantizeInfo *quantize_info );

A description of each parameter follows:

  quantize_info:
    Specifies a pointer to an QuantizeInfo structure.

### GetImageQuantizeError

> GetImageQuantizeError() measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value. These values are computed:

  mean_error_per_pixel:
    This value is the mean error for any single pixel in the image.

  normalized_mean_square_error:
    This value is the normalized mean quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in the image.

  normalized_maximum_square_error:
    Thsi value is the normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.

The format of the GetImageQuantizeError method is:

> unsigned int GetImageQuantizeError ( Image *image );

A description of each parameter follows.

  image:
    Specifies a pointer to an Image structure; returned from ReadImage.

### GetQuantizeInfo

> GetQuantizeInfo() initializes the QuantizeInfo structure.

The format of the GetQuantizeInfo method is:

> GetQuantizeInfo ( QuantizeInfo *quantize_info );

A description of each parameter follows:

  quantize_info:
    Specifies a pointer to a QuantizeInfo structure.

### MapImage

> MapImage() replaces the colors of an image with the closest color from a reference image.

The format of the MapImage method is:

> unsigned int MapImage ( Image *image, const Image *map_image, const unsigned int dither );

A description of each parameter follows:

  image:
    Specifies a pointer to an Image structure.

  map_image:
    Specifies a pointer to an Image structure. Reduce image to a set of colors represented by this image.

  dither:
    Set this integer value to something other than zero to dither the quantized image.

### MapImages

> MapImages() replaces the colors of a sequence of images with the closest color from a reference image.

The format of the MapImage method is:

> unsigned int MapImages ( Image *images, Image *map_image, const unsigned int dither );

A description of each parameter follows:

  image:
    Specifies a pointer to a set of Image structures.

  map_image:
    Specifies a pointer to an Image structure. Reduce image to a set of colors represented by this image.

  dither:
    Set this integer value to something other than zero to dither the quantized image.

### OrderedDitherImage

> OrderedDitherImage() uses the ordered dithering technique of reducing color images to monochrome using positional information to retain as much information as possible.

The format of the OrderedDitherImage method is:

> unsigned int OrderedDitherImage ( Image *image );

A description of each parameter follows.

  image:
    Specifies a pointer to an Image structure; returned from ReadImage.

### QuantizeImage

> QuantizeImage() analyzes the colors within a reference image and chooses a fixed number of colors to represent the image. The goal of the algorithm is to minimize the color difference between the input and output image while minimizing the processing time.

The format of the QuantizeImage method is:

> unsigned int QuantizeImage ( const QuantizeInfo *quantize_info, Image *image );

A description of each parameter follows:

  quantize_info:
    Specifies a pointer to an QuantizeInfo structure.

  image:
    Specifies a pointer to an Image structure.

### QuantizeImages

> QuantizeImages() analyzes the colors within a set of reference images and chooses a fixed number of colors to represent the set. The goal of the algorithm is to minimize the color difference between the input and output images while minimizing the processing time.

The format of the QuantizeImages method is:

> unsigned int QuantizeImages ( const QuantizeInfo *quantize_info, Image *images );

A description of each parameter follows:

  quantize_info:
    Specifies a pointer to an QuantizeInfo structure.

  images:
    Specifies a pointer to a list of Image structures.