image - ImageMagick Image Methods
Image * AllocateImage( const ImageInfo *image_info );
unsigned int AllocateImageColormap( Image *image, const unsigned int colors );
void AllocateNextImage( const ImageInfo *image_info, Image *image );
unsigned int AnimateImages( const ImageInfo *image_info, Image *image );
Image * AppendImages( Image *image, const unsigned int stack, ExceptionInfo *exception );
Image * AverageImages( const Image *image, ExceptionInfo *exception );
unsigned int ChannelImage( Image *image, const ChannelType channel );
Image * CloneImage( Image *image, const unsigned int columns, const unsigned int rows, const unsigned int orphan, ExceptionInfo *exception );
ImageInfo * CloneImageInfo( const ImageInfo *image_info );
unsigned int CompositeImage( Image *image, const CompositeOperator compose, Image *composite_image, const int x_offset, const int y_offset );
CycleColormapImage( Image *image, const int amount );
void DescribeImage( Image *image, FILE *file, const unsigned int verbose );
void DestroyImage( Image *image );
void DestroyImageInfo( ImageInfo *image_info );
void DestroyImages( Image *image );
unsigned int DisplayImages( const ImageInfo *image_info, Image *image );
unsigned int GetImageDepth( Image *image );
void GetImageInfo( ImageInfo *image_info );
ImageType GetImageType( Image *image );
Image * GetNextImage( Image *image );
unsigned int GetNumberScenes( const Image *image );
unsigned int IsImageTainted( const Image *image );
unsigned int IsImagesEqual( Image *image, Image *reference );
Image ** ListToGroupImage( Image *image, unsigned int *number_images );
void SetImage( Image *image, const Quantum opacity );
unsigned int SetImageDepth( Image *image, const unsigned int depth );
void SetImageOpacity( Image *image, const unsigned int opacity );
SetImageType( Image *image, const ImageType image_type );
void TextureImage( Image *image, Image *texture );
AllocateImage returns a pointer to an image structure initialized to default values.
The format of the AllocateImage method is:
Image *AllocateImage ( const ImageInfo *image_info );
A description of each parameter follows:
AllocateImageColormap allocates an image colormap and initializes it to a linear gray colorspace. If the image already has a colormap, it is replaced. AllocateImageColormap returns True if successful, otherwise False if there is not enough memory.
The format of the AllocateImageColormap method is:
unsigned int AllocateImageColormap ( Image *image, const unsigned int colors );
A description of each parameter follows:
Use AllocateNextImage to initialize the next image in a sequence. The next member of image points to the newly allocated image. If there is a memory shortage, next is assigned NULL.
The format of the AllocateNextImage method is:
void AllocateNextImage ( const ImageInfo *image_info, Image *image );
A description of each parameter follows:
AnimateImages repeatedly displays an image sequence to any X window screen. It returns a value other than 0 if successful. Check the exception member of image to determine the reason for any failure.
The format of the AnimateImages method is:
unsigned int AnimateImages ( const ImageInfo *image_info, Image *image );
A description of each parameter follows:
The Append method takes a set of images and appends them to each other. Each image in the set must have the equal width or equal height (or both). Append returns a single image where each image in the original set is side-by-side if all the heights are equal or stacked on top of each other if all widths are equal. On failure, a NULL image is returned and exception describes the reason for the failure.
The format of the AppendImage method is:
Image *AppendImages ( Image *image, const unsigned int stack, ExceptionInfo *exception );
A description of each parameter follows:
The Average method takes a set of images and averages them together. Each image in the set must have the same width and the same height. Average returns a single image with each corresponding pixel component of each image averaged. On failure, a NULL image is returned and exception describes the reason for the failure.
The format of the AverageImage method is:
Image *AverageImages ( const Image *image, ExceptionInfo *exception );
A description of each parameter follows:
Extract a channel from the image. A channel is a particular color component of each pixel in the image.
The format of the ChannelImage method is:
unsigned int ChannelImage ( Image *image, const ChannelType channel );
A description of each parameter follows:
CloneImage copies an image and returns the copy as a new image object. If the specified columns and rows is 0, an exact copy of the image is returned, otherwise the pixel data is undefined and must be initialized with the SetImagePixels and SyncImagePixels methods. A NULL image is returned if the image cannot be cloned; check exception for the reason why.
The format of the CloneImage method is:
Image *CloneImage ( Image *image, const unsigned int columns, const unsigned int rows, const unsigned int orphan, ExceptionInfo *exception );
A description of each parameter follows:
CloneImageInfo makes a copy of the given image info, or if is NULL, a new one.
The format of the CloneImageInfo method is:
ImageInfo *CloneImageInfo ( const ImageInfo *image_info );
A description of each parameter follows:
CompositeImage returns the second image composited onto the first at the specified offsets.
The format of the CompositeImage method is:
unsigned int CompositeImage ( Image *image, const CompositeOperator compose, Image *composite_image, const int x_offset, const int y_offset );
A description of each parameter follows:
OverCompositeOp InCompositeOp OutCompositeOP AtopCompositeOP XorCompositeOP PlusCompositeOP MinusCompositeOP AddCompositeOP SubtractCompositeOP DifferenceCompositeOP BumpmapCompositeOP CopyCompositeOP DisplaceCompositeOP =over 4
CycleColormap displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can produce a psychodelic effect.
The format of the CycleColormapImage method is:
CycleColormapImage ( Image *image, const int amount );
A description of each parameter follows:
DescribeImage describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.
The format of the DescribeImage method is:
void DescribeImage ( Image *image, FILE *file, const unsigned int verbose );
A description of each parameter follows:
DestroyImage deallocates memory associated with an image.
The format of the DestroyImage method is:
void DestroyImage ( Image *image );
A description of each parameter follows:
DestroyImageInfo deallocates memory associated with an ImageInfo structure.
The format of the DestroyImageInfo method is:
void DestroyImageInfo ( ImageInfo *image_info );
A description of each parameter follows:
DestroyImages deallocates memory associated with all the images in a sequence.
The format of the DestroyImages method is:
void DestroyImages ( Image *image );
A description of each parameter follows:
DisplayImages displays an image sequence to any X window screen. It returns a value other than 0 if successful. Check the exception member of image to determine the reason for any failure.
The format of the AllocateNextImage method is:
unsigned int DisplayImages ( const ImageInfo *image_info, Image *image );
A description of each parameter follows:
GetImageDepth returns the depth of the image, either 8 or 16 bits. By default, pixels components are stored as 16-bit two byte unsigned short integers that range in value from 0 to 65535. However, if all the pixels have lower-order bytes of zero, the image is considered to have a depth of 8-bit.
The format of the GetImageDepth method is:
unsigned int GetImageDepth ( Image *image );
A description of each parameter follows:
GetImageInfo initializes the ImageInfo structure to default values.
The format of the GetImageInfo method is:
void GetImageInfo ( ImageInfo *image_info );
A description of each parameter follows:
GetImageType returns the type of image:
Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte
The format of the GetImageType method is:
ImageType GetImageType ( Image *image );
A description of each parameter follows:
GetNextImage returns the next image in an image sequence.
The format of the GetNextImage method is:
Image *GetNextImage ( Image *image );
A description of each parameter follows:
Method GetNumberScenes returns the number of images in an image sequence.
The format of the GetNumberScenes method is:
unsigned int GetNumberScenes ( const Image *image );
A description of each parameter follows:
IsImagesEqual measures the difference between colors at each pixel location of two images. A value other than 0 means the colors match exactly. Otherwise an error measure is computed by summing over all pixels in an image the distance squared in RGB space between each image pixel and its corresponding pixel in the reference image. The error measure is assigned to these image members:
A small normalized mean square error, accessed as image->normalized_mean_error, suggests the images are very similiar in spatial layout and color.
The format of the IsImagesEqual method is:
unsigned int IsImagesEqual ( Image *image, Image *reference );
A description of each parameter follows.
IsImageTainted returns a value other than 0 if any pixel in an image has been altered since it was first constituted.
The format of the IsImageTainted method is:
unsigned int IsImageTainted ( const Image *image );
A description of each parameter follows:
ListToGroupImage is a convenience method that converts a linked list of images to a sequential array. For example,
images = ListToGroupImage ( image_list, \&n ); for ( i=0; i < n; i++ ) puts ( images[i]->filename ) ;;
The format of the ListToGroupImage method is:
Image **ListToGroupImage ( Image *image, unsigned int *number_images );
A description of each parameter follows:
SetImage sets the red, green, and blue components of each pixel to the image background color and the opacity component to the specified level of transparency. The background color is defined by the background_color member of the image.
The format of the SetImage method is:
void SetImage ( Image *image, const Quantum opacity );
A description of each parameter follows:
SetImageDepth sets the depth of the image, either 8 or 16. Some image formats support both 8 and 16-bits per color component (e.g. PNG). Use SetImageDepth to specify your preference. A value other than 0 is returned if the depth is set.
The format of the SetImageDepth method is:
unsigned int SetImageDepth ( Image *image, const unsigned int depth );
A description of each parameter follows:
SetImageOpacity attenuates the opacity channel of an image. If the image pixels are opaque, they are set to the specified opacity level. Otherwise, the pixel oapcity values are blended with the supplied transparency value.
The format of the SetImageOpacity method is:
void SetImageOpacity ( Image *image, const unsigned int opacity );
A description of each parameter follows:
SetImageType sets the type of image. Choose from these types:
Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte
The format of the SetImageType method is:
SetImageType ( Image *image, const ImageType image_type );
A description of each parameter follows:
TextureImage repeatedly tiles the texture image across and down the image canvas.
The format of the TextureImage method is:
void TextureImage ( Image *image, Image *texture );
A description of each parameter follows: