<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
<TITLE>GraphicsMagick Perl API</TITLE>
<META NAME="GENERATOR" CONTENT="StarOffice 7 (Solaris Sparc)">
<META NAME="CREATED" CONTENT="20030217;19430800">
<META NAME="CHANGEDBY" CONTENT="Robert Friesenhahn">
<META NAME="CHANGED" CONTENT="20040418;19152500">
<META NAME="DESCRIPTION" CONTENT="GraphicsMagick is a robust collection of tools and libraries to read, write, and manipulate an image in any of the more popular image formats including GIF, JPEG, PNG, PDF, and Photo CD. With GraphicsMagick you can create GIFs dynamically making it suitable for Web applications. You can also resize, rotate, sharpen, color reduce, or add special effects to an image and save your completed work in the same or differing image format.">
<META NAME="KEYWORDS" CONTENT="GraphicsMagick, Image Magick, Image Magic, PerlMagick, Perl Magick, Perl Magic, CineMagick, PixelMagick, Pixel Magic, WebMagick, Web Magic, visualization, image processing, software development, simulation, image, software, AniMagick, Animagic, Magick++">
<STYLE>
<!--
TD P { color: #000000; font-family: "Verdana", "Arial", "Helvetica", sans-serif; font-size: 12pt }
P { color: #000000; font-family: "Verdana", "Arial", "Helvetica", sans-serif; font-size: 12pt }
DD { color: #000000; font-family: "Verdana", "Arial", "Helvetica", sans-serif; font-size: 12pt }
BLOCKQUOTE { color: #000000; font-family: "Verdana", "Arial", "Helvetica", sans-serif; font-size: 12pt }
PRE { color: #000000 }
TH P { color: #000000; font-family: "Verdana", "Arial", "Helvetica", sans-serif; font-size: 12pt }
A:link { color: #0085c0 }
A:visited { color: #800080 }
-->
</STYLE>
</HEAD>
<BODY LANG="en-US" TEXT="#000000" LINK="#0085c0" VLINK="#800080" BGCOLOR="#ffffff" DIR="LTR"><A NAME="contents"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic2" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">GraphicsMagick
Perl API -- PerlMagick</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<UL>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#intr">Introduction</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#inst">Installation</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#over">Overview</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#exam">Example Script</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#read">Read or Write an
Image</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#mani">Manipulate an
Image</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#seta">Set an Image
Attribute</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#geta">Get an Image
Attribute</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#mont">Create an Image
Montage</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#blobs">Working with
Blobs</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#misc">Miscellaneous
Methods</A>
</P>
<LI><P STYLE="margin-bottom: 0in"><A HREF="#erro">Handling Errors</A>
</P>
<LI><P><A HREF="#copy">Copyright</A>
</P>
</UL><A NAME="intr"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic3" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Introduction</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in"><A HREF="download.html">PerlMagick</A>
is an objected-oriented <A HREF="http://www.perl.com/perl/">Perl</A>
interface to <A HREF="../index.html">GraphicsMagick</A>. Use the
module to read, manipulate, or write an image or image sequence from
within a Perl script. This makes it very suitable for Web CGI
scripts. You must have <B>GraphicsMagick</B> 1.0.0 or above and Perl
version 5.005_02 or greater installed on your system for either of
these utilities to work.
</DD><DD STYLE="margin-bottom: 0.2in">
There are a number of useful scripts available to show you the value
of <B>PerlMagick</B>. The <B>PerlMagick</B> demo directory provides
a number of sample demos. You can try <B>PerlMagick</B> from your
Web browser at the <A HREF="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">ImageMagick
Studio</A>. Or, you can see <A HREF="../images/examples.jpg">examples</A>
of select <B>PerlMagick</B> functions.</DD></DL>
<P>
<A HREF="#contents"><I>Back to Contents</I></A> <BR>
</P><A NAME="inst"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic4" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Installation</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in"><B>UNIX</B>
</DD></DL>
<BLOCKQUOTE>
PerlMagick is installed by default by installing <B>GraphicsMagick</B>.
Installing PerlMagick as a subordinate package of GraphicsMagick is
the best way to avoid problems.</BLOCKQUOTE>
<BLOCKQUOTE>For Unix, you typically need to be <TT>root</TT> to
install the software. There are ways around this. Consult the Perl
manual pages for more information.
</BLOCKQUOTE>
<BLOCKQUOTE><B>Windows XP / Windows 2000</B>
</BLOCKQUOTE>
<BLOCKQUOTE>Please note that a nice GUI installer is available for
GraphicsMagick. PerlMagick is included in this installer. If you are
using the installer, then there is no need to compile PerlMagick.</BLOCKQUOTE>
<BLOCKQUOTE>After GraphicsMagick has been compiled from the
GraphicsMagick Windows source distribution using Microsoft Visual
C++, PerlMagick may be manually built and installed by opening a CLI
window and performing the following steps:</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> cd PerlMagick
copy Makefile.nt Makefile.PL
perl Makefile.PL
nmake
nmake install</PRE><BLOCKQUOTE>
See the <A HREF="http://www.dylanbeattie.net/magick/">PerlMagick
Windows HowTo</A> page for further installation instructions.
</BLOCKQUOTE>
<BLOCKQUOTE><B>Running the Regression Tests</B>
</BLOCKQUOTE>
<BLOCKQUOTE> To verify a correct installation, type
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> make test</PRE><BLOCKQUOTE>
Use <TT>nmake test</TT> under Windows. There are a few demonstration
scripts available to exercise many of the functions <B>PerlMagick</B>
can perform. Type
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> cd demo
make</PRE><BLOCKQUOTE>
You are now ready to utilize the <B>PerlMagick</B> methods from
within your Perl scripts.</BLOCKQUOTE>
<P><A HREF="#contents"><I>Back to Contents</I></A> <BR>
</P><A NAME="over"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic5" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Overview</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">Any script that wants to use
<B>PerlMagick</B> methods must first define the methods within its
namespace and instantiate an image object. Do this with:
</DD></DL>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> use Graphics::Magick;
$image=Graphics::Magick->new;</PRE><BLOCKQUOTE>
Note that this differs from the ImageMagick version of PerlMagick
which uses the namespace Image::Magick. Any PerlMagick code written
for the ImageMagick version of PerlMagick requires a global
substition of <KBD>Image::Magick</KBD> to <KBD>Graphics::Magick</KBD>
in order to work with the GraphicsMagick version.</BLOCKQUOTE>
<BLOCKQUOTE>The new() method takes the same parameters as
<A HREF="#seta">SetAttribute</A> . For example,
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $image=Graphics::Magick->new(size=>'384x256');</PRE><BLOCKQUOTE>
Next you will want to read an image or image sequence, manipulate it,
and then display or write it. The input and output methods for
<B>PerlMagick</B> are defined in <A HREF="#read">Read or Write an
Image</A>. See <A HREF="#seta">Set an Image Attribute</A> for methods
that affect the way an image is read or written. Refer to <A HREF="#mani">Manipulate
an Image</A> for a list of methods to transform an image. <A HREF="#geta">Get
an Image Attribute</A> describes how to retrieve an attribute for an
image. Refer to <A HREF="#mont">Create an Image Montage</A> for
details about tiling your images as thumbnails on a background.
Finally, some methods do not neatly fit into any of the categories
just mentioned. Review <A HREF="#misc">Miscellaneous Methods</A> for
a list of these methods.
</BLOCKQUOTE>
<BLOCKQUOTE>Once you are finished with a <B>PerlMagick</B> object you
should consider destroying it. Each image in an image sequence is
stored in either virtual memory or as a file in the system's
temporary file directory. This can potentially add up to megabytes of
memory or disk. Upon destroying a <B>PerlMagick</B> object, the
memory is returned for use by other Perl methods. The recommended way
to destroy an object is with <TT>undef</TT>:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> undef $image;</PRE><BLOCKQUOTE>
To delete all the images but retain the <TT>Graphics::Magick</TT>
object use
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> @$image = ();</PRE><BLOCKQUOTE>
and finally, to delete a single image from a multi-image sequence,
use
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> undef $image->[x];</PRE><BLOCKQUOTE>
The next section illustrates how to use various <B>PerlMagick</B>
methods to manipulate an image sequence.</BLOCKQUOTE>
<BLOCKQUOTE>Some of the <B>PerlMagick</B> methods require external
programs such as <I>Ghostscript</I>. This may require an explicit
path in your PATH environment variable to work properly. For example,
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $ENV{PATH}='/bin:/usr/bin:/usr/local/bin';</PRE><BLOCKQUOTE>
<BR><BR>
</BLOCKQUOTE>
<P><A HREF="#contents"><I>Back to Contents</I></A> <BR>
</P><A NAME="exam"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic6" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Example
Script</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">Here is an example script to get
you started:
</DD></DL>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> #!/usr/local/bin/perl
use Graphics::Magick;
my($image, $x);
$image = Graphics::Magick->new;
$x = $image->Read('girl.png', 'logo.png', 'rose.png');
warn "$x" if "$x";
$x = $image->Crop(geometry=>'100x100"+1"00"+1"00');
warn "$x" if "$x";
$x = $image->Write('x.png');
warn "$x" if "$x";</PRE><BLOCKQUOTE>
The script reads three images, crops them, and writes a single image
as a GIF animation sequence. In many cases you may want to access
individual images of a sequence. The next example illustrates how
this is done:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> #!/usr/local/bin/perl
use Graphics::Magick;
my($image, $p, $q);
$image = new Graphics::Magick;
$image->Read('x1.png');
$image->Read('j*.jpg');
$image->Read('k.miff[1, 5, 3]');
$image->Contrast();
for ($x = 0; $image->[x]; $x++)
{
$image->[x]->Frame('100x200') if $image->[x]->Get('magick') eq 'GIF';
undef $image->[x] if $image->[x]->Get('columns') < 100;
}
$p = $image->[1];
$p->Draw(stroke=>'red', primitive=>'rectangle', points=>20,20 100,100');
$q = $p->Montage();
undef $image;
$q->Write('x.miff');</PRE><BLOCKQUOTE>
Suppose you want to start out with a 100 by 100 pixel white canvas
with a red pixel in the center. Try
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $image = Graphics::Magick->new;
$image->Set(size=>'100x100');
$image->ReadImage('xc:white');
$image->Set('pixel[49,49]'=>'red');</PRE><BLOCKQUOTE>
Or suppose you want to convert your color image to grayscale:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $image->Quantize(colorspace=>'gray');</PRE><BLOCKQUOTE>
Here we annotate an image with a Taipai TrueType font:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $text = 'Works like magick!';
$image->Annotate(font=>'kai.ttf', pointsize=>40, fill=>'green', text=>$text);</PRE><BLOCKQUOTE>
Other clever things you can do with a <B>PerlMagick</B> objects
include
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $i = $#$p"+1"; # return the number of images associated with object p
push(@$q, @$p); # push the images from object p onto object q
@$p = (); # delete the images but not the object p
$p->Convolve([1, 2, 1, 2, 4, 2, 1, 2, 1]); # 3x3 Gaussian kernel</PRE><P>
<A HREF="#contents"><I>Back to Contents</I></A> <BR>
</P><A NAME="read"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic7" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Read or
Write an Image</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">Use the methods listed below to
either read, write, or display an image or image sequence.
</DD></DL>
<P ALIGN=CENTER STYLE="margin-bottom: 0in">
Read or Write Methods</P>
<DL>
<DD>
<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2>
<TR>
<TH>
<P>Method</P>
</TH>
<TH>
<P>Parameters</P>
</TH>
<TH>
<P>Return Value</P>
</TH>
<TH>
<P>Description</P>
</TH>
</TR>
<TR>
<TD>
<P>Read</P>
</TD>
<TD>
<P>one or more filenames</P>
</TD>
<TD>
<P>the number of images read </P>
</TD>
<TD>
<P>read an image or image sequence</P>
</TD>
</TR>
<TR>
<TD>
<P>Write</P>
</TD>
<TD>
<P>filename</P>
</TD>
<TD>
<P>the number of images written </P>
</TD>
<TD>
<P>write an image or image sequence</P>
</TD>
</TR>
<TR>
<TD>
<P>Display</P>
</TD>
<TD>
<P>server name</P>
</TD>
<TD>
<P>the number of images displayed </P>
</TD>
<TD>
<P>display the image or image sequence to an X server</P>
</TD>
</TR>
<TR>
<TD>
<P>Animate</P>
</TD>
<TD>
<P>server name</P>
</TD>
<TD>
<P>the number of images animated </P>
</TD>
<TD>
<P>animate image sequence to an X server</P>
</TD>
</TR>
</TABLE>
</DL>
<BLOCKQUOTE>For convenience, methods Write(), Display(), and
Animate() can take any parameter that <A HREF="#seta">SetAttribute</A>
knows about. For example,
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $image->Write(filename=>'image.png', compression=>'None');</PRE><BLOCKQUOTE>
Use <TT>-</TT> as the filename to method Read() to read from standard
in or to method Write() to write to standard out:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> binmode STDOUT;
$image->Write('png:-');</PRE><BLOCKQUOTE>
To read an image in the GIF format from a PERL filehandle, use:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $image = Graphics::Magick->new;
open(IMAGE, 'image.gif');
$image->Read(file=>\*IMAGE);
close(IMAGE);</PRE><BLOCKQUOTE>
To write an image in the PNG format to a PERL filehandle, use:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $filename = "image.png";
open(IMAGE, ">$filename");
$image->Write(file=>\*IMAGE, filename=>$filename);
close(IMAGE);</PRE><BLOCKQUOTE>
If <TT>%0Nd, %0No, or %0Nx</TT> appears in the filename, it is
interpreted as a printf format specification and the specification is
replaced with the specified decimal, octal, or hexadecimal encoding
of the scene number. For example,</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> image%03d.miff</PRE><BLOCKQUOTE>
converts files image000.miff, image001.miff, etc.
</BLOCKQUOTE>
<BLOCKQUOTE>You can optionally add <I>Image</I> to any method name.
For example, ReadImage() is an alias for method Read().</BLOCKQUOTE>
<P><A HREF="#contents"><I>Back to Contents</I></A> <BR>
</P><A NAME="mani"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic8" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Manipulate
an Image</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">Once you create an image with, for
example, method ReadImage() you may want to operate on it. Below is
a list of all the image manipulations methods available to you with
<B>PerlMagick</B>. There are <A HREF="../images/examples.jpg">examples</A>
of select <B>PerlMagick</B> methods. Here is an example call to an
image manipulation method:
</DD></DL>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $image->Crop(geometry=>'100x100"+1"0+20');
$image->[x]->Frame("100x200");</PRE><BLOCKQUOTE>
Image method parameters are often redundant. For example, a
'<I>geometry</I>' string parameter (e.g. 800x600+10+20) is equivalent
to the explicit use of <I>width</I>, <I>height</I>, <I>x</I>, and <I>y</I>,
parameters.</BLOCKQUOTE>
<BLOCKQUOTE>The following image manipulation methods are available:</BLOCKQUOTE>
<P ALIGN=CENTER STYLE="margin-bottom: 0in">Image Manipulation Methods</P>
<DL>
<DD>
<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2>
<TR>
<TH>
<P>Method</P>
</TH>
<TH>
<P>Parameters</P>
</TH>
<TH>
<P>Description</P>
</TH>
</TR>
<TR>
<TD>
<P>AdaptiveThreshold</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I>, offset=><I>integer</I></P>
</TD>
<TD>
<P>Local adaptive thresholding. Width and height specify the size
of the local region while offset specifies the amount to subtract
from the average of the region.</P>
</TD>
</TR>
<TR>
<TD>
<P>AddNoise</P>
</TD>
<TD>
<P>noise=>{Uniform, Gaussian, Multiplicative, Impulse,
Laplacian, Poisson}</P>
</TD>
<TD>
<P>Add noise to an image across the red, green, and blue,
channels. Set the image colorspace to GRAY to obtain intensity
noise.</P>
</TD>
</TR>
<TR>
<TD>
<P>AffineTransform</P>
</TD>
<TD>
<P>affine=><I>array of float values</I>, translate=><I>float,
float</I>, scale=> <I>float, float</I>, rotate=><I>float</I>,
skewX=><I>float</I>, skewY=><I>float</I></P>
</TD>
<TD>
<P>Affine transform image</P>
</TD>
</TR>
<TR>
<TD>
<P>Annotate</P>
</TD>
<TD>
<P>text=><I>string</I>, font=><I>string</I>,
family=><I>string</I>, style=>{Normal, Italic, Oblique,
Any}, stretch=>{Normal, UltraCondensed, ExtraCondensed,
Condensed, SemiCondensed, SemiExpanded, Expanded, ExtraExpanded,
UltraExpanded}, weight=><I>integer</I>, pointsize=><I>integer</I>,
density=><I>geometry</I>, stroke=> <A HREF="color.html"><I>color
name</I></A>, strokewidth=><I>integer</I>, fill=><A HREF="color.html"><I>color
name</I></A>, undercolor=><A HREF="color.html"><I>color name</I></A>,
geometry=><I>geometry</I>, gravity=>{NorthWest, North,
NorthEast, West, Center, East, SouthWest, South, SouthEast},
antialias=>{true, false}, x=><I>integer</I>, y=><I>integer</I>,
affine=><I>array of float values</I>, translate=><I>float,
float</I>, scale=><I>float, float</I>, rotate=><I>float</I>.
skewX=><I>float</I>, skewY=> <I>float</I>, align=>{Left,
Center, Right}, encoding=>{UTF-8}
</P>
</TD>
<TD>
<P>annotate an image with text. See <A HREF="#misc">QueryFontMetrics</A>
to get font metrics without rendering any text.</P>
</TD>
</TR>
<TR>
<TD>
<P>Blur</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, radius=><I>double</I>,
sigma=> <I>double</I></P>
</TD>
<TD>
<P>blur the image with a Gaussian operator of the given radius
and standard deviation (sigma).</P>
</TD>
</TR>
<TR>
<TD>
<P>Border</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I>, fill=><A HREF="color.html"><I>color
name</I></A></P>
</TD>
<TD>
<P>surround the image with a border of color</P>
</TD>
</TR>
<TR>
<TD>
<P>Channel</P>
</TD>
<TD>
<P>channel=>{Red, Cyan, Green, Magenta, Blue, Yellow, Opacity,
Black}</P>
</TD>
<TD>
<P>extract a channel from the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Charcoal</P>
</TD>
<TD>
<P>order=><I>integer</I></P>
</TD>
<TD>
<P>simulate a charcoal drawing</P>
</TD>
</TR>
<TR>
<TD>
<P>Chop</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I>, x=><I>integer</I>, y=><I>integer</I></P>
</TD>
<TD>
<P>chop an image</P>
</TD>
</TR>
<TR>
<TD>
<P>Coalesce</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>merge a sequence of images</P>
</TD>
</TR>
<TR>
<TD>
<P>Clip</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>apply any clipping path information as an image clip mask.</P>
</TD>
</TR>
<TR>
<TD>
<P>ColorFloodfill</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, x=><I>integer</I>, y=><I>integer</I>
, fill=><A HREF="color.html"><I>color name</I></A>,
bordercolor=><A HREF="color.html"> <I>color name</I></A></P>
</TD>
<TD>
<P>changes the color value of any pixel that matches the color of
the target pixel and is a neighbor. If you specify a border
color, the color value is changed for any neighbor pixel that is
not that color.</P>
</TD>
</TR>
<TR>
<TD>
<P>Colorize</P>
</TD>
<TD>
<P>fill=><A HREF="color.html"><I>color name</I></A>,
opacity=><I>string</I></P>
</TD>
<TD>
<P>colorize the image with the fill color</P>
</TD>
</TR>
<TR>
<TD>
<P>Comment</P>
</TD>
<TD>
<P>string</P>
</TD>
<TD>
<P>add a comment to your image</P>
</TD>
</TR>
<TR>
<TD>
<P>Compare</P>
</TD>
<TD>
<P>image=><I>image-handle</I></P>
</TD>
<TD>
<P>compare image to a reference image</P>
</TD>
</TR>
<TR>
<TD>
<P>Composite</P>
</TD>
<TD>
<P>image=><I>image-handle</I>, compose=>{Over, In, Out,
Atop, Xor, Plus, Minus, Add, Subtract, Difference, Multiply,
Bumpmap, Copy, CopyRed, CopyGreen, CopyBlue, CopyMatte, Dissolve,
Clear, Displace, Modulate, Threshold}, mask=><I>image-handle</I>,
geometry=><I>geometry</I>, x=><I>integer</I>, y=><I>integer</I>,
gravity=>{NorthWest, North, NorthEast, West, Center, East,
SouthWest, South, SouthEast}, opacity=><I>integer</I>,
tile=>{True, False}, rotate=><I>double</I>, color=><I><A HREF="color.html">color
name</A> </I>
</P>
</TD>
<TD>
<P>composite one image onto another</P>
</TD>
</TR>
<TR>
<TD>
<P>Contrast</P>
</TD>
<TD>
<P>sharpen=>{True, False}</P>
</TD>
<TD>
<P>enhance or reduce the image contrast</P>
</TD>
</TR>
<TR>
<TD>
<P>Convolve</P>
</TD>
<TD>
<P>coefficients=><I>array of float values</I></P>
</TD>
<TD>
<P>apply a convolution kernel to the image. Given a kernel <I>order</I>
, you would supply <I>order*order</I> float values (e.g. 3x3
implies 9 values).</P>
</TD>
</TR>
<TR>
<TD>
<P>Crop</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I>, x=><I>integer</I>, y=><I>integer</I></P>
</TD>
<TD>
<P>crop an image</P>
</TD>
</TR>
<TR>
<TD>
<P>CycleColormap</P>
</TD>
<TD>
<P>amount=><I>integer</I></P>
</TD>
<TD>
<P>displace image colormap by amount</P>
</TD>
</TR>
<TR>
<TD>
<P>Deconstruct</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>break down an image sequence into constituent parts</P>
</TD>
</TR>
<TR>
<TD>
<P>Despeckle</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>reduce the speckles within an image</P>
</TD>
</TR>
<TR>
<TD>
<P>Draw</P>
</TD>
<TD>
<P>primitive=>{point, line, rectangle, arc, ellipse, circle,
path, polyline, polygon, bezier, color, matte, text, @<I>filename</I>},
points=><I>string</I> , method=><I>{Point, Replace,
Floodfill, FillToBorder, Reset}</I>, stroke=><A HREF="color.html">
<I>color name</I></A>, fill=><A HREF="color.html"><I>color
name</I></A>, tile=><I>image-handle</I>, strokewidth=><I>float</I>,
antialias=>{true, false}, bordercolor=><A HREF="color.html"><I>color
name</I></A>, x=> <I>float</I>, y=><I>float</I>,
affine=><I>array of float values</I>, translate=><I>float,
float</I>, scale=> <I>float, float</I>, rotate=><I>float</I>.
skewX=><I>float</I>, skewY=> <I>float</I></P>
</TD>
<TD>
<P>annotate an image with one or more graphic primitives</P>
</TD>
</TR>
<TR>
<TD>
<P>Edge</P>
</TD>
<TD>
<P>radius=><I>double</I></P>
</TD>
<TD>
<P>enhance edges within the image with a convolution filter of
the given radius.</P>
</TD>
</TR>
<TR>
<TD>
<P>Emboss</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, radius=><I>double</I>,
sigma=> <I>double</I></P>
</TD>
<TD>
<P>emboss the image with a convolution filter of the given radius
and standard deviation (sigma).</P>
</TD>
</TR>
<TR>
<TD>
<P>Enhance</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>apply a digital filter to enhance a noisy image</P>
</TD>
</TR>
<TR>
<TD>
<P>Equalize</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>perform histogram equalization to the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Flatten</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>flatten a sequence of images</P>
</TD>
</TR>
<TR>
<TD>
<P>Flip</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>create a <I>mirror image</I> by reflecting the image scanlines
in the vertical direction</P>
</TD>
</TR>
<TR>
<TD>
<P>Flop</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>create a <I>mirror image</I> by reflecting the image scanlines
in the horizontal direction</P>
</TD>
</TR>
<TR>
<TD>
<P>Frame</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I>, inner=><I>integer</I>,
outer=><I>integer</I>, fill=><A HREF="color.html"> <I>color
name</I></A></P>
</TD>
<TD>
<P>surround the image with an ornamental border</P>
</TD>
</TR>
<TR>
<TD>
<P>Gamma</P>
</TD>
<TD>
<P>gamma=><I>string</I>, red=><I>double</I>, green=><I>double</I>
, blue=><I>double</I></P>
</TD>
<TD>
<P>gamma correct the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Implode</P>
</TD>
<TD>
<P>amount=><I>double</I></P>
</TD>
<TD>
<P>implode image pixels about the center</P>
</TD>
</TR>
<TR>
<TD>
<P>Label</P>
</TD>
<TD>
<P>string</P>
</TD>
<TD>
<P>assign a label to an image</P>
</TD>
</TR>
<TR>
<TD>
<P>Level</P>
</TD>
<TD>
<P>level=><I>string</I>, 'black-point'=><I>double</I>,
'mid-point'=><I>double</I>, 'white-point'=><I>double</I></P>
</TD>
<TD>
<P>adjust the level of image contrast</P>
</TD>
</TR>
<TR>
<TD>
<P>Magnify</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>double the size of an image</P>
</TD>
</TR>
<TR>
<TD>
<P>Map</P>
</TD>
<TD>
<P>image=><I>image-handle</I>, dither=>{True, False}</P>
</TD>
<TD>
<P>choose a particular set of colors from this image</P>
</TD>
</TR>
<TR>
<TD>
<P>MatteFloodfill</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, x=><I>integer</I>, y=><I>integer</I>
, matte=><I>integer</I>, bordercolor=><A HREF="color.html"><I>color
name</I></A></P>
</TD>
<TD>
<P>changes the matte value of any pixel that matches the color of
the target pixel and is a neighbor. If you specify a border
color, the matte value is changed for any neighbor pixel that is
not that color.</P>
</TD>
</TR>
<TR>
<TD>
<P>MedianFilter</P>
</TD>
<TD>
<P>radius=><I>double</I></P>
</TD>
<TD>
<P>replace each pixel with the median intensity pixel of a
neighborhood. </P>
</TD>
</TR>
<TR>
<TD>
<P>Minify</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>half the size of an image</P>
</TD>
</TR>
<TR>
<TD>
<P>Modulate</P>
</TD>
<TD>
<P>brightness=><I>double</I>, saturation=><I>double</I>,
hue=> <I>double</I></P>
</TD>
<TD>
<P>vary the brightness, saturation, and hue of an image by the
specified percentage</P>
</TD>
</TR>
<TR>
<TD>
<P>MotionBlur</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, radius=><I>double</I>,
sigma=> <I>double</I>, angle=><I>double</I></P>
</TD>
<TD>
<P>blur the image with a Gaussian operator of the given radius
and standard deviation (sigma) at the given angle to simulate the
effect of motion</P>
</TD>
</TR>
<TR>
<TD>
<P>Negate</P>
</TD>
<TD>
<P>gray=>{True, False}</P>
</TD>
<TD>
<P>replace every pixel with its complementary color (white
becomes black, yellow becomes blue, etc.)</P>
</TD>
</TR>
<TR>
<TD>
<P>Normalize</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>transform image to span the full range of color values</P>
</TD>
</TR>
<TR>
<TD>
<P>OilPaint</P>
</TD>
<TD>
<P>radius=><I>integer</I></P>
</TD>
<TD>
<P>simulate an oil painting</P>
</TD>
</TR>
<TR>
<TD>
<P>Opaque</P>
</TD>
<TD>
<P>color=><A HREF="color.html"><I>color name</I></A>, fill=><A HREF="color.html">
<I>color name</I></A></P>
</TD>
<TD>
<P>change this color to the fill color within the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Quantize</P>
</TD>
<TD>
<P>colors=><I>integer</I>, colorspace=>{RGB, Gray,
Transparent, OHTA, XYZ, YCbCr, YIQ, YPbPr, YUV, CMYK},
treedepth=> <I>integer</I>, dither=>{True, False},
measure_error=>{True, False}, global_colormap=>{True,
False}</P>
</TD>
<TD>
<P>preferred number of colors in the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Profile</P>
</TD>
<TD>
<P>name=>{ICM, IPTC}, profile=><I>blob</I></P>
</TD>
<TD>
<P>add or remove ICC or IPTC image profile</P>
</TD>
</TR>
<TR>
<TD>
<P>Raise</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I>, x=><I>integer</I>, y=><I>integer</I>,
raise=>{True, False}</P>
</TD>
<TD>
<P>lighten or darken image edges to create a 3-D effect</P>
</TD>
</TR>
<TR>
<TD>
<P>ReduceNoise</P>
</TD>
<TD>
<P>radius=><I>double</I></P>
</TD>
<TD>
<P>reduce noise in the image with a noise peak elimination
filter </P>
</TD>
</TR>
<TR>
<TD>
<P>Resize</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I>, filter=>{Point, Box, Triangle,
Hermite, Hanning, Hamming, Blackman, Gaussian, Quadratic, Cubic,
Catrom, Mitchell, Lanczos, Bessel, Sinc}, blur=><I>double</I></P>
</TD>
<TD>
<P>scale image to desired size. Specify <TT>blur</TT> > 1 for
blurry or < 1 for sharp</P>
</TD>
</TR>
<TR>
<TD>
<P>Roll</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, x=><I>integer</I>, y=><I>integer</I></P>
</TD>
<TD>
<P>roll an image vertically or horizontally</P>
</TD>
</TR>
<TR>
<TD>
<P>Rotate</P>
</TD>
<TD>
<P>degrees=><I>double</I>, color=><A HREF="color.html"><I>color
name</I></A>
</P>
</TD>
<TD>
<P>rotate an image</P>
</TD>
</TR>
<TR>
<TD>
<P>Sample</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I></P>
</TD>
<TD>
<P>scale image with pixel sampling</P>
</TD>
</TR>
<TR>
<TD>
<P>Scale</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I></P>
</TD>
<TD>
<P>scale image to desired size</P>
</TD>
</TR>
<TR>
<TD>
<P>Segment</P>
</TD>
<TD>
<P>colorspace=>{RGB, Gray, Transparent, OHTA, XYZ, YCbCr, YCC,
YIQ, YPbPr, YUV, CMYK}, verbose={True, False}, cluster=><I>double</I>,
smooth= <I>double</I></P>
</TD>
<TD>
<P>segment an image by analyzing the histograms of the color
components and identifying units that are homogeneous</P>
</TD>
</TR>
<TR>
<TD>
<P>Shade</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, azimuth=><I>double</I>,
elevation=> <I>double</I>, gray=>{true, false} </P>
</TD>
<TD>
<P>shade the image using a distant light source</P>
</TD>
</TR>
<TR>
<TD>
<P>Sharpen</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, radius=><I>double</I>,
sigma=> <I>double</I></P>
</TD>
<TD>
<P>sharpen the image with a Gaussian operator of the given radius
and standard deviation (sigma).</P>
</TD>
</TR>
<TR>
<TD>
<P>Shave</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, width=><I>integer</I>,
height=> <I>integer</I>
</P>
</TD>
<TD>
<P>shave pixels from the image edges</P>
</TD>
</TR>
<TR>
<TD>
<P>Shear</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, x=><I>double</I>, y=><I>double</I>
color=><A HREF="color.html"><I>color name</I></A>
</P>
</TD>
<TD>
<P>shear the image along the X or Y axis by a positive or
negative shear angle</P>
</TD>
</TR>
<TR>
<TD>
<P>Signature</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>generate an SHA-256 message digest for the image pixel stream</P>
</TD>
</TR>
<TR>
<TD>
<P>Solarize</P>
</TD>
<TD>
<P>threshold=><I>integer</I></P>
</TD>
<TD>
<P>negate all pixels above the threshold level</P>
</TD>
</TR>
<TR>
<TD>
<P>Spread</P>
</TD>
<TD>
<P>amount=><I>integer</I></P>
</TD>
<TD>
<P>displace image pixels by a random amount</P>
</TD>
</TR>
<TR>
<TD>
<P>Stereo</P>
</TD>
<TD>
<P>image=><I>image-handle</I></P>
</TD>
<TD>
<P>composites two images and produces a single image that is the
composite of a left and right image of a stereo pair</P>
</TD>
</TR>
<TR>
<TD>
<P>Stegano</P>
</TD>
<TD>
<P>image=><I>image-handle</I>, offset=><I>integer</I></P>
</TD>
<TD>
<P>hide a digital watermark within the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Swirl</P>
</TD>
<TD>
<P>degrees=><I>double</I></P>
</TD>
<TD>
<P>swirl image pixels about the center</P>
</TD>
</TR>
<TR>
<TD>
<P>Texture</P>
</TD>
<TD>
<P>texture=><I>image-handle</I></P>
</TD>
<TD>
<P>name of texture to tile onto the image background</P>
</TD>
</TR>
<TR>
<TD>
<P>Threshold</P>
</TD>
<TD>
<P>threshold=><I>string</I></P>
</TD>
<TD>
<P>threshold the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Transparent</P>
</TD>
<TD>
<P>color=><A HREF="color.html"><I>color name</I></A></P>
</TD>
<TD>
<P>make this color transparent within the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Trim</P>
</TD>
<TD>
<P> </P>
</TD>
<TD>
<P>remove edges that are the background color from the image</P>
</TD>
</TR>
<TR>
<TD>
<P>UnsharpMask</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, radius=><I>double</I>,
sigma=> <I>double</I>, amount=><I>double</I>,
threshold=><I>double</I></P>
</TD>
<TD>
<P>sharpen the image with the unsharp mask algorithm.</P>
</TD>
</TR>
<TR>
<TD>
<P>Wave</P>
</TD>
<TD>
<P>geometry=><I>geometry</I>, amplitude=><I>double</I>,
wavelength=> <I>double</I></P>
</TD>
<TD>
<P>alter an image along a sine wave</P>
</TD>
</TR>
</TABLE>
</DL>
<BLOCKQUOTE>Note, that the <TT>geometry</TT> parameter is a short cut
for the <TT>width</TT> and <TT>height</TT> parameters (e.g.
<TT>geometry=>'106x80'</TT> is equivalent to <TT>width=>106,
height=>80</TT> ).
</BLOCKQUOTE>
<BLOCKQUOTE>You can specify <TT>@filename</TT> in both Annotate() and
Draw(). This reads the text or graphic primitive instructions from a
file on disk. For example,
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $image->Draw(fill=>'red', primitive=>'rectangle',
points=>'20,20 100,100 40,40 200,200 60,60 300,300');</PRE><BLOCKQUOTE>
Is equivalent to
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $image->Draw(fill=>'red', primitive=>'@draw.txt');</PRE><BLOCKQUOTE>
Where <TT>draw.txt</TT> is a file on disk that contains this:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> rectangle 20, 20 100, 100
rectangle 40, 40 200, 200
rectangle 60, 60 300, 300</PRE><BLOCKQUOTE>
The <I>text</I> parameter for methods, Annotate(), Comment(), Draw(),
and Label() can include the image filename, type, width, height, or
other image attribute by embedding these special format characters:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> %b file size
%d comment
%d directory
%e filename extension
%f filename
%h height
%m magick
%p page number
%s scene number
%t top of filename
%w width
%x x resolution
%y y resolution
\n newline
\r carriage return</PRE><BLOCKQUOTE>
For example,
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> text=>"%m:%f %wx%h"</PRE><BLOCKQUOTE>
produces an annotation of <B>MIFF:bird.miff 512x480</B> for an image
titled <B>bird.miff</B> and whose width is 512 and height is 480.
</BLOCKQUOTE>
<BLOCKQUOTE>You can optionally add <I>Image</I> to any method name.
For example, TrimImage() is an alias for method Trim().
</BLOCKQUOTE>
<BLOCKQUOTE>Most of the attributes listed above have an analog in
<A HREF="convert.html">convert</A>. See the documentation for a more
detailed description of these attributes.</BLOCKQUOTE>
<P><A HREF="#contents"><I>Back to Contents</I></A> <BR>
</P><A NAME="seta"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic9" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Set an
Image Attribute</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">Use method Set() to set an image
attribute. For example,
</DD></DL>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $image->Set(dither=>'True');
$image->[$x]->Set(delay=>3);</PRE><BLOCKQUOTE>
And here is a list of all the image attributes you can set:</BLOCKQUOTE>
<P ALIGN=CENTER STYLE="margin-bottom: 0in">Image Attributes</P>
<DL>
<DD>
<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2>
<TR>
<TH>
<P>Attribute</P>
</TH>
<TH>
<P>Values</P>
</TH>
<TH>
<P>Description</P>
</TH>
</TR>
<TR>
<TD>
<P>adjoin</P>
</TD>
<TD>
<P>{True, False}</P>
</TD>
<TD>
<P>join images into a single multi-image file</P>
</TD>
</TR>
<TR>
<TD>
<P>antialias</P>
</TD>
<TD>
<P>{True, False}</P>
</TD>
<TD>
<P>remove pixel aliasing</P>
</TD>
</TR>
<TR>
<TD>
<P>authenticate</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>decrypt image with this password.</P>
</TD>
</TR>
<TR>
<TD>
<P>background</P>
</TD>
<TD>
<P><A HREF="color.html"><I>color name</I></A></P>
</TD>
<TD>
<P>image background color</P>
</TD>
</TR>
<TR>
<TD>
<P>blue-primary</P>
</TD>
<TD>
<P><I>x-value</I>, <I>y-value</I></P>
</TD>
<TD>
<P>chromaticity blue primary point (e.g. 0.15, 0.06)</P>
</TD>
</TR>
<TR>
<TD>
<P>bordercolor</P>
</TD>
<TD>
<P><A HREF="color.html"><I>color name</I></A></P>
</TD>
<TD>
<P>set the image border color</P>
</TD>
</TR>
<TR>
<TD>
<P>clip-mask</P>
</TD>
<TD>
<P><I>image</I></P>
</TD>
<TD>
<P>Associate a clip mask with the image.</P>
</TD>
</TR>
<TR>
<TD>
<P>colormap[<I>i</I>]</P>
</TD>
<TD>
<P><A HREF="color.html"><I>color name</I></A></P>
</TD>
<TD>
<P>color name (e.g. red) or hex value (e.g. #ccc) at position <I>i</I></P>
</TD>
</TR>
<TR>
<TD>
<P>colorspace</P>
</TD>
<TD>
<P>{RGB, CMYK}</P>
</TD>
<TD>
<P>type of colorspace</P>
</TD>
</TR>
<TR>
<TD>
<P>comment</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>Append to the image comment.</P>
</TD>
</TR>
<TR>
<TD>
<P>compression</P>
</TD>
<TD>
<P>{None, BZip, Fax, Group4, JPEG, LosslessJPEG, LZW, RLE, Zip}</P>
</TD>
<TD>
<P>type of image compression</P>
</TD>
</TR>
<TR>
<TD>
<P>debug</P>
</TD>
<TD>
<P><I>{No, Configure, Annotate, Render, Locale, Coder, X11,
Cache, Blob, All}</I></P>
</TD>
<TD>
<P>display copious debugging information</P>
</TD>
</TR>
<TR>
<TD>
<P>delay</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>this many 1/100ths of a second\fP must expire before
displaying the next image in a sequence</P>
</TD>
</TR>
<TR>
<TD>
<P>density</P>
</TD>
<TD>
<P><I>geometry</I></P>
</TD>
<TD>
<P>vertical and horizontal resolution in pixels of the image</P>
</TD>
</TR>
<TR>
<TD>
<P>disk-limit</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>set disk resource limit in megabytes</P>
</TD>
</TR>
<TR>
<TD>
<P>dispose</P>
</TD>
<TD>
<P><I>{Undefined, None, Background, Previous}</I></P>
</TD>
<TD>
<P>GIF disposal method</P>
</TD>
</TR>
<TR>
<TD>
<P>dither</P>
</TD>
<TD>
<P>{True, False}</P>
</TD>
<TD>
<P>apply error diffusion to the image</P>
</TD>
</TR>
<TR>
<TD>
<P>display</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>specifies the X server to contact</P>
</TD>
</TR>
<TR>
<TD>
<P>file</P>
</TD>
<TD>
<P><I>filehandle</I></P>
</TD>
<TD>
<P>set the image filehandle</P>
</TD>
</TR>
<TR>
<TD>
<P>filename</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>set the image filename</P>
</TD>
</TR>
<TR>
<TD>
<P>fill</P>
</TD>
<TD>
<P><I>color</I></P>
</TD>
<TD>
<P>The fill color paints any areas inside the outline of drawn
shape.</P>
</TD>
</TR>
<TR>
<TD>
<P>font</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>use this font when annotating the image with text</P>
</TD>
</TR>
<TR>
<TD>
<P>fuzz</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>colors within this distance are considered equal</P>
</TD>
</TR>
<TR>
<TD>
<P>gamma</P>
</TD>
<TD>
<P><I>double</I></P>
</TD>
<TD>
<P>gamma level of the image</P>
</TD>
</TR>
<TR>
<TD>
<P>Gravity</P>
</TD>
<TD>
<P>{Forget, NorthWest, North, NorthEast, West, Center, East,
SouthWest, South, SouthEast}</P>
</TD>
<TD>
<P>type of image gravity</P>
</TD>
</TR>
<TR>
<TD>
<P>green-primary</P>
</TD>
<TD>
<P><I>x-value</I>, <I>y-value</I></P>
</TD>
<TD>
<P>chromaticity green primary point (e.g. 0.3, 0.6)</P>
</TD>
</TR>
<TR>
<TD>
<P>index[<I>x</I>, <I>y</I>]</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>colormap index at position (<I>x</I>, <I>y</I>)</P>
</TD>
</TR>
<TR>
<TD>
<P>interlace</P>
</TD>
<TD>
<P>{None, Line, Plane, Partition}</P>
</TD>
<TD>
<P>the type of interlacing scheme</P>
</TD>
</TR>
<TR>
<TD>
<P>iterations</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>add Netscape loop extension to your GIF animation</P>
</TD>
</TR>
<TR>
<TD>
<P>label</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>Append to the image label.</P>
</TD>
</TR>
<TR>
<TD>
<P>loop</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>add Netscape loop extension to your GIF animation</P>
</TD>
</TR>
<TR>
<TD>
<P>magick</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>set the image format</P>
</TD>
</TR>
<TR>
<TD>
<P>matte</P>
</TD>
<TD>
<P>{True, False}</P>
</TD>
<TD>
<P>True if the image has transparency</P>
</TD>
</TR>
<TR>
<TD>
<P>mattecolor</P>
</TD>
<TD>
<P><A HREF="color.html"><I>color name</I></A></P>
</TD>
<TD>
<P>set the image matte color</P>
</TD>
</TR>
<TR>
<TD>
<P>map-limit</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>set map resource limit in megabytes</P>
</TD>
</TR>
<TR>
<TD>
<P>memory-limit</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>set memory resource limit in megabytes</P>
</TD>
</TR>
<TR>
<TD>
<P>monochrome</P>
</TD>
<TD>
<P>{True, False}</P>
</TD>
<TD>
<P>transform the image to black and white</P>
</TD>
</TR>
<TR>
<TD>
<P>page</P>
</TD>
<TD>
<P>{ Letter, Tabloid, Ledger, Legal, Statement, Executive, A3,
A4, A5, B4, B5, Folio, Quarto, 10x14} or <I>geometry</I></P>
</TD>
<TD>
<P>preferred size and location of an image canvas</P>
</TD>
</TR>
<TR>
<TD>
<P>pixel[<I>x</I>, <I>y</I>]</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>hex value (e.g. #ccc) at position (<I>x</I>, <I>y</I>)</P>
</TD>
</TR>
<TR>
<TD>
<P>pointsize</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>pointsize of the Postscript or TrueType font</P>
</TD>
</TR>
<TR>
<TD>
<P>preview</P>
</TD>
<TD>
<P>{ Rotate, Shear, Roll, Hue, Saturation, Brightness, Gamma,
Spiff, Dull, Grayscale, Quantize, Despeckle, ReduceNoise,
AddNoise, Sharpen, Blur, Threshold, EdgeDetect, Spread, Solarize,
Shade, Raise, Segment, Swirl, Implode, Wave, OilPaint,
CharcoalDrawing, JPEG} </P>
</TD>
<TD>
<P>type of preview for the Preview image format</P>
</TD>
</TR>
<TR>
<TD>
<P>quality</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>JPEG/MIFF/PNG compression level</P>
</TD>
</TR>
<TR>
<TD>
<P>red-primary</P>
</TD>
<TD>
<P><I>x-value</I>, <I>y-value</I></P>
</TD>
<TD>
<P>chromaticity red primary point (e.g. 0.64, 0.33)</P>
</TD>
</TR>
<TR>
<TD>
<P>rendering-intent</P>
</TD>
<TD>
<P>{Undefined, Saturation, Perceptual, Absolute, Relative}</P>
</TD>
<TD>
<P>the type of rendering intent</P>
</TD>
</TR>
<TR>
<TD>
<P>sampling-factor</P>
</TD>
<TD>
<P><I>geometry</I></P>
</TD>
<TD>
<P>horizontal and vertical sampling factor</P>
</TD>
</TR>
<TR>
<TD>
<P>scene</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>image scene number</P>
</TD>
</TR>
<TR>
<TD>
<P>subimage</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>subimage of an image sequence</P>
</TD>
</TR>
<TR>
<TD>
<P>subrange</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>number of images relative to the base image</P>
</TD>
</TR>
<TR>
<TD>
<P>server</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>specifies the X server to contact</P>
</TD>
</TR>
<TR>
<TD>
<P>size</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>width and height of a raw image</P>
</TD>
</TR>
<TR>
<TD>
<P>stroke</P>
</TD>
<TD>
<P><I>color</I></P>
</TD>
<TD>
<P>The stroke color paints along the outline of a shape.</P>
</TD>
</TR>
<TR>
<TD>
<P>tile</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>tile name</P>
</TD>
</TR>
<TR>
<TD>
<P>texture</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>name of texture to tile onto the image background</P>
</TD>
</TR>
<TR>
<TD>
<P>type</P>
</TD>
<TD>
<P>{Bilevel, Grayscale, GrayscaleMatte, Palette, PaletteMatte,
TrueColor, TrueColorMatte, ColorSeparation, ColorSeparationMatte,
Optimize }</P>
</TD>
<TD>
<P>image type</P>
</TD>
</TR>
<TR>
<TD>
<P>units</P>
</TD>
<TD>
<P>{ Undefined, PixelsPerInch, PixelsPerCentimeters}</P>
</TD>
<TD>
<P>units of image resolution</P>
</TD>
</TR>
<TR>
<TD>
<P>verbose</P>
</TD>
<TD>
<P>{True, False}</P>
</TD>
<TD>
<P>print detailed information about the image</P>
</TD>
</TR>
<TR>
<TD>
<P>virtual-pixel</P>
</TD>
<TD>
<P>{Constant, Edge, Mirror, Tile}</P>
</TD>
<TD>
<P>the virtual pixel method</P>
</TD>
</TR>
<TR>
<TD>
<P>white-point</P>
</TD>
<TD>
<P><I>x-value</I>, <I>y-value</I></P>
</TD>
<TD>
<P>chromaticity white point (e.g. 0.3127, 0.329)</P>
</TD>
</TR>
</TABLE>
</DL>
<BLOCKQUOTE>Note, that the <TT>geometry</TT> parameter is a short cut
for the <TT>width</TT> and <TT>height</TT> parameters (e.g.
<TT>geometry=>'106x80'</TT> is equivalent to <TT>width=>106,
height=>80</TT>).
</BLOCKQUOTE>
<BLOCKQUOTE>SetAttribute() is an alias for method Set().
</BLOCKQUOTE>
<BLOCKQUOTE>Most of the attributes listed above have an analog in <A HREF="convert.html">gm
convert</A>. See the <A HREF="GraphicsMagick.html">gm</A>
documentation for a more detailed description of these attributes.</BLOCKQUOTE>
<P><A HREF="#contents">Back to Contents</A> <BR>
</P><A NAME="geta"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic10" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Get an
Image Attribute</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">Use method Get() to get an image
attribute. For example,
</DD></DL>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> ($a, $b, $c) = $image->Get('colorspace', 'magick', 'adjoin');
$width = $image->[3]->Get('columns');</PRE><BLOCKQUOTE>
In addition to all the attributes listed in <A HREF="#seta">Set an
Image Attribute</A> , you can get these additional attributes:</BLOCKQUOTE>
<P ALIGN=CENTER STYLE="margin-bottom: 0in">Image Attributes</P>
<DL>
<DD>
<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2>
<TR>
<TH>
<P>Attribute</P>
</TH>
<TH>
<P>Values</P>
</TH>
<TH>
<P>Description</P>
</TH>
</TR>
<TR>
<TD>
<P>base-columns</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>base image width (before transformations)</P>
</TD>
</TR>
<TR>
<TD>
<P>base-filename</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>base image filename (before transformations)</P>
</TD>
</TR>
<TR>
<TD>
<P>base-rows</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>base image height (before transformations)</P>
</TD>
</TR>
<TR>
<TD>
<P>class</P>
</TD>
<TD>
<P>{Direct, Pseudo}</P>
</TD>
<TD>
<P>image class</P>
</TD>
</TR>
<TR>
<TD>
<P>colors</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>number of unique colors in the image</P>
</TD>
</TR>
<TR>
<TD>
<P>comment</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>image comment</P>
</TD>
</TR>
<TR>
<TD>
<P>columns</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>image width</P>
</TD>
</TR>
<TR>
<TD>
<P>depth</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>image depth</P>
</TD>
</TR>
<TR>
<TD>
<P>directory</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>tile names from within an image montage</P>
</TD>
</TR>
<TR>
<TD>
<P>error</P>
</TD>
<TD>
<P><I>double</I></P>
</TD>
<TD>
<P>the mean error per pixel computed with methods Compare() or
Quantize()</P>
</TD>
</TR>
<TR>
<TD>
<P>filesize</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>number of bytes of the image on disk</P>
</TD>
</TR>
<TR>
<TD>
<P>format</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>get the descriptive image format</P>
</TD>
</TR>
<TR>
<TD>
<P>geometry</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>image geometry</P>
</TD>
</TR>
<TR>
<TD>
<P>height</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>the number of rows or height of an image</P>
</TD>
</TR>
<TR>
<TD>
<P>id</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>GraphicsMagick registry id</P>
</TD>
</TR>
<TR>
<TD>
<P>label</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>image label</P>
</TD>
</TR>
<TR>
<TD>
<P>maximum-error</P>
</TD>
<TD>
<P><I>double</I></P>
</TD>
<TD>
<P>the normalized max error per pixel computed with methods
Compare() or Quantize()</P>
</TD>
</TR>
<TR>
<TD>
<P>mean-error</P>
</TD>
<TD>
<P><I>double</I></P>
</TD>
<TD>
<P>the normalized mean error per pixel computed with methods
Compare() or Quantize()</P>
</TD>
</TR>
<TR>
<TD>
<P>montage</P>
</TD>
<TD>
<P><I>geometry</I></P>
</TD>
<TD>
<P>tile size and offset within an image montage</P>
</TD>
</TR>
<TR>
<TD>
<P>rows</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>the number of rows or height of an image</P>
</TD>
</TR>
<TR>
<TD>
<P>signature</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>SHA-256 message digest associated with the image pixel stream</P>
</TD>
</TR>
<TR>
<TD>
<P>taint</P>
</TD>
<TD>
<P>{True, False}</P>
</TD>
<TD>
<P>True if the image has been modified</P>
</TD>
</TR>
<TR>
<TD>
<P>width</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>the number of columns or width of an image</P>
</TD>
</TR>
<TR>
<TD>
<P>x-resolution</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>x resolution of the image</P>
</TD>
</TR>
<TR>
<TD>
<P>y-resolution</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>y resolution of the image</P>
</TD>
</TR>
</TABLE>
</DL>
<BLOCKQUOTE>GetAttribute() is an alias for method Get().
</BLOCKQUOTE>
<BLOCKQUOTE>Most of the attributes listed above have an analog in
<A HREF="convert.html">convert</A>. See the documentation for a more
detailed description of these attributes.</BLOCKQUOTE>
<P><A HREF="#contents">Back to Contents</A> <BR>
</P><A NAME="mont"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic11" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Create an
Image Montage</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">Use method Montage() to create a
composite image by combining several separate images. The images are
tiled on the composite image with the name of the image optionally
appearing just below the individual tile. For example,
</DD></DL>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $image->Montage(geometry=>'160x160', tile=>'2x2', texture=>'granite:');</PRE><BLOCKQUOTE>
And here is a list of Montage() parameters you can set:</BLOCKQUOTE>
<P ALIGN=CENTER STYLE="margin-bottom: 0in">Montage Parameters</P>
<DL>
<DD>
<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2>
<TR>
<TH>
<P>Parameter</P>
</TH>
<TH>
<P>Values</P>
</TH>
<TH>
<P>Description</P>
</TH>
</TR>
<TR>
<TD>
<P>background</P>
</TD>
<TD>
<P><A HREF="color.html"><I>color name</I></A></P>
</TD>
<TD>
<P>background color name</P>
</TD>
</TR>
<TR>
<TD>
<P>borderwidth</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>image border width</P>
</TD>
</TR>
<TR>
<TD>
<P>compose</P>
</TD>
<TD>
<P>{Over, In, Out, Atop, Xor, Plus, Minus, Add, Subtract,
Difference, Bumpmap, Copy, Mask, Dissolve, Clear, Displace}</P>
</TD>
<TD>
<P>composite operator</P>
</TD>
</TR>
<TR>
<TD>
<P>filename</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>name of montage image</P>
</TD>
</TR>
<TR>
<TD>
<P>fill</P>
</TD>
<TD>
<P><A HREF="color.html">color name</A></P>
</TD>
<TD>
<P>fill color for annotations</P>
</TD>
</TR>
<TR>
<TD>
<P>font</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>X11 font name</P>
</TD>
</TR>
<TR>
<TD>
<P>frame</P>
</TD>
<TD>
<P><I>geometry</I></P>
</TD>
<TD>
<P>surround the image with an ornamental border</P>
</TD>
</TR>
<TR>
<TD>
<P>geometry</P>
</TD>
<TD>
<P><I>geometry</I></P>
</TD>
<TD>
<P>preferred tile and border size of each tile of the composite
image</P>
</TD>
</TR>
<TR>
<TD>
<P>gravity</P>
</TD>
<TD>
<P>{NorthWest, North, NorthEast, West, Center, East, SouthWest,
South, SouthEast}</P>
</TD>
<TD>
<P>direction image gravitates to within a tile</P>
</TD>
</TR>
<TR>
<TD>
<P>ICM</P>
</TD>
<TD>
<P><I>blob</I></P>
</TD>
<TD>
<P>color information profile</P>
</TD>
</TR>
<TR>
<TD>
<P>IPTC</P>
</TD>
<TD>
<P><I>blob</I></P>
</TD>
<TD>
<P>newswire information profile</P>
</TD>
</TR>
<TR>
<TD>
<P>label</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>assign a label to an image</P>
</TD>
</TR>
<TR>
<TD>
<P>mode</P>
</TD>
<TD>
<P>{Frame, Unframe, Concatenate}</P>
</TD>
<TD>
<P>thumbnail framing options</P>
</TD>
</TR>
<TR>
<TD>
<P>pointsize</P>
</TD>
<TD>
<P><I>integer</I></P>
</TD>
<TD>
<P>pointsize of the Postscript or TrueType font</P>
</TD>
</TR>
<TR>
<TD>
<P>shadow</P>
</TD>
<TD>
<P>{True, False}</P>
</TD>
<TD>
<P>add a shadow beneath a tile to simulate depth</P>
</TD>
</TR>
<TR>
<TD>
<P>stroke</P>
</TD>
<TD>
<P><A HREF="color.html">color name</A></P>
</TD>
<TD>
<P>stroke color for annotations</P>
</TD>
</TR>
<TR>
<TD>
<P>texture</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>name of texture to tile onto the image background</P>
</TD>
</TR>
<TR>
<TD>
<P>tile</P>
</TD>
<TD>
<P><I>geometry</I></P>
</TD>
<TD>
<P>number of tiles per row and column</P>
</TD>
</TR>
<TR>
<TD>
<P>title</P>
</TD>
<TD>
<P>string</P>
</TD>
<TD>
<P>assign a title to the image montage</P>
</TD>
</TR>
<TR>
<TD>
<P>transparent</P>
</TD>
<TD>
<P><I>string</I></P>
</TD>
<TD>
<P>make this color transparent within the image</P>
</TD>
</TR>
</TABLE>
</DL>
<BLOCKQUOTE>Note, that the <TT>geometry</TT> parameter is a short cut
for the <TT>width</TT> and <TT>height</TT> parameters (e.g.
<TT>geometry=>'106x80'</TT> is equivalent to <TT>width=>106,
height=>80</TT>).
</BLOCKQUOTE>
<BLOCKQUOTE>MontageImage() is an alias for method Montage().
</BLOCKQUOTE>
<BLOCKQUOTE>Most of the attributes listed above have an analog in
<A HREF="montage.html">montage</A>. See the documentation for a more
detailed description of these attributes.</BLOCKQUOTE>
<P><A HREF="#contents"><I>Back to Contents</I></A> <BR>
</P><A NAME="blobs"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic12" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Working
with Blobs</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">A blob contains data that directly
represent a particular image format in memory instead of on disk.
<B>PerlMagick</B> supports blobs in any of these image <A HREF="formats.html">formats</A>
and provides methods to convert a blob to or from a particular image
format.
</DD></DL>
<P ALIGN=CENTER STYLE="margin-bottom: 0in">
Blob Methods</P>
<DL>
<DD>
<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2>
<TR>
<TH>
<P>Method</P>
</TH>
<TH>
<P>Parameters</P>
</TH>
<TH>
<P>Return Value</P>
</TH>
<TH>
<P>Description</P>
</TH>
</TR>
<TR>
<TD>
<P>ImageToBlob</P>
</TD>
<TD>
<P>any image <A HREF="#seta">attribute</A></P>
</TD>
<TD>
<P>an array of image data in the respective image format</P>
</TD>
<TD>
<P>convert an image or image sequence to an array of blobs</P>
</TD>
</TR>
<TR>
<TD>
<P>BlobToImage</P>
</TD>
<TD>
<P>one or more blobs</P>
</TD>
<TD>
<P>the number of blobs converted to an image</P>
</TD>
<TD>
<P>convert one or more blobs to an image</P>
</TD>
</TR>
</TABLE>
</DL>
<BLOCKQUOTE>ImageToBlob() returns the image data in their respective
formats. You can then print it, save it to an ODBC database, write it
to a file, or pipe it to a display program:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> @blobs = $image->ImageToBlob();
open(DISPLAY,"| display -") || die;
binmode DISPLAY;
print DISPLAY $blobs[0];
close DISPLAY;</PRE><BLOCKQUOTE>
Method BlobToImage() returns an image or image sequence converted
from the supplied blob:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> @blob=$db->GetImage();
$image=Graphics::Magick->new(magick=>'jpg');
$image->BlobToImage(@blob);</PRE><BLOCKQUOTE>
<BR><BR>
</BLOCKQUOTE>
<P><A HREF="#contents">Back to Contents</A> <BR>
</P><A NAME="misc"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic13" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Miscellaneous
Methods</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">The Append() method append a set of
images. For example,
</DD></DL>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $p = $image->Append(stack=>{true,false});</PRE><BLOCKQUOTE>
appends all the images associated with object <TT>$image</TT>. By
default, images are stacked left-to-right. Set <TT>stack</TT> to True
to stack them top-to-bottom.
</BLOCKQUOTE>
<BLOCKQUOTE>The Average() method averages a set of images. For
example,
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $p = $image->Average();</PRE><BLOCKQUOTE>
averages all the images associated with object <TT>$image</TT>.
</BLOCKQUOTE>
<BLOCKQUOTE>The Clone() method copies a set of images. For example,
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $p = $image->Clone();</PRE><BLOCKQUOTE>
copies all the images from object <TT>$q</TT> to <TT>$p</TT>. You can
use this method for single or multi-image sequences.
</BLOCKQUOTE>
<BLOCKQUOTE>The Morph() method morphs a set of images. Both the image
pixels and size are linearly interpolated to give the appearance of a
meta-morphosis from one image to the next:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $p = $image->Morph(frames=><I>integer</I>);</PRE><BLOCKQUOTE>
where <I>frames</I> is the number of in-between images to generate.
The default is 1.
</BLOCKQUOTE>
<BLOCKQUOTE>Mosaic() creates an mosaic from an image sequence.
</BLOCKQUOTE>
<BLOCKQUOTE>Method Mogrify() is a single entry point for the image
manipulation methods (<A HREF="#mani">Manipulate an Image</A>). The
parameters are the name of a method followed by any parameters the
method may require. For example, these calls are equivalent:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $image->Crop('340x256+0+0');
$image->Mogrify('crop', '340x256+0+0');</PRE><BLOCKQUOTE>
Method MogrifyRegion() applies a transform to a region of the image.
It is similar to Mogrify() but begins with the region geometry. For
example, suppose you want to brighten a 100x100 region of your image
at location (40, 50):
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $image->MogrifyRegion('100x100+40+50', 'modulate', brightness=>50);</PRE><BLOCKQUOTE>
Ping() is a convenience method that returns information about an
image without having to read the image into memory. It returns the
width, height, file size in bytes, and the file format of the image.
You can specify more than one filename but only one filehandle:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> ($width, $height, $size, $format) = $image->Ping('logo.png');
($width, $height, $size, $format) = $image->Ping(file=>\*IMAGE);
($width, $height, $size, $format) = $image->Ping(blob=>$blob);</PRE><BLOCKQUOTE>
This is a more efficient and less memory intensive way to query if an
image exists and what its characteristics are.
</BLOCKQUOTE>
<BLOCKQUOTE>To have full control over text positioning you need font
metric information. Use
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> ($x_ppem, $y_ppem, $ascender, $descender, $width, $height, $max_advance) =
$image->QueryFontMetrics(<I>parameters</I>);</PRE><BLOCKQUOTE>
Where <I>parameters</I> is any parameter of the <A HREF="#mani">Annotate</A>
method. The return values are
</BLOCKQUOTE>
<UL>
<LI><BLOCKQUOTE STYLE="margin-bottom: 0in">character width
</BLOCKQUOTE>
<LI><BLOCKQUOTE STYLE="margin-bottom: 0in">character height
</BLOCKQUOTE>
<LI><BLOCKQUOTE STYLE="margin-bottom: 0in">ascender
</BLOCKQUOTE>
<LI><BLOCKQUOTE STYLE="margin-bottom: 0in">descender
</BLOCKQUOTE>
<LI><BLOCKQUOTE STYLE="margin-bottom: 0in">text width
</BLOCKQUOTE>
<LI><BLOCKQUOTE STYLE="margin-bottom: 0in">text height
</BLOCKQUOTE>
<LI><BLOCKQUOTE>maximum horizontal advance
</BLOCKQUOTE>
</UL>
<BLOCKQUOTE>Call QueryColor() with no parameters to return a list of
known colors names or specify one or more color names to get these
attributes: red, green, blue, and opacity value.
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> @colors = $image->QueryColor();
($red, $green, $blue, $opacity) = $image->QueryColor('cyan');
($red, $green, $blue, $opacity) = $image->QueryColor('#716bae');</PRE><BLOCKQUOTE>
QueryColorname() accepts a color value and returns its respective
name or hex value;</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $name = $image->QueryColorname('rgba(80,60,0,0)');</PRE><BLOCKQUOTE>
Call QueryFont() with no parameters to return a list of known fonts
or specify one or more font names to get these attributes: font name,
description, family, style, stretch, weight, encoding, foundry,
format, metrics, and glyphs values.</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> @fonts = $image->QueryFont();
$weight = ($image->QueryFont('Helvetica'))[5];</PRE><BLOCKQUOTE>
Call QueryFormat() with no parameters to return a list of known image
formats or specify one or more format names to get these attributes:
adjoin, blob support, raw, decoder, encoder, description, and module.
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> @formats = $image->QueryFormat();
($adjoin, $blob_support, $raw, $decoder, $encoder, $description, $module) = $image->QueryFormat('gif');</PRE><BLOCKQUOTE>
Use RemoteCommand() to send a command to an already running <A HREF="display.html">display</A>
or <A HREF="animate.html">animate</A> application. The only parameter
is the name of the image file to display or animate.
</BLOCKQUOTE>
<BLOCKQUOTE>Finally, the Transform() method accepts a fully-qualified
geometry specification for cropping or resizing one or more images.
For example,
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> $p = $image->Transform(crop=>'100x100');</PRE><BLOCKQUOTE>
You can optionally add <I>Image</I> to any method name above. For
example, PingImage() is an alias for method Ping().</BLOCKQUOTE>
<P><A HREF="#contents">Back to Contents</A> <BR>
</P><A NAME="erro"></A>
<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
<TR>
<TD BGCOLOR="#52799e">
<P ALIGN=LEFT><IMG SRC="../images/right_triangle.png" NAME="Graphic14" ALT=">" ALIGN=BOTTOM WIDTH=15 HEIGHT=14 BORDER=0>
<B><FONT FACE="Helvetica, Arial"><FONT COLOR="#ffffff">Handling
Errors</FONT></FONT></B></P>
</TD>
</TR>
</TABLE>
<DL>
<DD STYLE="margin-bottom: 0.2in">All <B>PerlMagick</B> methods
return an undefined string context upon success. If any problems
occur, the error is returned as a string with an embedded numeric
status code. A status code less than 400 is a warning. This means
that the operation did not complete but was recoverable to some
degree. A numeric code greater or equal to 400 is an error and
indicates the operation failed completely. Here is how errors are
returned for the different methods:
</DD></DL>
<UL>
<UL>
<LI><P>
Methods which return a number (e.g. Read(), Write()):
</P>
<PRE> $x = $image->Read(...);
warn "$x" if "$x"; # print the error message
$x =~ /(\d+)/;
print $1; # print the error number
print 0+$x; # print the number of images read</PRE>
<LI><P>Methods which operate on an image (e.g. Resize(), Crop()):
</P>
<PRE> $x = $image->Crop(...);
warn "$x" if "$x"; # print the error message
$x =~ /(\d+)/;
print $1; # print the error number</PRE>
<LI><P>Methods which return images (Average(), Montage(), Clone())
should be checked for errors this way:
</P>
<PRE> $x = $image->Montage(...);
warn "$x" if !ref($x); # print the error message
$x =~ /(\d+)/;
print $1; # print the error number</PRE>
</UL>
</UL>
<BLOCKQUOTE>Here is an example error message:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in; margin-bottom: 0.2in"> Error 400: Memory allocation failed</PRE><BLOCKQUOTE>
Below is a list of error and warning codes:
</BLOCKQUOTE>
<P ALIGN=CENTER STYLE="margin-bottom: 0in">Error and Warning Codes</P>
<DL>
<DD>
<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2>
<TR>
<TH>
<P>Code</P>
</TH>
<TH>
<P>Mnemonic</P>
</TH>
<TH>
<P>Description</P>
</TH>
</TR>
<TR>
<TD>
<P>0</P>
</TD>
<TD>
<P>Success</P>
</TD>
<TD>
<P>method completed without an error or warning</P>
</TD>
</TR>
<TR>
<TD>
<P>300</P>
</TD>
<TD>
<P>ResourceLimitWarning</P>
</TD>
<TD>
<P>a program resource is exhausted (e.g. not enough memory)</P>
</TD>
</TR>
<TR>
<TD>
<P>305</P>
</TD>
<TD>
<P>TypeWarning</P>
</TD>
<TD>
<P>A font is unavailable; a substitution may have occurred</P>
</TD>
</TR>
<TR>
<TD>
<P>310</P>
</TD>
<TD>
<P>OptionWarning</P>
</TD>
<TD>
<P>a command-line option was malformed</P>
</TD>
</TR>
<TR>
<TD>
<P>315</P>
</TD>
<TD>
<P>DelegateWarning</P>
</TD>
<TD>
<P>an GraphicsMagick <I>delegate</I> returned a warning</P>
</TD>
</TR>
<TR>
<TD>
<P>320</P>
</TD>
<TD>
<P>MissingDelegateWarning</P>
</TD>
<TD>
<P>the image type can not be read or written because the
appropriate <I>Delegate</I> is missing</P>
</TD>
</TR>
<TR>
<TD>
<P>325</P>
</TD>
<TD>
<P>CorruptImageWarning</P>
</TD>
<TD>
<P>the image file may be corrupt</P>
</TD>
</TR>
<TR>
<TD>
<P>330</P>
</TD>
<TD>
<P>FileOpenWarning</P>
</TD>
<TD>
<P>the image file could not be opened</P>
</TD>
</TR>
<TR>
<TD>
<P>335</P>
</TD>
<TD>
<P>BlobWarning</P>
</TD>
<TD>
<P>a binary large object could not be allocated</P>
</TD>
</TR>
<TR>
<TD>
<P>340</P>
</TD>
<TD>
<P>StreamWarning</P>
</TD>
<TD>
<P>there was a problem reading or writing from a stream</P>
</TD>
</TR>
<TR>
<TD>
<P>345</P>
</TD>
<TD>
<P>CacheWarning</P>
</TD>
<TD>
<P>pixels could not be saved to the pixel cache</P>
</TD>
</TR>
<TR>
<TD>
<P>350</P>
</TD>
<TD>
<P>CoderWarning</P>
</TD>
<TD>
<P>there was a problem with an image coder</P>
</TD>
</TR>
<TR>
<TD>
<P>355</P>
</TD>
<TD>
<P>ModuleWarning</P>
</TD>
<TD>
<P>there was a problem with an image module</P>
</TD>
</TR>
<TR>
<TD>
<P>360</P>
</TD>
<TD>
<P>DrawWarning</P>
</TD>
<TD>
<P>a drawing operation failed</P>
</TD>
</TR>
<TR>
<TD>
<P>365</P>
</TD>
<TD>
<P>ImageWarning</P>
</TD>
<TD>
<P>the operation could not complete due to an incompatible image</P>
</TD>
</TR>
<TR>
<TD>
<P>380</P>
</TD>
<TD>
<P>XServerWarning</P>
</TD>
<TD>
<P>an X resource is unavailable</P>
</TD>
</TR>
<TR>
<TD>
<P>385</P>
</TD>
<TD>
<P>MonitorWarning</P>
</TD>
<TD>
<P>there was a problem with prgress monitor</P>
</TD>
</TR>
<TR>
<TD>
<P>390</P>
</TD>
<TD>
<P>RegistryWarning</P>
</TD>
<TD>
<P>there was a problem getting or setting the registry</P>
</TD>
</TR>
<TR>
<TD>
<P>395</P>
</TD>
<TD>
<P>ConfigureWarning</P>
</TD>
<TD>
<P>there was a problem getting a configuration file</P>
</TD>
</TR>
<TR>
<TD>
<P>400</P>
</TD>
<TD>
<P>ResourceLimitError</P>
</TD>
<TD>
<P>a program resource is exhausted (e.g. not enough memory)</P>
</TD>
</TR>
<TR>
<TD>
<P>405</P>
</TD>
<TD>
<P>TypeError</P>
</TD>
<TD>
<P>A font is unavailable; a substitution may have occurred</P>
</TD>
</TR>
<TR>
<TD>
<P>410</P>
</TD>
<TD>
<P>OptionError</P>
</TD>
<TD>
<P>a command-line option was malformed</P>
</TD>
</TR>
<TR>
<TD>
<P>415</P>
</TD>
<TD>
<P>DelegateError</P>
</TD>
<TD>
<P>an GraphicsMagick <I>delegate</I> returned a warning</P>
</TD>
</TR>
<TR>
<TD>
<P>420</P>
</TD>
<TD>
<P>MissingDelegateError</P>
</TD>
<TD>
<P>the image type can not be read or written because the
appropriate <I>Delegate</I> is missing</P>
</TD>
</TR>
<TR>
<TD>
<P>425</P>
</TD>
<TD>
<P>CorruptImageError</P>
</TD>
<TD>
<P>the image file may be corrupt</P>
</TD>
</TR>
<TR>
<TD>
<P>430</P>
</TD>
<TD>
<P>FileOpenError</P>
</TD>
<TD>
<P>the image file could not be opened</P>
</TD>
</TR>
<TR>
<TD>
<P>435</P>
</TD>
<TD>
<P>BlobError</P>
</TD>
<TD>
<P>a binary large object could not be allocated</P>
</TD>
</TR>
<TR>
<TD>
<P>440</P>
</TD>
<TD>
<P>StreamError</P>
</TD>
<TD>
<P>there was a problem reading or writing from a stream</P>
</TD>
</TR>
<TR>
<TD>
<P>445</P>
</TD>
<TD>
<P>CacheError</P>
</TD>
<TD>
<P>pixels could not be saved to the pixel cache</P>
</TD>
</TR>
<TR>
<TD>
<P>450</P>
</TD>
<TD>
<P>CoderError</P>
</TD>
<TD>
<P>there was a problem with an image coder</P>
</TD>
</TR>
<TR>
<TD>
<P>455</P>
</TD>
<TD>
<P>ModuleError</P>
</TD>
<TD>
<P>there was a problem with an image module</P>
</TD>
</TR>
<TR>
<TD>
<P>460</P>
</TD>
<TD>
<P>DrawError</P>
</TD>
<TD>
<P>a drawing operation failed</P>
</TD>
</TR>
<TR>
<TD>
<P>465</P>
</TD>
<TD>
<P>ImageError</P>
</TD>
<TD>
<P>the operation could not complete due to an incompatible image</P>
</TD>
</TR>
<TR>
<TD>
<P>480</P>
</TD>
<TD>
<P>XServerError</P>
</TD>
<TD>
<P>an X resource is unavailable</P>
</TD>
</TR>
<TR>
<TD>
<P>480</P>
</TD>
<TD>
<P>MonitorError</P>
</TD>
<TD>
<P>there was a progress monitor error</P>
</TD>
</TR>
<TR>
<TD>
<P>490</P>
</TD>
<TD>
<P>RegistryError</P>
</TD>
<TD>
<P>there was a problem getting or setting the registry</P>
</TD>
</TR>
<TR>
<TD>
<P>495</P>
</TD>
<TD>
<P>ConfigureError</P>
</TD>
<TD>
<P>there was a problem getting a configuration file</P>
</TD>
</TR>
</TABLE>
</DL>
<BLOCKQUOTE>The following illustrates how you can use a numeric
status code:
</BLOCKQUOTE>
<PRE STYLE="margin-left: 0.39in; margin-right: 0.39in"> $x = $image->Read('rose.png');
$x =~ /(\d+)/;
die "unable to continue" if ($1 == ResourceLimitError);</PRE><P STYLE="margin-bottom: 0in">
<A HREF="#contents">Back to Contents</A>
</P>
<HR>
<P ALIGN=CENTER><A HREF="Copyright.html">Copyright</A> <FONT FACE="Abadi Mt Condensed Extra Bold">©</FONT>
GraphicsMagick Group 2002, 2003, 2004</P>
</BODY>
</HTML>
