The Imagick classClass synopsisImagick
class Imagick
implements
Iterator {
public __construct(mixed
$files = ?)public bool adaptiveBlurImage(float
$radius , float $sigma , int $channel = Imagick::CHANNEL_DEFAULT)public bool adaptiveResizeImage(
int $columns ,int $rows ,bool $bestfit = false ,bool $legacy = false ) public bool adaptiveSharpenImage(float
$radius , float $sigma , int $channel = Imagick::CHANNEL_DEFAULT)public bool adaptiveThresholdImage(int
$width , int $height , int $offset )public bool addImage(Imagick
$source )public bool addNoiseImage(int
$noise_type , int $channel = Imagick::CHANNEL_DEFAULT)public bool affineTransformImage(ImagickDraw
$matrix )public bool animateImages(string
$x_server )public bool annotateImage(
ImagickDraw $draw_settings ,float $x ,float $y ,float $angle ,string $text ) public Imagick appendImages(bool
$stack )public bool autoLevelImage(int
$channel = Imagick::CHANNEL_DEFAULT)public Imagick averageImages()
public bool blackThresholdImage(mixed
$threshold )public bool blueShiftImage(float
$factor = 1.5)public bool blurImage(float
$radius , float $sigma , int $channel = ?)public bool borderImage(mixed
$bordercolor , int $width , int $height )public bool brightnessContrastImage(float
$brightness , float $contrast , int $channel = Imagick::CHANNEL_DEFAULT)public bool charcoalImage(float
$radius , float $sigma )public bool chopImage(
int $width ,int $height ,int $x ,int $y ) public bool clampImage(int
$channel = Imagick::CHANNEL_DEFAULT)public bool clear()
public bool clipImage()
public void clipImagePath(string
$pathname , string $inside )public bool clipPathImage(string
$pathname , bool $inside )public Imagick clone()
public bool clutImage(Imagick
$lookup_table , int $channel = Imagick::CHANNEL_DEFAULT)public Imagick coalesceImages()
public bool colorFloodfillImage(
mixed $fill ,float $fuzz ,mixed $bordercolor ,int $x ,int $y ) public bool colorizeImage(mixed
$colorize , mixed $opacity , bool $legacy = false )public bool colorMatrixImage(array
$color_matrix = Imagick::CHANNEL_DEFAULT)public Imagick combineImages(int
$channelType )public bool commentImage(string
$comment )public array compareImageChannels(Imagick
$image , int $channelType , int $metricType )public Imagick compareImageLayers(int
$method )public array compareImages(Imagick
$compare , int $metric )public bool compositeImage(
Imagick $composite_object ,int $composite ,int $x ,int $y ,int $channel = Imagick::CHANNEL_DEFAULT) public bool contrastImage(bool
$sharpen )public bool contrastStretchImage(float
$black_point , float $white_point , int $channel = Imagick::CHANNEL_DEFAULT)public bool convolveImage(array
$kernel , int $channel = Imagick::CHANNEL_DEFAULT)public int count(int
$mode = 0)public bool cropImage(
int $width ,int $height ,int $x ,int $y ) public bool cropThumbnailImage(int
$width , int $height , bool $legacy = false )public Imagick current()
public bool cycleColormapImage(int
$displace )public bool decipherImage(string
$passphrase )public Imagick deconstructImages()
public bool deleteImageArtifact(string
$artifact )public bool deleteImageProperty(string
$name )public bool deskewImage(float
$threshold )public bool despeckleImage()
public bool destroy()
public bool displayImage(string
$servername )public bool displayImages(string
$servername )public bool distortImage(int
$method , array $arguments , bool $bestfit )public bool drawImage(ImagickDraw
$draw )public bool edgeImage(float
$radius )public bool embossImage(float
$radius , float $sigma )public bool encipherImage(string
$passphrase )public bool enhanceImage()
public bool equalizeImage()
public bool evaluateImage(int
$op , float $constant , int $channel = Imagick::CHANNEL_DEFAULT)public array exportImagePixels(
int $x ,int $y ,int $width ,int $height ,string $map ,int $STORAGE ) public bool extentImage(
int $width ,int $height ,int $x ,int $y ) public bool filter(ImagickKernel
$ImagickKernel , int $channel = Imagick::CHANNEL_UNDEFINED)public Imagick flattenImages()
public bool flipImage()
public bool floodFillPaintImage(
mixed $fill ,float $fuzz ,mixed $target ,int $x ,int $y ,bool $invert ,int $channel = Imagick::CHANNEL_DEFAULT) public bool flopImage()
public bool forwardFourierTransformimage(bool
$magnitude )public bool frameImage(
mixed $matte_color ,int $width ,int $height ,int $inner_bevel ,int $outer_bevel ) public bool functionImage(int
$function , array $arguments , int $channel = Imagick::CHANNEL_DEFAULT)public Imagick fxImage(string
$expression , int $channel = Imagick::CHANNEL_DEFAULT)public bool gammaImage(float
$gamma , int $channel = Imagick::CHANNEL_DEFAULT)public bool gaussianBlurImage(float
$radius , float $sigma , int $channel = Imagick::CHANNEL_DEFAULT)public int getColorspace()
public int getCompression()
public int getCompressionQuality()
public static string getCopyright()
public string getFilename()
public string getFont()
public string getFormat()
public int getGravity()
public static string getHomeURL()
public Imagick getImage()
public bool getImageAlphaChannel()
public string getImageArtifact(string
$artifact )public string getImageAttribute(string
$key )public ImagickPixel getImageBackgroundColor()
public string getImageBlob()
public array getImageBluePrimary()
public ImagickPixel getImageBorderColor()
public int getImageChannelDepth(int
$channel )public float getImageChannelDistortion(Imagick
$reference , int $channel , int $metric )public float getImageChannelDistortions(Imagick
$reference , int $metric , int $channel = Imagick::CHANNEL_DEFAULT)public array getImageChannelExtrema(int
$channel )public array getImageChannelKurtosis(int
$channel = Imagick::CHANNEL_DEFAULT)public array getImageChannelMean(int
$channel )public array getImageChannelRange(int
$channel )public array getImageChannelStatistics()
public Imagick getImageClipMask()
public ImagickPixel getImageColormapColor(int
$index )public int getImageColors()
public int getImageColorspace()
public int getImageCompose()
public int getImageCompression()
public int getImageCompressionQuality()
public int getImageDelay()
public int getImageDepth()
public int getImageDispose()
public float getImageDistortion(MagickWand
$reference , int $metric )public array getImageExtrema()
public string getImageFilename()
public string getImageFormat()
public float getImageGamma()
public array getImageGeometry()
public int getImageGravity()
public array getImageGreenPrimary()
public int getImageHeight()
public array getImageHistogram()
public int getImageIndex()
public int getImageInterlaceScheme()
public int getImageInterpolateMethod()
public int getImageIterations()
public int getImageLength()
public bool getImageMatte()
public ImagickPixel getImageMatteColor()
public string getImageMimeType()
public int getImageOrientation()
public array getImagePage()
public ImagickPixel getImagePixelColor(int
$x , int $y )public string getImageProfile(string
$name )public array getImageProfiles(string
$pattern = "*", bool $include_values = true )public array getImageProperties(string
$pattern = "*", bool $include_values = true )public string getImageProperty(string
$name )public array getImageRedPrimary()
public Imagick getImageRegion(
int $width ,int $height ,int $x ,int $y ) public int getImageRenderingIntent()
public array getImageResolution()
public string getImagesBlob()
public int getImageScene()
public string getImageSignature()
public int getImageSize()
public int getImageTicksPerSecond()
public float getImageTotalInkDensity()
public int getImageType()
public int getImageUnits()
public int getImageVirtualPixelMethod()
public array getImageWhitePoint()
public int getImageWidth()
public int getInterlaceScheme()
public int getIteratorIndex()
public int getNumberImages()
public string getOption(string
$key )public static string getPackageName()
public array getPage()
public ImagickPixelIterator getPixelIterator()
public ImagickPixelIterator getPixelRegionIterator(
int $x ,int $y ,int $columns ,int $rows ) public float getPointSize()
public static int getQuantum()
public static array getQuantumDepth()
public static array getQuantumRange()
public static string getRegistry(string
$key )public static string getReleaseDate()
public static int getResource(int
$type )public static int getResourceLimit(int
$type )public array getSamplingFactors()
public array getSize()
public int getSizeOffset()
public static array getVersion()
public bool haldClutImage(Imagick
$clut , int $channel = Imagick::CHANNEL_DEFAULT)public bool hasNextImage()
public bool hasPreviousImage()
public stringfalse identifyFormat(string
$embedText )public array identifyImage(bool
$appendRawOutput = false )public bool implodeImage(float
$radius )public bool importImagePixels(
int $x ,int $y ,int $width ,int $height ,string $map ,int $storage ,array $pixels ) public bool inverseFourierTransformImage(Imagick
$complement , bool $magnitude )public bool labelImage(string
$label )public bool levelImage(
float $blackPoint ,float $gamma ,float $whitePoint ,int $channel = Imagick::CHANNEL_DEFAULT) public bool linearStretchImage(float
$blackPoint , float $whitePoint )public bool liquidRescaleImage(
int $width ,int $height ,float $delta_x ,float $rigidity ) public static array listRegistry()
public bool magnifyImage()
public bool mapImage(Imagick
$map , bool $dither )public bool matteFloodfillImage(
float $alpha ,float $fuzz ,mixed $bordercolor ,int $x ,int $y ) public bool medianFilterImage(float
$radius )public Imagick mergeImageLayers(int
$layer_method )public bool minifyImage()
public bool modulateImage(float
$brightness , float $saturation , float $hue )public Imagick montageImage(
ImagickDraw $draw ,string $tile_geometry ,string $thumbnail_geometry ,int $mode ,string $frame ) public Imagick morphImages(int
$number_frames )public bool morphology(
int $morphologyMethod ,int $iterations ,ImagickKernel $ImagickKernel ,int $channel = Imagick::CHANNEL_DEFAULT) public Imagick mosaicImages()
public bool motionBlurImage(
float $radius ,float $sigma ,float $angle ,int $channel = Imagick::CHANNEL_DEFAULT) public bool negateImage(bool
$gray , int $channel = Imagick::CHANNEL_DEFAULT)public bool newImage(
int $cols ,int $rows ,mixed $background ,string $format = ?) public bool newPseudoImage(int
$columns , int $rows , string $pseudoString )public bool nextImage()
public bool normalizeImage(int
$channel = Imagick::CHANNEL_DEFAULT)public bool oilPaintImage(float
$radius )public bool opaquePaintImage(
mixed $target ,mixed $fill ,float $fuzz ,bool $invert ,int $channel = Imagick::CHANNEL_DEFAULT) public bool optimizeImageLayers()
public bool orderedPosterizeImage(string
$threshold_map , int $channel = Imagick::CHANNEL_DEFAULT)public bool paintFloodfillImage(
mixed $fill ,float $fuzz ,mixed $bordercolor ,int $x ,int $y ,int $channel = Imagick::CHANNEL_DEFAULT) public bool paintOpaqueImage(
mixed $target ,mixed $fill ,float $fuzz ,int $channel = Imagick::CHANNEL_DEFAULT) public bool paintTransparentImage(mixed
$target , float $alpha , float $fuzz )public bool pingImage(string
$filename )public bool pingImageBlob(string
$image )public bool pingImageFile(resource
$filehandle , string $fileName = ?)public bool polaroidImage(ImagickDraw
$properties , float $angle )public bool posterizeImage(int
$levels , bool $dither )public bool previewImages(int
$preview )public bool previousImage()
public bool profileImage(string
$name , ?string $profile )public bool quantizeImage(
int $numberColors ,int $colorspace ,int $treedepth ,bool $dither ,bool $measureError ) public bool quantizeImages(
int $numberColors ,int $colorspace ,int $treedepth ,bool $dither ,bool $measureError ) public array queryFontMetrics(ImagickDraw
$properties , string $text , bool $multiline = ?)public static array queryFonts(string
$pattern = "*")public static array queryFormats(string
$pattern = "*")public bool radialBlurImage(float
$angle , int $channel = Imagick::CHANNEL_DEFAULT)public bool raiseImage(
int $width ,int $height ,int $x ,int $y ,bool $raise ) public bool randomThresholdImage(float
$low , float $high , int $channel = Imagick::CHANNEL_DEFAULT)public bool readImage(string
$filename )public bool readImageBlob(string
$image , string $filename = ?)public bool readImageFile(resource
$filehandle , string $fileName = null )public bool readImages(array
$filenames )public bool recolorImage(array
$matrix )public bool reduceNoiseImage(float
$radius )public bool remapImage(Imagick
$replacement , int $DITHER )public bool removeImage()
public string removeImageProfile(string
$name )public bool render()
public bool resampleImage(
float $x_resolution ,float $y_resolution ,int $filter ,float $blur ) public bool resetImagePage(string
$page )public bool resizeImage(
int $columns ,int $rows ,int $filter ,float $blur ,bool $bestfit = false ,bool $legacy = false ) public bool rollImage(int
$x , int $y )public bool rotateImage(mixed
$background , float $degrees )public bool rotationalBlurImage(float
$angle , int $channel = Imagick::CHANNEL_DEFAULT)public bool roundCorners(
float $x_rounding ,float $y_rounding ,float $stroke_width = 10,float $displace = 5,float $size_correction = -6) public bool sampleImage(int
$columns , int $rows )public bool scaleImage(
int $columns ,int $rows ,bool $bestfit = false ,bool $legacy = false ) public bool segmentImage(
int $COLORSPACE ,float $cluster_threshold ,float $smooth_threshold ,bool $verbose = false ) public bool selectiveBlurImage(
float $radius ,float $sigma ,float $threshold ,int $channel = Imagick::CHANNEL_DEFAULT) public bool separateImageChannel(int
$channel )public bool sepiaToneImage(float
$threshold )public bool setBackgroundColor(mixed
$background )public bool setColorspace(int
$COLORSPACE )public bool setCompression(int
$compression )public bool setCompressionQuality(int
$quality )public bool setFilename(string
$filename )public bool setFirstIterator()
public bool setFont(string
$font )public bool setFormat(string
$format )public bool setGravity(int
$gravity )public bool setImage(Imagick
$replace )public bool setImageAlphaChannel(int
$mode )public bool setImageArtifact(string
$artifact , string $value )public bool setImageAttribute(string
$key , string $value )public bool setImageBackgroundColor(mixed
$background )public bool setImageBias(float
$bias )public void setImageBiasQuantum(float
$bias )public bool setImageBluePrimary(float
$x , float $y )public bool setImageBorderColor(mixed
$border )public bool setImageChannelDepth(int
$channel , int $depth )public bool setImageClipMask(Imagick
$clip_mask )public bool setImageColormapColor(int
$index , ImagickPixel $color )public bool setImageColorspace(int
$colorspace )public bool setImageCompose(int
$compose )public bool setImageCompression(int
$compression )public bool setImageCompressionQuality(int
$quality )public bool setImageDelay(int
$delay )public bool setImageDepth(int
$depth )public bool setImageDispose(int
$dispose )public bool setImageExtent(int
$columns , int $rows )public bool setImageFilename(string
$filename )public bool setImageFormat(string
$format )public bool setImageGamma(float
$gamma )public bool setImageGravity(int
$gravity )public bool setImageGreenPrimary(float
$x , float $y )public bool setImageIndex(int
$index )public bool setImageInterlaceScheme(int
$interlace_scheme )public bool setImageInterpolateMethod(int
$method )public bool setImageIterations(int
$iterations )public bool setImageMatte(bool
$matte )public bool setImageMatteColor(mixed
$matte )public bool setImageOpacity(float
$opacity )public bool setImageOrientation(int
$orientation )public bool setImagePage(
int $width ,int $height ,int $x ,int $y ) public bool setImageProfile(string
$name , string $profile )public bool setImageProperty(string
$name , string $value )public bool setImageRedPrimary(float
$x , float $y )public bool setImageRenderingIntent(int
$rendering_intent )public bool setImageResolution(float
$x_resolution , float $y_resolution )public bool setImageScene(int
$scene )public bool setImageTicksPerSecond(int
$ticks_per_second )public bool setImageType(int
$image_type )public bool setImageUnits(int
$units )public bool setImageVirtualPixelMethod(int
$method )public bool setImageWhitePoint(float
$x , float $y )public bool setInterlaceScheme(int
$interlace_scheme )public bool setIteratorIndex(int
$index )public bool setLastIterator()
public bool setOption(string
$key , string $value )public bool setPage(
int $width ,int $height ,int $x ,int $y ) public bool setPointSize(float
$point_size )public bool setProgressMonitor(callable
$callback )public static bool setRegistry(string
$key , string $value )public bool setResolution(float
$x_resolution , float $y_resolution )public static bool setResourceLimit(int
$type , int $limit )public bool setSamplingFactors(array
$factors )public bool setSize(int
$columns , int $rows )public bool setSizeOffset(int
$columns , int $rows , int $offset )public bool setType(int
$image_type )public bool shadeImage(bool
$gray , float $azimuth , float $elevation )public bool shadowImage(
float $opacity ,float $sigma ,int $x ,int $y ) public bool sharpenImage(float
$radius , float $sigma , int $channel = Imagick::CHANNEL_DEFAULT)public bool shaveImage(int
$columns , int $rows )public bool shearImage(mixed
$background , float $x_shear , float $y_shear )public bool sigmoidalContrastImage(
bool $sharpen ,float $alpha ,float $beta ,int $channel = Imagick::CHANNEL_DEFAULT) public bool sketchImage(float
$radius , float $sigma , float $angle )public Imagick smushImages(bool
$stack , int $offset )public bool solarizeImage(int
$threshold )public bool sparseColorImage(int
$SPARSE_METHOD , array $arguments , int $channel = Imagick::CHANNEL_DEFAULT)public bool spliceImage(
int $width ,int $height ,int $x ,int $y ) public bool spreadImage(float
$radius )public bool statisticImage(
int $type ,int $width ,int $height ,int $channel = Imagick::CHANNEL_DEFAULT) public Imagick steganoImage(Imagick
$watermark_wand , int $offset )public bool stereoImage(Imagick
$offset_wand )public bool stripImage()
public Imagick subImageMatch(Imagick
$Imagick , array &$offset = ?, float &$similarity = ?)bool swirlImage(float
$degrees )Imagick textureImage(Imagick
$texture_wand )public bool thresholdImage(float
$threshold , int $channel = Imagick::CHANNEL_DEFAULT)public bool thumbnailImage(
int $columns ,int $rows ,bool $bestfit = false ,bool $fill = false ,bool $legacy = false ) public bool tintImage(mixed
$tint , mixed $opacity , bool $legacy = false )public string __toString()
public Imagick transformImage(string
$crop , string $geometry )public bool transformImageColorspace(int
$colorspace )public bool transparentPaintImage(
mixed $target ,float $alpha ,float $fuzz ,bool $invert ) public bool transposeImage()
public bool transverseImage()
public bool trimImage(float
$fuzz )public bool uniqueImageColors()
public bool unsharpMaskImage(
float $radius ,float $sigma ,float $amount ,float $threshold ,int $channel = Imagick::CHANNEL_DEFAULT) public bool valid()
public bool vignetteImage(
float $blackPoint ,float $whitePoint ,int $x ,int $y ) public bool waveImage(float
$amplitude , float $length )public bool whiteThresholdImage(mixed
$threshold )public bool writeImage(string
$filename = NULL)public bool writeImageFile(resource
$filehandle , string $format = ?)public bool writeImages(string
$filename , bool $adjoin )public bool writeImagesFile(resource
}$filehandle , string $format = ?)Image methods and global methodsThe Imagick class has the ability to hold and operate on multiple images simultaneously. This is achieved through an internal stack. There is always an internal pointer that points at the current image. Some functions operate on all images in the Imagick class, but most operate only on the current image in the internal stack. As a convention, method names can contain the word Image to denote they affect only the current image in the stack. Class MethodsBecause there are so many methods, here is a handy list of methods, somewhat reduced to their general purpose:
|