Module transform Methods

ChopImage() removes a region of an image and collapses the image to occupy the removed portion.

The format of the ChopImage method is:

  Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
    ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

chop_info

Define the region of the image to chop.

exception

return any errors or warnings in this structure.

CropImage() extracts a region of the image starting at the offset defined by geometry. Region must be fully defined, and no special handling of geometry flags is performed.

The format of the CropImage method is:

  Image *CropImage(const Image *image,const RectangleInfo *geometry,
    ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

geometry

Define the region of the image to crop with members x, y, width, and height.

exception

return any errors or warnings in this structure.

CropImageToTiles() will crop a single image, into a possible list of tiles. This may include a single sub-region of the image. This basically applies all the normal geometry flags for Crop.

Image *CropImageToTiles(const Image *image,const RectangleInfo *crop_geometry, ExceptionInfo *exception)

A description of each parameter follows:

image

the image The transformed image is returned as this parameter.

crop_geometry

A crop geometry string.

exception

return any errors or warnings in this structure.

ExcerptImage() returns a excerpt of the image as defined by the geometry.

The format of the ExcerptImage method is:

  Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
    ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

geometry

Define the region of the image to extend with members x, y, width, and height.

exception

return any errors or warnings in this structure.

ExtentImage() extends the image as defined by the geometry, gravity, and image background color. Set the (x,y) offset of the geometry to move the original image relative to the extended image.

The format of the ExtentImage method is:

  Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
    ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

geometry

Define the region of the image to extend with members x, y, width, and height.

exception

return any errors or warnings in this structure.

FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.

The format of the FlipImage method is:

  Image *FlipImage(const Image *image,ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

exception

return any errors or warnings in this structure.

FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.

The format of the FlopImage method is:

  Image *FlopImage(const Image *image,ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

exception

return any errors or warnings in this structure.

RollImage() offsets an image as defined by x_offset and y_offset.

The format of the RollImage method is:

  Image *RollImage(const Image *image,const ssize_t x_offset,
    const ssize_t y_offset,ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

x_offset

the number of columns to roll in the horizontal direction.

y_offset

the number of rows to roll in the vertical direction.

exception

return any errors or warnings in this structure.

ShaveImage() shaves pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the ShaveImage method is:

  Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
    ExceptionInfo *exception)

A description of each parameter follows:

shave_image

Method ShaveImage returns a pointer to the shaved image. A null image is returned if there is a memory shortage or if the image width or height is zero.

image

the image.

shave_info

Specifies a pointer to a RectangleInfo which defines the region of the image to crop.

exception

return any errors or warnings in this structure.

SpliceImage() splices a solid color into the image as defined by the geometry.

The format of the SpliceImage method is:

  Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
    ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

geometry

Define the region of the image to splice with members x, y, width, and height.

exception

return any errors or warnings in this structure.

TransformImage() is a convenience method that behaves like ResizeImage() or CropImage() but accepts scaling and/or cropping information as a region geometry specification. If the operation fails, the original image handle is left as is.

This should only be used for single images.

The format of the TransformImage method is:

  MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
    const char *image_geometry)

A description of each parameter follows:

image

the image The transformed image is returned as this parameter.

crop_geometry

A crop geometry string. This geometry defines a subregion of the image to crop.

image_geometry

An image geometry string. This geometry defines the final size of the image.

to CropImageToTiles() or ResizeImage(), as appropriate.

TransformImages() calls TransformImage() on each image of a sequence.

The format of the TransformImage method is:

  MagickBooleanType TransformImages(Image **image,
    const char *crop_geometry,const char *image_geometry)

A description of each parameter follows:

image

the image The transformed image is returned as this parameter.

crop_geometry

A crop geometry string. This geometry defines a subregion of the image to crop.

image_geometry

An image geometry string. This geometry defines the final size of the image.

TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.

The format of the TransposeImage method is:

  Image *TransposeImage(const Image *image,ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

exception

return any errors or warnings in this structure.

TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.

The format of the TransverseImage method is:

  Image *TransverseImage(const Image *image,ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

exception

return any errors or warnings in this structure.

TrimImage() trims pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

The format of the TrimImage method is:

  Image *TrimImage(const Image *image,ExceptionInfo *exception)

A description of each parameter follows:

image

the image.

exception

return any errors or warnings in this structure.