2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % M M AAA GGGG IIIII CCCC K K %
7 % MM MM A A G I C K K %
8 % M M M AAAAA G GGG I C KKK %
9 % M M A A G G I C K K %
10 % M M A A GGGG IIIII CCCC K K %
12 % IIIII M M AAA GGGG EEEEE %
14 % I M M M AAAAA G GG EEE %
16 % IIIII M M A A GGGG EEEEE %
19 % MagickWand Image Methods %
26 % Copyright 1999-2015 ImageMagick Studio LLC, a non-profit organization %
27 % dedicated to making software imaging solutions freely available. %
29 % You may not use this file except in compliance with the License. You may %
30 % obtain a copy of the License at %
32 % http://www.imagemagick.org/script/license.php %
34 % Unless required by applicable law or agreed to in writing, software %
35 % distributed under the License is distributed on an "AS IS" BASIS, %
36 % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
37 % See the License for the specific language governing permissions and %
38 % limitations under the License. %
40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
49 #include "MagickWand/studio.h"
50 #include "MagickWand/MagickWand.h"
51 #include "MagickWand/magick-wand-private.h"
52 #include "MagickWand/wand.h"
53 #include "MagickWand/pixel-wand-private.h"
54 #include "MagickCore/image-private.h"
59 #define MagickWandId "MagickWand"
62 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
66 + C l o n e M a g i c k W a n d F r o m I m a g e s %
70 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
72 % CloneMagickWandFromImages() clones the magick wand and inserts a new image
75 % The format of the CloneMagickWandFromImages method is:
77 % MagickWand *CloneMagickWandFromImages(const MagickWand *wand,
80 % A description of each parameter follows:
82 % o wand: the magick wand.
84 % o images: replace the image list with these image(s).
87 static MagickWand *CloneMagickWandFromImages(const MagickWand *wand,
93 assert(wand != (MagickWand *) NULL);
94 assert(wand->signature == MagickWandSignature);
95 if (IfMagickTrue(wand->debug))
96 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
97 clone_wand=(MagickWand *) AcquireMagickMemory(sizeof(*clone_wand));
98 if (clone_wand == (MagickWand *) NULL)
99 ThrowWandFatalException(ResourceLimitFatalError,"MemoryAllocationFailed",
101 (void) ResetMagickMemory(clone_wand,0,sizeof(*clone_wand));
102 clone_wand->id=AcquireWandId();
103 (void) FormatLocaleString(clone_wand->name,MagickPathExtent,"%s-%.20g",
104 MagickWandId,(double) clone_wand->id);
105 clone_wand->exception=AcquireExceptionInfo();
106 InheritException(clone_wand->exception,wand->exception);
107 clone_wand->image_info=CloneImageInfo(wand->image_info);
108 clone_wand->images=images;
109 clone_wand->debug=IsEventLogging();
110 clone_wand->signature=MagickWandSignature;
111 if (IfMagickTrue(clone_wand->debug))
112 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",clone_wand->name);
117 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
121 % G e t I m a g e F r o m M a g i c k W a n d %
125 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
127 % GetImageFromMagickWand() returns the current image from the magick wand.
129 % The format of the GetImageFromMagickWand method is:
131 % Image *GetImageFromMagickWand(const MagickWand *wand)
133 % A description of each parameter follows:
135 % o wand: the magick wand.
138 WandExport Image *GetImageFromMagickWand(const MagickWand *wand)
140 assert(wand != (MagickWand *) NULL);
141 assert(wand->signature == MagickWandSignature);
142 if (IfMagickTrue(wand->debug))
143 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
144 if (wand->images == (Image *) NULL)
146 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
147 "ContainsNoImages","`%s'",wand->name);
148 return((Image *) NULL);
150 return(wand->images);
154 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
158 % M a g i c k A d a p t i v e S h a r p e n I m a g e %
162 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
164 % MagickAdaptiveBlurImage() adaptively blurs the image by blurring
165 % less intensely near image edges and more intensely far from edges. We
166 % blur the image with a Gaussian operator of the given radius and standard
167 % deviation (sigma). For reasonable results, radius should be larger than
168 % sigma. Use a radius of 0 and MagickAdaptiveBlurImage() selects a
169 % suitable radius for you.
171 % The format of the MagickAdaptiveBlurImage method is:
173 % MagickBooleanType MagickAdaptiveBlurImage(MagickWand *wand,
174 % const double radius,const double sigma)
176 % A description of each parameter follows:
178 % o wand: the magick wand.
180 % o radius: the radius of the Gaussian, in pixels, not counting the center
183 % o sigma: the standard deviation of the Gaussian, in pixels.
186 WandExport MagickBooleanType MagickAdaptiveBlurImage(MagickWand *wand,
187 const double radius,const double sigma)
192 assert(wand != (MagickWand *) NULL);
193 assert(wand->signature == MagickWandSignature);
194 if (IfMagickTrue(wand->debug))
195 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
196 if (wand->images == (Image *) NULL)
197 ThrowWandException(WandError,"ContainsNoImages",wand->name);
198 sharp_image=AdaptiveBlurImage(wand->images,radius,sigma,wand->exception);
199 if (sharp_image == (Image *) NULL)
201 ReplaceImageInList(&wand->images,sharp_image);
206 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
210 % M a g i c k A d a p t i v e R e s i z e I m a g e %
214 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
216 % MagickAdaptiveResizeImage() adaptively resize image with data dependent
219 % MagickBooleanType MagickAdaptiveResizeImage(MagickWand *wand,
220 % const size_t columns,const size_t rows)
222 % A description of each parameter follows:
224 % o wand: the magick wand.
226 % o columns: the number of columns in the scaled image.
228 % o rows: the number of rows in the scaled image.
231 WandExport MagickBooleanType MagickAdaptiveResizeImage(MagickWand *wand,
232 const size_t columns,const size_t rows)
237 assert(wand != (MagickWand *) NULL);
238 assert(wand->signature == MagickWandSignature);
239 if (IfMagickTrue(wand->debug))
240 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
241 if (wand->images == (Image *) NULL)
242 ThrowWandException(WandError,"ContainsNoImages",wand->name);
243 resize_image=AdaptiveResizeImage(wand->images,columns,rows,wand->exception);
244 if (resize_image == (Image *) NULL)
246 ReplaceImageInList(&wand->images,resize_image);
251 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
255 % M a g i c k A d a p t i v e S h a r p e n I m a g e %
259 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
261 % MagickAdaptiveSharpenImage() adaptively sharpens the image by sharpening
262 % more intensely near image edges and less intensely far from edges. We
263 % sharpen the image with a Gaussian operator of the given radius and standard
264 % deviation (sigma). For reasonable results, radius should be larger than
265 % sigma. Use a radius of 0 and MagickAdaptiveSharpenImage() selects a
266 % suitable radius for you.
268 % The format of the MagickAdaptiveSharpenImage method is:
270 % MagickBooleanType MagickAdaptiveSharpenImage(MagickWand *wand,
271 % const double radius,const double sigma)
273 % A description of each parameter follows:
275 % o wand: the magick wand.
277 % o radius: the radius of the Gaussian, in pixels, not counting the center
280 % o sigma: the standard deviation of the Gaussian, in pixels.
283 WandExport MagickBooleanType MagickAdaptiveSharpenImage(MagickWand *wand,
284 const double radius,const double sigma)
289 assert(wand != (MagickWand *) NULL);
290 assert(wand->signature == MagickWandSignature);
291 if (IfMagickTrue(wand->debug))
292 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
293 if (wand->images == (Image *) NULL)
294 ThrowWandException(WandError,"ContainsNoImages",wand->name);
295 sharp_image=AdaptiveSharpenImage(wand->images,radius,sigma,wand->exception);
296 if (sharp_image == (Image *) NULL)
298 ReplaceImageInList(&wand->images,sharp_image);
303 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
307 % M a g i c k A d a p t i v e T h r e s h o l d I m a g e %
311 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
313 % MagickAdaptiveThresholdImage() selects an individual threshold for each pixel
314 % based on the range of intensity values in its local neighborhood. This
315 % allows for thresholding of an image whose global intensity histogram
316 % doesn't contain distinctive peaks.
318 % The format of the AdaptiveThresholdImage method is:
320 % MagickBooleanType MagickAdaptiveThresholdImage(MagickWand *wand,
321 % const size_t width,const size_t height,const double bias)
323 % A description of each parameter follows:
325 % o wand: the magick wand.
327 % o width: the width of the local neighborhood.
329 % o height: the height of the local neighborhood.
331 % o offset: the mean bias.
334 WandExport MagickBooleanType MagickAdaptiveThresholdImage(MagickWand *wand,
335 const size_t width,const size_t height,const double bias)
340 assert(wand != (MagickWand *) NULL);
341 assert(wand->signature == MagickWandSignature);
342 if (IfMagickTrue(wand->debug))
343 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
344 if (wand->images == (Image *) NULL)
345 ThrowWandException(WandError,"ContainsNoImages",wand->name);
346 threshold_image=AdaptiveThresholdImage(wand->images,width,height,bias,
348 if (threshold_image == (Image *) NULL)
350 ReplaceImageInList(&wand->images,threshold_image);
355 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
359 % M a g i c k A d d I m a g e %
363 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
365 % MagickAddImage() adds a clone of the images from the second wand and
366 % inserts them into the first wand.
368 % Use MagickSetLastIterator(), to append new images into an existing wand,
369 % current image will be set to last image so later adds with also be
370 % appened to end of wand.
372 % Use MagickSetFirstIterator() to prepend new images into wand, any more
373 % images added will also be prepended before other images in the wand.
374 % However the order of a list of new images will not change.
376 % Otherwise the new images will be inserted just after the current image,
377 % and any later image will also be added after this current image but
378 % before the previously added images. Caution is advised when multiple
379 % image adds are inserted into the middle of the wand image list.
381 % The format of the MagickAddImage method is:
383 % MagickBooleanType MagickAddImage(MagickWand *wand,
384 % const MagickWand *add_wand)
386 % A description of each parameter follows:
388 % o wand: the magick wand.
390 % o add_wand: A wand that contains the image list to be added
393 static inline MagickBooleanType InsertImageInWand(MagickWand *wand,
396 if (wand->images == (Image *) NULL)
399 No images in wand, just add them, set current as appropriate.
401 if (IfMagickTrue(wand->insert_before))
402 wand->images=GetFirstImageInList(images);
404 wand->images=GetLastImageInList(images);
407 /* user jumped to first image, so prepend new images - remain active */
408 if (IfMagickTrue((wand->insert_before)) &&
409 (wand->images->previous == (Image *) NULL))
411 PrependImageToList(&wand->images,images);
412 wand->images=GetFirstImageInList(images);
416 Note you should never have 'insert_before' true when current image is not
417 the first image in the wand! That is no insert before current image, only
420 if (wand->images->next == (Image *) NULL)
423 At last image, append new images.
425 InsertImageInList(&wand->images,images);
426 wand->images=GetLastImageInList(images);
430 Insert new images, just after the current image.
432 InsertImageInList(&wand->images,images);
436 WandExport MagickBooleanType MagickAddImage(MagickWand *wand,
437 const MagickWand *add_wand)
442 assert(wand != (MagickWand *) NULL);
443 assert(wand->signature == MagickWandSignature);
444 if (IfMagickTrue(wand->debug))
445 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
446 assert(add_wand != (MagickWand *) NULL);
447 assert(add_wand->signature == MagickWandSignature);
448 if (add_wand->images == (Image *) NULL)
449 ThrowWandException(WandError,"ContainsNoImages",add_wand->name);
451 Clone images in second wand, and insert into first.
453 images=CloneImageList(add_wand->images,wand->exception);
454 if (images == (Image *) NULL)
456 return(InsertImageInWand(wand,images));
460 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
464 % M a g i c k A d d N o i s e I m a g e %
468 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
470 % MagickAddNoiseImage() adds random noise to the image.
472 % The format of the MagickAddNoiseImage method is:
474 % MagickBooleanType MagickAddNoiseImage(MagickWand *wand,
475 % const NoiseType noise_type,const double attenuate)
477 % A description of each parameter follows:
479 % o wand: the magick wand.
481 % o noise_type: The type of noise: Uniform, Gaussian, Multiplicative,
482 % Impulse, Laplacian, or Poisson.
484 % o attenuate: attenuate the random distribution.
487 WandExport MagickBooleanType MagickAddNoiseImage(MagickWand *wand,
488 const NoiseType noise_type,const double attenuate)
493 assert(wand != (MagickWand *) NULL);
494 assert(wand->signature == MagickWandSignature);
495 if (IfMagickTrue(wand->debug))
496 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
497 if (wand->images == (Image *) NULL)
498 ThrowWandException(WandError,"ContainsNoImages",wand->name);
499 noise_image=AddNoiseImage(wand->images,noise_type,attenuate,wand->exception);
500 if (noise_image == (Image *) NULL)
502 ReplaceImageInList(&wand->images,noise_image);
507 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
511 % M a g i c k A f f i n e T r a n s f o r m I m a g e %
515 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
517 % MagickAffineTransformImage() transforms an image as dictated by the affine
518 % matrix of the drawing wand.
520 % The format of the MagickAffineTransformImage method is:
522 % MagickBooleanType MagickAffineTransformImage(MagickWand *wand,
523 % const DrawingWand *drawing_wand)
525 % A description of each parameter follows:
527 % o wand: the magick wand.
529 % o drawing_wand: the draw wand.
532 WandExport MagickBooleanType MagickAffineTransformImage(MagickWand *wand,
533 const DrawingWand *drawing_wand)
541 assert(wand != (MagickWand *) NULL);
542 assert(wand->signature == MagickWandSignature);
543 if (IfMagickTrue(wand->debug))
544 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
545 if (wand->images == (Image *) NULL)
546 ThrowWandException(WandError,"ContainsNoImages",wand->name);
547 draw_info=PeekDrawingWand(drawing_wand);
548 if (draw_info == (DrawInfo *) NULL)
550 affine_image=AffineTransformImage(wand->images,&draw_info->affine,
552 draw_info=DestroyDrawInfo(draw_info);
553 if (affine_image == (Image *) NULL)
555 ReplaceImageInList(&wand->images,affine_image);
560 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
564 % M a g i c k A n n o t a t e I m a g e %
568 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
570 % MagickAnnotateImage() annotates an image with text.
572 % The format of the MagickAnnotateImage method is:
574 % MagickBooleanType MagickAnnotateImage(MagickWand *wand,
575 % const DrawingWand *drawing_wand,const double x,const double y,
576 % const double angle,const char *text)
578 % A description of each parameter follows:
580 % o wand: the magick wand.
582 % o drawing_wand: the draw wand.
584 % o x: x ordinate to left of text
586 % o y: y ordinate to text baseline
588 % o angle: rotate text relative to this angle.
590 % o text: text to draw
593 WandExport MagickBooleanType MagickAnnotateImage(MagickWand *wand,
594 const DrawingWand *drawing_wand,const double x,const double y,
595 const double angle,const char *text)
598 geometry[MagickPathExtent];
606 assert(wand != (MagickWand *) NULL);
607 assert(wand->signature == MagickWandSignature);
608 if (IfMagickTrue(wand->debug))
609 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
610 if (wand->images == (Image *) NULL)
611 ThrowWandException(WandError,"ContainsNoImages",wand->name);
612 draw_info=PeekDrawingWand(drawing_wand);
613 if (draw_info == (DrawInfo *) NULL)
615 (void) CloneString(&draw_info->text,text);
616 (void) FormatLocaleString(geometry,MagickPathExtent,"%+g%+g",x,y);
617 draw_info->affine.sx=cos((double) DegreesToRadians(fmod(angle,360.0)));
618 draw_info->affine.rx=sin((double) DegreesToRadians(fmod(angle,360.0)));
619 draw_info->affine.ry=(-sin((double) DegreesToRadians(fmod(angle,360.0))));
620 draw_info->affine.sy=cos((double) DegreesToRadians(fmod(angle,360.0)));
621 (void) CloneString(&draw_info->geometry,geometry);
622 status=AnnotateImage(wand->images,draw_info,wand->exception);
623 draw_info=DestroyDrawInfo(draw_info);
628 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
632 % M a g i c k A n i m a t e I m a g e s %
636 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
638 % MagickAnimateImages() animates an image or image sequence.
640 % The format of the MagickAnimateImages method is:
642 % MagickBooleanType MagickAnimateImages(MagickWand *wand,
643 % const char *server_name)
645 % A description of each parameter follows:
647 % o wand: the magick wand.
649 % o server_name: the X server name.
652 WandExport MagickBooleanType MagickAnimateImages(MagickWand *wand,
653 const char *server_name)
658 assert(wand != (MagickWand *) NULL);
659 assert(wand->signature == MagickWandSignature);
660 if (IfMagickTrue(wand->debug))
661 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
662 (void) CloneString(&wand->image_info->server_name,server_name);
663 status=AnimateImages(wand->image_info,wand->images,wand->exception);
668 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
672 % M a g i c k A p p e n d I m a g e s %
676 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
678 % MagickAppendImages() append the images in a wand from the current image
679 % onwards, creating a new wand with the single image result. This is
680 % affected by the gravity and background settings of the first image.
682 % Typically you would call either MagickResetIterator() or
683 % MagickSetFirstImage() before calling this function to ensure that all
684 % the images in the wand's image list will be appended together.
686 % The format of the MagickAppendImages method is:
688 % MagickWand *MagickAppendImages(MagickWand *wand,
689 % const MagickBooleanType stack)
691 % A description of each parameter follows:
693 % o wand: the magick wand.
695 % o stack: By default, images are stacked left-to-right. Set stack to
696 % MagickTrue to stack them top-to-bottom.
699 WandExport MagickWand *MagickAppendImages(MagickWand *wand,
700 const MagickBooleanType stack)
705 assert(wand != (MagickWand *) NULL);
706 assert(wand->signature == MagickWandSignature);
707 if (IfMagickTrue(wand->debug))
708 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
709 if (wand->images == (Image *) NULL)
710 return((MagickWand *) NULL);
711 append_image=AppendImages(wand->images,stack,wand->exception);
712 if (append_image == (Image *) NULL)
713 return((MagickWand *) NULL);
714 return(CloneMagickWandFromImages(wand,append_image));
718 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
722 % M a g i c k A u t o G a m m a I m a g e %
726 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
728 % MagickAutoGammaImage() extracts the 'mean' from the image and adjust the
729 % image to try make set its gamma appropriatally.
731 % The format of the MagickAutoGammaImage method is:
733 % MagickBooleanType MagickAutoGammaImage(MagickWand *wand)
735 % A description of each parameter follows:
737 % o wand: the magick wand.
740 WandExport MagickBooleanType MagickAutoGammaImage(MagickWand *wand)
745 assert(wand != (MagickWand *) NULL);
746 assert(wand->signature == MagickWandSignature);
747 if (IfMagickTrue(wand->debug))
748 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
749 if (wand->images == (Image *) NULL)
750 ThrowWandException(WandError,"ContainsNoImages",wand->name);
751 status=AutoGammaImage(wand->images,wand->exception);
756 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
760 % M a g i c k A u t o L e v e l I m a g e %
764 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
766 % MagickAutoLevelImage() adjusts the levels of a particular image channel by
767 % scaling the minimum and maximum values to the full quantum range.
769 % The format of the MagickAutoLevelImage method is:
771 % MagickBooleanType MagickAutoLevelImage(MagickWand *wand)
773 % A description of each parameter follows:
775 % o wand: the magick wand.
778 WandExport MagickBooleanType MagickAutoLevelImage(MagickWand *wand)
783 assert(wand != (MagickWand *) NULL);
784 assert(wand->signature == MagickWandSignature);
785 if (IfMagickTrue(wand->debug))
786 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
787 if (wand->images == (Image *) NULL)
788 ThrowWandException(WandError,"ContainsNoImages",wand->name);
789 status=AutoLevelImage(wand->images,wand->exception);
794 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
798 % M a g i c k A u t o O r i e n t I m a g e %
802 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
804 % MagickAutoOrientImage() adjusts an image so that its orientation is suitable
805 $ for viewing (i.e. top-left orientation).
807 % The format of the MagickAutoOrientImage method is:
809 % MagickBooleanType MagickAutoOrientImage(MagickWand *image)
811 % A description of each parameter follows:
813 % o wand: the magick wand.
816 WandExport MagickBooleanType MagickAutoOrientImage(MagickWand *wand)
822 assert(wand != (MagickWand *) NULL);
823 assert(wand->signature == MagickWandSignature);
824 if (wand->debug != MagickFalse)
825 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
826 if (wand->images == (Image *) NULL)
827 ThrowWandException(WandError,"ContainsNoImages",wand->name);
828 orient_image=AutoOrientImage(wand->images,wand->images->orientation,
830 if (orient_image == (Image *) NULL)
832 ReplaceImageInList(&wand->images,orient_image);
837 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
841 % M a g i c k B l a c k T h r e s h o l d I m a g e %
845 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
847 % MagickBlackThresholdImage() is like MagickThresholdImage() but forces all
848 % pixels below the threshold into black while leaving all pixels above the
849 % threshold unchanged.
851 % The format of the MagickBlackThresholdImage method is:
853 % MagickBooleanType MagickBlackThresholdImage(MagickWand *wand,
854 % const PixelWand *threshold)
856 % A description of each parameter follows:
858 % o wand: the magick wand.
860 % o threshold: the pixel wand.
863 WandExport MagickBooleanType MagickBlackThresholdImage(MagickWand *wand,
864 const PixelWand *threshold)
867 thresholds[MagickPathExtent];
872 assert(wand != (MagickWand *) NULL);
873 assert(wand->signature == MagickWandSignature);
874 if (IfMagickTrue(wand->debug))
875 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
876 if (wand->images == (Image *) NULL)
877 ThrowWandException(WandError,"ContainsNoImages",wand->name);
878 (void) FormatLocaleString(thresholds,MagickPathExtent,
879 QuantumFormat "," QuantumFormat "," QuantumFormat "," QuantumFormat,
880 PixelGetRedQuantum(threshold),PixelGetGreenQuantum(threshold),
881 PixelGetBlueQuantum(threshold),PixelGetAlphaQuantum(threshold));
882 status=BlackThresholdImage(wand->images,thresholds,wand->exception);
887 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
891 % M a g i c k B l u e S h i f t I m a g e %
895 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
897 % MagickBlueShiftImage() mutes the colors of the image to simulate a scene at
898 % nighttime in the moonlight.
900 % The format of the MagickBlueShiftImage method is:
902 % MagickBooleanType MagickBlueShiftImage(MagickWand *wand,
903 % const double factor)
905 % A description of each parameter follows:
907 % o wand: the magick wand.
909 % o factor: the blue shift factor (default 1.5)
912 WandExport MagickBooleanType MagickBlueShiftImage(MagickWand *wand,
918 assert(wand != (MagickWand *) NULL);
919 assert(wand->signature == MagickWandSignature);
920 if (IfMagickTrue(wand->debug))
921 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
922 if (wand->images == (Image *) NULL)
923 ThrowWandException(WandError,"ContainsNoImages",wand->name);
924 shift_image=BlueShiftImage(wand->images,factor,wand->exception);
925 if (shift_image == (Image *) NULL)
927 ReplaceImageInList(&wand->images,shift_image);
932 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
936 % M a g i c k B l u r I m a g e %
940 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
942 % MagickBlurImage() blurs an image. We convolve the image with a
943 % gaussian operator of the given radius and standard deviation (sigma).
944 % For reasonable results, the radius should be larger than sigma. Use a
945 % radius of 0 and BlurImage() selects a suitable radius for you.
947 % The format of the MagickBlurImage method is:
949 % MagickBooleanType MagickBlurImage(MagickWand *wand,const double radius,
950 % const double sigma)
952 % A description of each parameter follows:
954 % o wand: the magick wand.
956 % o radius: the radius of the , in pixels, not counting the center
959 % o sigma: the standard deviation of the , in pixels.
962 WandExport MagickBooleanType MagickBlurImage(MagickWand *wand,
963 const double radius,const double sigma)
968 assert(wand != (MagickWand *) NULL);
969 assert(wand->signature == MagickWandSignature);
970 if (IfMagickTrue(wand->debug))
971 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
972 if (wand->images == (Image *) NULL)
973 ThrowWandException(WandError,"ContainsNoImages",wand->name);
974 blur_image=BlurImage(wand->images,radius,sigma,wand->exception);
975 if (blur_image == (Image *) NULL)
977 ReplaceImageInList(&wand->images,blur_image);
982 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
986 % M a g i c k B o r d e r I m a g e %
990 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
992 % MagickBorderImage() surrounds the image with a border of the color defined
993 % by the bordercolor pixel wand.
995 % The format of the MagickBorderImage method is:
997 % MagickBooleanType MagickBorderImage(MagickWand *wand,
998 % const PixelWand *bordercolor,const size_t width,
999 % const size_t height,const CompositeOperator compose)
1001 % A description of each parameter follows:
1003 % o wand: the magick wand.
1005 % o bordercolor: the border color pixel wand.
1007 % o width: the border width.
1009 % o height: the border height.
1011 % o compose: the composite operator.
1014 WandExport MagickBooleanType MagickBorderImage(MagickWand *wand,
1015 const PixelWand *bordercolor,const size_t width,const size_t height,
1016 const CompositeOperator compose)
1024 assert(wand != (MagickWand *) NULL);
1025 assert(wand->signature == MagickWandSignature);
1026 if (IfMagickTrue(wand->debug))
1027 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1028 if (wand->images == (Image *) NULL)
1029 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1030 border_info.width=width;
1031 border_info.height=height;
1034 PixelGetQuantumPacket(bordercolor,&wand->images->border_color);
1035 border_image=BorderImage(wand->images,&border_info,compose,wand->exception);
1036 if (border_image == (Image *) NULL)
1037 return(MagickFalse);
1038 ReplaceImageInList(&wand->images,border_image);
1043 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1047 % M a g i c k B r i g h t n e s s C o n t r a s t S t r e t c h I m a g e %
1051 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1053 % Use MagickBrightnessContrastImage() to change the brightness and/or contrast
1054 % of an image. It converts the brightness and contrast parameters into slope
1055 % and intercept and calls a polynomical function to apply to the image.
1058 % The format of the MagickBrightnessContrastImage method is:
1060 % MagickBooleanType MagickBrightnessContrastImage(MagickWand *wand,
1061 % const double brightness,const double contrast)
1063 % A description of each parameter follows:
1065 % o wand: the magick wand.
1067 % o brightness: the brightness percent (-100 .. 100).
1069 % o contrast: the contrast percent (-100 .. 100).
1072 WandExport MagickBooleanType MagickBrightnessContrastImage(
1073 MagickWand *wand,const double brightness,const double contrast)
1078 assert(wand != (MagickWand *) NULL);
1079 assert(wand->signature == MagickWandSignature);
1080 if (IfMagickTrue(wand->debug))
1081 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1082 if (wand->images == (Image *) NULL)
1083 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1084 status=BrightnessContrastImage(wand->images,brightness,contrast,
1090 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1094 % M a g i c k C h a n n e l F x I m a g e %
1098 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1100 % MagickChannelFxImage() applies a channel expression to the specified image.
1101 % The expression consists of one or more channels, either mnemonic or numeric
1102 % (e.g. red, 1), separated by actions as follows:
1104 % <=> exchange two channels (e.g. red<=>blue)
1105 % => transfer a channel to another (e.g. red=>green)
1106 % , separate channel operations (e.g. red, green)
1107 % | read channels from next input image (e.g. red | green)
1108 % ; write channels to next output image (e.g. red; green; blue)
1110 % A channel without a operation symbol implies extract. For example, to create
1111 % 3 grayscale images from the red, green, and blue channels of an image, use:
1113 % -channel-fx "red; green; blue"
1115 % The format of the MagickChannelFxImage method is:
1117 % MagickWand *MagickChannelFxImage(MagickWand *wand,const char *expression)
1119 % A description of each parameter follows:
1121 % o wand: the magick wand.
1123 % o expression: the expression.
1126 WandExport MagickWand *MagickChannelFxImage(MagickWand *wand,
1127 const char *expression)
1132 assert(wand != (MagickWand *) NULL);
1133 assert(wand->signature == MagickWandSignature);
1134 if (IfMagickTrue(wand->debug))
1135 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1136 if (wand->images == (Image *) NULL)
1137 return((MagickWand *) NULL);
1138 fx_image=ChannelFxImage(wand->images,expression,wand->exception);
1139 if (fx_image == (Image *) NULL)
1140 return((MagickWand *) NULL);
1141 return(CloneMagickWandFromImages(wand,fx_image));
1145 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1149 % M a g i c k C h a r c o a l I m a g e %
1153 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1155 % MagickCharcoalImage() simulates a charcoal drawing.
1157 % The format of the MagickCharcoalImage method is:
1159 % MagickBooleanType MagickCharcoalImage(MagickWand *wand,
1160 % const double radius,const double sigma)
1162 % A description of each parameter follows:
1164 % o wand: the magick wand.
1166 % o radius: the radius of the Gaussian, in pixels, not counting the center
1169 % o sigma: the standard deviation of the Gaussian, in pixels.
1172 WandExport MagickBooleanType MagickCharcoalImage(MagickWand *wand,
1173 const double radius,const double sigma)
1178 assert(wand != (MagickWand *) NULL);
1179 assert(wand->signature == MagickWandSignature);
1180 if (IfMagickTrue(wand->debug))
1181 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1182 if (wand->images == (Image *) NULL)
1183 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1184 charcoal_image=CharcoalImage(wand->images,radius,sigma,wand->exception);
1185 if (charcoal_image == (Image *) NULL)
1186 return(MagickFalse);
1187 ReplaceImageInList(&wand->images,charcoal_image);
1192 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1196 % M a g i c k C h o p I m a g e %
1200 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1202 % MagickChopImage() removes a region of an image and collapses the image to
1203 % occupy the removed portion
1205 % The format of the MagickChopImage method is:
1207 % MagickBooleanType MagickChopImage(MagickWand *wand,
1208 % const size_t width,const size_t height,const ssize_t x,
1211 % A description of each parameter follows:
1213 % o wand: the magick wand.
1215 % o width: the region width.
1217 % o height: the region height.
1219 % o x: the region x offset.
1221 % o y: the region y offset.
1225 WandExport MagickBooleanType MagickChopImage(MagickWand *wand,
1226 const size_t width,const size_t height,const ssize_t x,
1235 assert(wand != (MagickWand *) NULL);
1236 assert(wand->signature == MagickWandSignature);
1237 if (IfMagickTrue(wand->debug))
1238 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1239 if (wand->images == (Image *) NULL)
1240 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1245 chop_image=ChopImage(wand->images,&chop,wand->exception);
1246 if (chop_image == (Image *) NULL)
1247 return(MagickFalse);
1248 ReplaceImageInList(&wand->images,chop_image);
1253 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1257 % M a g i c k C l a m p I m a g e %
1261 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1263 % MagickClampImage() restricts the color range from 0 to the quantum depth.
1265 % The format of the MagickClampImage method is:
1267 % MagickBooleanType MagickClampImage(MagickWand *wand)
1269 % A description of each parameter follows:
1271 % o wand: the magick wand.
1273 % o channel: the channel.
1276 WandExport MagickBooleanType MagickClampImage(MagickWand *wand)
1278 assert(wand != (MagickWand *) NULL);
1279 assert(wand->signature == MagickWandSignature);
1280 if (IfMagickTrue(wand->debug))
1281 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1282 if (wand->images == (Image *) NULL)
1283 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1284 return(ClampImage(wand->images,wand->exception));
1288 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1292 % M a g i c k C l i p I m a g e %
1296 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1298 % MagickClipImage() clips along the first path from the 8BIM profile, if
1301 % The format of the MagickClipImage method is:
1303 % MagickBooleanType MagickClipImage(MagickWand *wand)
1305 % A description of each parameter follows:
1307 % o wand: the magick wand.
1310 WandExport MagickBooleanType MagickClipImage(MagickWand *wand)
1315 assert(wand != (MagickWand *) NULL);
1316 assert(wand->signature == MagickWandSignature);
1317 if (IfMagickTrue(wand->debug))
1318 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1319 if (wand->images == (Image *) NULL)
1320 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1321 status=ClipImage(wand->images,wand->exception);
1326 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1330 % M a g i c k C l i p I m a g e P a t h %
1334 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1336 % MagickClipImagePath() clips along the named paths from the 8BIM profile, if
1337 % present. Later operations take effect inside the path. Id may be a number
1338 % if preceded with #, to work on a numbered path, e.g., "#1" to use the first
1341 % The format of the MagickClipImagePath method is:
1343 % MagickBooleanType MagickClipImagePath(MagickWand *wand,
1344 % const char *pathname,const MagickBooleanType inside)
1346 % A description of each parameter follows:
1348 % o wand: the magick wand.
1350 % o pathname: name of clipping path resource. If name is preceded by #, use
1351 % clipping path numbered by name.
1353 % o inside: if non-zero, later operations take effect inside clipping path.
1354 % Otherwise later operations take effect outside clipping path.
1357 WandExport MagickBooleanType MagickClipImagePath(MagickWand *wand,
1358 const char *pathname,const MagickBooleanType inside)
1363 assert(wand != (MagickWand *) NULL);
1364 assert(wand->signature == MagickWandSignature);
1365 if (IfMagickTrue(wand->debug))
1366 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1367 if (wand->images == (Image *) NULL)
1368 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1369 status=ClipImagePath(wand->images,pathname,inside,wand->exception);
1374 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1378 % M a g i c k C l u t I m a g e %
1382 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1384 % MagickClutImage() replaces colors in the image from a color lookup table.
1386 % The format of the MagickClutImage method is:
1388 % MagickBooleanType MagickClutImage(MagickWand *wand,
1389 % const MagickWand *clut_wand,const PixelInterpolateMethod method)
1391 % A description of each parameter follows:
1393 % o wand: the magick wand.
1395 % o clut_image: the clut image.
1397 % o method: the pixel interpolation method.
1400 WandExport MagickBooleanType MagickClutImage(MagickWand *wand,
1401 const MagickWand *clut_wand,const PixelInterpolateMethod method)
1406 assert(wand != (MagickWand *) NULL);
1407 assert(wand->signature == MagickWandSignature);
1408 if (IfMagickTrue(wand->debug))
1409 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1410 if ((wand->images == (Image *) NULL) || (clut_wand->images == (Image *) NULL))
1411 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1412 status=ClutImage(wand->images,clut_wand->images,method,wand->exception);
1417 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1421 % M a g i c k C o a l e s c e I m a g e s %
1425 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1427 % MagickCoalesceImages() composites a set of images while respecting any page
1428 % offsets and disposal methods. GIF, MIFF, and MNG animation sequences
1429 % typically start with an image background and each subsequent image
1430 % varies in size and offset. MagickCoalesceImages() returns a new sequence
1431 % where each image in the sequence is the same size as the first and
1432 % composited with the next image in the sequence.
1434 % The format of the MagickCoalesceImages method is:
1436 % MagickWand *MagickCoalesceImages(MagickWand *wand)
1438 % A description of each parameter follows:
1440 % o wand: the magick wand.
1443 WandExport MagickWand *MagickCoalesceImages(MagickWand *wand)
1448 assert(wand != (MagickWand *) NULL);
1449 assert(wand->signature == MagickWandSignature);
1450 if (IfMagickTrue(wand->debug))
1451 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1452 if (wand->images == (Image *) NULL)
1453 return((MagickWand *) NULL);
1454 coalesce_image=CoalesceImages(wand->images,wand->exception);
1455 if (coalesce_image == (Image *) NULL)
1456 return((MagickWand *) NULL);
1457 return(CloneMagickWandFromImages(wand,coalesce_image));
1461 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1465 % M a g i c k C o l o r D e c i s i o n I m a g e %
1469 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1471 % MagickColorDecisionListImage() accepts a lightweight Color Correction
1472 % Collection (CCC) file which solely contains one or more color corrections
1473 % and applies the color correction to the image. Here is a sample CCC file:
1475 % <ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2">
1476 % <ColorCorrection id="cc03345">
1478 % <Slope> 0.9 1.2 0.5 </Slope>
1479 % <Offset> 0.4 -0.5 0.6 </Offset>
1480 % <Power> 1.0 0.8 1.5 </Power>
1483 % <Saturation> 0.85 </Saturation>
1485 % </ColorCorrection>
1486 % </ColorCorrectionCollection>
1488 % which includes the offset, slope, and power for each of the RGB channels
1489 % as well as the saturation.
1491 % The format of the MagickColorDecisionListImage method is:
1493 % MagickBooleanType MagickColorDecisionListImage(MagickWand *wand,
1494 % const char *color_correction_collection)
1496 % A description of each parameter follows:
1498 % o wand: the magick wand.
1500 % o color_correction_collection: the color correction collection in XML.
1503 WandExport MagickBooleanType MagickColorDecisionListImage(MagickWand *wand,
1504 const char *color_correction_collection)
1509 assert(wand != (MagickWand *) NULL);
1510 assert(wand->signature == MagickWandSignature);
1511 if (IfMagickTrue(wand->debug))
1512 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1513 if (wand->images == (Image *) NULL)
1514 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1515 status=ColorDecisionListImage(wand->images,color_correction_collection,
1521 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1525 % M a g i c k C o l o r i z e I m a g e %
1529 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1531 % MagickColorizeImage() blends the fill color with each pixel in the image.
1533 % The format of the MagickColorizeImage method is:
1535 % MagickBooleanType MagickColorizeImage(MagickWand *wand,
1536 % const PixelWand *colorize,const PixelWand *blend)
1538 % A description of each parameter follows:
1540 % o wand: the magick wand.
1542 % o colorize: the colorize pixel wand.
1544 % o alpha: the alpha pixel wand.
1547 WandExport MagickBooleanType MagickColorizeImage(MagickWand *wand,
1548 const PixelWand *colorize,const PixelWand *blend)
1551 percent_blend[MagickPathExtent];
1559 assert(wand != (MagickWand *) NULL);
1560 assert(wand->signature == MagickWandSignature);
1561 if (IfMagickTrue(wand->debug))
1562 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1563 if (wand->images == (Image *) NULL)
1564 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1565 GetPixelInfo(wand->images,&target);
1566 if (target.colorspace != CMYKColorspace)
1567 (void) FormatLocaleString(percent_blend,MagickPathExtent,
1568 "%g,%g,%g,%g",(double) (100.0*QuantumScale*
1569 PixelGetRedQuantum(blend)),(double) (100.0*QuantumScale*
1570 PixelGetGreenQuantum(blend)),(double) (100.0*QuantumScale*
1571 PixelGetBlueQuantum(blend)),(double) (100.0*QuantumScale*
1572 PixelGetAlphaQuantum(blend)));
1574 (void) FormatLocaleString(percent_blend,MagickPathExtent,
1575 "%g,%g,%g,%g,%g",(double) (100.0*QuantumScale*
1576 PixelGetRedQuantum(blend)),(double) (100.0*QuantumScale*
1577 PixelGetGreenQuantum(blend)),(double) (100.0*QuantumScale*
1578 PixelGetBlueQuantum(blend)),(double) (100.0*QuantumScale*
1579 PixelGetBlackQuantum(blend)),(double) (100.0*QuantumScale*
1580 PixelGetAlphaQuantum(blend)));
1581 target=PixelGetPixel(colorize);
1582 colorize_image=ColorizeImage(wand->images,percent_blend,&target,
1584 if (colorize_image == (Image *) NULL)
1585 return(MagickFalse);
1586 ReplaceImageInList(&wand->images,colorize_image);
1591 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1595 % M a g i c k C o l o r M a t r i x I m a g e %
1599 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1601 % MagickColorMatrixImage() apply color transformation to an image. The method
1602 % permits saturation changes, hue rotation, luminance to alpha, and various
1603 % other effects. Although variable-sized transformation matrices can be used,
1604 % typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA
1605 % (or RGBA with offsets). The matrix is similar to those used by Adobe Flash
1606 % except offsets are in column 6 rather than 5 (in support of CMYKA images)
1607 % and offsets are normalized (divide Flash offset by 255).
1609 % The format of the MagickColorMatrixImage method is:
1611 % MagickBooleanType MagickColorMatrixImage(MagickWand *wand,
1612 % const KernelInfo *color_matrix)
1614 % A description of each parameter follows:
1616 % o wand: the magick wand.
1618 % o color_matrix: the color matrix.
1621 WandExport MagickBooleanType MagickColorMatrixImage(MagickWand *wand,
1622 const KernelInfo *color_matrix)
1627 assert(wand != (MagickWand *) NULL);
1628 assert(wand->signature == MagickWandSignature);
1629 if (IfMagickTrue(wand->debug))
1630 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1631 if (color_matrix == (const KernelInfo *) NULL)
1632 return(MagickFalse);
1633 if (wand->images == (Image *) NULL)
1634 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1635 color_image=ColorMatrixImage(wand->images,color_matrix,wand->exception);
1636 if (color_image == (Image *) NULL)
1637 return(MagickFalse);
1638 ReplaceImageInList(&wand->images,color_image);
1643 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1647 % M a g i c k C o m b i n e I m a g e s %
1651 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1653 % MagickCombineImages() combines one or more images into a single image. The
1654 % grayscale value of the pixels of each image in the sequence is assigned in
1655 % order to the specified hannels of the combined image. The typical
1656 % ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.
1658 % The format of the MagickCombineImages method is:
1660 % MagickWand *MagickCombineImages(MagickWand *wand,
1661 % const ColorspaceType colorspace)
1663 % A description of each parameter follows:
1665 % o wand: the magick wand.
1667 % o colorspace: the colorspace.
1670 WandExport MagickWand *MagickCombineImages(MagickWand *wand,
1671 const ColorspaceType colorspace)
1676 assert(wand != (MagickWand *) NULL);
1677 assert(wand->signature == MagickWandSignature);
1678 if (IfMagickTrue(wand->debug))
1679 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1680 if (wand->images == (Image *) NULL)
1681 return((MagickWand *) NULL);
1682 combine_image=CombineImages(wand->images,colorspace,wand->exception);
1683 if (combine_image == (Image *) NULL)
1684 return((MagickWand *) NULL);
1685 return(CloneMagickWandFromImages(wand,combine_image));
1689 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1693 % M a g i c k C o m m e n t I m a g e %
1697 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1699 % MagickCommentImage() adds a comment to your image.
1701 % The format of the MagickCommentImage method is:
1703 % MagickBooleanType MagickCommentImage(MagickWand *wand,
1704 % const char *comment)
1706 % A description of each parameter follows:
1708 % o wand: the magick wand.
1710 % o comment: the image comment.
1713 WandExport MagickBooleanType MagickCommentImage(MagickWand *wand,
1714 const char *comment)
1719 assert(wand != (MagickWand *) NULL);
1720 assert(wand->signature == MagickWandSignature);
1721 if (IfMagickTrue(wand->debug))
1722 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1723 if (wand->images == (Image *) NULL)
1724 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1725 status=SetImageProperty(wand->images,"comment",comment,wand->exception);
1730 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1734 % M a g i c k C o m p a r e I m a g e L a y e r s %
1738 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1740 % MagickCompareImagesLayers() compares each image with the next in a sequence
1741 % and returns the maximum bounding region of any pixel differences it
1744 % The format of the MagickCompareImagesLayers method is:
1746 % MagickWand *MagickCompareImagesLayers(MagickWand *wand,
1747 % const LayerMethod method)
1749 % A description of each parameter follows:
1751 % o wand: the magick wand.
1753 % o method: the compare method.
1756 WandExport MagickWand *MagickCompareImagesLayers(MagickWand *wand,
1757 const LayerMethod method)
1762 assert(wand != (MagickWand *) NULL);
1763 assert(wand->signature == MagickWandSignature);
1764 if (IfMagickTrue(wand->debug))
1765 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1766 if (wand->images == (Image *) NULL)
1767 return((MagickWand *) NULL);
1768 layers_image=CompareImagesLayers(wand->images,method,wand->exception);
1769 if (layers_image == (Image *) NULL)
1770 return((MagickWand *) NULL);
1771 return(CloneMagickWandFromImages(wand,layers_image));
1775 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1779 % M a g i c k C o m p a r e I m a g e s %
1783 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1785 % MagickCompareImages() compares an image to a reconstructed image and returns
1786 % the specified difference image.
1788 % The format of the MagickCompareImages method is:
1790 % MagickWand *MagickCompareImages(MagickWand *wand,
1791 % const MagickWand *reference,const MetricType metric,
1792 % double *distortion)
1794 % A description of each parameter follows:
1796 % o wand: the magick wand.
1798 % o reference: the reference wand.
1800 % o metric: the metric.
1802 % o distortion: the computed distortion between the images.
1805 WandExport MagickWand *MagickCompareImages(MagickWand *wand,
1806 const MagickWand *reference,const MetricType metric,double *distortion)
1812 assert(wand != (MagickWand *) NULL);
1813 assert(wand->signature == MagickWandSignature);
1814 if (IfMagickTrue(wand->debug))
1815 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1816 if ((wand->images == (Image *) NULL) || (reference->images == (Image *) NULL))
1818 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
1819 "ContainsNoImages","`%s'",wand->name);
1820 return((MagickWand *) NULL);
1822 compare_image=CompareImages(wand->images,reference->images,metric,distortion,
1824 if (compare_image == (Image *) NULL)
1825 return((MagickWand *) NULL);
1826 return(CloneMagickWandFromImages(wand,compare_image));
1830 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1834 % M a g i c k C o m p o s i t e I m a g e %
1838 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1840 % MagickCompositeImage() composite one image onto another at the specified
1843 % The format of the MagickCompositeImage method is:
1845 % MagickBooleanType MagickCompositeImage(MagickWand *wand,
1846 % const MagickWand *source_wand,const CompositeOperator compose,
1847 % const MagickBooleanType clip_to_self,const ssize_t x,const ssize_t y)
1849 % A description of each parameter follows:
1851 % o wand: the magick wand holding the destination images
1853 % o source_image: the magick wand holding source image.
1855 % o compose: This operator affects how the composite is applied to the
1856 % image. The default is Over. These are some of the compose methods
1859 % OverCompositeOp InCompositeOp OutCompositeOp
1860 % AtopCompositeOp XorCompositeOp PlusCompositeOp
1861 % MinusCompositeOp AddCompositeOp SubtractCompositeOp
1862 % DifferenceCompositeOp BumpmapCompositeOp CopyCompositeOp
1863 % DisplaceCompositeOp
1865 % o clip_to_self: set to MagickTrue to limit composition to area composed.
1867 % o x: the column offset of the composited image.
1869 % o y: the row offset of the composited image.
1872 WandExport MagickBooleanType MagickCompositeImage(MagickWand *wand,
1873 const MagickWand *source_wand,const CompositeOperator compose,
1874 const MagickBooleanType clip_to_self,const ssize_t x,const ssize_t y)
1879 assert(wand != (MagickWand *) NULL);
1880 assert(wand->signature == MagickWandSignature);
1881 if (IfMagickTrue(wand->debug))
1882 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1883 if ((wand->images == (Image *) NULL) ||
1884 (source_wand->images == (Image *) NULL))
1885 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1886 status=CompositeImage(wand->images,source_wand->images,compose,clip_to_self,
1887 x,y,wand->exception);
1892 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1896 % M a g i c k C o m p o s i t e I m a g e G r a v i t y %
1900 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1902 % MagickCompositeImageGravity() composite one image onto another using the
1903 % specified gravity.
1905 % The format of the MagickCompositeImageGravity method is:
1907 % MagickBooleanType MagickCompositeImageGravity(MagickWand *wand,
1908 % const MagickWand *source_wand,const CompositeOperator compose,
1909 % const GravityType gravity)
1911 % A description of each parameter follows:
1913 % o wand: the magick wand holding the destination images
1915 % o source_image: the magick wand holding source image.
1917 % o compose: This operator affects how the composite is applied to the
1918 % image. The default is Over. These are some of the compose methods
1921 % OverCompositeOp InCompositeOp OutCompositeOp
1922 % AtopCompositeOp XorCompositeOp PlusCompositeOp
1923 % MinusCompositeOp AddCompositeOp SubtractCompositeOp
1924 % DifferenceCompositeOp BumpmapCompositeOp CopyCompositeOp
1925 % DisplaceCompositeOp
1927 % o gravity: positioning gravity (NorthWestGravity, NorthGravity,
1928 % NorthEastGravity, WestGravity, CenterGravity,
1929 % EastGravity, SouthWestGravity, SouthGravity,
1933 WandExport MagickBooleanType MagickCompositeImageGravity(MagickWand *wand,
1934 const MagickWand *source_wand,const CompositeOperator compose,
1935 const GravityType gravity)
1943 assert(wand != (MagickWand *) NULL);
1944 assert(wand->signature == MagickWandSignature);
1945 if (IfMagickTrue(wand->debug))
1946 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
1947 if ((wand->images == (Image *) NULL) ||
1948 (source_wand->images == (Image *) NULL))
1949 ThrowWandException(WandError,"ContainsNoImages",wand->name);
1950 SetGeometry(source_wand->images,&geometry);
1951 GravityAdjustGeometry(wand->images->columns,wand->images->rows,gravity,
1953 status=CompositeImage(wand->images,source_wand->images,compose,MagickTrue,
1954 geometry.x,geometry.y,wand->exception);
1959 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1963 % M a g i c k C o m p o s i t e L a y e r s %
1967 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1969 % MagickCompositeLayers() composite the images in the source wand over the
1970 % images in the destination wand in sequence, starting with the current
1971 % image in both lists.
1973 % Each layer from the two image lists are composted together until the end of
1974 % one of the image lists is reached. The offset of each composition is also
1975 % adjusted to match the virtual canvas offsets of each layer. As such the
1976 % given offset is relative to the virtual canvas, and not the actual image.
1978 % Composition uses given x and y offsets, as the 'origin' location of the
1979 % source images virtual canvas (not the real image) allowing you to compose a
1980 % list of 'layer images' into the destiantioni images. This makes it well
1981 % sutiable for directly composing 'Clears Frame Animations' or 'Coaleased
1982 % Animations' onto a static or other 'Coaleased Animation' destination image
1983 % list. GIF disposal handling is not looked at.
1985 % Special case:- If one of the image sequences is the last image (just a
1986 % single image remaining), that image is repeatally composed with all the
1987 % images in the other image list. Either the source or destination lists may
1988 % be the single image, for this situation.
1990 % In the case of a single destination image (or last image given), that image
1991 % will ve cloned to match the number of images remaining in the source image
1994 % This is equivelent to the "-layer Composite" Shell API operator.
1996 % The format of the MagickCompositeLayers method is:
1998 % MagickBooleanType MagickCompositeLayers(MagickWand *wand,
1999 % const MagickWand *source_wand, const CompositeOperator compose,
2000 % const ssize_t x,const ssize_t y)
2002 % A description of each parameter follows:
2004 % o wand: the magick wand holding destaintion images
2006 % o source_wand: the wand holding the source images
2008 % o compose, x, y: composition arguments
2011 WandExport MagickBooleanType MagickCompositeLayers(MagickWand *wand,
2012 const MagickWand *source_wand,const CompositeOperator compose,
2013 const ssize_t x,const ssize_t y)
2018 assert(wand != (MagickWand *) NULL);
2019 assert(wand->signature == MagickWandSignature);
2020 if (IfMagickTrue(wand->debug))
2021 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2022 if ((wand->images == (Image *) NULL) ||
2023 (source_wand->images == (Image *) NULL))
2024 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2025 CompositeLayers(wand->images,compose,source_wand->images,x,y,wand->exception);
2026 status=MagickTrue; /* FUTURE: determine status from exceptions */
2031 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2035 % M a g i c k C o n t r a s t I m a g e %
2039 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2041 % MagickContrastImage() enhances the intensity differences between the lighter
2042 % and darker elements of the image. Set sharpen to a value other than 0 to
2043 % increase the image contrast otherwise the contrast is reduced.
2045 % The format of the MagickContrastImage method is:
2047 % MagickBooleanType MagickContrastImage(MagickWand *wand,
2048 % const MagickBooleanType sharpen)
2050 % A description of each parameter follows:
2052 % o wand: the magick wand.
2054 % o sharpen: Increase or decrease image contrast.
2058 WandExport MagickBooleanType MagickContrastImage(MagickWand *wand,
2059 const MagickBooleanType sharpen)
2064 assert(wand != (MagickWand *) NULL);
2065 assert(wand->signature == MagickWandSignature);
2066 if (IfMagickTrue(wand->debug))
2067 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2068 if (wand->images == (Image *) NULL)
2069 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2070 status=ContrastImage(wand->images,sharpen,wand->exception);
2075 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2079 % M a g i c k C o n t r a s t S t r e t c h I m a g e %
2083 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2085 % MagickContrastStretchImage() enhances the contrast of a color image by
2086 % adjusting the pixels color to span the entire range of colors available.
2087 % You can also reduce the influence of a particular channel with a gamma
2090 % The format of the MagickContrastStretchImage method is:
2092 % MagickBooleanType MagickContrastStretchImage(MagickWand *wand,
2093 % const double black_point,const double white_point)
2095 % A description of each parameter follows:
2097 % o wand: the magick wand.
2099 % o black_point: the black point.
2101 % o white_point: the white point.
2104 WandExport MagickBooleanType MagickContrastStretchImage(MagickWand *wand,
2105 const double black_point,const double white_point)
2110 assert(wand != (MagickWand *) NULL);
2111 assert(wand->signature == MagickWandSignature);
2112 if (IfMagickTrue(wand->debug))
2113 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2114 if (wand->images == (Image *) NULL)
2115 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2116 status=ContrastStretchImage(wand->images,black_point,white_point,
2122 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2126 % M a g i c k C o n v o l v e I m a g e %
2130 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2132 % MagickConvolveImage() applies a custom convolution kernel to the image.
2134 % The format of the MagickConvolveImage method is:
2136 % MagickBooleanType MagickConvolveImage(MagickWand *wand,
2137 % const KernelInfo *kernel)
2139 % A description of each parameter follows:
2141 % o wand: the magick wand.
2143 % o kernel: An array of doubles representing the convolution kernel.
2146 WandExport MagickBooleanType MagickConvolveImage(MagickWand *wand,
2147 const KernelInfo *kernel)
2152 assert(wand != (MagickWand *) NULL);
2153 assert(wand->signature == MagickWandSignature);
2154 if (IfMagickTrue(wand->debug))
2155 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2156 if (kernel == (const KernelInfo *) NULL)
2157 return(MagickFalse);
2158 if (wand->images == (Image *) NULL)
2159 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2160 filter_image=ConvolveImage(wand->images,kernel,wand->exception);
2161 if (filter_image == (Image *) NULL)
2162 return(MagickFalse);
2163 ReplaceImageInList(&wand->images,filter_image);
2168 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2172 % M a g i c k C r o p I m a g e %
2176 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2178 % MagickCropImage() extracts a region of the image.
2180 % The format of the MagickCropImage method is:
2182 % MagickBooleanType MagickCropImage(MagickWand *wand,
2183 % const size_t width,const size_t height,const ssize_t x,const ssize_t y)
2185 % A description of each parameter follows:
2187 % o wand: the magick wand.
2189 % o width: the region width.
2191 % o height: the region height.
2193 % o x: the region x-offset.
2195 % o y: the region y-offset.
2198 WandExport MagickBooleanType MagickCropImage(MagickWand *wand,
2199 const size_t width,const size_t height,const ssize_t x,const ssize_t y)
2207 assert(wand != (MagickWand *) NULL);
2208 assert(wand->signature == MagickWandSignature);
2209 if (IfMagickTrue(wand->debug))
2210 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2211 if (wand->images == (Image *) NULL)
2212 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2217 crop_image=CropImage(wand->images,&crop,wand->exception);
2218 if (crop_image == (Image *) NULL)
2219 return(MagickFalse);
2220 ReplaceImageInList(&wand->images,crop_image);
2225 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2229 % M a g i c k C y c l e C o l o r m a p I m a g e %
2233 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2235 % MagickCycleColormapImage() displaces an image's colormap by a given number
2236 % of positions. If you cycle the colormap a number of times you can produce
2237 % a psychodelic effect.
2239 % The format of the MagickCycleColormapImage method is:
2241 % MagickBooleanType MagickCycleColormapImage(MagickWand *wand,
2242 % const ssize_t displace)
2244 % A description of each parameter follows:
2246 % o wand: the magick wand.
2248 % o pixel_wand: the pixel wand.
2251 WandExport MagickBooleanType MagickCycleColormapImage(MagickWand *wand,
2252 const ssize_t displace)
2257 assert(wand != (MagickWand *) NULL);
2258 assert(wand->signature == MagickWandSignature);
2259 if (IfMagickTrue(wand->debug))
2260 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2261 if (wand->images == (Image *) NULL)
2262 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2263 status=CycleColormapImage(wand->images,displace,wand->exception);
2268 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2272 % M a g i c k C o n s t i t u t e I m a g e %
2276 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2278 % MagickConstituteImage() adds an image to the wand comprised of the pixel
2279 % data you supply. The pixel data must be in scanline order top-to-bottom.
2280 % The data can be char, short int, int, float, or double. Float and double
2281 % require the pixels to be normalized [0..1], otherwise [0..Max], where Max
2282 % is the maximum value the type can accomodate (e.g. 255 for char). For
2283 % example, to create a 640x480 image from unsigned red-green-blue character
2286 % MagickConstituteImage(wand,640,640,"RGB",CharPixel,pixels);
2288 % The format of the MagickConstituteImage method is:
2290 % MagickBooleanType MagickConstituteImage(MagickWand *wand,
2291 % const size_t columns,const size_t rows,const char *map,
2292 % const StorageType storage,void *pixels)
2294 % A description of each parameter follows:
2296 % o wand: the magick wand.
2298 % o columns: width in pixels of the image.
2300 % o rows: height in pixels of the image.
2302 % o map: This string reflects the expected ordering of the pixel array.
2303 % It can be any combination or order of R = red, G = green, B = blue,
2304 % A = alpha (0 is transparent), O = alpha (0 is opaque), C = cyan,
2305 % Y = yellow, M = magenta, K = black, I = intensity (for grayscale),
2308 % o storage: Define the data type of the pixels. Float and double types are
2309 % expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from
2310 % these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel,
2311 % LongPixel, QuantumPixel, or ShortPixel.
2313 % o pixels: This array of values contain the pixel components as defined by
2314 % map and type. You must preallocate this array where the expected
2315 % length varies depending on the values of width, height, map, and type.
2319 WandExport MagickBooleanType MagickConstituteImage(MagickWand *wand,
2320 const size_t columns,const size_t rows,const char *map,
2321 const StorageType storage,const void *pixels)
2326 assert(wand != (MagickWand *) NULL);
2327 assert(wand->signature == MagickWandSignature);
2328 if (IfMagickTrue(wand->debug))
2329 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2330 images=ConstituteImage(columns,rows,map,storage,pixels,wand->exception);
2331 if (images == (Image *) NULL)
2332 return(MagickFalse);
2333 return(InsertImageInWand(wand,images));
2337 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2341 % M a g i c k D e c i p h e r I m a g e %
2345 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2347 % MagickDecipherImage() converts cipher pixels to plain pixels.
2349 % The format of the MagickDecipherImage method is:
2351 % MagickBooleanType MagickDecipherImage(MagickWand *wand,
2352 % const char *passphrase)
2354 % A description of each parameter follows:
2356 % o wand: the magick wand.
2358 % o passphrase: the passphrase.
2361 WandExport MagickBooleanType MagickDecipherImage(MagickWand *wand,
2362 const char *passphrase)
2364 assert(wand != (MagickWand *) NULL);
2365 assert(wand->signature == MagickWandSignature);
2366 if (IfMagickTrue(wand->debug))
2367 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2368 if (wand->images == (Image *) NULL)
2369 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2370 return(DecipherImage(wand->images,passphrase,wand->exception));
2374 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2378 % M a g i c k D e c o n s t r u c t I m a g e s %
2382 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2384 % MagickDeconstructImages() compares each image with the next in a sequence
2385 % and returns the maximum bounding region of any pixel differences it
2388 % The format of the MagickDeconstructImages method is:
2390 % MagickWand *MagickDeconstructImages(MagickWand *wand)
2392 % A description of each parameter follows:
2394 % o wand: the magick wand.
2397 WandExport MagickWand *MagickDeconstructImages(MagickWand *wand)
2402 assert(wand != (MagickWand *) NULL);
2403 assert(wand->signature == MagickWandSignature);
2404 if (IfMagickTrue(wand->debug))
2405 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2406 if (wand->images == (Image *) NULL)
2407 return((MagickWand *) NULL);
2408 deconstruct_image=CompareImagesLayers(wand->images,CompareAnyLayer,
2410 if (deconstruct_image == (Image *) NULL)
2411 return((MagickWand *) NULL);
2412 return(CloneMagickWandFromImages(wand,deconstruct_image));
2416 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2420 % M a g i c k D e s k e w I m a g e %
2424 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2426 % MagickDeskewImage() removes skew from the image. Skew is an artifact that
2427 % occurs in scanned images because of the camera being misaligned,
2428 % imperfections in the scanning or surface, or simply because the paper was
2429 % not placed completely flat when scanned.
2431 % The format of the MagickDeskewImage method is:
2433 % MagickBooleanType MagickDeskewImage(MagickWand *wand,
2434 % const double threshold)
2436 % A description of each parameter follows:
2438 % o wand: the magick wand.
2440 % o threshold: separate background from foreground.
2443 WandExport MagickBooleanType MagickDeskewImage(MagickWand *wand,
2444 const double threshold)
2449 assert(wand != (MagickWand *) NULL);
2450 assert(wand->signature == MagickWandSignature);
2451 if (IfMagickTrue(wand->debug))
2452 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2453 if (wand->images == (Image *) NULL)
2454 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2455 sepia_image=DeskewImage(wand->images,threshold,wand->exception);
2456 if (sepia_image == (Image *) NULL)
2457 return(MagickFalse);
2458 ReplaceImageInList(&wand->images,sepia_image);
2463 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2467 % M a g i c k D e s p e c k l e I m a g e %
2471 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2473 % MagickDespeckleImage() reduces the speckle noise in an image while
2474 % perserving the edges of the original image.
2476 % The format of the MagickDespeckleImage method is:
2478 % MagickBooleanType MagickDespeckleImage(MagickWand *wand)
2480 % A description of each parameter follows:
2482 % o wand: the magick wand.
2485 WandExport MagickBooleanType MagickDespeckleImage(MagickWand *wand)
2490 assert(wand != (MagickWand *) NULL);
2491 assert(wand->signature == MagickWandSignature);
2492 if (IfMagickTrue(wand->debug))
2493 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2494 if (wand->images == (Image *) NULL)
2495 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2496 despeckle_image=DespeckleImage(wand->images,wand->exception);
2497 if (despeckle_image == (Image *) NULL)
2498 return(MagickFalse);
2499 ReplaceImageInList(&wand->images,despeckle_image);
2504 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2508 % M a g i c k D e s t r o y I m a g e %
2512 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2514 % MagickDestroyImage() dereferences an image, deallocating memory associated
2515 % with the image if the reference count becomes zero.
2517 % The format of the MagickDestroyImage method is:
2519 % Image *MagickDestroyImage(Image *image)
2521 % A description of each parameter follows:
2523 % o image: the image.
2526 WandExport Image *MagickDestroyImage(Image *image)
2528 return(DestroyImage(image));
2532 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2536 % M a g i c k D i s p l a y I m a g e %
2540 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2542 % MagickDisplayImage() displays an image.
2544 % The format of the MagickDisplayImage method is:
2546 % MagickBooleanType MagickDisplayImage(MagickWand *wand,
2547 % const char *server_name)
2549 % A description of each parameter follows:
2551 % o wand: the magick wand.
2553 % o server_name: the X server name.
2556 WandExport MagickBooleanType MagickDisplayImage(MagickWand *wand,
2557 const char *server_name)
2565 assert(wand != (MagickWand *) NULL);
2566 assert(wand->signature == MagickWandSignature);
2567 if (IfMagickTrue(wand->debug))
2568 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2569 if (wand->images == (Image *) NULL)
2570 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2571 image=CloneImage(wand->images,0,0,MagickTrue,wand->exception);
2572 if (image == (Image *) NULL)
2573 return(MagickFalse);
2574 (void) CloneString(&wand->image_info->server_name,server_name);
2575 status=DisplayImages(wand->image_info,image,wand->exception);
2576 image=DestroyImage(image);
2581 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2585 % M a g i c k D i s p l a y I m a g e s %
2589 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2591 % MagickDisplayImages() displays an image or image sequence.
2593 % The format of the MagickDisplayImages method is:
2595 % MagickBooleanType MagickDisplayImages(MagickWand *wand,
2596 % const char *server_name)
2598 % A description of each parameter follows:
2600 % o wand: the magick wand.
2602 % o server_name: the X server name.
2605 WandExport MagickBooleanType MagickDisplayImages(MagickWand *wand,
2606 const char *server_name)
2611 assert(wand != (MagickWand *) NULL);
2612 assert(wand->signature == MagickWandSignature);
2613 if (IfMagickTrue(wand->debug))
2614 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2615 (void) CloneString(&wand->image_info->server_name,server_name);
2616 status=DisplayImages(wand->image_info,wand->images,wand->exception);
2621 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2625 % M a g i c k D i s t o r t I m a g e %
2629 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2631 % MagickDistortImage() distorts an image using various distortion methods, by
2632 % mapping color lookups of the source image to a new destination image
2633 % usally of the same size as the source image, unless 'bestfit' is set to
2636 % If 'bestfit' is enabled, and distortion allows it, the destination image is
2637 % adjusted to ensure the whole source 'image' will just fit within the final
2638 % destination image, which will be sized and offset accordingly. Also in
2639 % many cases the virtual offset of the source image will be taken into
2640 % account in the mapping.
2642 % The format of the MagickDistortImage method is:
2644 % MagickBooleanType MagickDistortImage(MagickWand *wand,
2645 % const DistortImageMethod method,const size_t number_arguments,
2646 % const double *arguments,const MagickBooleanType bestfit)
2648 % A description of each parameter follows:
2650 % o image: the image to be distorted.
2652 % o method: the method of image distortion.
2654 % ArcDistortion always ignores the source image offset, and always
2655 % 'bestfit' the destination image with the top left corner offset
2656 % relative to the polar mapping center.
2658 % Bilinear has no simple inverse mapping so it does not allow 'bestfit'
2659 % style of image distortion.
2661 % Affine, Perspective, and Bilinear, do least squares fitting of the
2662 % distortion when more than the minimum number of control point pairs
2665 % Perspective, and Bilinear, falls back to a Affine distortion when less
2666 % that 4 control point pairs are provided. While Affine distortions let
2667 % you use any number of control point pairs, that is Zero pairs is a
2668 % no-Op (viewport only) distrotion, one pair is a translation and two
2669 % pairs of control points do a scale-rotate-translate, without any
2672 % o number_arguments: the number of arguments given for this distortion
2675 % o arguments: the arguments for this distortion method.
2677 % o bestfit: Attempt to resize destination to fit distorted source.
2680 WandExport MagickBooleanType MagickDistortImage(MagickWand *wand,
2681 const DistortImageMethod method,const size_t number_arguments,
2682 const double *arguments,const MagickBooleanType bestfit)
2687 assert(wand != (MagickWand *) NULL);
2688 assert(wand->signature == MagickWandSignature);
2689 if (IfMagickTrue(wand->debug))
2690 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2691 if (wand->images == (Image *) NULL)
2692 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2693 distort_image=DistortImage(wand->images,method,number_arguments,arguments,
2694 bestfit,wand->exception);
2695 if (distort_image == (Image *) NULL)
2696 return(MagickFalse);
2697 ReplaceImageInList(&wand->images,distort_image);
2702 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2706 % M a g i c k D r a w I m a g e %
2710 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2712 % MagickDrawImage() renders the drawing wand on the current image.
2714 % The format of the MagickDrawImage method is:
2716 % MagickBooleanType MagickDrawImage(MagickWand *wand,
2717 % const DrawingWand *drawing_wand)
2719 % A description of each parameter follows:
2721 % o wand: the magick wand.
2723 % o drawing_wand: the draw wand.
2726 WandExport MagickBooleanType MagickDrawImage(MagickWand *wand,
2727 const DrawingWand *drawing_wand)
2738 assert(wand != (MagickWand *) NULL);
2739 assert(wand->signature == MagickWandSignature);
2740 if (IfMagickTrue(wand->debug))
2741 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2742 if (wand->images == (Image *) NULL)
2743 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2744 draw_info=PeekDrawingWand(drawing_wand);
2745 if ((draw_info == (DrawInfo *) NULL) ||
2746 (draw_info->primitive == (char *) NULL))
2747 return(MagickFalse);
2748 primitive=AcquireString(draw_info->primitive);
2749 draw_info=DestroyDrawInfo(draw_info);
2750 draw_info=CloneDrawInfo(wand->image_info,(DrawInfo *) NULL);
2751 draw_info->primitive=primitive;
2752 status=DrawImage(wand->images,draw_info,wand->exception);
2753 draw_info=DestroyDrawInfo(draw_info);
2758 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2762 % M a g i c k E d g e I m a g e %
2766 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2768 % MagickEdgeImage() enhance edges within the image with a convolution filter
2769 % of the given radius. Use a radius of 0 and Edge() selects a suitable
2772 % The format of the MagickEdgeImage method is:
2774 % MagickBooleanType MagickEdgeImage(MagickWand *wand,const double radius)
2776 % A description of each parameter follows:
2778 % o wand: the magick wand.
2780 % o radius: the radius of the pixel neighborhood.
2783 WandExport MagickBooleanType MagickEdgeImage(MagickWand *wand,
2784 const double radius)
2789 assert(wand != (MagickWand *) NULL);
2790 assert(wand->signature == MagickWandSignature);
2791 if (IfMagickTrue(wand->debug))
2792 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2793 if (wand->images == (Image *) NULL)
2794 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2795 edge_image=EdgeImage(wand->images,radius,wand->exception);
2796 if (edge_image == (Image *) NULL)
2797 return(MagickFalse);
2798 ReplaceImageInList(&wand->images,edge_image);
2803 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2807 % M a g i c k E m b o s s I m a g e %
2811 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2813 % MagickEmbossImage() returns a grayscale image with a three-dimensional
2814 % effect. We convolve the image with a Gaussian operator of the given radius
2815 % and standard deviation (sigma). For reasonable results, radius should be
2816 % larger than sigma. Use a radius of 0 and Emboss() selects a suitable
2819 % The format of the MagickEmbossImage method is:
2821 % MagickBooleanType MagickEmbossImage(MagickWand *wand,const double radius,
2822 % const double sigma)
2824 % A description of each parameter follows:
2826 % o wand: the magick wand.
2828 % o radius: the radius of the Gaussian, in pixels, not counting the center
2831 % o sigma: the standard deviation of the Gaussian, in pixels.
2834 WandExport MagickBooleanType MagickEmbossImage(MagickWand *wand,
2835 const double radius,const double sigma)
2840 assert(wand != (MagickWand *) NULL);
2841 assert(wand->signature == MagickWandSignature);
2842 if (IfMagickTrue(wand->debug))
2843 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2844 if (wand->images == (Image *) NULL)
2845 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2846 emboss_image=EmbossImage(wand->images,radius,sigma,wand->exception);
2847 if (emboss_image == (Image *) NULL)
2848 return(MagickFalse);
2849 ReplaceImageInList(&wand->images,emboss_image);
2854 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2858 % M a g i c k E n c i p h e r I m a g e %
2862 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2864 % MagickEncipherImage() converts plaint pixels to cipher pixels.
2866 % The format of the MagickEncipherImage method is:
2868 % MagickBooleanType MagickEncipherImage(MagickWand *wand,
2869 % const char *passphrase)
2871 % A description of each parameter follows:
2873 % o wand: the magick wand.
2875 % o passphrase: the passphrase.
2878 WandExport MagickBooleanType MagickEncipherImage(MagickWand *wand,
2879 const char *passphrase)
2881 assert(wand != (MagickWand *) NULL);
2882 assert(wand->signature == MagickWandSignature);
2883 if (IfMagickTrue(wand->debug))
2884 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2885 if (wand->images == (Image *) NULL)
2886 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2887 return(EncipherImage(wand->images,passphrase,wand->exception));
2891 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2895 % M a g i c k E n h a n c e I m a g e %
2899 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2901 % MagickEnhanceImage() applies a digital filter that improves the quality of a
2904 % The format of the MagickEnhanceImage method is:
2906 % MagickBooleanType MagickEnhanceImage(MagickWand *wand)
2908 % A description of each parameter follows:
2910 % o wand: the magick wand.
2913 WandExport MagickBooleanType MagickEnhanceImage(MagickWand *wand)
2918 assert(wand != (MagickWand *) NULL);
2919 assert(wand->signature == MagickWandSignature);
2920 if (IfMagickTrue(wand->debug))
2921 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2922 if (wand->images == (Image *) NULL)
2923 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2924 enhance_image=EnhanceImage(wand->images,wand->exception);
2925 if (enhance_image == (Image *) NULL)
2926 return(MagickFalse);
2927 ReplaceImageInList(&wand->images,enhance_image);
2932 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2936 % M a g i c k E q u a l i z e I m a g e %
2940 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2942 % MagickEqualizeImage() equalizes the image histogram.
2944 % The format of the MagickEqualizeImage method is:
2946 % MagickBooleanType MagickEqualizeImage(MagickWand *wand)
2948 % A description of each parameter follows:
2950 % o wand: the magick wand.
2952 % o channel: the image channel(s).
2955 WandExport MagickBooleanType MagickEqualizeImage(MagickWand *wand)
2960 assert(wand != (MagickWand *) NULL);
2961 assert(wand->signature == MagickWandSignature);
2962 if (IfMagickTrue(wand->debug))
2963 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
2964 if (wand->images == (Image *) NULL)
2965 ThrowWandException(WandError,"ContainsNoImages",wand->name);
2966 status=EqualizeImage(wand->images,wand->exception);
2971 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2975 % M a g i c k E v a l u a t e I m a g e %
2979 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2981 % MagickEvaluateImage() applys an arithmetic, relational, or logical
2982 % expression to an image. Use these operators to lighten or darken an image,
2983 % to increase or decrease contrast in an image, or to produce the "negative"
2986 % The format of the MagickEvaluateImage method is:
2988 % MagickBooleanType MagickEvaluateImage(MagickWand *wand,
2989 % const MagickEvaluateOperator operator,const double value)
2990 % MagickBooleanType MagickEvaluateImages(MagickWand *wand,
2991 % const MagickEvaluateOperator operator)
2993 % A description of each parameter follows:
2995 % o wand: the magick wand.
2997 % o op: A channel operator.
2999 % o value: A value value.
3003 WandExport MagickWand *MagickEvaluateImages(MagickWand *wand,
3004 const MagickEvaluateOperator op)
3009 assert(wand != (MagickWand *) NULL);
3010 assert(wand->signature == MagickWandSignature);
3011 if (IfMagickTrue(wand->debug))
3012 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3013 if (wand->images == (Image *) NULL)
3014 return((MagickWand *) NULL);
3015 evaluate_image=EvaluateImages(wand->images,op,wand->exception);
3016 if (evaluate_image == (Image *) NULL)
3017 return((MagickWand *) NULL);
3018 return(CloneMagickWandFromImages(wand,evaluate_image));
3021 WandExport MagickBooleanType MagickEvaluateImage(MagickWand *wand,
3022 const MagickEvaluateOperator op,const double value)
3027 assert(wand != (MagickWand *) NULL);
3028 assert(wand->signature == MagickWandSignature);
3029 if (IfMagickTrue(wand->debug))
3030 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3031 if (wand->images == (Image *) NULL)
3032 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3033 status=EvaluateImage(wand->images,op,value,wand->exception);
3038 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3042 % M a g i c k E x p o r t I m a g e P i x e l s %
3046 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3048 % MagickExportImagePixels() extracts pixel data from an image and returns it
3049 % to you. The method returns MagickTrue on success otherwise MagickFalse if
3050 % an error is encountered. The data is returned as char, short int, int,
3051 % ssize_t, float, or double in the order specified by map.
3053 % Suppose you want to extract the first scanline of a 640x480 image as
3054 % character data in red-green-blue order:
3056 % MagickExportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
3058 % The format of the MagickExportImagePixels method is:
3060 % MagickBooleanType MagickExportImagePixels(MagickWand *wand,
3061 % const ssize_t x,const ssize_t y,const size_t columns,
3062 % const size_t rows,const char *map,const StorageType storage,
3065 % A description of each parameter follows:
3067 % o wand: the magick wand.
3069 % o x, y, columns, rows: These values define the perimeter
3070 % of a region of pixels you want to extract.
3072 % o map: This string reflects the expected ordering of the pixel array.
3073 % It can be any combination or order of R = red, G = green, B = blue,
3074 % A = alpha (0 is transparent), O = alpha (0 is opaque), C = cyan,
3075 % Y = yellow, M = magenta, K = black, I = intensity (for grayscale),
3078 % o storage: Define the data type of the pixels. Float and double types are
3079 % expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from
3080 % these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel,
3081 % LongPixel, QuantumPixel, or ShortPixel.
3083 % o pixels: This array of values contain the pixel components as defined by
3084 % map and type. You must preallocate this array where the expected
3085 % length varies depending on the values of width, height, map, and type.
3088 WandExport MagickBooleanType MagickExportImagePixels(MagickWand *wand,
3089 const ssize_t x,const ssize_t y,const size_t columns,
3090 const size_t rows,const char *map,const StorageType storage,
3096 assert(wand != (MagickWand *) NULL);
3097 assert(wand->signature == MagickWandSignature);
3098 if (IfMagickTrue(wand->debug))
3099 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3100 if (wand->images == (Image *) NULL)
3101 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3102 status=ExportImagePixels(wand->images,x,y,columns,rows,map,
3103 storage,pixels,wand->exception);
3108 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3112 % M a g i c k E x t e n t I m a g e %
3116 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3118 % MagickExtentImage() extends the image as defined by the geometry, gravity,
3119 % and wand background color. Set the (x,y) offset of the geometry to move
3120 % the original wand relative to the extended wand.
3122 % The format of the MagickExtentImage method is:
3124 % MagickBooleanType MagickExtentImage(MagickWand *wand,const size_t width,
3125 % const size_t height,const ssize_t x,const ssize_t y)
3127 % A description of each parameter follows:
3129 % o wand: the magick wand.
3131 % o width: the region width.
3133 % o height: the region height.
3135 % o x: the region x offset.
3137 % o y: the region y offset.
3140 WandExport MagickBooleanType MagickExtentImage(MagickWand *wand,
3141 const size_t width,const size_t height,const ssize_t x,const ssize_t y)
3149 assert(wand != (MagickWand *) NULL);
3150 assert(wand->signature == MagickWandSignature);
3151 if (IfMagickTrue(wand->debug))
3152 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3153 if (wand->images == (Image *) NULL)
3154 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3156 extent.height=height;
3159 extent_image=ExtentImage(wand->images,&extent,wand->exception);
3160 if (extent_image == (Image *) NULL)
3161 return(MagickFalse);
3162 ReplaceImageInList(&wand->images,extent_image);
3167 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3171 % M a g i c k F l i p I m a g e %
3175 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3177 % MagickFlipImage() creates a vertical mirror image by reflecting the pixels
3178 % around the central x-axis.
3180 % The format of the MagickFlipImage method is:
3182 % MagickBooleanType MagickFlipImage(MagickWand *wand)
3184 % A description of each parameter follows:
3186 % o wand: the magick wand.
3189 WandExport MagickBooleanType MagickFlipImage(MagickWand *wand)
3194 assert(wand != (MagickWand *) NULL);
3195 assert(wand->signature == MagickWandSignature);
3196 if (IfMagickTrue(wand->debug))
3197 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3198 if (wand->images == (Image *) NULL)
3199 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3200 flip_image=FlipImage(wand->images,wand->exception);
3201 if (flip_image == (Image *) NULL)
3202 return(MagickFalse);
3203 ReplaceImageInList(&wand->images,flip_image);
3208 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3212 % M a g i c k F l o o d f i l l P a i n t I m a g e %
3216 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3218 % MagickFloodfillPaintImage() changes the color value of any pixel that matches
3219 % target and is an immediate neighbor. If the method FillToBorderMethod is
3220 % specified, the color value is changed for any neighbor pixel that does not
3221 % match the bordercolor member of image.
3223 % The format of the MagickFloodfillPaintImage method is:
3225 % MagickBooleanType MagickFloodfillPaintImage(MagickWand *wand,
3226 % const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
3227 % const ssize_t x,const ssize_t y,const MagickBooleanType invert)
3229 % A description of each parameter follows:
3231 % o wand: the magick wand.
3233 % o fill: the floodfill color pixel wand.
3235 % o fuzz: By default target must match a particular pixel color
3236 % exactly. However, in many cases two colors may differ by a small amount.
3237 % The fuzz member of image defines how much tolerance is acceptable to
3238 % consider two colors as the same. For example, set fuzz to 10 and the
3239 % color red at intensities of 100 and 102 respectively are now interpreted
3240 % as the same color for the purposes of the floodfill.
3242 % o bordercolor: the border color pixel wand.
3244 % o x,y: the starting location of the operation.
3246 % o invert: paint any pixel that does not match the target color.
3249 WandExport MagickBooleanType MagickFloodfillPaintImage(MagickWand *wand,
3250 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
3251 const ssize_t x,const ssize_t y,const MagickBooleanType invert)
3262 assert(wand != (MagickWand *) NULL);
3263 assert(wand->signature == MagickWandSignature);
3264 if (IfMagickTrue(wand->debug))
3265 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3266 if (wand->images == (Image *) NULL)
3267 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3268 draw_info=CloneDrawInfo(wand->image_info,(DrawInfo *) NULL);
3269 PixelGetQuantumPacket(fill,&draw_info->fill);
3270 (void) GetOneVirtualPixelInfo(wand->images,TileVirtualPixelMethod,x %
3271 wand->images->columns,y % wand->images->rows,&target,wand->exception);
3272 if (bordercolor != (PixelWand *) NULL)
3273 PixelGetMagickColor(bordercolor,&target);
3274 wand->images->fuzz=fuzz;
3275 status=FloodfillPaintImage(wand->images,draw_info,&target,x,y,invert,
3277 draw_info=DestroyDrawInfo(draw_info);
3282 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3286 % M a g i c k F l o p I m a g e %
3290 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3292 % MagickFlopImage() creates a horizontal mirror image by reflecting the pixels
3293 % around the central y-axis.
3295 % The format of the MagickFlopImage method is:
3297 % MagickBooleanType MagickFlopImage(MagickWand *wand)
3299 % A description of each parameter follows:
3301 % o wand: the magick wand.
3304 WandExport MagickBooleanType MagickFlopImage(MagickWand *wand)
3309 assert(wand != (MagickWand *) NULL);
3310 assert(wand->signature == MagickWandSignature);
3311 if (IfMagickTrue(wand->debug))
3312 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3313 if (wand->images == (Image *) NULL)
3314 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3315 flop_image=FlopImage(wand->images,wand->exception);
3316 if (flop_image == (Image *) NULL)
3317 return(MagickFalse);
3318 ReplaceImageInList(&wand->images,flop_image);
3323 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3327 % M a g i c k F o u r i e r T r a n s f o r m I m a g e %
3331 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3333 % MagickForwardFourierTransformImage() implements the discrete Fourier
3334 % transform (DFT) of the image either as a magnitude / phase or real /
3335 % imaginary image pair.
3337 % The format of the MagickForwardFourierTransformImage method is:
3339 % MagickBooleanType MagickForwardFourierTransformImage(MagickWand *wand,
3340 % const MagickBooleanType magnitude)
3342 % A description of each parameter follows:
3344 % o wand: the magick wand.
3346 % o magnitude: if true, return as magnitude / phase pair otherwise a real /
3347 % imaginary image pair.
3350 WandExport MagickBooleanType MagickForwardFourierTransformImage(
3351 MagickWand *wand,const MagickBooleanType magnitude)
3356 assert(wand != (MagickWand *) NULL);
3357 assert(wand->signature == MagickWandSignature);
3358 if (IfMagickTrue(wand->debug))
3359 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3360 if (wand->images == (Image *) NULL)
3361 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3362 forward_image=ForwardFourierTransformImage(wand->images,magnitude,
3364 if (forward_image == (Image *) NULL)
3365 return(MagickFalse);
3366 ReplaceImageInList(&wand->images,forward_image);
3371 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3375 % M a g i c k F r a m e I m a g e %
3379 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3381 % MagickFrameImage() adds a simulated three-dimensional border around the
3382 % image. The width and height specify the border width of the vertical and
3383 % horizontal sides of the frame. The inner and outer bevels indicate the
3384 % width of the inner and outer shadows of the frame.
3386 % The format of the MagickFrameImage method is:
3388 % MagickBooleanType MagickFrameImage(MagickWand *wand,
3389 % const PixelWand *matte_color,const size_t width,
3390 % const size_t height,const ssize_t inner_bevel,
3391 % const ssize_t outer_bevel,const CompositeOperator compose)
3393 % A description of each parameter follows:
3395 % o wand: the magick wand.
3397 % o matte_color: the frame color pixel wand.
3399 % o width: the border width.
3401 % o height: the border height.
3403 % o inner_bevel: the inner bevel width.
3405 % o outer_bevel: the outer bevel width.
3407 % o compose: the composite operator.
3410 WandExport MagickBooleanType MagickFrameImage(MagickWand *wand,
3411 const PixelWand *matte_color,const size_t width,const size_t height,
3412 const ssize_t inner_bevel,const ssize_t outer_bevel,
3413 const CompositeOperator compose)
3421 assert(wand != (MagickWand *) NULL);
3422 assert(wand->signature == MagickWandSignature);
3423 if (IfMagickTrue(wand->debug))
3424 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3425 if (wand->images == (Image *) NULL)
3426 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3427 (void) ResetMagickMemory(&frame_info,0,sizeof(frame_info));
3428 frame_info.width=wand->images->columns+2*width;
3429 frame_info.height=wand->images->rows+2*height;
3430 frame_info.x=(ssize_t) width;
3431 frame_info.y=(ssize_t) height;
3432 frame_info.inner_bevel=inner_bevel;
3433 frame_info.outer_bevel=outer_bevel;
3434 PixelGetQuantumPacket(matte_color,&wand->images->matte_color);
3435 frame_image=FrameImage(wand->images,&frame_info,compose,wand->exception);
3436 if (frame_image == (Image *) NULL)
3437 return(MagickFalse);
3438 ReplaceImageInList(&wand->images,frame_image);
3443 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3447 % M a g i c k F u n c t i o n I m a g e %
3451 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3453 % MagickFunctionImage() applys an arithmetic, relational, or logical
3454 % expression to an image. Use these operators to lighten or darken an image,
3455 % to increase or decrease contrast in an image, or to produce the "negative"
3458 % The format of the MagickFunctionImage method is:
3460 % MagickBooleanType MagickFunctionImage(MagickWand *wand,
3461 % const MagickFunction function,const size_t number_arguments,
3462 % const double *arguments)
3464 % A description of each parameter follows:
3466 % o wand: the magick wand.
3468 % o function: the image function.
3470 % o number_arguments: the number of function arguments.
3472 % o arguments: the function arguments.
3475 WandExport MagickBooleanType MagickFunctionImage(MagickWand *wand,
3476 const MagickFunction function,const size_t number_arguments,
3477 const double *arguments)
3482 assert(wand != (MagickWand *) NULL);
3483 assert(wand->signature == MagickWandSignature);
3484 if (IfMagickTrue(wand->debug))
3485 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3486 if (wand->images == (Image *) NULL)
3487 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3488 status=FunctionImage(wand->images,function,number_arguments,arguments,
3494 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3498 % M a g i c k F x I m a g e %
3502 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3504 % MagickFxImage() evaluate expression for each pixel in the image.
3506 % The format of the MagickFxImage method is:
3508 % MagickWand *MagickFxImage(MagickWand *wand,const char *expression)
3510 % A description of each parameter follows:
3512 % o wand: the magick wand.
3514 % o expression: the expression.
3517 WandExport MagickWand *MagickFxImage(MagickWand *wand,const char *expression)
3522 assert(wand != (MagickWand *) NULL);
3523 assert(wand->signature == MagickWandSignature);
3524 if (IfMagickTrue(wand->debug))
3525 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3526 if (wand->images == (Image *) NULL)
3527 return((MagickWand *) NULL);
3528 fx_image=FxImage(wand->images,expression,wand->exception);
3529 if (fx_image == (Image *) NULL)
3530 return((MagickWand *) NULL);
3531 return(CloneMagickWandFromImages(wand,fx_image));
3535 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3539 % M a g i c k G a m m a I m a g e %
3543 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3545 % MagickGammaImage() gamma-corrects an image. The same image viewed on
3546 % different devices will have perceptual differences in the way the image's
3547 % intensities are represented on the screen. Specify individual gamma levels
3548 % for the red, green, and blue channels, or adjust all three with the gamma
3549 % parameter. Values typically range from 0.8 to 2.3.
3551 % You can also reduce the influence of a particular channel with a gamma
3554 % The format of the MagickGammaImage method is:
3556 % MagickBooleanType MagickGammaImage(MagickWand *wand,const double gamma)
3558 % A description of each parameter follows:
3560 % o wand: the magick wand.
3562 % o level: Define the level of gamma correction.
3565 WandExport MagickBooleanType MagickGammaImage(MagickWand *wand,
3571 assert(wand != (MagickWand *) NULL);
3572 assert(wand->signature == MagickWandSignature);
3573 if (IfMagickTrue(wand->debug))
3574 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3575 if (wand->images == (Image *) NULL)
3576 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3577 status=GammaImage(wand->images,gamma,wand->exception);
3582 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3586 % M a g i c k G a u s s i a n B l u r I m a g e %
3590 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3592 % MagickGaussianBlurImage() blurs an image. We convolve the image with a
3593 % Gaussian operator of the given radius and standard deviation (sigma).
3594 % For reasonable results, the radius should be larger than sigma. Use a
3595 % radius of 0 and MagickGaussianBlurImage() selects a suitable radius for you.
3597 % The format of the MagickGaussianBlurImage method is:
3599 % MagickBooleanType MagickGaussianBlurImage(MagickWand *wand,
3600 % const double radius,const double sigma)
3602 % A description of each parameter follows:
3604 % o wand: the magick wand.
3606 % o radius: the radius of the Gaussian, in pixels, not counting the center
3609 % o sigma: the standard deviation of the Gaussian, in pixels.
3612 WandExport MagickBooleanType MagickGaussianBlurImage(MagickWand *wand,
3613 const double radius,const double sigma)
3618 assert(wand != (MagickWand *) NULL);
3619 assert(wand->signature == MagickWandSignature);
3620 if (IfMagickTrue(wand->debug))
3621 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3622 if (wand->images == (Image *) NULL)
3623 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3624 blur_image=GaussianBlurImage(wand->images,radius,sigma,wand->exception);
3625 if (blur_image == (Image *) NULL)
3626 return(MagickFalse);
3627 ReplaceImageInList(&wand->images,blur_image);
3632 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3636 % M a g i c k G e t I m a g e %
3640 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3642 % MagickGetImage() gets the image at the current image index.
3644 % The format of the MagickGetImage method is:
3646 % MagickWand *MagickGetImage(MagickWand *wand)
3648 % A description of each parameter follows:
3650 % o wand: the magick wand.
3653 WandExport MagickWand *MagickGetImage(MagickWand *wand)
3658 assert(wand != (MagickWand *) NULL);
3659 assert(wand->signature == MagickWandSignature);
3660 if (IfMagickTrue(wand->debug))
3661 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3662 if (wand->images == (Image *) NULL)
3664 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
3665 "ContainsNoImages","`%s'",wand->name);
3666 return((MagickWand *) NULL);
3668 image=CloneImage(wand->images,0,0,MagickTrue,wand->exception);
3669 if (image == (Image *) NULL)
3670 return((MagickWand *) NULL);
3671 return(CloneMagickWandFromImages(wand,image));
3675 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3679 % M a g i c k G e t I m a g e A l p h a C h a n n e l %
3683 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3685 % MagickGetImageAlphaChannel() returns MagickFalse if the image alpha channel
3686 % is not activated. That is, the image is RGB rather than RGBA or CMYK rather
3689 % The format of the MagickGetImageAlphaChannel method is:
3691 % MagickBooleanType MagickGetImageAlphaChannel(MagickWand *wand)
3693 % A description of each parameter follows:
3695 % o wand: the magick wand.
3698 WandExport MagickBooleanType MagickGetImageAlphaChannel(MagickWand *wand)
3700 assert(wand != (MagickWand *) NULL);
3701 assert(wand->signature == MagickWandSignature);
3702 if (IfMagickTrue(wand->debug))
3703 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3704 if (wand->images == (Image *) NULL)
3705 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3706 return(GetImageAlphaChannel(wand->images));
3710 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3714 % M a g i c k G e t I m a g e C l i p M a s k %
3718 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3720 % MagickGetImageMask() gets the image clip mask at the current image index.
3722 % The format of the MagickGetImageMask method is:
3724 % MagickWand *MagickGetImageMask(MagickWand *wand)
3726 % A description of each parameter follows:
3728 % o wand: the magick wand.
3731 WandExport MagickWand *MagickGetImageMask(MagickWand *wand)
3736 assert(wand != (MagickWand *) NULL);
3737 assert(wand->signature == MagickWandSignature);
3738 if (IfMagickTrue(wand->debug))
3739 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3740 if (wand->images == (Image *) NULL)
3742 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
3743 "ContainsNoImages","`%s'",wand->name);
3744 return((MagickWand *) NULL);
3746 image=GetImageMask(wand->images,wand->exception);
3747 if (image == (Image *) NULL)
3748 return((MagickWand *) NULL);
3749 return(CloneMagickWandFromImages(wand,image));
3753 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3757 % M a g i c k G e t I m a g e B a c k g r o u n d C o l o r %
3761 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3763 % MagickGetImageBackgroundColor() returns the image background color.
3765 % The format of the MagickGetImageBackgroundColor method is:
3767 % MagickBooleanType MagickGetImageBackgroundColor(MagickWand *wand,
3768 % PixelWand *background_color)
3770 % A description of each parameter follows:
3772 % o wand: the magick wand.
3774 % o background_color: Return the background color.
3777 WandExport MagickBooleanType MagickGetImageBackgroundColor(MagickWand *wand,
3778 PixelWand *background_color)
3780 assert(wand != (MagickWand *) NULL);
3781 assert(wand->signature == MagickWandSignature);
3782 if (IfMagickTrue(wand->debug))
3783 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3784 if (wand->images == (Image *) NULL)
3785 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3786 PixelSetPixelColor(background_color,&wand->images->background_color);
3791 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3795 % M a g i c k G e t I m a g e B l o b %
3799 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3801 % MagickGetImageBlob() implements direct to memory image formats. It returns
3802 % the image as a blob (a formatted "file" in memory) and its length, starting
3803 % from the current position in the image sequence. Use MagickSetImageFormat()
3804 % to set the format to write to the blob (GIF, JPEG, PNG, etc.).
3806 % Utilize MagickResetIterator() to ensure the write is from the beginning of
3807 % the image sequence.
3809 % Use MagickRelinquishMemory() to free the blob when you are done with it.
3811 % The format of the MagickGetImageBlob method is:
3813 % unsigned char *MagickGetImageBlob(MagickWand *wand,size_t *length)
3815 % A description of each parameter follows:
3817 % o wand: the magick wand.
3819 % o length: the length of the blob.
3822 WandExport unsigned char *MagickGetImageBlob(MagickWand *wand,size_t *length)
3827 assert(wand != (MagickWand *) NULL);
3828 assert(wand->signature == MagickWandSignature);
3829 if (IfMagickTrue(wand->debug))
3830 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3831 if (wand->images == (Image *) NULL)
3833 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
3834 "ContainsNoImages","`%s'",wand->name);
3835 return((unsigned char *) NULL);
3837 blob=(unsigned char *) ImageToBlob(wand->image_info,wand->images,length,
3843 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3847 % M a g i c k G e t I m a g e s B l o b %
3851 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3853 % MagickGetImageBlob() implements direct to memory image formats. It
3854 % returns the image sequence as a blob and its length. The format of the image
3855 % determines the format of the returned blob (GIF, JPEG, PNG, etc.). To
3856 % return a different image format, use MagickSetImageFormat().
3858 % Note, some image formats do not permit multiple images to the same image
3859 % stream (e.g. JPEG). in this instance, just the first image of the
3860 % sequence is returned as a blob.
3862 % The format of the MagickGetImagesBlob method is:
3864 % unsigned char *MagickGetImagesBlob(MagickWand *wand,size_t *length)
3866 % A description of each parameter follows:
3868 % o wand: the magick wand.
3870 % o length: the length of the blob.
3873 WandExport unsigned char *MagickGetImagesBlob(MagickWand *wand,size_t *length)
3878 assert(wand != (MagickWand *) NULL);
3879 assert(wand->signature == MagickWandSignature);
3880 if (IfMagickTrue(wand->debug))
3881 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3882 if (wand->images == (Image *) NULL)
3884 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
3885 "ContainsNoImages","`%s'",wand->name);
3886 return((unsigned char *) NULL);
3888 blob=(unsigned char *) ImagesToBlob(wand->image_info,GetFirstImageInList(
3889 wand->images),length,wand->exception);
3894 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3898 % M a g i c k G e t I m a g e B l u e P r i m a r y %
3902 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3904 % MagickGetImageBluePrimary() returns the chromaticy blue primary point for the
3907 % The format of the MagickGetImageBluePrimary method is:
3909 % MagickBooleanType MagickGetImageBluePrimary(MagickWand *wand,double *x,
3912 % A description of each parameter follows:
3914 % o wand: the magick wand.
3916 % o x: the chromaticity blue primary x-point.
3918 % o y: the chromaticity blue primary y-point.
3921 WandExport MagickBooleanType MagickGetImageBluePrimary(MagickWand *wand,
3922 double *x,double *y)
3924 assert(wand != (MagickWand *) NULL);
3925 assert(wand->signature == MagickWandSignature);
3926 if (IfMagickTrue(wand->debug))
3927 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3928 if (wand->images == (Image *) NULL)
3929 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3930 *x=wand->images->chromaticity.blue_primary.x;
3931 *y=wand->images->chromaticity.blue_primary.y;
3936 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3940 % M a g i c k G e t I m a g e B o r d e r C o l o r %
3944 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3946 % MagickGetImageBorderColor() returns the image border color.
3948 % The format of the MagickGetImageBorderColor method is:
3950 % MagickBooleanType MagickGetImageBorderColor(MagickWand *wand,
3951 % PixelWand *border_color)
3953 % A description of each parameter follows:
3955 % o wand: the magick wand.
3957 % o border_color: Return the border color.
3960 WandExport MagickBooleanType MagickGetImageBorderColor(MagickWand *wand,
3961 PixelWand *border_color)
3963 assert(wand != (MagickWand *) NULL);
3964 assert(wand->signature == MagickWandSignature);
3965 if (IfMagickTrue(wand->debug))
3966 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
3967 if (wand->images == (Image *) NULL)
3968 ThrowWandException(WandError,"ContainsNoImages",wand->name);
3969 PixelSetPixelColor(border_color,&wand->images->border_color);
3974 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3978 % M a g i c k G e t I m a g e F e a t u r e s %
3982 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3984 % MagickGetImageFeatures() returns features for each channel in the
3985 % image in each of four directions (horizontal, vertical, left and right
3986 % diagonals) for the specified distance. The features include the angular
3987 % second moment, contrast, correlation, sum of squares: variance, inverse
3988 % difference moment, sum average, sum varience, sum entropy, entropy,
3989 % difference variance, difference entropy, information measures of
3990 % correlation 1, information measures of correlation 2, and maximum
3991 % correlation coefficient. You can access the red channel contrast, for
3992 % example, like this:
3994 % channel_features=MagickGetImageFeatures(wand,1);
3995 % contrast=channel_features[RedPixelChannel].contrast[0];
3997 % Use MagickRelinquishMemory() to free the statistics buffer.
3999 % The format of the MagickGetImageFeatures method is:
4001 % ChannelFeatures *MagickGetImageFeatures(MagickWand *wand,
4002 % const size_t distance)
4004 % A description of each parameter follows:
4006 % o wand: the magick wand.
4008 % o distance: the distance.
4011 WandExport ChannelFeatures *MagickGetImageFeatures(MagickWand *wand,
4012 const size_t distance)
4014 assert(wand != (MagickWand *) NULL);
4015 assert(wand->signature == MagickWandSignature);
4016 if (IfMagickTrue(wand->debug))
4017 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4018 if (wand->images == (Image *) NULL)
4020 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4021 "ContainsNoImages","`%s'",wand->name);
4022 return((ChannelFeatures *) NULL);
4024 return(GetImageFeatures(wand->images,distance,wand->exception));
4028 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4032 % M a g i c k G e t I m a g e K u r t o s i s %
4036 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4038 % MagickGetImageKurtosis() gets the kurtosis and skewness of one or
4039 % more image channels.
4041 % The format of the MagickGetImageKurtosis method is:
4043 % MagickBooleanType MagickGetImageKurtosis(MagickWand *wand,
4044 % double *kurtosis,double *skewness)
4046 % A description of each parameter follows:
4048 % o wand: the magick wand.
4050 % o kurtosis: The kurtosis for the specified channel(s).
4052 % o skewness: The skewness for the specified channel(s).
4055 WandExport MagickBooleanType MagickGetImageKurtosis(MagickWand *wand,
4056 double *kurtosis,double *skewness)
4061 assert(wand != (MagickWand *) NULL);
4062 assert(wand->signature == MagickWandSignature);
4063 if (IfMagickTrue(wand->debug))
4064 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4065 if (wand->images == (Image *) NULL)
4066 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4067 status=GetImageKurtosis(wand->images,kurtosis,skewness,wand->exception);
4072 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4076 % M a g i c k G e t I m a g e M e a n %
4080 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4082 % MagickGetImageMean() gets the mean and standard deviation of one or more
4085 % The format of the MagickGetImageMean method is:
4087 % MagickBooleanType MagickGetImageMean(MagickWand *wand,double *mean,
4088 % double *standard_deviation)
4090 % A description of each parameter follows:
4092 % o wand: the magick wand.
4094 % o channel: the image channel(s).
4096 % o mean: The mean pixel value for the specified channel(s).
4098 % o standard_deviation: The standard deviation for the specified channel(s).
4101 WandExport MagickBooleanType MagickGetImageMean(MagickWand *wand,double *mean,
4102 double *standard_deviation)
4107 assert(wand != (MagickWand *) NULL);
4108 assert(wand->signature == MagickWandSignature);
4109 if (IfMagickTrue(wand->debug))
4110 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4111 if (wand->images == (Image *) NULL)
4112 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4113 status=GetImageMean(wand->images,mean,standard_deviation,wand->exception);
4118 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4122 % M a g i c k G e t I m a g e R a n g e %
4126 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4128 % MagickGetImageRange() gets the range for one or more image channels.
4130 % The format of the MagickGetImageRange method is:
4132 % MagickBooleanType MagickGetImageRange(MagickWand *wand,double *minima,
4135 % A description of each parameter follows:
4137 % o wand: the magick wand.
4139 % o minima: The minimum pixel value for the specified channel(s).
4141 % o maxima: The maximum pixel value for the specified channel(s).
4144 WandExport MagickBooleanType MagickGetImageRange(MagickWand *wand,
4145 double *minima,double *maxima)
4150 assert(wand != (MagickWand *) NULL);
4151 assert(wand->signature == MagickWandSignature);
4152 if (IfMagickTrue(wand->debug))
4153 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4154 if (wand->images == (Image *) NULL)
4155 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4156 status=GetImageRange(wand->images,minima,maxima,wand->exception);
4161 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4165 % M a g i c k G e t I m a g e S t a t i s t i c s %
4169 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4171 % MagickGetImageStatistics() returns statistics for each channel in the
4172 % image. The statistics include the channel depth, its minima and
4173 % maxima, the mean, the standard deviation, the kurtosis and the skewness.
4174 % You can access the red channel mean, for example, like this:
4176 % channel_statistics=MagickGetImageStatistics(wand);
4177 % red_mean=channel_statistics[RedPixelChannel].mean;
4179 % Use MagickRelinquishMemory() to free the statistics buffer.
4181 % The format of the MagickGetImageStatistics method is:
4183 % ChannelStatistics *MagickGetImageStatistics(MagickWand *wand)
4185 % A description of each parameter follows:
4187 % o wand: the magick wand.
4190 WandExport ChannelStatistics *MagickGetImageStatistics(MagickWand *wand)
4192 assert(wand != (MagickWand *) NULL);
4193 assert(wand->signature == MagickWandSignature);
4194 if (IfMagickTrue(wand->debug))
4195 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4196 if (wand->images == (Image *) NULL)
4198 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4199 "ContainsNoImages","`%s'",wand->name);
4200 return((ChannelStatistics *) NULL);
4202 return(GetImageStatistics(wand->images,wand->exception));
4206 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4210 % M a g i c k G e t I m a g e C o l o r m a p C o l o r %
4214 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4216 % MagickGetImageColormapColor() returns the color of the specified colormap
4219 % The format of the MagickGetImageColormapColor method is:
4221 % MagickBooleanType MagickGetImageColormapColor(MagickWand *wand,
4222 % const size_t index,PixelWand *color)
4224 % A description of each parameter follows:
4226 % o wand: the magick wand.
4228 % o index: the offset into the image colormap.
4230 % o color: Return the colormap color in this wand.
4233 WandExport MagickBooleanType MagickGetImageColormapColor(MagickWand *wand,
4234 const size_t index,PixelWand *color)
4236 assert(wand != (MagickWand *) NULL);
4237 assert(wand->signature == MagickWandSignature);
4238 if (IfMagickTrue(wand->debug))
4239 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4240 if (wand->images == (Image *) NULL)
4241 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4242 if ((wand->images->colormap == (PixelInfo *) NULL) ||
4243 (index >= wand->images->colors))
4245 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4246 "InvalidColormapIndex","`%s'",wand->name);
4247 return(MagickFalse);
4249 PixelSetPixelColor(color,wand->images->colormap+index);
4254 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4258 % M a g i c k G e t I m a g e C o l o r s %
4262 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4264 % MagickGetImageColors() gets the number of unique colors in the image.
4266 % The format of the MagickGetImageColors method is:
4268 % size_t MagickGetImageColors(MagickWand *wand)
4270 % A description of each parameter follows:
4272 % o wand: the magick wand.
4275 WandExport size_t MagickGetImageColors(MagickWand *wand)
4277 assert(wand != (MagickWand *) NULL);
4278 assert(wand->signature == MagickWandSignature);
4279 if (IfMagickTrue(wand->debug))
4280 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4281 if (wand->images == (Image *) NULL)
4283 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4284 "ContainsNoImages","`%s'",wand->name);
4287 return(GetNumberColors(wand->images,(FILE *) NULL,wand->exception));
4291 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4295 % M a g i c k G e t I m a g e C o l o r s p a c e %
4299 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4301 % MagickGetImageColorspace() gets the image colorspace.
4303 % The format of the MagickGetImageColorspace method is:
4305 % ColorspaceType MagickGetImageColorspace(MagickWand *wand)
4307 % A description of each parameter follows:
4309 % o wand: the magick wand.
4312 WandExport ColorspaceType MagickGetImageColorspace(MagickWand *wand)
4314 assert(wand != (MagickWand *) NULL);
4315 assert(wand->signature == MagickWandSignature);
4316 if (IfMagickTrue(wand->debug))
4317 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4318 if (wand->images == (Image *) NULL)
4320 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4321 "ContainsNoImages","`%s'",wand->name);
4322 return(UndefinedColorspace);
4324 return(wand->images->colorspace);
4328 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4332 % M a g i c k G e t I m a g e C o m p o s e %
4336 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4338 % MagickGetImageCompose() returns the composite operator associated with the
4341 % The format of the MagickGetImageCompose method is:
4343 % CompositeOperator MagickGetImageCompose(MagickWand *wand)
4345 % A description of each parameter follows:
4347 % o wand: the magick wand.
4350 WandExport CompositeOperator MagickGetImageCompose(MagickWand *wand)
4352 assert(wand != (MagickWand *) NULL);
4353 assert(wand->signature == MagickWandSignature);
4354 if (IfMagickTrue(wand->debug))
4355 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4356 if (wand->images == (Image *) NULL)
4358 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4359 "ContainsNoImages","`%s'",wand->name);
4360 return(UndefinedCompositeOp);
4362 return(wand->images->compose);
4366 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4370 % M a g i c k G e t I m a g e C o m p r e s s i o n %
4374 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4376 % MagickGetImageCompression() gets the image compression.
4378 % The format of the MagickGetImageCompression method is:
4380 % CompressionType MagickGetImageCompression(MagickWand *wand)
4382 % A description of each parameter follows:
4384 % o wand: the magick wand.
4387 WandExport CompressionType MagickGetImageCompression(MagickWand *wand)
4389 assert(wand != (MagickWand *) NULL);
4390 assert(wand->signature == MagickWandSignature);
4391 if (IfMagickTrue(wand->debug))
4392 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4393 if (wand->images == (Image *) NULL)
4395 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4396 "ContainsNoImages","`%s'",wand->name);
4397 return(UndefinedCompression);
4399 return(wand->images->compression);
4403 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4407 % M a g i c k G e t I m a g e C o m p r e s s i o n Q u a l i t y %
4411 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4413 % MagickGetImageCompressionQuality() gets the image compression quality.
4415 % The format of the MagickGetImageCompressionQuality method is:
4417 % size_t MagickGetImageCompressionQuality(MagickWand *wand)
4419 % A description of each parameter follows:
4421 % o wand: the magick wand.
4424 WandExport size_t MagickGetImageCompressionQuality(MagickWand *wand)
4426 assert(wand != (MagickWand *) NULL);
4427 assert(wand->signature == MagickWandSignature);
4428 if (IfMagickTrue(wand->debug))
4429 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4430 if (wand->images == (Image *) NULL)
4432 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4433 "ContainsNoImages","`%s'",wand->name);
4436 return(wand->images->quality);
4440 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4444 % M a g i c k G e t I m a g e D e l a y %
4448 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4450 % MagickGetImageDelay() gets the image delay.
4452 % The format of the MagickGetImageDelay method is:
4454 % size_t MagickGetImageDelay(MagickWand *wand)
4456 % A description of each parameter follows:
4458 % o wand: the magick wand.
4461 WandExport size_t MagickGetImageDelay(MagickWand *wand)
4463 assert(wand != (MagickWand *) NULL);
4464 assert(wand->signature == MagickWandSignature);
4465 if (IfMagickTrue(wand->debug))
4466 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4467 if (wand->images == (Image *) NULL)
4468 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4469 return(wand->images->delay);
4473 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4477 % M a g i c k G e t I m a g e D e p t h %
4481 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4483 % MagickGetImageDepth() gets the image depth.
4485 % The format of the MagickGetImageDepth method is:
4487 % size_t MagickGetImageDepth(MagickWand *wand)
4489 % A description of each parameter follows:
4491 % o wand: the magick wand.
4494 WandExport size_t MagickGetImageDepth(MagickWand *wand)
4496 assert(wand != (MagickWand *) NULL);
4497 assert(wand->signature == MagickWandSignature);
4498 if (IfMagickTrue(wand->debug))
4499 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4500 if (wand->images == (Image *) NULL)
4501 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4502 return(wand->images->depth);
4506 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4510 % M a g i c k G e t I m a g e D i s p o s e %
4514 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4516 % MagickGetImageDispose() gets the image disposal method.
4518 % The format of the MagickGetImageDispose method is:
4520 % DisposeType MagickGetImageDispose(MagickWand *wand)
4522 % A description of each parameter follows:
4524 % o wand: the magick wand.
4527 WandExport DisposeType MagickGetImageDispose(MagickWand *wand)
4529 assert(wand != (MagickWand *) NULL);
4530 assert(wand->signature == MagickWandSignature);
4531 if (IfMagickTrue(wand->debug))
4532 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4533 if (wand->images == (Image *) NULL)
4535 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4536 "ContainsNoImages","`%s'",wand->name);
4537 return(UndefinedDispose);
4539 return((DisposeType) wand->images->dispose);
4543 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4547 % M a g i c k G e t I m a g e D i s t o r t i o n %
4551 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4553 % MagickGetImageDistortion() compares an image to a reconstructed image and
4554 % returns the specified distortion metric.
4556 % The format of the MagickGetImageDistortion method is:
4558 % MagickBooleanType MagickGetImageDistortion(MagickWand *wand,
4559 % const MagickWand *reference,const MetricType metric,
4560 % double *distortion)
4562 % A description of each parameter follows:
4564 % o wand: the magick wand.
4566 % o reference: the reference wand.
4568 % o metric: the metric.
4570 % o distortion: the computed distortion between the images.
4573 WandExport MagickBooleanType MagickGetImageDistortion(MagickWand *wand,
4574 const MagickWand *reference,const MetricType metric,double *distortion)
4579 assert(wand != (MagickWand *) NULL);
4580 assert(wand->signature == MagickWandSignature);
4581 if (IfMagickTrue(wand->debug))
4582 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4583 if ((wand->images == (Image *) NULL) || (reference->images == (Image *) NULL))
4584 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4585 status=GetImageDistortion(wand->images,reference->images,metric,distortion,
4591 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4595 % M a g i c k G e t I m a g e D i s t o r t i o n s %
4599 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4601 % MagickGetImageDistortions() compares one or more pixel channels of an
4602 % image to a reconstructed image and returns the specified distortion metrics.
4604 % Use MagickRelinquishMemory() to free the metrics when you are done with them.
4606 % The format of the MagickGetImageDistortion method is:
4608 % double *MagickGetImageDistortion(MagickWand *wand,
4609 % const MagickWand *reference,const MetricType metric)
4611 % A description of each parameter follows:
4613 % o wand: the magick wand.
4615 % o reference: the reference wand.
4617 % o metric: the metric.
4620 WandExport double *MagickGetImageDistortions(MagickWand *wand,
4621 const MagickWand *reference,const MetricType metric)
4624 *channel_distortion;
4626 assert(wand != (MagickWand *) NULL);
4627 assert(wand->signature == MagickWandSignature);
4628 if (IfMagickTrue(wand->debug))
4629 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4630 assert(reference != (MagickWand *) NULL);
4631 assert(reference->signature == MagickWandSignature);
4632 if ((wand->images == (Image *) NULL) || (reference->images == (Image *) NULL))
4634 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4635 "ContainsNoImages","`%s'",wand->name);
4636 return((double *) NULL);
4638 channel_distortion=GetImageDistortions(wand->images,reference->images,
4639 metric,wand->exception);
4640 return(channel_distortion);
4644 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4648 % M a g i c k G e t I m a g e E n d i a n %
4652 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4654 % MagickGetImageEndian() gets the image endian.
4656 % The format of the MagickGetImageEndian method is:
4658 % EndianType MagickGetImageEndian(MagickWand *wand)
4660 % A description of each parameter follows:
4662 % o wand: the magick wand.
4665 WandExport EndianType MagickGetImageEndian(MagickWand *wand)
4667 assert(wand != (MagickWand *) NULL);
4668 assert(wand->signature == MagickWandSignature);
4669 if (IfMagickTrue(wand->debug))
4670 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4671 if (wand->images == (Image *) NULL)
4673 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4674 "ContainsNoImages","`%s'",wand->name);
4675 return(UndefinedEndian);
4677 return(wand->images->endian);
4681 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4685 % M a g i c k G e t I m a g e F i l e n a m e %
4689 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4691 % MagickGetImageFilename() returns the filename of a particular image in a
4694 % The format of the MagickGetImageFilename method is:
4696 % char *MagickGetImageFilename(MagickWand *wand)
4698 % A description of each parameter follows:
4700 % o wand: the magick wand.
4703 WandExport char *MagickGetImageFilename(MagickWand *wand)
4705 assert(wand != (MagickWand *) NULL);
4706 assert(wand->signature == MagickWandSignature);
4707 if (IfMagickTrue(wand->debug))
4708 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4709 if (wand->images == (Image *) NULL)
4711 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4712 "ContainsNoImages","`%s'",wand->name);
4713 return((char *) NULL);
4715 return(AcquireString(wand->images->filename));
4719 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4723 % M a g i c k G e t I m a g e F o r m a t %
4727 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4729 % MagickGetImageFormat() returns the format of a particular image in a
4732 % The format of the MagickGetImageFormat method is:
4734 % char *MagickGetImageFormat(MagickWand *wand)
4736 % A description of each parameter follows:
4738 % o wand: the magick wand.
4741 WandExport char *MagickGetImageFormat(MagickWand *wand)
4743 assert(wand != (MagickWand *) NULL);
4744 assert(wand->signature == MagickWandSignature);
4745 if (IfMagickTrue(wand->debug))
4746 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4747 if (wand->images == (Image *) NULL)
4749 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4750 "ContainsNoImages","`%s'",wand->name);
4751 return((char *) NULL);
4753 return(AcquireString(wand->images->magick));
4757 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4761 % M a g i c k G e t I m a g e F u z z %
4765 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4767 % MagickGetImageFuzz() gets the image fuzz.
4769 % The format of the MagickGetImageFuzz method is:
4771 % double MagickGetImageFuzz(MagickWand *wand)
4773 % A description of each parameter follows:
4775 % o wand: the magick wand.
4778 WandExport double MagickGetImageFuzz(MagickWand *wand)
4780 assert(wand != (MagickWand *) NULL);
4781 assert(wand->signature == MagickWandSignature);
4782 if (IfMagickTrue(wand->debug))
4783 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4784 if (wand->images == (Image *) NULL)
4786 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4787 "ContainsNoImages","`%s'",wand->name);
4790 return(wand->images->fuzz);
4794 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4798 % M a g i c k G e t I m a g e G a m m a %
4802 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4804 % MagickGetImageGamma() gets the image gamma.
4806 % The format of the MagickGetImageGamma method is:
4808 % double MagickGetImageGamma(MagickWand *wand)
4810 % A description of each parameter follows:
4812 % o wand: the magick wand.
4815 WandExport double MagickGetImageGamma(MagickWand *wand)
4817 assert(wand != (MagickWand *) NULL);
4818 assert(wand->signature == MagickWandSignature);
4819 if (IfMagickTrue(wand->debug))
4820 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4821 if (wand->images == (Image *) NULL)
4823 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4824 "ContainsNoImages","`%s'",wand->name);
4827 return(wand->images->gamma);
4831 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4835 % M a g i c k G e t I m a g e G r a v i t y %
4839 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4841 % MagickGetImageGravity() gets the image gravity.
4843 % The format of the MagickGetImageGravity method is:
4845 % GravityType MagickGetImageGravity(MagickWand *wand)
4847 % A description of each parameter follows:
4849 % o wand: the magick wand.
4852 WandExport GravityType MagickGetImageGravity(MagickWand *wand)
4854 assert(wand != (MagickWand *) NULL);
4855 assert(wand->signature == MagickWandSignature);
4856 if (IfMagickTrue(wand->debug))
4857 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4858 if (wand->images == (Image *) NULL)
4860 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4861 "ContainsNoImages","`%s'",wand->name);
4862 return(UndefinedGravity);
4864 return(wand->images->gravity);
4868 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4872 % M a g i c k G e t I m a g e G r e e n P r i m a r y %
4876 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4878 % MagickGetImageGreenPrimary() returns the chromaticy green primary point.
4880 % The format of the MagickGetImageGreenPrimary method is:
4882 % MagickBooleanType MagickGetImageGreenPrimary(MagickWand *wand,double *x,
4885 % A description of each parameter follows:
4887 % o wand: the magick wand.
4889 % o x: the chromaticity green primary x-point.
4891 % o y: the chromaticity green primary y-point.
4894 WandExport MagickBooleanType MagickGetImageGreenPrimary(MagickWand *wand,
4895 double *x,double *y)
4897 assert(wand != (MagickWand *) NULL);
4898 assert(wand->signature == MagickWandSignature);
4899 if (IfMagickTrue(wand->debug))
4900 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4901 if (wand->images == (Image *) NULL)
4902 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4903 *x=wand->images->chromaticity.green_primary.x;
4904 *y=wand->images->chromaticity.green_primary.y;
4909 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4913 % M a g i c k G e t I m a g e H e i g h t %
4917 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4919 % MagickGetImageHeight() returns the image height.
4921 % The format of the MagickGetImageHeight method is:
4923 % size_t MagickGetImageHeight(MagickWand *wand)
4925 % A description of each parameter follows:
4927 % o wand: the magick wand.
4930 WandExport size_t MagickGetImageHeight(MagickWand *wand)
4932 assert(wand != (MagickWand *) NULL);
4933 assert(wand->signature == MagickWandSignature);
4934 if (IfMagickTrue(wand->debug))
4935 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4936 if (wand->images == (Image *) NULL)
4937 ThrowWandException(WandError,"ContainsNoImages",wand->name);
4938 return(wand->images->rows);
4942 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4946 % M a g i c k G e t I m a g e H i s t o g r a m %
4950 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4952 % MagickGetImageHistogram() returns the image histogram as an array of
4955 % The format of the MagickGetImageHistogram method is:
4957 % PixelWand **MagickGetImageHistogram(MagickWand *wand,
4958 % size_t *number_colors)
4960 % A description of each parameter follows:
4962 % o wand: the magick wand.
4964 % o number_colors: the number of unique colors in the image and the number
4965 % of pixel wands returned.
4968 WandExport PixelWand **MagickGetImageHistogram(MagickWand *wand,
4969 size_t *number_colors)
4980 assert(wand != (MagickWand *) NULL);
4981 assert(wand->signature == MagickWandSignature);
4982 if (IfMagickTrue(wand->debug))
4983 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
4984 if (wand->images == (Image *) NULL)
4986 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
4987 "ContainsNoImages","`%s'",wand->name);
4988 return((PixelWand **) NULL);
4990 histogram=GetImageHistogram(wand->images,number_colors,wand->exception);
4991 if (histogram == (PixelInfo *) NULL)
4992 return((PixelWand **) NULL);
4993 pixel_wands=NewPixelWands(*number_colors);
4994 for (i=0; i < (ssize_t) *number_colors; i++)
4996 PixelSetPixelColor(pixel_wands[i],&histogram[i]);
4997 PixelSetColorCount(pixel_wands[i],(size_t) histogram[i].count);
4999 histogram=(PixelInfo *) RelinquishMagickMemory(histogram);
5000 return(pixel_wands);
5004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5008 % M a g i c k G e t I m a g e I n t e r l a c e S c h e m e %
5012 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5014 % MagickGetImageInterlaceScheme() gets the image interlace scheme.
5016 % The format of the MagickGetImageInterlaceScheme method is:
5018 % InterlaceType MagickGetImageInterlaceScheme(MagickWand *wand)
5020 % A description of each parameter follows:
5022 % o wand: the magick wand.
5025 WandExport InterlaceType MagickGetImageInterlaceScheme(MagickWand *wand)
5027 assert(wand != (MagickWand *) NULL);
5028 assert(wand->signature == MagickWandSignature);
5029 if (IfMagickTrue(wand->debug))
5030 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5031 if (wand->images == (Image *) NULL)
5033 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5034 "ContainsNoImages","`%s'",wand->name);
5035 return(UndefinedInterlace);
5037 return(wand->images->interlace);
5041 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5045 % M a g i c k G e t I m a g e I n t e r p o l a t e M e t h o d %
5049 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5051 % MagickGetImageInterpolateMethod() returns the interpolation method for the
5054 % The format of the MagickGetImageInterpolateMethod method is:
5056 % PixelInterpolateMethod MagickGetImagePixelInterpolateMethod(
5059 % A description of each parameter follows:
5061 % o wand: the magick wand.
5064 WandExport PixelInterpolateMethod MagickGetImageInterpolateMethod(
5067 assert(wand != (MagickWand *) NULL);
5068 assert(wand->signature == MagickWandSignature);
5069 if (IfMagickTrue(wand->debug))
5070 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5071 if (wand->images == (Image *) NULL)
5073 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5074 "ContainsNoImages","`%s'",wand->name);
5075 return(UndefinedInterpolatePixel);
5077 return(wand->images->interpolate);
5081 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5085 % M a g i c k G e t I m a g e I t e r a t i o n s %
5089 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5091 % MagickGetImageIterations() gets the image iterations.
5093 % The format of the MagickGetImageIterations method is:
5095 % size_t MagickGetImageIterations(MagickWand *wand)
5097 % A description of each parameter follows:
5099 % o wand: the magick wand.
5102 WandExport size_t MagickGetImageIterations(MagickWand *wand)
5104 assert(wand != (MagickWand *) NULL);
5105 assert(wand->signature == MagickWandSignature);
5106 if (IfMagickTrue(wand->debug))
5107 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5108 if (wand->images == (Image *) NULL)
5109 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5110 return(wand->images->iterations);
5114 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5118 % M a g i c k G e t I m a g e L e n g t h %
5122 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5124 % MagickGetImageLength() returns the image length in bytes.
5126 % The format of the MagickGetImageLength method is:
5128 % MagickBooleanType MagickGetImageLength(MagickWand *wand,
5129 % MagickSizeType *length)
5131 % A description of each parameter follows:
5133 % o wand: the magick wand.
5135 % o length: the image length in bytes.
5138 WandExport MagickBooleanType MagickGetImageLength(MagickWand *wand,
5139 MagickSizeType *length)
5141 assert(wand != (MagickWand *) NULL);
5142 assert(wand->signature == MagickWandSignature);
5143 if (IfMagickTrue(wand->debug))
5144 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5145 if (wand->images == (Image *) NULL)
5146 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5147 *length=GetBlobSize(wand->images);
5152 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5156 % M a g i c k G e t I m a g e M a t t e C o l o r %
5160 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5162 % MagickGetImageMatteColor() returns the image matte color.
5164 % The format of the MagickGetImageMatteColor method is:
5166 % MagickBooleanType MagickGetImagematteColor(MagickWand *wand,
5167 % PixelWand *matte_color)
5169 % A description of each parameter follows:
5171 % o wand: the magick wand.
5173 % o matte_color: Return the matte color.
5176 WandExport MagickBooleanType MagickGetImageMatteColor(MagickWand *wand,
5177 PixelWand *matte_color)
5179 assert(wand != (MagickWand *) NULL);
5180 assert(wand->signature == MagickWandSignature);
5181 if (IfMagickTrue(wand->debug))
5182 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5183 if (wand->images == (Image *) NULL)
5184 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5185 PixelSetPixelColor(matte_color,&wand->images->matte_color);
5190 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5194 % M a g i c k G e t I m a g e O r i e n t a t i o n %
5198 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5200 % MagickGetImageOrientation() returns the image orientation.
5202 % The format of the MagickGetImageOrientation method is:
5204 % OrientationType MagickGetImageOrientation(MagickWand *wand)
5206 % A description of each parameter follows:
5208 % o wand: the magick wand.
5211 WandExport OrientationType MagickGetImageOrientation(MagickWand *wand)
5213 assert(wand != (MagickWand *) NULL);
5214 assert(wand->signature == MagickWandSignature);
5215 if (IfMagickTrue(wand->debug))
5216 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5217 if (wand->images == (Image *) NULL)
5219 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5220 "ContainsNoImages","`%s'",wand->name);
5221 return(UndefinedOrientation);
5223 return(wand->images->orientation);
5227 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5231 % M a g i c k G e t I m a g e P a g e %
5235 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5237 % MagickGetImagePage() returns the page geometry associated with the image.
5239 % The format of the MagickGetImagePage method is:
5241 % MagickBooleanType MagickGetImagePage(MagickWand *wand,
5242 % size_t *width,size_t *height,ssize_t *x,ssize_t *y)
5244 % A description of each parameter follows:
5246 % o wand: the magick wand.
5248 % o width: the page width.
5250 % o height: the page height.
5252 % o x: the page x-offset.
5254 % o y: the page y-offset.
5257 WandExport MagickBooleanType MagickGetImagePage(MagickWand *wand,
5258 size_t *width,size_t *height,ssize_t *x,ssize_t *y)
5260 assert(wand != (const MagickWand *) NULL);
5261 assert(wand->signature == MagickWandSignature);
5262 if (IfMagickTrue(wand->debug))
5263 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5264 if (wand->images == (Image *) NULL)
5265 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5266 *width=wand->images->page.width;
5267 *height=wand->images->page.height;
5268 *x=wand->images->page.x;
5269 *y=wand->images->page.y;
5274 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5278 % M a g i c k G e t I m a g e P i x e l C o l o r %
5282 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5284 % MagickGetImagePixelColor() returns the color of the specified pixel.
5286 % The format of the MagickGetImagePixelColor method is:
5288 % MagickBooleanType MagickGetImagePixelColor(MagickWand *wand,
5289 % const ssize_t x,const ssize_t y,PixelWand *color)
5291 % A description of each parameter follows:
5293 % o wand: the magick wand.
5295 % o x,y: the pixel offset into the image.
5297 % o color: Return the colormap color in this wand.
5300 WandExport MagickBooleanType MagickGetImagePixelColor(MagickWand *wand,
5301 const ssize_t x,const ssize_t y,PixelWand *color)
5303 register const Quantum
5309 assert(wand != (MagickWand *) NULL);
5310 assert(wand->signature == MagickWandSignature);
5311 if (IfMagickTrue(wand->debug))
5312 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5313 if (wand->images == (Image *) NULL)
5314 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5315 image_view=AcquireVirtualCacheView(wand->images,wand->exception);
5316 p=GetCacheViewVirtualPixels(image_view,x,y,1,1,wand->exception);
5317 if (p == (const Quantum *) NULL)
5319 image_view=DestroyCacheView(image_view);
5320 return(MagickFalse);
5322 PixelSetQuantumPixel(wand->images,p,color);
5323 image_view=DestroyCacheView(image_view);
5328 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5332 % M a g i c k G e t I m a g e R e d P r i m a r y %
5336 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5338 % MagickGetImageRedPrimary() returns the chromaticy red primary point.
5340 % The format of the MagickGetImageRedPrimary method is:
5342 % MagickBooleanType MagickGetImageRedPrimary(MagickWand *wand,double *x,
5345 % A description of each parameter follows:
5347 % o wand: the magick wand.
5349 % o x: the chromaticity red primary x-point.
5351 % o y: the chromaticity red primary y-point.
5354 WandExport MagickBooleanType MagickGetImageRedPrimary(MagickWand *wand,
5355 double *x,double *y)
5357 assert(wand != (MagickWand *) NULL);
5358 assert(wand->signature == MagickWandSignature);
5359 if (IfMagickTrue(wand->debug))
5360 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5361 if (wand->images == (Image *) NULL)
5362 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5363 *x=wand->images->chromaticity.red_primary.x;
5364 *y=wand->images->chromaticity.red_primary.y;
5369 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5373 % M a g i c k G e t I m a g e R e g i o n %
5377 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5379 % MagickGetImageRegion() extracts a region of the image and returns it as a
5382 % The format of the MagickGetImageRegion method is:
5384 % MagickWand *MagickGetImageRegion(MagickWand *wand,
5385 % const size_t width,const size_t height,const ssize_t x,
5388 % A description of each parameter follows:
5390 % o wand: the magick wand.
5392 % o width: the region width.
5394 % o height: the region height.
5396 % o x: the region x offset.
5398 % o y: the region y offset.
5401 WandExport MagickWand *MagickGetImageRegion(MagickWand *wand,
5402 const size_t width,const size_t height,const ssize_t x,
5411 assert(wand != (MagickWand *) NULL);
5412 assert(wand->signature == MagickWandSignature);
5413 if (IfMagickTrue(wand->debug))
5414 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5415 if (wand->images == (Image *) NULL)
5416 return((MagickWand *) NULL);
5418 region.height=height;
5421 region_image=CropImage(wand->images,®ion,wand->exception);
5422 if (region_image == (Image *) NULL)
5423 return((MagickWand *) NULL);
5424 return(CloneMagickWandFromImages(wand,region_image));
5428 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5432 % M a g i c k G e t I m a g e R e n d e r i n g I n t e n t %
5436 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5438 % MagickGetImageRenderingIntent() gets the image rendering intent.
5440 % The format of the MagickGetImageRenderingIntent method is:
5442 % RenderingIntent MagickGetImageRenderingIntent(MagickWand *wand)
5444 % A description of each parameter follows:
5446 % o wand: the magick wand.
5449 WandExport RenderingIntent MagickGetImageRenderingIntent(MagickWand *wand)
5451 assert(wand != (MagickWand *) NULL);
5452 assert(wand->signature == MagickWandSignature);
5453 if (IfMagickTrue(wand->debug))
5454 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5455 if (wand->images == (Image *) NULL)
5457 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5458 "ContainsNoImages","`%s'",wand->name);
5459 return(UndefinedIntent);
5461 return((RenderingIntent) wand->images->rendering_intent);
5465 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5469 % M a g i c k G e t I m a g e R e s o l u t i o n %
5473 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5475 % MagickGetImageResolution() gets the image X and Y resolution.
5477 % The format of the MagickGetImageResolution method is:
5479 % MagickBooleanType MagickGetImageResolution(MagickWand *wand,double *x,
5482 % A description of each parameter follows:
5484 % o wand: the magick wand.
5486 % o x: the image x-resolution.
5488 % o y: the image y-resolution.
5491 WandExport MagickBooleanType MagickGetImageResolution(MagickWand *wand,
5492 double *x,double *y)
5494 assert(wand != (MagickWand *) NULL);
5495 assert(wand->signature == MagickWandSignature);
5496 if (IfMagickTrue(wand->debug))
5497 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5498 if (wand->images == (Image *) NULL)
5499 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5500 *x=wand->images->resolution.x;
5501 *y=wand->images->resolution.y;
5506 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5510 % M a g i c k G e t I m a g e S c e n e %
5514 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5516 % MagickGetImageScene() gets the image scene.
5518 % The format of the MagickGetImageScene method is:
5520 % size_t MagickGetImageScene(MagickWand *wand)
5522 % A description of each parameter follows:
5524 % o wand: the magick wand.
5527 WandExport size_t MagickGetImageScene(MagickWand *wand)
5529 assert(wand != (MagickWand *) NULL);
5530 assert(wand->signature == MagickWandSignature);
5531 if (IfMagickTrue(wand->debug))
5532 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5533 if (wand->images == (Image *) NULL)
5534 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5535 return(wand->images->scene);
5539 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5543 % M a g i c k G e t I m a g e S i g n a t u r e %
5547 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5549 % MagickGetImageSignature() generates an SHA-256 message digest for the image
5552 % The format of the MagickGetImageSignature method is:
5554 % char *MagickGetImageSignature(MagickWand *wand)
5556 % A description of each parameter follows:
5558 % o wand: the magick wand.
5561 WandExport char *MagickGetImageSignature(MagickWand *wand)
5569 assert(wand != (MagickWand *) NULL);
5570 assert(wand->signature == MagickWandSignature);
5571 if (IfMagickTrue(wand->debug))
5572 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5573 if (wand->images == (Image *) NULL)
5575 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5576 "ContainsNoImages","`%s'",wand->name);
5577 return((char *) NULL);
5579 status=SignatureImage(wand->images,wand->exception);
5580 if (IfMagickFalse(status))
5581 return((char *) NULL);
5582 value=GetImageProperty(wand->images,"signature",wand->exception);
5583 if (value == (const char *) NULL)
5584 return((char *) NULL);
5585 return(AcquireString(value));
5589 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5593 % M a g i c k G e t I m a g e T i c k s P e r S e c o n d %
5597 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5599 % MagickGetImageTicksPerSecond() gets the image ticks-per-second.
5601 % The format of the MagickGetImageTicksPerSecond method is:
5603 % size_t MagickGetImageTicksPerSecond(MagickWand *wand)
5605 % A description of each parameter follows:
5607 % o wand: the magick wand.
5610 WandExport size_t MagickGetImageTicksPerSecond(MagickWand *wand)
5612 assert(wand != (MagickWand *) NULL);
5613 assert(wand->signature == MagickWandSignature);
5614 if (IfMagickTrue(wand->debug))
5615 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5616 if (wand->images == (Image *) NULL)
5617 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5618 return((size_t) wand->images->ticks_per_second);
5622 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5626 % M a g i c k G e t I m a g e T y p e %
5630 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5632 % MagickGetImageType() gets the potential image type:
5634 % Bilevel Grayscale GrayscaleMatte
5635 % Palette PaletteMatte TrueColor
5636 % TrueColorMatte ColorSeparation ColorSeparationMatte
5638 % The format of the MagickGetImageType method is:
5640 % ImageType MagickGetImageType(MagickWand *wand)
5642 % A description of each parameter follows:
5644 % o wand: the magick wand.
5647 WandExport ImageType MagickGetImageType(MagickWand *wand)
5649 assert(wand != (MagickWand *) NULL);
5650 assert(wand->signature == MagickWandSignature);
5651 if (IfMagickTrue(wand->debug))
5652 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5653 if (wand->images == (Image *) NULL)
5655 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5656 "ContainsNoImages","`%s'",wand->name);
5657 return(UndefinedType);
5659 return(GetImageType(wand->images));
5663 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5667 % M a g i c k G e t I m a g e U n i t s %
5671 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5673 % MagickGetImageUnits() gets the image units of resolution.
5675 % The format of the MagickGetImageUnits method is:
5677 % ResolutionType MagickGetImageUnits(MagickWand *wand)
5679 % A description of each parameter follows:
5681 % o wand: the magick wand.
5684 WandExport ResolutionType MagickGetImageUnits(MagickWand *wand)
5686 assert(wand != (MagickWand *) NULL);
5687 assert(wand->signature == MagickWandSignature);
5688 if (IfMagickTrue(wand->debug))
5689 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5690 if (wand->images == (Image *) NULL)
5692 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5693 "ContainsNoImages","`%s'",wand->name);
5694 return(UndefinedResolution);
5696 return(wand->images->units);
5700 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5704 % M a g i c k G e t I m a g e V i r t u a l P i x e l M e t h o d %
5708 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5710 % MagickGetImageVirtualPixelMethod() returns the virtual pixel method for the
5713 % The format of the MagickGetImageVirtualPixelMethod method is:
5715 % VirtualPixelMethod MagickGetImageVirtualPixelMethod(MagickWand *wand)
5717 % A description of each parameter follows:
5719 % o wand: the magick wand.
5722 WandExport VirtualPixelMethod MagickGetImageVirtualPixelMethod(MagickWand *wand)
5724 assert(wand != (MagickWand *) NULL);
5725 assert(wand->signature == MagickWandSignature);
5726 if (IfMagickTrue(wand->debug))
5727 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5728 if (wand->images == (Image *) NULL)
5730 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5731 "ContainsNoImages","`%s'",wand->name);
5732 return(UndefinedVirtualPixelMethod);
5734 return(GetImageVirtualPixelMethod(wand->images));
5738 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5742 % M a g i c k G e t I m a g e W h i t e P o i n t %
5746 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5748 % MagickGetImageWhitePoint() returns the chromaticy white point.
5750 % The format of the MagickGetImageWhitePoint method is:
5752 % MagickBooleanType MagickGetImageWhitePoint(MagickWand *wand,double *x,
5755 % A description of each parameter follows:
5757 % o wand: the magick wand.
5759 % o x: the chromaticity white x-point.
5761 % o y: the chromaticity white y-point.
5764 WandExport MagickBooleanType MagickGetImageWhitePoint(MagickWand *wand,
5765 double *x,double *y)
5767 assert(wand != (MagickWand *) NULL);
5768 assert(wand->signature == MagickWandSignature);
5769 if (IfMagickTrue(wand->debug))
5770 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5771 if (wand->images == (Image *) NULL)
5772 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5773 *x=wand->images->chromaticity.white_point.x;
5774 *y=wand->images->chromaticity.white_point.y;
5779 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5783 % M a g i c k G e t I m a g e W i d t h %
5787 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5789 % MagickGetImageWidth() returns the image width.
5791 % The format of the MagickGetImageWidth method is:
5793 % size_t MagickGetImageWidth(MagickWand *wand)
5795 % A description of each parameter follows:
5797 % o wand: the magick wand.
5800 WandExport size_t MagickGetImageWidth(MagickWand *wand)
5802 assert(wand != (MagickWand *) NULL);
5803 assert(wand->signature == MagickWandSignature);
5804 if (IfMagickTrue(wand->debug))
5805 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5806 if (wand->images == (Image *) NULL)
5807 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5808 return(wand->images->columns);
5812 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5816 % M a g i c k G e t N u m b e r I m a g e s %
5820 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5822 % MagickGetNumberImages() returns the number of images associated with a
5825 % The format of the MagickGetNumberImages method is:
5827 % size_t MagickGetNumberImages(MagickWand *wand)
5829 % A description of each parameter follows:
5831 % o wand: the magick wand.
5834 WandExport size_t MagickGetNumberImages(MagickWand *wand)
5836 assert(wand != (MagickWand *) NULL);
5837 assert(wand->signature == MagickWandSignature);
5838 if (IfMagickTrue(wand->debug))
5839 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5840 return(GetImageListLength(wand->images));
5844 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5848 % M a g i c k I m a g e G e t T o t a l I n k D e n s i t y %
5852 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5854 % MagickGetImageTotalInkDensity() gets the image total ink density.
5856 % The format of the MagickGetImageTotalInkDensity method is:
5858 % double MagickGetImageTotalInkDensity(MagickWand *wand)
5860 % A description of each parameter follows:
5862 % o wand: the magick wand.
5865 WandExport double MagickGetImageTotalInkDensity(MagickWand *wand)
5867 assert(wand != (MagickWand *) NULL);
5868 assert(wand->signature == MagickWandSignature);
5869 if (IfMagickTrue(wand->debug))
5870 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5871 if (wand->images == (Image *) NULL)
5873 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
5874 "ContainsNoImages","`%s'",wand->name);
5877 return(GetImageTotalInkDensity(wand->images,wand->exception));
5881 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5885 % M a g i c k H a l d C l u t I m a g e %
5889 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5891 % MagickHaldClutImage() replaces colors in the image from a Hald color lookup
5892 % table. A Hald color lookup table is a 3-dimensional color cube mapped to 2
5893 % dimensions. Create it with the HALD coder. You can apply any color
5894 % transformation to the Hald image and then use this method to apply the
5895 % transform to the image.
5897 % The format of the MagickHaldClutImage method is:
5899 % MagickBooleanType MagickHaldClutImage(MagickWand *wand,
5900 % const MagickWand *hald_wand)
5902 % A description of each parameter follows:
5904 % o wand: the magick wand.
5906 % o hald_image: the hald CLUT image.
5909 WandExport MagickBooleanType MagickHaldClutImage(MagickWand *wand,
5910 const MagickWand *hald_wand)
5915 assert(wand != (MagickWand *) NULL);
5916 assert(wand->signature == MagickWandSignature);
5917 if (IfMagickTrue(wand->debug))
5918 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5919 if ((wand->images == (Image *) NULL) || (hald_wand->images == (Image *) NULL))
5920 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5921 status=HaldClutImage(wand->images,hald_wand->images,wand->exception);
5926 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5930 % M a g i c k H a s N e x t I m a g e %
5934 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5936 % MagickHasNextImage() returns MagickTrue if the wand has more images when
5937 % traversing the list in the forward direction
5939 % The format of the MagickHasNextImage method is:
5941 % MagickBooleanType MagickHasNextImage(MagickWand *wand)
5943 % A description of each parameter follows:
5945 % o wand: the magick wand.
5948 WandExport MagickBooleanType MagickHasNextImage(MagickWand *wand)
5950 assert(wand != (MagickWand *) NULL);
5951 assert(wand->signature == MagickWandSignature);
5952 if (IfMagickTrue(wand->debug))
5953 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5954 if (wand->images == (Image *) NULL)
5955 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5956 if (GetNextImageInList(wand->images) == (Image *) NULL)
5957 return(MagickFalse);
5962 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5966 % M a g i c k H a s P r e v i o u s I m a g e %
5970 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5972 % MagickHasPreviousImage() returns MagickTrue if the wand has more images when
5973 % traversing the list in the reverse direction
5975 % The format of the MagickHasPreviousImage method is:
5977 % MagickBooleanType MagickHasPreviousImage(MagickWand *wand)
5979 % A description of each parameter follows:
5981 % o wand: the magick wand.
5984 WandExport MagickBooleanType MagickHasPreviousImage(MagickWand *wand)
5986 assert(wand != (MagickWand *) NULL);
5987 assert(wand->signature == MagickWandSignature);
5988 if (IfMagickTrue(wand->debug))
5989 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
5990 if (wand->images == (Image *) NULL)
5991 ThrowWandException(WandError,"ContainsNoImages",wand->name);
5992 if (GetPreviousImageInList(wand->images) == (Image *) NULL)
5993 return(MagickFalse);
5998 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6002 % M a g i c k I d e n t i f y I m a g e %
6006 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6008 % MagickIdentifyImage() identifies an image by printing its attributes to the
6009 % file. Attributes include the image width, height, size, and others.
6011 % The format of the MagickIdentifyImage method is:
6013 % const char *MagickIdentifyImage(MagickWand *wand)
6015 % A description of each parameter follows:
6017 % o wand: the magick wand.
6020 WandExport char *MagickIdentifyImage(MagickWand *wand)
6024 filename[MagickPathExtent];
6032 assert(wand != (MagickWand *) NULL);
6033 assert(wand->signature == MagickWandSignature);
6034 if (IfMagickTrue(wand->debug))
6035 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6036 if (wand->images == (Image *) NULL)
6038 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
6039 "ContainsNoImages","`%s'",wand->name);
6040 return((char *) NULL);
6042 description=(char *) NULL;
6043 unique_file=AcquireUniqueFileResource(filename);
6045 if (unique_file != -1)
6046 file=fdopen(unique_file,"wb");
6047 if ((unique_file == -1) || (file == (FILE *) NULL))
6049 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
6050 "UnableToCreateTemporaryFile","`%s'",wand->name);
6051 return((char *) NULL);
6053 (void) IdentifyImage(wand->images,file,MagickTrue,wand->exception);
6054 (void) fclose(file);
6055 description=FileToString(filename,~0UL,wand->exception);
6056 (void) RelinquishUniqueFileResource(filename);
6057 return(description);
6061 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6065 % M a g i c k I d e n t i f y I m a g e T y p e %
6069 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6071 % MagickIdentifyImageType() gets the potential image type:
6073 % Bilevel Grayscale GrayscaleMatte
6074 % Palette PaletteMatte TrueColor
6075 % TrueColorMatte ColorSeparation ColorSeparationMatte
6077 % To ensure the image type matches its potential, use MagickSetImageType():
6079 % (void) MagickSetImageType(wand,MagickIdentifyImageType(wand));
6081 % The format of the MagickIdentifyImageType method is:
6083 % ImageType MagickIdentifyImageType(MagickWand *wand)
6085 % A description of each parameter follows:
6087 % o wand: the magick wand.
6090 WandExport ImageType MagickIdentifyImageType(MagickWand *wand)
6092 assert(wand != (MagickWand *) NULL);
6093 assert(wand->signature == MagickWandSignature);
6094 if (IfMagickTrue(wand->debug))
6095 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6096 if (wand->images == (Image *) NULL)
6098 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
6099 "ContainsNoImages","`%s'",wand->name);
6100 return(UndefinedType);
6102 return(IdentifyImageType(wand->images,wand->exception));
6106 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6110 % M a g i c k I m p l o d e I m a g e %
6114 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6116 % MagickImplodeImage() creates a new image that is a copy of an existing
6117 % one with the image pixels "implode" by the specified percentage. It
6118 % allocates the memory necessary for the new Image structure and returns a
6119 % pointer to the new image.
6121 % The format of the MagickImplodeImage method is:
6123 % MagickBooleanType MagickImplodeImage(MagickWand *wand,
6124 % const double radius,const PixelInterpolateMethod method)
6126 % A description of each parameter follows:
6128 % o wand: the magick wand.
6130 % o amount: Define the extent of the implosion.
6132 % o method: the pixel interpolation method.
6135 WandExport MagickBooleanType MagickImplodeImage(MagickWand *wand,
6136 const double amount,const PixelInterpolateMethod method)
6141 assert(wand != (MagickWand *) NULL);
6142 assert(wand->signature == MagickWandSignature);
6143 if (IfMagickTrue(wand->debug))
6144 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6145 if (wand->images == (Image *) NULL)
6146 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6147 implode_image=ImplodeImage(wand->images,amount,method,wand->exception);
6148 if (implode_image == (Image *) NULL)
6149 return(MagickFalse);
6150 ReplaceImageInList(&wand->images,implode_image);
6155 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6159 % M a g i c k I m p o r t I m a g e P i x e l s %
6163 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6165 % MagickImportImagePixels() accepts pixel datand stores it in the image at the
6166 % location you specify. The method returns MagickFalse on success otherwise
6167 % MagickTrue if an error is encountered. The pixel data can be either char,
6168 % short int, int, ssize_t, float, or double in the order specified by map.
6170 % Suppose your want to upload the first scanline of a 640x480 image from
6171 % character data in red-green-blue order:
6173 % MagickImportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
6175 % The format of the MagickImportImagePixels method is:
6177 % MagickBooleanType MagickImportImagePixels(MagickWand *wand,
6178 % const ssize_t x,const ssize_t y,const size_t columns,
6179 % const size_t rows,const char *map,const StorageType storage,
6180 % const void *pixels)
6182 % A description of each parameter follows:
6184 % o wand: the magick wand.
6186 % o x, y, columns, rows: These values define the perimeter of a region
6187 % of pixels you want to define.
6189 % o map: This string reflects the expected ordering of the pixel array.
6190 % It can be any combination or order of R = red, G = green, B = blue,
6191 % A = alpha (0 is transparent), O = alpha (0 is opaque), C = cyan,
6192 % Y = yellow, M = magenta, K = black, I = intensity (for grayscale),
6195 % o storage: Define the data type of the pixels. Float and double types are
6196 % expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from
6197 % these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel,
6200 % o pixels: This array of values contain the pixel components as defined by
6201 % map and type. You must preallocate this array where the expected
6202 % length varies depending on the values of width, height, map, and type.
6205 WandExport MagickBooleanType MagickImportImagePixels(MagickWand *wand,
6206 const ssize_t x,const ssize_t y,const size_t columns,const size_t rows,
6207 const char *map,const StorageType storage,const void *pixels)
6212 assert(wand != (MagickWand *) NULL);
6213 assert(wand->signature == MagickWandSignature);
6214 if (IfMagickTrue(wand->debug))
6215 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6216 if (wand->images == (Image *) NULL)
6217 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6218 status=ImportImagePixels(wand->images,x,y,columns,rows,map,storage,pixels,
6224 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6228 % M a g i c k I n t e r p o l a t i v e R e s i z e I m a g e %
6232 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6234 % MagickInterpolativeResizeImage() resize image using a interpolative
6237 % MagickBooleanType MagickInterpolativeResizeImage(MagickWand *wand,
6238 % const size_t columns,const size_t rows,
6239 % const PixelInterpolateMethod method)
6241 % A description of each parameter follows:
6243 % o wand: the magick wand.
6245 % o columns: the number of columns in the scaled image.
6247 % o rows: the number of rows in the scaled image.
6249 % o interpolate: the pixel interpolation method.
6252 WandExport MagickBooleanType MagickInterpolativeResizeImage(MagickWand *wand,
6253 const size_t columns,const size_t rows,const PixelInterpolateMethod method)
6258 assert(wand != (MagickWand *) NULL);
6259 assert(wand->signature == MagickWandSignature);
6260 if (IfMagickTrue(wand->debug))
6261 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6262 if (wand->images == (Image *) NULL)
6263 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6264 resize_image=InterpolativeResizeImage(wand->images,columns,rows,method,
6266 if (resize_image == (Image *) NULL)
6267 return(MagickFalse);
6268 ReplaceImageInList(&wand->images,resize_image);
6273 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6277 % M a g i c k I n v e r s e F o u r i e r T r a n s f o r m I m a g e %
6281 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6283 % MagickInverseFourierTransformImage() implements the inverse discrete
6284 % Fourier transform (DFT) of the image either as a magnitude / phase or real /
6285 % imaginary image pair.
6287 % The format of the MagickInverseFourierTransformImage method is:
6289 % MagickBooleanType MagickInverseFourierTransformImage(
6290 % MagickWand *magnitude_wand,MagickWand *phase_wand,
6291 % const MagickBooleanType magnitude)
6293 % A description of each parameter follows:
6295 % o magnitude_wand: the magnitude or real wand.
6297 % o phase_wand: the phase or imaginary wand.
6299 % o magnitude: if true, return as magnitude / phase pair otherwise a real /
6300 % imaginary image pair.
6303 WandExport MagickBooleanType MagickInverseFourierTransformImage(
6304 MagickWand *magnitude_wand,MagickWand *phase_wand,
6305 const MagickBooleanType magnitude)
6313 assert(magnitude_wand != (MagickWand *) NULL);
6314 assert(magnitude_wand->signature == MagickWandSignature);
6315 if (IfMagickTrue(magnitude_wand->debug))
6316 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",
6317 magnitude_wand->name);
6318 wand=magnitude_wand;
6319 if (magnitude_wand->images == (Image *) NULL)
6320 ThrowWandException(WandError,"ContainsNoImages",
6321 magnitude_wand->name);
6322 assert(phase_wand != (MagickWand *) NULL);
6323 assert(phase_wand->signature == MagickWandSignature);
6324 inverse_image=InverseFourierTransformImage(magnitude_wand->images,
6325 phase_wand->images,magnitude,wand->exception);
6326 if (inverse_image == (Image *) NULL)
6327 return(MagickFalse);
6328 ReplaceImageInList(&wand->images,inverse_image);
6333 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6337 % M a g i c k L a b e l I m a g e %
6341 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6343 % MagickLabelImage() adds a label to your image.
6345 % The format of the MagickLabelImage method is:
6347 % MagickBooleanType MagickLabelImage(MagickWand *wand,const char *label)
6349 % A description of each parameter follows:
6351 % o wand: the magick wand.
6353 % o label: the image label.
6356 WandExport MagickBooleanType MagickLabelImage(MagickWand *wand,
6362 assert(wand != (MagickWand *) NULL);
6363 assert(wand->signature == MagickWandSignature);
6364 if (IfMagickTrue(wand->debug))
6365 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6366 if (wand->images == (Image *) NULL)
6367 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6368 status=SetImageProperty(wand->images,"label",label,wand->exception);
6373 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6377 % M a g i c k L e v e l I m a g e %
6381 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6383 % MagickLevelImage() adjusts the levels of an image by scaling the colors
6384 % falling between specified white and black points to the full available
6385 % quantum range. The parameters provided represent the black, mid, and white
6386 % points. The black point specifies the darkest color in the image. Colors
6387 % darker than the black point are set to zero. Mid point specifies a gamma
6388 % correction to apply to the image. White point specifies the lightest color
6389 % in the image. Colors brighter than the white point are set to the maximum
6392 % The format of the MagickLevelImage method is:
6394 % MagickBooleanType MagickLevelImage(MagickWand *wand,
6395 % const double black_point,const double gamma,const double white_point)
6396 % MagickBooleanType MagickLevelImage(MagickWand *wand,
6397 % const ChannelType channel,const double black_point,const double gamma,
6398 % const double white_point)
6400 % A description of each parameter follows:
6402 % o wand: the magick wand.
6404 % o channel: Identify which channel to level: RedPixelChannel,
6405 % GreenPixelChannel, etc.
6407 % o black_point: the black point.
6409 % o gamma: the gamma.
6411 % o white_point: the white point.
6414 WandExport MagickBooleanType MagickLevelImage(MagickWand *wand,
6415 const double black_point,const double gamma,const double white_point)
6420 assert(wand != (MagickWand *) NULL);
6421 assert(wand->signature == MagickWandSignature);
6422 if (IfMagickTrue(wand->debug))
6423 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6424 if (wand->images == (Image *) NULL)
6425 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6426 status=LevelImage(wand->images,black_point,white_point,gamma,
6432 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6436 % M a g i c k L i n e a r S t r e t c h I m a g e %
6440 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6442 % MagickLinearStretchImage() stretches with saturation the image intensity.
6444 % You can also reduce the influence of a particular channel with a gamma
6447 % The format of the MagickLinearStretchImage method is:
6449 % MagickBooleanType MagickLinearStretchImage(MagickWand *wand,
6450 % const double black_point,const double white_point)
6452 % A description of each parameter follows:
6454 % o wand: the magick wand.
6456 % o black_point: the black point.
6458 % o white_point: the white point.
6461 WandExport MagickBooleanType MagickLinearStretchImage(MagickWand *wand,
6462 const double black_point,const double white_point)
6467 assert(wand != (MagickWand *) NULL);
6468 assert(wand->signature == MagickWandSignature);
6469 if (IfMagickTrue(wand->debug))
6470 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6471 if (wand->images == (Image *) NULL)
6472 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6473 status=LinearStretchImage(wand->images,black_point,white_point,
6479 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6483 % M a g i c k L i q u i d R e s c a l e I m a g e %
6487 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6489 % MagickLiquidRescaleImage() rescales image with seam carving.
6491 % MagickBooleanType MagickLiquidRescaleImage(MagickWand *wand,
6492 % const size_t columns,const size_t rows,
6493 % const double delta_x,const double rigidity)
6495 % A description of each parameter follows:
6497 % o wand: the magick wand.
6499 % o columns: the number of columns in the scaled image.
6501 % o rows: the number of rows in the scaled image.
6503 % o delta_x: maximum seam transversal step (0 means straight seams).
6505 % o rigidity: introduce a bias for non-straight seams (typically 0).
6508 WandExport MagickBooleanType MagickLiquidRescaleImage(MagickWand *wand,
6509 const size_t columns,const size_t rows,const double delta_x,
6510 const double rigidity)
6515 assert(wand != (MagickWand *) NULL);
6516 assert(wand->signature == MagickWandSignature);
6517 if (IfMagickTrue(wand->debug))
6518 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6519 if (wand->images == (Image *) NULL)
6520 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6521 rescale_image=LiquidRescaleImage(wand->images,columns,rows,delta_x,
6522 rigidity,wand->exception);
6523 if (rescale_image == (Image *) NULL)
6524 return(MagickFalse);
6525 ReplaceImageInList(&wand->images,rescale_image);
6530 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6534 % M a g i c k M a g n i f y I m a g e %
6538 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6540 % MagickMagnifyImage() is a convenience method that scales an image
6541 % proportionally to twice its original size.
6543 % The format of the MagickMagnifyImage method is:
6545 % MagickBooleanType MagickMagnifyImage(MagickWand *wand)
6547 % A description of each parameter follows:
6549 % o wand: the magick wand.
6552 WandExport MagickBooleanType MagickMagnifyImage(MagickWand *wand)
6557 assert(wand != (MagickWand *) NULL);
6558 assert(wand->signature == MagickWandSignature);
6559 if (IfMagickTrue(wand->debug))
6560 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6561 if (wand->images == (Image *) NULL)
6562 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6563 magnify_image=MagnifyImage(wand->images,wand->exception);
6564 if (magnify_image == (Image *) NULL)
6565 return(MagickFalse);
6566 ReplaceImageInList(&wand->images,magnify_image);
6571 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6575 % M a g i c k M e r g e I m a g e L a y e r s %
6579 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6581 % MagickMergeImageLayers() composes all the image layers from the current
6582 % given image onward to produce a single image of the merged layers.
6584 % The inital canvas's size depends on the given LayerMethod, and is
6585 % initialized using the first images background color. The images
6586 % are then compositied onto that image in sequence using the given
6587 % composition that has been assigned to each individual image.
6589 % The format of the MagickMergeImageLayers method is:
6591 % MagickWand *MagickMergeImageLayers(MagickWand *wand,
6592 % const LayerMethod method)
6594 % A description of each parameter follows:
6596 % o wand: the magick wand.
6598 % o method: the method of selecting the size of the initial canvas.
6600 % MergeLayer: Merge all layers onto a canvas just large enough
6601 % to hold all the actual images. The virtual canvas of the
6602 % first image is preserved but otherwise ignored.
6604 % FlattenLayer: Use the virtual canvas size of first image.
6605 % Images which fall outside this canvas is clipped.
6606 % This can be used to 'fill out' a given virtual canvas.
6608 % MosaicLayer: Start with the virtual canvas of the first image,
6609 % enlarging left and right edges to contain all images.
6610 % Images with negative offsets will be clipped.
6613 WandExport MagickWand *MagickMergeImageLayers(MagickWand *wand,
6614 const LayerMethod method)
6619 assert(wand != (MagickWand *) NULL);
6620 assert(wand->signature == MagickWandSignature);
6621 if (IfMagickTrue(wand->debug))
6622 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6623 if (wand->images == (Image *) NULL)
6624 return((MagickWand *) NULL);
6625 mosaic_image=MergeImageLayers(wand->images,method,wand->exception);
6626 if (mosaic_image == (Image *) NULL)
6627 return((MagickWand *) NULL);
6628 return(CloneMagickWandFromImages(wand,mosaic_image));
6632 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6636 % M a g i c k M i n i f y I m a g e %
6640 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6642 % MagickMinifyImage() is a convenience method that scales an image
6643 % proportionally to one-half its original size
6645 % The format of the MagickMinifyImage method is:
6647 % MagickBooleanType MagickMinifyImage(MagickWand *wand)
6649 % A description of each parameter follows:
6651 % o wand: the magick wand.
6654 WandExport MagickBooleanType MagickMinifyImage(MagickWand *wand)
6659 assert(wand != (MagickWand *) NULL);
6660 assert(wand->signature == MagickWandSignature);
6661 if (IfMagickTrue(wand->debug))
6662 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6663 if (wand->images == (Image *) NULL)
6664 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6665 minify_image=MinifyImage(wand->images,wand->exception);
6666 if (minify_image == (Image *) NULL)
6667 return(MagickFalse);
6668 ReplaceImageInList(&wand->images,minify_image);
6673 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6677 % M a g i c k M o d u l a t e I m a g e %
6681 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6683 % MagickModulateImage() lets you control the brightness, saturation, and hue
6684 % of an image. Hue is the percentage of absolute rotation from the current
6685 % position. For example 50 results in a counter-clockwise rotation of 90
6686 % degrees, 150 results in a clockwise rotation of 90 degrees, with 0 and 200
6687 % both resulting in a rotation of 180 degrees.
6689 % To increase the color brightness by 20% and decrease the color saturation by
6690 % 10% and leave the hue unchanged, use: 120,90,100.
6692 % The format of the MagickModulateImage method is:
6694 % MagickBooleanType MagickModulateImage(MagickWand *wand,
6695 % const double brightness,const double saturation,const double hue)
6697 % A description of each parameter follows:
6699 % o wand: the magick wand.
6701 % o brightness: the percent change in brighness.
6703 % o saturation: the percent change in saturation.
6705 % o hue: the percent change in hue.
6708 WandExport MagickBooleanType MagickModulateImage(MagickWand *wand,
6709 const double brightness,const double saturation,const double hue)
6712 modulate[MagickPathExtent];
6717 assert(wand != (MagickWand *) NULL);
6718 assert(wand->signature == MagickWandSignature);
6719 if (IfMagickTrue(wand->debug))
6720 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6721 if (wand->images == (Image *) NULL)
6722 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6723 (void) FormatLocaleString(modulate,MagickPathExtent,"%g,%g,%g",
6724 brightness,saturation,hue);
6725 status=ModulateImage(wand->images,modulate,wand->exception);
6730 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6734 % M a g i c k M o n t a g e I m a g e %
6738 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6740 % MagickMontageImage() creates a composite image by combining several
6741 % separate images. The images are tiled on the composite image with the name
6742 % of the image optionally appearing just below the individual tile.
6744 % The format of the MagickMontageImage method is:
6746 % MagickWand *MagickMontageImage(MagickWand *wand,
6747 % const DrawingWand drawing_wand,const char *tile_geometry,
6748 % const char *thumbnail_geometry,const MontageMode mode,
6749 % const char *frame)
6751 % A description of each parameter follows:
6753 % o wand: the magick wand.
6755 % o drawing_wand: the drawing wand. The font name, size, and color are
6756 % obtained from this wand.
6758 % o tile_geometry: the number of tiles per row and page (e.g. 6x4+0+0).
6760 % o thumbnail_geometry: Preferred image size and border size of each
6761 % thumbnail (e.g. 120x120+4+3>).
6763 % o mode: Thumbnail framing mode: Frame, Unframe, or Concatenate.
6765 % o frame: Surround the image with an ornamental border (e.g. 15x15+3+3).
6766 % The frame color is that of the thumbnail's matte color.
6769 WandExport MagickWand *MagickMontageImage(MagickWand *wand,
6770 const DrawingWand *drawing_wand,const char *tile_geometry,
6771 const char *thumbnail_geometry,const MontageMode mode,const char *frame)
6785 assert(wand != (MagickWand *) NULL);
6786 assert(wand->signature == MagickWandSignature);
6787 if (IfMagickTrue(wand->debug))
6788 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6789 if (wand->images == (Image *) NULL)
6790 return((MagickWand *) NULL);
6791 montage_info=CloneMontageInfo(wand->image_info,(MontageInfo *) NULL);
6796 (void) CloneString(&montage_info->frame,"15x15+3+3");
6797 montage_info->shadow=MagickTrue;
6802 montage_info->frame=(char *) NULL;
6803 montage_info->shadow=MagickFalse;
6804 montage_info->border_width=0;
6807 case ConcatenateMode:
6809 montage_info->frame=(char *) NULL;
6810 montage_info->shadow=MagickFalse;
6811 (void) CloneString(&montage_info->geometry,"+0+0");
6812 montage_info->border_width=0;
6818 font=DrawGetFont(drawing_wand);
6819 if (font != (char *) NULL)
6820 (void) CloneString(&montage_info->font,font);
6821 if (frame != (char *) NULL)
6822 (void) CloneString(&montage_info->frame,frame);
6823 montage_info->pointsize=DrawGetFontSize(drawing_wand);
6824 pixel_wand=NewPixelWand();
6825 DrawGetFillColor(drawing_wand,pixel_wand);
6826 PixelGetQuantumPacket(pixel_wand,&montage_info->fill);
6827 DrawGetStrokeColor(drawing_wand,pixel_wand);
6828 PixelGetQuantumPacket(pixel_wand,&montage_info->stroke);
6829 pixel_wand=DestroyPixelWand(pixel_wand);
6830 if (thumbnail_geometry != (char *) NULL)
6831 (void) CloneString(&montage_info->geometry,thumbnail_geometry);
6832 if (tile_geometry != (char *) NULL)
6833 (void) CloneString(&montage_info->tile,tile_geometry);
6834 montage_image=MontageImageList(wand->image_info,montage_info,wand->images,
6836 montage_info=DestroyMontageInfo(montage_info);
6837 if (montage_image == (Image *) NULL)
6838 return((MagickWand *) NULL);
6839 return(CloneMagickWandFromImages(wand,montage_image));
6843 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6847 % M a g i c k M o r p h I m a g e s %
6851 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6853 % MagickMorphImages() method morphs a set of images. Both the image pixels
6854 % and size are linearly interpolated to give the appearance of a
6855 % meta-morphosis from one image to the next.
6857 % The format of the MagickMorphImages method is:
6859 % MagickWand *MagickMorphImages(MagickWand *wand,
6860 % const size_t number_frames)
6862 % A description of each parameter follows:
6864 % o wand: the magick wand.
6866 % o number_frames: the number of in-between images to generate.
6869 WandExport MagickWand *MagickMorphImages(MagickWand *wand,
6870 const size_t number_frames)
6875 assert(wand != (MagickWand *) NULL);
6876 assert(wand->signature == MagickWandSignature);
6877 if (IfMagickTrue(wand->debug))
6878 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6879 if (wand->images == (Image *) NULL)
6880 return((MagickWand *) NULL);
6881 morph_image=MorphImages(wand->images,number_frames,wand->exception);
6882 if (morph_image == (Image *) NULL)
6883 return((MagickWand *) NULL);
6884 return(CloneMagickWandFromImages(wand,morph_image));
6888 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6892 % M a g i c k M o r p h o l o g y I m a g e %
6896 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6898 % MagickMorphologyImage() applies a user supplied kernel to the image
6899 % according to the given mophology method.
6901 % The format of the MagickMorphologyImage method is:
6903 % MagickBooleanType MagickMorphologyImage(MagickWand *wand,
6904 % MorphologyMethod method,const ssize_t iterations,KernelInfo *kernel)
6906 % A description of each parameter follows:
6908 % o wand: the magick wand.
6910 % o method: the morphology method to be applied.
6912 % o iterations: apply the operation this many times (or no change).
6913 % A value of -1 means loop until no change found. How this is applied
6914 % may depend on the morphology method. Typically this is a value of 1.
6916 % o kernel: An array of doubles representing the morphology kernel.
6919 WandExport MagickBooleanType MagickMorphologyImage(MagickWand *wand,
6920 MorphologyMethod method,const ssize_t iterations,KernelInfo *kernel)
6925 assert(wand != (MagickWand *) NULL);
6926 assert(wand->signature == MagickWandSignature);
6927 if (IfMagickTrue(wand->debug))
6928 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6929 if (kernel == (const KernelInfo *) NULL)
6930 return(MagickFalse);
6931 if (wand->images == (Image *) NULL)
6932 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6933 morphology_image=MorphologyImage(wand->images,method,iterations,kernel,
6935 if (morphology_image == (Image *) NULL)
6936 return(MagickFalse);
6937 ReplaceImageInList(&wand->images,morphology_image);
6942 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6946 % M a g i c k M o t i o n B l u r I m a g e %
6950 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6952 % MagickMotionBlurImage() simulates motion blur. We convolve the image with a
6953 % Gaussian operator of the given radius and standard deviation (sigma).
6954 % For reasonable results, radius should be larger than sigma. Use a
6955 % radius of 0 and MotionBlurImage() selects a suitable radius for you.
6956 % Angle gives the angle of the blurring motion.
6958 % The format of the MagickMotionBlurImage method is:
6960 % MagickBooleanType MagickMotionBlurImage(MagickWand *wand,
6961 % const double radius,const double sigma,const double angle)
6963 % A description of each parameter follows:
6965 % o wand: the magick wand.
6967 % o radius: the radius of the Gaussian, in pixels, not counting
6970 % o sigma: the standard deviation of the Gaussian, in pixels.
6972 % o angle: Apply the effect along this angle.
6975 WandExport MagickBooleanType MagickMotionBlurImage(MagickWand *wand,
6976 const double radius,const double sigma,const double angle)
6981 assert(wand != (MagickWand *) NULL);
6982 assert(wand->signature == MagickWandSignature);
6983 if (IfMagickTrue(wand->debug))
6984 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
6985 if (wand->images == (Image *) NULL)
6986 ThrowWandException(WandError,"ContainsNoImages",wand->name);
6987 blur_image=MotionBlurImage(wand->images,radius,sigma,angle,wand->exception);
6988 if (blur_image == (Image *) NULL)
6989 return(MagickFalse);
6990 ReplaceImageInList(&wand->images,blur_image);
6995 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6999 % M a g i c k N e g a t e I m a g e %
7003 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7005 % MagickNegateImage() negates the colors in the reference image. The
7006 % Grayscale option means that only grayscale values within the image are
7009 % You can also reduce the influence of a particular channel with a gamma
7012 % The format of the MagickNegateImage method is:
7014 % MagickBooleanType MagickNegateImage(MagickWand *wand,
7015 % const MagickBooleanType gray)
7017 % A description of each parameter follows:
7019 % o wand: the magick wand.
7021 % o gray: If MagickTrue, only negate grayscale pixels within the image.
7024 WandExport MagickBooleanType MagickNegateImage(MagickWand *wand,
7025 const MagickBooleanType gray)
7030 assert(wand != (MagickWand *) NULL);
7031 assert(wand->signature == MagickWandSignature);
7032 if (IfMagickTrue(wand->debug))
7033 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7034 if (wand->images == (Image *) NULL)
7035 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7036 status=NegateImage(wand->images,gray,wand->exception);
7041 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7045 % M a g i c k N e w I m a g e %
7049 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7051 % MagickNewImage() adds a blank image canvas of the specified size and
7052 % background color to the wand.
7054 % The format of the MagickNewImage method is:
7056 % MagickBooleanType MagickNewImage(MagickWand *wand,
7057 % const size_t columns,const size_t rows,
7058 % const PixelWand *background)
7060 % A description of each parameter follows:
7062 % o wand: the magick wand.
7064 % o width: the image width.
7066 % o height: the image height.
7068 % o background: the image color.
7071 WandExport MagickBooleanType MagickNewImage(MagickWand *wand,const size_t width,
7072 const size_t height,const PixelWand *background)
7080 assert(wand != (MagickWand *) NULL);
7081 assert(wand->signature == MagickWandSignature);
7082 if (IfMagickTrue(wand->debug))
7083 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7084 PixelGetMagickColor(background,&pixel);
7085 images=NewMagickImage(wand->image_info,width,height,&pixel,wand->exception);
7086 if (images == (Image *) NULL)
7087 return(MagickFalse);
7088 return(InsertImageInWand(wand,images));
7092 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7096 % M a g i c k N e x t I m a g e %
7100 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7102 % MagickNextImage() sets the next image in the wand as the current image.
7104 % It is typically used after MagickResetIterator(), after which its first use
7105 % will set the first image as the current image (unless the wand is empty).
7107 % It will return MagickFalse when no more images are left to be returned
7108 % which happens when the wand is empty, or the current image is the last
7111 % When the above condition (end of image list) is reached, the iterator is
7112 % automaticall set so that you can start using MagickPreviousImage() to
7113 % again iterate over the images in the reverse direction, starting with the
7114 % last image (again). You can jump to this condition immeditally using
7115 % MagickSetLastIterator().
7117 % The format of the MagickNextImage method is:
7119 % MagickBooleanType MagickNextImage(MagickWand *wand)
7121 % A description of each parameter follows:
7123 % o wand: the magick wand.
7126 WandExport MagickBooleanType MagickNextImage(MagickWand *wand)
7128 assert(wand != (MagickWand *) NULL);
7129 assert(wand->signature == MagickWandSignature);
7130 if (IfMagickTrue(wand->debug))
7131 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7132 if (wand->images == (Image *) NULL)
7133 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7134 wand->insert_before=MagickFalse; /* Inserts is now appended */
7135 if (IfMagickTrue(wand->image_pending))
7137 wand->image_pending=MagickFalse;
7140 if (GetNextImageInList(wand->images) == (Image *) NULL)
7142 wand->image_pending=MagickTrue; /* No image, PreviousImage re-gets */
7143 return(MagickFalse);
7145 wand->images=GetNextImageInList(wand->images);
7150 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7154 % M a g i c k N o r m a l i z e I m a g e %
7158 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7160 % MagickNormalizeImage() enhances the contrast of a color image by adjusting
7161 % the pixels color to span the entire range of colors available
7163 % You can also reduce the influence of a particular channel with a gamma
7166 % The format of the MagickNormalizeImage method is:
7168 % MagickBooleanType MagickNormalizeImage(MagickWand *wand)
7170 % A description of each parameter follows:
7172 % o wand: the magick wand.
7175 WandExport MagickBooleanType MagickNormalizeImage(MagickWand *wand)
7180 assert(wand != (MagickWand *) NULL);
7181 assert(wand->signature == MagickWandSignature);
7182 if (IfMagickTrue(wand->debug))
7183 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7184 if (wand->images == (Image *) NULL)
7185 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7186 status=NormalizeImage(wand->images,wand->exception);
7191 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7195 % M a g i c k O i l P a i n t I m a g e %
7199 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7201 % MagickOilPaintImage() applies a special effect filter that simulates an oil
7202 % painting. Each pixel is replaced by the most frequent color occurring
7203 % in a circular region defined by radius.
7205 % The format of the MagickOilPaintImage method is:
7207 % MagickBooleanType MagickOilPaintImage(MagickWand *wand,
7208 % const double radius,const double sigma)
7210 % A description of each parameter follows:
7212 % o wand: the magick wand.
7214 % o radius: the radius of the circular neighborhood.
7216 % o sigma: the standard deviation of the Gaussian, in pixels.
7219 WandExport MagickBooleanType MagickOilPaintImage(MagickWand *wand,
7220 const double radius,const double sigma)
7225 assert(wand != (MagickWand *) NULL);
7226 assert(wand->signature == MagickWandSignature);
7227 if (IfMagickTrue(wand->debug))
7228 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7229 if (wand->images == (Image *) NULL)
7230 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7231 paint_image=OilPaintImage(wand->images,radius,sigma,wand->exception);
7232 if (paint_image == (Image *) NULL)
7233 return(MagickFalse);
7234 ReplaceImageInList(&wand->images,paint_image);
7239 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7243 % M a g i c k O p a q u e P a i n t I m a g e %
7247 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7249 % MagickOpaquePaintImage() changes any pixel that matches color with the color
7252 % The format of the MagickOpaquePaintImage method is:
7254 % MagickBooleanType MagickOpaquePaintImage(MagickWand *wand,
7255 % const PixelWand *target,const PixelWand *fill,const double fuzz,
7256 % const MagickBooleanType invert)
7258 % A description of each parameter follows:
7260 % o wand: the magick wand.
7262 % o target: Change this target color to the fill color within the image.
7264 % o fill: the fill pixel wand.
7266 % o fuzz: By default target must match a particular pixel color
7267 % exactly. However, in many cases two colors may differ by a small amount.
7268 % The fuzz member of image defines how much tolerance is acceptable to
7269 % consider two colors as the same. For example, set fuzz to 10 and the
7270 % color red at intensities of 100 and 102 respectively are now interpreted
7271 % as the same color for the purposes of the floodfill.
7273 % o invert: paint any pixel that does not match the target color.
7276 WandExport MagickBooleanType MagickOpaquePaintImage(MagickWand *wand,
7277 const PixelWand *target,const PixelWand *fill,const double fuzz,
7278 const MagickBooleanType invert)
7287 assert(wand != (MagickWand *) NULL);
7288 assert(wand->signature == MagickWandSignature);
7289 if (IfMagickTrue(wand->debug))
7290 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7291 if (wand->images == (Image *) NULL)
7292 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7293 PixelGetMagickColor(target,&target_pixel);
7294 PixelGetMagickColor(fill,&fill_pixel);
7295 wand->images->fuzz=fuzz;
7296 status=OpaquePaintImage(wand->images,&target_pixel,&fill_pixel,invert,
7302 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7306 % M a g i c k O p t i m i z e I m a g e L a y e r s %
7310 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7312 % MagickOptimizeImageLayers() compares each image the GIF disposed forms of the
7313 % previous image in the sequence. From this it attempts to select the
7314 % smallest cropped image to replace each frame, while preserving the results
7317 % The format of the MagickOptimizeImageLayers method is:
7319 % MagickWand *MagickOptimizeImageLayers(MagickWand *wand)
7321 % A description of each parameter follows:
7323 % o wand: the magick wand.
7326 WandExport MagickWand *MagickOptimizeImageLayers(MagickWand *wand)
7331 assert(wand != (MagickWand *) NULL);
7332 assert(wand->signature == MagickWandSignature);
7333 if (IfMagickTrue(wand->debug))
7334 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7335 if (wand->images == (Image *) NULL)
7336 return((MagickWand *) NULL);
7337 optimize_image=OptimizeImageLayers(wand->images,wand->exception);
7338 if (optimize_image == (Image *) NULL)
7339 return((MagickWand *) NULL);
7340 return(CloneMagickWandFromImages(wand,optimize_image));
7344 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7348 % M a g i c k O p t i m i z e I m a g e T r a n s p a r e n c y %
7352 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7354 % MagickOptimizeImageTransparency() takes a frame optimized GIF animation, and
7355 % compares the overlayed pixels against the disposal image resulting from all
7356 % the previous frames in the animation. Any pixel that does not change the
7357 % disposal image (and thus does not effect the outcome of an overlay) is made
7360 % WARNING: This modifies the current images directly, rather than generate
7361 % a new image sequence.
7362 % The format of the MagickOptimizeImageTransparency method is:
7364 % MagickBooleanType MagickOptimizeImageTransparency(MagickWand *wand)
7366 % A description of each parameter follows:
7368 % o wand: the magick wand.
7371 WandExport MagickBooleanType MagickOptimizeImageTransparency(MagickWand *wand)
7373 assert(wand != (MagickWand *) NULL);
7374 assert(wand->signature == MagickWandSignature);
7375 if (IfMagickTrue(wand->debug))
7376 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7377 if (wand->images == (Image *) NULL)
7378 return(MagickFalse);
7379 OptimizeImageTransparency(wand->images,wand->exception);
7384 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7388 % M a g i c k O r d e r e d P o s t e r i z e I m a g e %
7392 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7394 % MagickOrderedPosterizeImage() performs an ordered dither based on a number
7395 % of pre-defined dithering threshold maps, but over multiple intensity levels,
7396 % which can be different for different channels, according to the input
7399 % The format of the MagickOrderedPosterizeImage method is:
7401 % MagickBooleanType MagickOrderedPosterizeImage(MagickWand *wand,
7402 % const char *threshold_map)
7404 % A description of each parameter follows:
7406 % o image: the image.
7408 % o threshold_map: A string containing the name of the threshold dither
7409 % map to use, followed by zero or more numbers representing the number of
7410 % color levels tho dither between.
7412 % Any level number less than 2 is equivalent to 2, and means only binary
7413 % dithering will be applied to each color channel.
7415 % No numbers also means a 2 level (bitmap) dither will be applied to all
7416 % channels, while a single number is the number of levels applied to each
7417 % channel in sequence. More numbers will be applied in turn to each of
7418 % the color channels.
7420 % For example: "o3x3,6" generates a 6 level posterization of the image
7421 % with a ordered 3x3 diffused pixel dither being applied between each
7422 % level. While checker,8,8,4 will produce a 332 colormaped image with
7423 % only a single checkerboard hash pattern (50% grey) between each color
7424 % level, to basically double the number of color levels with a bare
7425 % minimim of dithering.
7428 WandExport MagickBooleanType MagickOrderedPosterizeImage(MagickWand *wand,
7429 const char *threshold_map)
7434 assert(wand != (MagickWand *) NULL);
7435 assert(wand->signature == MagickWandSignature);
7436 if (IfMagickTrue(wand->debug))
7437 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7438 if (wand->images == (Image *) NULL)
7439 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7440 status=OrderedPosterizeImage(wand->images,threshold_map,wand->exception);
7445 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7449 % M a g i c k P i n g I m a g e %
7453 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7455 % MagickPingImage() is the same as MagickReadImage() except the only valid
7456 % information returned is the image width, height, size, and format. It
7457 % is designed to efficiently obtain this information from a file without
7458 % reading the entire image sequence into memory.
7460 % The format of the MagickPingImage method is:
7462 % MagickBooleanType MagickPingImage(MagickWand *wand,const char *filename)
7464 % A description of each parameter follows:
7466 % o wand: the magick wand.
7468 % o filename: the image filename.
7471 WandExport MagickBooleanType MagickPingImage(MagickWand *wand,
7472 const char *filename)
7480 assert(wand != (MagickWand *) NULL);
7481 assert(wand->signature == MagickWandSignature);
7482 if (IfMagickTrue(wand->debug))
7483 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7484 ping_info=CloneImageInfo(wand->image_info);
7485 if (filename != (const char *) NULL)
7486 (void) CopyMagickString(ping_info->filename,filename,MagickPathExtent);
7487 images=PingImage(ping_info,wand->exception);
7488 ping_info=DestroyImageInfo(ping_info);
7489 if (images == (Image *) NULL)
7490 return(MagickFalse);
7491 return(InsertImageInWand(wand,images));
7495 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7499 % M a g i c k P i n g I m a g e B l o b %
7503 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7505 % MagickPingImageBlob() pings an image or image sequence from a blob.
7507 % The format of the MagickPingImageBlob method is:
7509 % MagickBooleanType MagickPingImageBlob(MagickWand *wand,
7510 % const void *blob,const size_t length)
7512 % A description of each parameter follows:
7514 % o wand: the magick wand.
7518 % o length: the blob length.
7521 WandExport MagickBooleanType MagickPingImageBlob(MagickWand *wand,
7522 const void *blob,const size_t length)
7530 assert(wand != (MagickWand *) NULL);
7531 assert(wand->signature == MagickWandSignature);
7532 if (wand->debug != MagickFalse)
7533 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7534 read_info=CloneImageInfo(wand->image_info);
7535 SetImageInfoBlob(read_info,blob,length);
7536 images=PingImage(read_info,wand->exception);
7537 read_info=DestroyImageInfo(read_info);
7538 if (images == (Image *) NULL)
7539 return(MagickFalse);
7540 return(InsertImageInWand(wand,images));
7544 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7548 % M a g i c k P i n g I m a g e F i l e %
7552 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7554 % MagickPingImageFile() pings an image or image sequence from an open file
7557 % The format of the MagickPingImageFile method is:
7559 % MagickBooleanType MagickPingImageFile(MagickWand *wand,FILE *file)
7561 % A description of each parameter follows:
7563 % o wand: the magick wand.
7565 % o file: the file descriptor.
7568 WandExport MagickBooleanType MagickPingImageFile(MagickWand *wand,FILE *file)
7576 assert(wand != (MagickWand *) NULL);
7577 assert(wand->signature == MagickWandSignature);
7578 assert(file != (FILE *) NULL);
7579 if (IfMagickTrue(wand->debug))
7580 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7581 read_info=CloneImageInfo(wand->image_info);
7582 SetImageInfoFile(read_info,file);
7583 images=PingImage(read_info,wand->exception);
7584 read_info=DestroyImageInfo(read_info);
7585 if (images == (Image *) NULL)
7586 return(MagickFalse);
7587 return(InsertImageInWand(wand,images));
7591 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7595 % M a g i c k P o l a r o i d I m a g e %
7599 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7601 % MagickPolaroidImage() simulates a Polaroid picture.
7603 % The format of the MagickPolaroidImage method is:
7605 % MagickBooleanType MagickPolaroidImage(MagickWand *wand,
7606 % const DrawingWand *drawing_wand,const char *caption,const double angle,
7607 % const PixelInterpolateMethod method)
7609 % A description of each parameter follows:
7611 % o wand: the magick wand.
7613 % o drawing_wand: the draw wand.
7615 % o caption: the Polaroid caption.
7617 % o angle: Apply the effect along this angle.
7619 % o method: the pixel interpolation method.
7622 WandExport MagickBooleanType MagickPolaroidImage(MagickWand *wand,
7623 const DrawingWand *drawing_wand,const char *caption,const double angle,
7624 const PixelInterpolateMethod method)
7632 assert(wand != (MagickWand *) NULL);
7633 assert(wand->signature == MagickWandSignature);
7634 if (IfMagickTrue(wand->debug))
7635 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7636 if (wand->images == (Image *) NULL)
7637 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7638 draw_info=PeekDrawingWand(drawing_wand);
7639 if (draw_info == (DrawInfo *) NULL)
7640 return(MagickFalse);
7641 polaroid_image=PolaroidImage(wand->images,draw_info,caption,angle,method,
7643 if (polaroid_image == (Image *) NULL)
7644 return(MagickFalse);
7645 ReplaceImageInList(&wand->images,polaroid_image);
7650 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7654 % M a g i c k P o s t e r i z e I m a g e %
7658 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7660 % MagickPosterizeImage() reduces the image to a limited number of color level.
7662 % The format of the MagickPosterizeImage method is:
7664 % MagickBooleanType MagickPosterizeImage(MagickWand *wand,
7665 % const size_t levels,const DitherMethod method)
7667 % A description of each parameter follows:
7669 % o wand: the magick wand.
7671 % o levels: Number of color levels allowed in each channel. Very low values
7672 % (2, 3, or 4) have the most visible effect.
7674 % o method: choose the dither method: UndefinedDitherMethod,
7675 % NoDitherMethod, RiemersmaDitherMethod, or FloydSteinbergDitherMethod.
7678 WandExport MagickBooleanType MagickPosterizeImage(MagickWand *wand,
7679 const size_t levels,const DitherMethod dither)
7684 assert(wand != (MagickWand *) NULL);
7685 assert(wand->signature == MagickWandSignature);
7686 if (IfMagickTrue(wand->debug))
7687 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7688 if (wand->images == (Image *) NULL)
7689 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7690 status=PosterizeImage(wand->images,levels,dither,wand->exception);
7695 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7699 % M a g i c k P r e v i e w I m a g e s %
7703 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7705 % MagickPreviewImages() tiles 9 thumbnails of the specified image with an
7706 % image processing operation applied at varying strengths. This helpful
7707 % to quickly pin-point an appropriate parameter for an image processing
7710 % The format of the MagickPreviewImages method is:
7712 % MagickWand *MagickPreviewImages(MagickWand *wand,
7713 % const PreviewType preview)
7715 % A description of each parameter follows:
7717 % o wand: the magick wand.
7719 % o preview: the preview type.
7722 WandExport MagickWand *MagickPreviewImages(MagickWand *wand,
7723 const PreviewType preview)
7728 assert(wand != (MagickWand *) NULL);
7729 assert(wand->signature == MagickWandSignature);
7730 if (IfMagickTrue(wand->debug))
7731 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7732 if (wand->images == (Image *) NULL)
7733 return((MagickWand *) NULL);
7734 preview_image=PreviewImage(wand->images,preview,wand->exception);
7735 if (preview_image == (Image *) NULL)
7736 return((MagickWand *) NULL);
7737 return(CloneMagickWandFromImages(wand,preview_image));
7741 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7745 % M a g i c k P r e v i o u s I m a g e %
7749 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7751 % MagickPreviousImage() sets the previous image in the wand as the current
7754 % It is typically used after MagickSetLastIterator(), after which its first
7755 % use will set the last image as the current image (unless the wand is empty).
7757 % It will return MagickFalse when no more images are left to be returned
7758 % which happens when the wand is empty, or the current image is the first
7759 % image. At that point the iterator is than reset to again process images in
7760 % the forward direction, again starting with the first image in list. Images
7761 % added at this point are prepended.
7763 % Also at that point any images added to the wand using MagickAddImages() or
7764 % MagickReadImages() will be prepended before the first image. In this sense
7765 % the condition is not quite exactly the same as MagickResetIterator().
7767 % The format of the MagickPreviousImage method is:
7769 % MagickBooleanType MagickPreviousImage(MagickWand *wand)
7771 % A description of each parameter follows:
7773 % o wand: the magick wand.
7776 WandExport MagickBooleanType MagickPreviousImage(MagickWand *wand)
7778 assert(wand != (MagickWand *) NULL);
7779 assert(wand->signature == MagickWandSignature);
7780 if (IfMagickTrue(wand->debug))
7781 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7782 if (wand->images == (Image *) NULL)
7783 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7784 if (IfMagickTrue(wand->image_pending))
7786 wand->image_pending=MagickFalse; /* image returned no longer pending */
7789 if (GetPreviousImageInList(wand->images) == (Image *) NULL)
7791 wand->image_pending=MagickTrue; /* Next now re-gets first image */
7792 wand->insert_before=MagickTrue; /* insert/add prepends new images */
7793 return(MagickFalse);
7795 wand->images=GetPreviousImageInList(wand->images);
7800 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7804 % M a g i c k Q u a n t i z e I m a g e %
7808 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7810 % MagickQuantizeImage() analyzes the colors within a reference image and
7811 % chooses a fixed number of colors to represent the image. The goal of the
7812 % algorithm is to minimize the color difference between the input and output
7813 % image while minimizing the processing time.
7815 % The format of the MagickQuantizeImage method is:
7817 % MagickBooleanType MagickQuantizeImage(MagickWand *wand,
7818 % const size_t number_colors,const ColorspaceType colorspace,
7819 % const size_t treedepth,const DitherMethod dither_method,
7820 % const MagickBooleanType measure_error)
7822 % A description of each parameter follows:
7824 % o wand: the magick wand.
7826 % o number_colors: the number of colors.
7828 % o colorspace: Perform color reduction in this colorspace, typically
7831 % o treedepth: Normally, this integer value is zero or one. A zero or
7832 % one tells Quantize to choose a optimal tree depth of Log4(number_colors).% A tree of this depth generally allows the best representation of the
7833 % reference image with the least amount of memory and the fastest
7834 % computational speed. In some cases, such as an image with low color
7835 % dispersion (a few number of colors), a value other than
7836 % Log4(number_colors) is required. To expand the color tree completely,
7839 % o dither_method: choose from UndefinedDitherMethod, NoDitherMethod,
7840 % RiemersmaDitherMethod, FloydSteinbergDitherMethod.
7842 % o measure_error: A value other than zero measures the difference between
7843 % the original and quantized images. This difference is the total
7844 % quantization error. The error is computed by summing over all pixels
7845 % in an image the distance squared in RGB space between each reference
7846 % pixel value and its quantized value.
7849 WandExport MagickBooleanType MagickQuantizeImage(MagickWand *wand,
7850 const size_t number_colors,const ColorspaceType colorspace,
7851 const size_t treedepth,const DitherMethod dither_method,
7852 const MagickBooleanType measure_error)
7860 assert(wand != (MagickWand *) NULL);
7861 assert(wand->signature == MagickWandSignature);
7862 if (IfMagickTrue(wand->debug))
7863 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7864 if (wand->images == (Image *) NULL)
7865 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7866 quantize_info=CloneQuantizeInfo((QuantizeInfo *) NULL);
7867 quantize_info->number_colors=number_colors;
7868 quantize_info->dither_method=dither_method;
7869 quantize_info->tree_depth=treedepth;
7870 quantize_info->colorspace=colorspace;
7871 quantize_info->measure_error=measure_error;
7872 status=QuantizeImage(quantize_info,wand->images,wand->exception);
7873 quantize_info=DestroyQuantizeInfo(quantize_info);
7878 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7882 % M a g i c k Q u a n t i z e I m a g e s %
7886 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7888 % MagickQuantizeImages() analyzes the colors within a sequence of images and
7889 % chooses a fixed number of colors to represent the image. The goal of the
7890 % algorithm is to minimize the color difference between the input and output
7891 % image while minimizing the processing time.
7893 % The format of the MagickQuantizeImages method is:
7895 % MagickBooleanType MagickQuantizeImages(MagickWand *wand,
7896 % const size_t number_colors,const ColorspaceType colorspace,
7897 % const size_t treedepth,const DitherMethod dither_method,
7898 % const MagickBooleanType measure_error)
7900 % A description of each parameter follows:
7902 % o wand: the magick wand.
7904 % o number_colors: the number of colors.
7906 % o colorspace: Perform color reduction in this colorspace, typically
7909 % o treedepth: Normally, this integer value is zero or one. A zero or
7910 % one tells Quantize to choose a optimal tree depth of Log4(number_colors).% A tree of this depth generally allows the best representation of the
7911 % reference image with the least amount of memory and the fastest
7912 % computational speed. In some cases, such as an image with low color
7913 % dispersion (a few number of colors), a value other than
7914 % Log4(number_colors) is required. To expand the color tree completely,
7917 % o dither_method: choose from these dither methods: NoDitherMethod,
7918 % RiemersmaDitherMethod, or FloydSteinbergDitherMethod.
7920 % o measure_error: A value other than zero measures the difference between
7921 % the original and quantized images. This difference is the total
7922 % quantization error. The error is computed by summing over all pixels
7923 % in an image the distance squared in RGB space between each reference
7924 % pixel value and its quantized value.
7927 WandExport MagickBooleanType MagickQuantizeImages(MagickWand *wand,
7928 const size_t number_colors,const ColorspaceType colorspace,
7929 const size_t treedepth,const DitherMethod dither_method,
7930 const MagickBooleanType measure_error)
7938 assert(wand != (MagickWand *) NULL);
7939 assert(wand->signature == MagickWandSignature);
7940 if (IfMagickTrue(wand->debug))
7941 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7942 if (wand->images == (Image *) NULL)
7943 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7944 quantize_info=CloneQuantizeInfo((QuantizeInfo *) NULL);
7945 quantize_info->number_colors=number_colors;
7946 quantize_info->dither_method=dither_method;
7947 quantize_info->tree_depth=treedepth;
7948 quantize_info->colorspace=colorspace;
7949 quantize_info->measure_error=measure_error;
7950 status=QuantizeImages(quantize_info,wand->images,wand->exception);
7951 quantize_info=DestroyQuantizeInfo(quantize_info);
7956 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7960 % M a g i c k R o t a t i o n a l B l u r I m a g e %
7964 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7966 % MagickRotationalBlurImage() rotational blurs an image.
7968 % The format of the MagickRotationalBlurImage method is:
7970 % MagickBooleanType MagickRotationalBlurImage(MagickWand *wand,
7971 % const double angle)
7973 % A description of each parameter follows:
7975 % o wand: the magick wand.
7977 % o angle: the angle of the blur in degrees.
7980 WandExport MagickBooleanType MagickRotationalBlurImage(MagickWand *wand,
7986 assert(wand != (MagickWand *) NULL);
7987 assert(wand->signature == MagickWandSignature);
7988 if (IfMagickTrue(wand->debug))
7989 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
7990 if (wand->images == (Image *) NULL)
7991 ThrowWandException(WandError,"ContainsNoImages",wand->name);
7992 blur_image=RotationalBlurImage(wand->images,angle,wand->exception);
7993 if (blur_image == (Image *) NULL)
7994 return(MagickFalse);
7995 ReplaceImageInList(&wand->images,blur_image);
8000 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8004 % M a g i c k R a i s e I m a g e %
8008 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8010 % MagickRaiseImage() creates a simulated three-dimensional button-like effect
8011 % by lightening and darkening the edges of the image. Members width and
8012 % height of raise_info define the width of the vertical and horizontal
8013 % edge of the effect.
8015 % The format of the MagickRaiseImage method is:
8017 % MagickBooleanType MagickRaiseImage(MagickWand *wand,
8018 % const size_t width,const size_t height,const ssize_t x,
8019 % const ssize_t y,const MagickBooleanType raise)
8021 % A description of each parameter follows:
8023 % o wand: the magick wand.
8025 % o width,height,x,y: Define the dimensions of the area to raise.
8027 % o raise: A value other than zero creates a 3-D raise effect,
8028 % otherwise it has a lowered effect.
8031 WandExport MagickBooleanType MagickRaiseImage(MagickWand *wand,
8032 const size_t width,const size_t height,const ssize_t x,
8033 const ssize_t y,const MagickBooleanType raise)
8041 assert(wand != (MagickWand *) NULL);
8042 assert(wand->signature == MagickWandSignature);
8043 if (IfMagickTrue(wand->debug))
8044 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8045 if (wand->images == (Image *) NULL)
8046 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8047 raise_info.width=width;
8048 raise_info.height=height;
8051 status=RaiseImage(wand->images,&raise_info,raise,wand->exception);
8056 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8060 % M a g i c k R a n d o m T h r e s h o l d I m a g e %
8064 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8066 % MagickRandomThresholdImage() changes the value of individual pixels based on
8067 % the intensity of each pixel compared to threshold. The result is a
8068 % high-contrast, two color image.
8070 % The format of the MagickRandomThresholdImage method is:
8072 % MagickBooleanType MagickRandomThresholdImage(MagickWand *wand,
8073 % const double low,const double high)
8075 % A description of each parameter follows:
8077 % o wand: the magick wand.
8079 % o low,high: Specify the high and low thresholds. These values range from
8080 % 0 to QuantumRange.
8083 WandExport MagickBooleanType MagickRandomThresholdImage(MagickWand *wand,
8084 const double low,const double high)
8087 threshold[MagickPathExtent];
8089 assert(wand != (MagickWand *) NULL);
8090 assert(wand->signature == MagickWandSignature);
8091 if (IfMagickTrue(wand->debug))
8092 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8093 if (wand->images == (Image *) NULL)
8094 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8095 (void) FormatLocaleString(threshold,MagickPathExtent,"%gx%g",low,high);
8096 return(RandomThresholdImage(wand->images,threshold,wand->exception));
8100 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8104 % M a g i c k R e a d I m a g e %
8108 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8110 % MagickReadImage() reads an image or image sequence. The images are inserted
8111 % jjust before the current image pointer position.
8113 % Use MagickSetFirstIterator(), to insert new images before all the current
8114 % images in the wand, MagickSetLastIterator() to append add to the end,
8115 % MagickSetIteratorIndex() to place images just after the given index.
8117 % The format of the MagickReadImage method is:
8119 % MagickBooleanType MagickReadImage(MagickWand *wand,const char *filename)
8121 % A description of each parameter follows:
8123 % o wand: the magick wand.
8125 % o filename: the image filename.
8128 WandExport MagickBooleanType MagickReadImage(MagickWand *wand,
8129 const char *filename)
8137 assert(wand != (MagickWand *) NULL);
8138 assert(wand->signature == MagickWandSignature);
8139 if (IfMagickTrue(wand->debug))
8140 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8141 read_info=CloneImageInfo(wand->image_info);
8142 if (filename != (const char *) NULL)
8143 (void) CopyMagickString(read_info->filename,filename,MagickPathExtent);
8144 images=ReadImage(read_info,wand->exception);
8145 read_info=DestroyImageInfo(read_info);
8146 if (images == (Image *) NULL)
8147 return(MagickFalse);
8148 return(InsertImageInWand(wand,images));
8152 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8156 % M a g i c k R e a d I m a g e B l o b %
8160 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8162 % MagickReadImageBlob() reads an image or image sequence from a blob.
8163 % In all other respects it is like MagickReadImage().
8165 % The format of the MagickReadImageBlob method is:
8167 % MagickBooleanType MagickReadImageBlob(MagickWand *wand,
8168 % const void *blob,const size_t length)
8170 % A description of each parameter follows:
8172 % o wand: the magick wand.
8176 % o length: the blob length.
8179 WandExport MagickBooleanType MagickReadImageBlob(MagickWand *wand,
8180 const void *blob,const size_t length)
8185 assert(wand != (MagickWand *) NULL);
8186 assert(wand->signature == MagickWandSignature);
8187 if (IfMagickTrue(wand->debug))
8188 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8189 images=BlobToImage(wand->image_info,blob,length,wand->exception);
8190 if (images == (Image *) NULL)
8191 return(MagickFalse);
8192 return(InsertImageInWand(wand,images));
8196 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8200 % M a g i c k R e a d I m a g e F i l e %
8204 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8206 % MagickReadImageFile() reads an image or image sequence from an already
8207 % opened file descriptor. Otherwise it is like MagickReadImage().
8209 % The format of the MagickReadImageFile method is:
8211 % MagickBooleanType MagickReadImageFile(MagickWand *wand,FILE *file)
8213 % A description of each parameter follows:
8215 % o wand: the magick wand.
8217 % o file: the file descriptor.
8220 WandExport MagickBooleanType MagickReadImageFile(MagickWand *wand,FILE *file)
8228 assert(wand != (MagickWand *) NULL);
8229 assert(wand->signature == MagickWandSignature);
8230 assert(file != (FILE *) NULL);
8231 if (IfMagickTrue(wand->debug))
8232 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8233 read_info=CloneImageInfo(wand->image_info);
8234 SetImageInfoFile(read_info,file);
8235 images=ReadImage(read_info,wand->exception);
8236 read_info=DestroyImageInfo(read_info);
8237 if (images == (Image *) NULL)
8238 return(MagickFalse);
8239 return(InsertImageInWand(wand,images));
8243 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8247 % M a g i c k R e m a p I m a g e %
8251 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8253 % MagickRemapImage() replaces the colors of an image with the closest color
8254 % from a reference image.
8256 % The format of the MagickRemapImage method is:
8258 % MagickBooleanType MagickRemapImage(MagickWand *wand,
8259 % const MagickWand *remap_wand,const DitherMethod method)
8261 % A description of each parameter follows:
8263 % o wand: the magick wand.
8265 % o affinity: the affinity wand.
8267 % o method: choose from these dither methods: NoDitherMethod,
8268 % RiemersmaDitherMethod, or FloydSteinbergDitherMethod.
8271 WandExport MagickBooleanType MagickRemapImage(MagickWand *wand,
8272 const MagickWand *remap_wand,const DitherMethod dither_method)
8280 assert(wand != (MagickWand *) NULL);
8281 assert(wand->signature == MagickWandSignature);
8282 if (IfMagickTrue(wand->debug))
8283 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8284 if ((wand->images == (Image *) NULL) ||
8285 (remap_wand->images == (Image *) NULL))
8286 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8287 quantize_info=AcquireQuantizeInfo(wand->image_info);
8288 quantize_info->dither_method=dither_method;
8289 status=RemapImage(quantize_info,wand->images,remap_wand->images,
8291 quantize_info=DestroyQuantizeInfo(quantize_info);
8296 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8300 % M a g i c k R e m o v e I m a g e %
8304 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8306 % MagickRemoveImage() removes an image from the image list.
8308 % The format of the MagickRemoveImage method is:
8310 % MagickBooleanType MagickRemoveImage(MagickWand *wand)
8312 % A description of each parameter follows:
8314 % o wand: the magick wand.
8316 % o insert: the splice wand.
8319 WandExport MagickBooleanType MagickRemoveImage(MagickWand *wand)
8321 assert(wand != (MagickWand *) NULL);
8322 assert(wand->signature == MagickWandSignature);
8323 if (IfMagickTrue(wand->debug))
8324 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8325 if (wand->images == (Image *) NULL)
8326 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8327 DeleteImageFromList(&wand->images);
8332 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8336 % M a g i c k R e s a m p l e I m a g e %
8340 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8342 % MagickResampleImage() resample image to desired resolution.
8344 % Bessel Blackman Box
8345 % Catrom Cubic Gaussian
8346 % Hanning Hermite Lanczos
8347 % Mitchell Point Quandratic
8350 % Most of the filters are FIR (finite impulse response), however, Bessel,
8351 % Gaussian, and Sinc are IIR (infinite impulse response). Bessel and Sinc
8352 % are windowed (brought down to zero) with the Blackman filter.
8354 % The format of the MagickResampleImage method is:
8356 % MagickBooleanType MagickResampleImage(MagickWand *wand,
8357 % const double x_resolution,const double y_resolution,
8358 % const FilterTypes filter)
8360 % A description of each parameter follows:
8362 % o wand: the magick wand.
8364 % o x_resolution: the new image x resolution.
8366 % o y_resolution: the new image y resolution.
8368 % o filter: Image filter to use.
8371 WandExport MagickBooleanType MagickResampleImage(MagickWand *wand,
8372 const double x_resolution,const double y_resolution,const FilterTypes filter)
8377 assert(wand != (MagickWand *) NULL);
8378 assert(wand->signature == MagickWandSignature);
8379 if (IfMagickTrue(wand->debug))
8380 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8381 if (wand->images == (Image *) NULL)
8382 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8383 resample_image=ResampleImage(wand->images,x_resolution,y_resolution,filter,
8385 if (resample_image == (Image *) NULL)
8386 return(MagickFalse);
8387 ReplaceImageInList(&wand->images,resample_image);
8392 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8396 % M a g i c k R e s e t I m a g e P a g e %
8400 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8402 % MagickResetImagePage() resets the Wand page canvas and position.
8404 % The format of the MagickResetImagePage method is:
8406 % MagickBooleanType MagickResetImagePage(MagickWand *wand,
8409 % A description of each parameter follows:
8411 % o wand: the magick wand.
8413 % o page: the relative page specification.
8416 WandExport MagickBooleanType MagickResetImagePage(MagickWand *wand,
8419 assert(wand != (MagickWand *) NULL);
8420 assert(wand->signature == MagickWandSignature);
8421 if (IfMagickTrue(wand->debug))
8422 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8423 if (wand->images == (Image *) NULL)
8424 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8425 if ((page == (char *) NULL) || (*page == '\0'))
8427 (void) ParseAbsoluteGeometry("0x0+0+0",&wand->images->page);
8430 return(ResetImagePage(wand->images,page));
8434 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8438 % M a g i c k R e s i z e I m a g e %
8442 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8444 % MagickResizeImage() scales an image to the desired dimensions with one of
8447 % Bessel Blackman Box
8448 % Catrom Cubic Gaussian
8449 % Hanning Hermite Lanczos
8450 % Mitchell Point Quandratic
8453 % Most of the filters are FIR (finite impulse response), however, Bessel,
8454 % Gaussian, and Sinc are IIR (infinite impulse response). Bessel and Sinc
8455 % are windowed (brought down to zero) with the Blackman filter.
8457 % The format of the MagickResizeImage method is:
8459 % MagickBooleanType MagickResizeImage(MagickWand *wand,
8460 % const size_t columns,const size_t rows,const FilterTypes filter)
8462 % A description of each parameter follows:
8464 % o wand: the magick wand.
8466 % o columns: the number of columns in the scaled image.
8468 % o rows: the number of rows in the scaled image.
8470 % o filter: Image filter to use.
8473 WandExport MagickBooleanType MagickResizeImage(MagickWand *wand,
8474 const size_t columns,const size_t rows,const FilterTypes filter)
8479 assert(wand != (MagickWand *) NULL);
8480 assert(wand->signature == MagickWandSignature);
8481 if (IfMagickTrue(wand->debug))
8482 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8483 if (wand->images == (Image *) NULL)
8484 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8485 resize_image=ResizeImage(wand->images,columns,rows,filter,wand->exception);
8486 if (resize_image == (Image *) NULL)
8487 return(MagickFalse);
8488 ReplaceImageInList(&wand->images,resize_image);
8493 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8497 % M a g i c k R o l l I m a g e %
8501 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8503 % MagickRollImage() offsets an image as defined by x and y.
8505 % The format of the MagickRollImage method is:
8507 % MagickBooleanType MagickRollImage(MagickWand *wand,const ssize_t x,
8510 % A description of each parameter follows:
8512 % o wand: the magick wand.
8514 % o x: the x offset.
8516 % o y: the y offset.
8520 WandExport MagickBooleanType MagickRollImage(MagickWand *wand,
8521 const ssize_t x,const ssize_t y)
8526 assert(wand != (MagickWand *) NULL);
8527 assert(wand->signature == MagickWandSignature);
8528 if (IfMagickTrue(wand->debug))
8529 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8530 if (wand->images == (Image *) NULL)
8531 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8532 roll_image=RollImage(wand->images,x,y,wand->exception);
8533 if (roll_image == (Image *) NULL)
8534 return(MagickFalse);
8535 ReplaceImageInList(&wand->images,roll_image);
8540 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8544 % M a g i c k R o t a t e I m a g e %
8548 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8550 % MagickRotateImage() rotates an image the specified number of degrees. Empty
8551 % triangles left over from rotating the image are filled with the
8554 % The format of the MagickRotateImage method is:
8556 % MagickBooleanType MagickRotateImage(MagickWand *wand,
8557 % const PixelWand *background,const double degrees)
8559 % A description of each parameter follows:
8561 % o wand: the magick wand.
8563 % o background: the background pixel wand.
8565 % o degrees: the number of degrees to rotate the image.
8569 WandExport MagickBooleanType MagickRotateImage(MagickWand *wand,
8570 const PixelWand *background,const double degrees)
8575 assert(wand != (MagickWand *) NULL);
8576 assert(wand->signature == MagickWandSignature);
8577 if (IfMagickTrue(wand->debug))
8578 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8579 if (wand->images == (Image *) NULL)
8580 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8581 PixelGetQuantumPacket(background,&wand->images->background_color);
8582 rotate_image=RotateImage(wand->images,degrees,wand->exception);
8583 if (rotate_image == (Image *) NULL)
8584 return(MagickFalse);
8585 ReplaceImageInList(&wand->images,rotate_image);
8590 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8594 % M a g i c k S a m p l e I m a g e %
8598 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8600 % MagickSampleImage() scales an image to the desired dimensions with pixel
8601 % sampling. Unlike other scaling methods, this method does not introduce
8602 % any additional color into the scaled image.
8604 % The format of the MagickSampleImage method is:
8606 % MagickBooleanType MagickSampleImage(MagickWand *wand,
8607 % const size_t columns,const size_t rows)
8609 % A description of each parameter follows:
8611 % o wand: the magick wand.
8613 % o columns: the number of columns in the scaled image.
8615 % o rows: the number of rows in the scaled image.
8619 WandExport MagickBooleanType MagickSampleImage(MagickWand *wand,
8620 const size_t columns,const size_t rows)
8625 assert(wand != (MagickWand *) NULL);
8626 assert(wand->signature == MagickWandSignature);
8627 if (IfMagickTrue(wand->debug))
8628 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8629 if (wand->images == (Image *) NULL)
8630 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8631 sample_image=SampleImage(wand->images,columns,rows,wand->exception);
8632 if (sample_image == (Image *) NULL)
8633 return(MagickFalse);
8634 ReplaceImageInList(&wand->images,sample_image);
8639 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8643 % M a g i c k S c a l e I m a g e %
8647 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8649 % MagickScaleImage() scales the size of an image to the given dimensions.
8651 % The format of the MagickScaleImage method is:
8653 % MagickBooleanType MagickScaleImage(MagickWand *wand,
8654 % const size_t columns,const size_t rows)
8656 % A description of each parameter follows:
8658 % o wand: the magick wand.
8660 % o columns: the number of columns in the scaled image.
8662 % o rows: the number of rows in the scaled image.
8666 WandExport MagickBooleanType MagickScaleImage(MagickWand *wand,
8667 const size_t columns,const size_t rows)
8672 assert(wand != (MagickWand *) NULL);
8673 assert(wand->signature == MagickWandSignature);
8674 if (IfMagickTrue(wand->debug))
8675 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8676 if (wand->images == (Image *) NULL)
8677 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8678 scale_image=ScaleImage(wand->images,columns,rows,wand->exception);
8679 if (scale_image == (Image *) NULL)
8680 return(MagickFalse);
8681 ReplaceImageInList(&wand->images,scale_image);
8686 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8690 % M a g i c k S e g m e n t I m a g e %
8694 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8696 % MagickSegmentImage() segments an image by analyzing the histograms of the
8697 % color components and identifying units that are homogeneous with the fuzzy
8698 % C-means technique.
8700 % The format of the SegmentImage method is:
8702 % MagickBooleanType MagickSegmentImage(MagickWand *wand,
8703 % const ColorspaceType colorspace,const MagickBooleanType verbose,
8704 % const double cluster_threshold,const double smooth_threshold)
8706 % A description of each parameter follows.
8710 % o colorspace: the image colorspace.
8712 % o verbose: Set to MagickTrue to print detailed information about the
8713 % identified classes.
8715 % o cluster_threshold: This represents the minimum number of pixels
8716 % contained in a hexahedra before it can be considered valid (expressed as
8719 % o smooth_threshold: the smoothing threshold eliminates noise in the second
8720 % derivative of the histogram. As the value is increased, you can expect a
8721 % smoother second derivative.
8724 MagickExport MagickBooleanType MagickSegmentImage(MagickWand *wand,
8725 const ColorspaceType colorspace,const MagickBooleanType verbose,
8726 const double cluster_threshold,const double smooth_threshold)
8731 assert(wand != (MagickWand *) NULL);
8732 assert(wand->signature == MagickWandSignature);
8733 if (IfMagickTrue(wand->debug))
8734 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8735 if (wand->images == (Image *) NULL)
8736 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8737 status=SegmentImage(wand->images,colorspace,verbose,cluster_threshold,
8738 smooth_threshold,wand->exception);
8743 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8747 % M a g i c k S e l e c t i v e B l u r I m a g e %
8751 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8753 % MagickSelectiveBlurImage() selectively blur an image within a contrast
8754 % threshold. It is similar to the unsharpen mask that sharpens everything with
8755 % contrast above a certain threshold.
8757 % The format of the MagickSelectiveBlurImage method is:
8759 % MagickBooleanType MagickSelectiveBlurImage(MagickWand *wand,
8760 % const double radius,const double sigma,const double threshold)
8762 % A description of each parameter follows:
8764 % o wand: the magick wand.
8766 % o radius: the radius of the gaussian, in pixels, not counting the center
8769 % o sigma: the standard deviation of the gaussian, in pixels.
8771 % o threshold: only pixels within this contrast threshold are included
8772 % in the blur operation.
8775 WandExport MagickBooleanType MagickSelectiveBlurImage(MagickWand *wand,
8776 const double radius,const double sigma,const double threshold)
8781 assert(wand != (MagickWand *) NULL);
8782 assert(wand->signature == MagickWandSignature);
8783 if (IfMagickTrue(wand->debug))
8784 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8785 if (wand->images == (Image *) NULL)
8786 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8787 blur_image=SelectiveBlurImage(wand->images,radius,sigma,threshold,
8789 if (blur_image == (Image *) NULL)
8790 return(MagickFalse);
8791 ReplaceImageInList(&wand->images,blur_image);
8796 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8800 % M a g i c k S e p a r a t e I m a g e C h a n n e l %
8804 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8806 % MagickSeparateImage() separates a channel from the image and returns a
8807 % grayscale image. A channel is a particular color component of each pixel
8810 % The format of the MagickSeparateImage method is:
8812 % MagickBooleanType MagickSeparateImage(MagickWand *wand,
8813 % const ChannelType channel)
8815 % A description of each parameter follows:
8817 % o wand: the magick wand.
8819 % o channel: the channel.
8822 WandExport MagickBooleanType MagickSeparateImage(MagickWand *wand,
8823 const ChannelType channel)
8828 assert(wand != (MagickWand *) NULL);
8829 assert(wand->signature == MagickWandSignature);
8830 if (IfMagickTrue(wand->debug))
8831 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8832 if (wand->images == (Image *) NULL)
8833 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8834 separate_image=SeparateImage(wand->images,channel,wand->exception);
8835 if (separate_image == (Image *) NULL)
8836 return(MagickFalse);
8837 ReplaceImageInList(&wand->images,separate_image);
8842 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8846 % M a g i c k S e p i a T o n e I m a g e %
8850 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8852 % MagickSepiaToneImage() applies a special effect to the image, similar to the
8853 % effect achieved in a photo darkroom by sepia toning. Threshold ranges from
8854 % 0 to QuantumRange and is a measure of the extent of the sepia toning. A
8855 % threshold of 80% is a good starting point for a reasonable tone.
8857 % The format of the MagickSepiaToneImage method is:
8859 % MagickBooleanType MagickSepiaToneImage(MagickWand *wand,
8860 % const double threshold)
8862 % A description of each parameter follows:
8864 % o wand: the magick wand.
8866 % o threshold: Define the extent of the sepia toning.
8869 WandExport MagickBooleanType MagickSepiaToneImage(MagickWand *wand,
8870 const double threshold)
8875 assert(wand != (MagickWand *) NULL);
8876 assert(wand->signature == MagickWandSignature);
8877 if (IfMagickTrue(wand->debug))
8878 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8879 if (wand->images == (Image *) NULL)
8880 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8881 sepia_image=SepiaToneImage(wand->images,threshold,wand->exception);
8882 if (sepia_image == (Image *) NULL)
8883 return(MagickFalse);
8884 ReplaceImageInList(&wand->images,sepia_image);
8889 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8893 % M a g i c k S e t I m a g e %
8897 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8899 % MagickSetImage() replaces the last image returned by MagickSetIteratorIndex(),
8900 % MagickNextImage(), MagickPreviousImage() with the images from the specified
8903 % The format of the MagickSetImage method is:
8905 % MagickBooleanType MagickSetImage(MagickWand *wand,
8906 % const MagickWand *set_wand)
8908 % A description of each parameter follows:
8910 % o wand: the magick wand.
8912 % o set_wand: the set_wand wand.
8915 WandExport MagickBooleanType MagickSetImage(MagickWand *wand,
8916 const MagickWand *set_wand)
8921 assert(wand != (MagickWand *) NULL);
8922 assert(wand->signature == MagickWandSignature);
8923 if (IfMagickTrue(wand->debug))
8924 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8925 assert(set_wand != (MagickWand *) NULL);
8926 assert(set_wand->signature == MagickWandSignature);
8927 if (IfMagickTrue(wand->debug))
8928 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",set_wand->name);
8929 if (set_wand->images == (Image *) NULL)
8930 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8931 images=CloneImageList(set_wand->images,wand->exception);
8932 if (images == (Image *) NULL)
8933 return(MagickFalse);
8934 ReplaceImageInList(&wand->images,images);
8939 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8943 % M a g i c k S e t I m a g e A l p h a C h a n n e l %
8947 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8949 % MagickSetImageAlphaChannel() activates, deactivates, resets, or sets the
8952 % The format of the MagickSetImageAlphaChannel method is:
8954 % MagickBooleanType MagickSetImageAlphaChannel(MagickWand *wand,
8955 % const AlphaChannelOption alpha_type)
8957 % A description of each parameter follows:
8959 % o wand: the magick wand.
8961 % o alpha_type: the alpha channel type: ActivateAlphaChannel,
8962 % DeactivateAlphaChannel, OpaqueAlphaChannel, or SetAlphaChannel.
8965 WandExport MagickBooleanType MagickSetImageAlphaChannel(MagickWand *wand,
8966 const AlphaChannelOption alpha_type)
8968 assert(wand != (MagickWand *) NULL);
8969 assert(wand->signature == MagickWandSignature);
8970 if (IfMagickTrue(wand->debug))
8971 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
8972 if (wand->images == (Image *) NULL)
8973 ThrowWandException(WandError,"ContainsNoImages",wand->name);
8974 return(SetImageAlphaChannel(wand->images,alpha_type,wand->exception));
8978 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8982 % M a g i c k S e t I m a g e B a c k g r o u n d C o l o r %
8986 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8988 % MagickSetImageBackgroundColor() sets the image background color.
8990 % The format of the MagickSetImageBackgroundColor method is:
8992 % MagickBooleanType MagickSetImageBackgroundColor(MagickWand *wand,
8993 % const PixelWand *background)
8995 % A description of each parameter follows:
8997 % o wand: the magick wand.
8999 % o background: the background pixel wand.
9002 WandExport MagickBooleanType MagickSetImageBackgroundColor(MagickWand *wand,
9003 const PixelWand *background)
9005 assert(wand != (MagickWand *) NULL);
9006 assert(wand->signature == MagickWandSignature);
9007 if (IfMagickTrue(wand->debug))
9008 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9009 if (wand->images == (Image *) NULL)
9010 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9011 PixelGetQuantumPacket(background,&wand->images->background_color);
9016 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9020 % M a g i c k S e t I m a g e B l u e P r i m a r y %
9024 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9026 % MagickSetImageBluePrimary() sets the image chromaticity blue primary point.
9028 % The format of the MagickSetImageBluePrimary method is:
9030 % MagickBooleanType MagickSetImageBluePrimary(MagickWand *wand,
9031 % const double x,const double y)
9033 % A description of each parameter follows:
9035 % o wand: the magick wand.
9037 % o x: the blue primary x-point.
9039 % o y: the blue primary y-point.
9042 WandExport MagickBooleanType MagickSetImageBluePrimary(MagickWand *wand,
9043 const double x,const double y)
9045 assert(wand != (MagickWand *) NULL);
9046 assert(wand->signature == MagickWandSignature);
9047 if (IfMagickTrue(wand->debug))
9048 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9049 if (wand->images == (Image *) NULL)
9050 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9051 wand->images->chromaticity.blue_primary.x=x;
9052 wand->images->chromaticity.blue_primary.y=y;
9057 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9061 % M a g i c k S e t I m a g e B o r d e r C o l o r %
9065 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9067 % MagickSetImageBorderColor() sets the image border color.
9069 % The format of the MagickSetImageBorderColor method is:
9071 % MagickBooleanType MagickSetImageBorderColor(MagickWand *wand,
9072 % const PixelWand *border)
9074 % A description of each parameter follows:
9076 % o wand: the magick wand.
9078 % o border: the border pixel wand.
9081 WandExport MagickBooleanType MagickSetImageBorderColor(MagickWand *wand,
9082 const PixelWand *border)
9084 assert(wand != (MagickWand *) NULL);
9085 assert(wand->signature == MagickWandSignature);
9086 if (IfMagickTrue(wand->debug))
9087 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9088 if (wand->images == (Image *) NULL)
9089 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9090 PixelGetQuantumPacket(border,&wand->images->border_color);
9095 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9099 % M a g i c k S e t I m a g e C h a n n e l M a s k %
9103 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9105 % MagickSetImageChannelMask() sets image channel mask.
9107 % The format of the MagickSetImageChannelMask method is:
9109 % ChannelType MagickSetImageChannelMask(MagickWand *wand,
9110 % const ChannelType channel_mask)
9112 % A description of each parameter follows:
9114 % o wand: the magick wand.
9116 % o channel_mask: the channel_mask wand.
9119 WandExport ChannelType MagickSetImageChannelMask(MagickWand *wand,
9120 const ChannelType channel_mask)
9122 assert(wand != (MagickWand *) NULL);
9123 assert(wand->signature == MagickWandSignature);
9124 if (IfMagickTrue(wand->debug))
9125 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9126 return(SetImageChannelMask(wand->images,channel_mask));
9130 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9134 % M a g i c k S e t I m a g e M a s k %
9138 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9140 % MagickSetImageMask() sets image clip mask.
9142 % The format of the MagickSetImageMask method is:
9144 % MagickBooleanType MagickSetImageMask(MagickWand *wand,
9145 % const PixelMask type,const MagickWand *clip_mask)
9147 % A description of each parameter follows:
9149 % o wand: the magick wand.
9151 % o type: type of mask, ReadPixelMask or WritePixelMask.
9153 % o clip_mask: the clip_mask wand.
9156 WandExport MagickBooleanType MagickSetImageMask(MagickWand *wand,
9157 const PixelMask type,const MagickWand *clip_mask)
9159 assert(wand != (MagickWand *) NULL);
9160 assert(wand->signature == MagickWandSignature);
9161 if (IfMagickTrue(wand->debug))
9162 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9163 assert(clip_mask != (MagickWand *) NULL);
9164 assert(clip_mask->signature == MagickWandSignature);
9165 if (IfMagickTrue(clip_mask->debug))
9166 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",clip_mask->name);
9167 if (clip_mask->images == (Image *) NULL)
9168 ThrowWandException(WandError,"ContainsNoImages",clip_mask->name);
9169 return(SetImageMask(wand->images,type,clip_mask->images,wand->exception));
9173 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9177 % M a g i c k S e t I m a g e C o l o r %
9181 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9183 % MagickSetImageColor() set the entire wand canvas to the specified color.
9185 % The format of the MagickSetImageColor method is:
9187 % MagickBooleanType MagickSetImageColor(MagickWand *wand,
9188 % const PixelWand *color)
9190 % A description of each parameter follows:
9192 % o wand: the magick wand.
9194 % o background: the image color.
9197 WandExport MagickBooleanType MagickSetImageColor(MagickWand *wand,
9198 const PixelWand *color)
9203 assert(wand != (MagickWand *) NULL);
9204 assert(wand->signature == MagickWandSignature);
9205 if (IfMagickTrue(wand->debug))
9206 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9207 PixelGetMagickColor(color,&pixel);
9208 return(SetImageColor(wand->images,&pixel,wand->exception));
9212 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9216 % M a g i c k S e t I m a g e C o l o r m a p C o l o r %
9220 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9222 % MagickSetImageColormapColor() sets the color of the specified colormap
9225 % The format of the MagickSetImageColormapColor method is:
9227 % MagickBooleanType MagickSetImageColormapColor(MagickWand *wand,
9228 % const size_t index,const PixelWand *color)
9230 % A description of each parameter follows:
9232 % o wand: the magick wand.
9234 % o index: the offset into the image colormap.
9236 % o color: Return the colormap color in this wand.
9239 WandExport MagickBooleanType MagickSetImageColormapColor(MagickWand *wand,
9240 const size_t index,const PixelWand *color)
9242 assert(wand != (MagickWand *) NULL);
9243 assert(wand->signature == MagickWandSignature);
9244 if (IfMagickTrue(wand->debug))
9245 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9246 if (wand->images == (Image *) NULL)
9247 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9248 if ((wand->images->colormap == (PixelInfo *) NULL) ||
9249 (index >= wand->images->colors))
9250 ThrowWandException(WandError,"InvalidColormapIndex",wand->name);
9251 PixelGetQuantumPacket(color,wand->images->colormap+index);
9252 return(SyncImage(wand->images,wand->exception));
9256 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9260 % M a g i c k S e t I m a g e C o l o r s p a c e %
9264 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9266 % MagickSetImageColorspace() sets the image colorspace. But does not modify
9269 % The format of the MagickSetImageColorspace method is:
9271 % MagickBooleanType MagickSetImageColorspace(MagickWand *wand,
9272 % const ColorspaceType colorspace)
9274 % A description of each parameter follows:
9276 % o wand: the magick wand.
9278 % o colorspace: the image colorspace: UndefinedColorspace, RGBColorspace,
9279 % GRAYColorspace, TransparentColorspace, OHTAColorspace, XYZColorspace,
9280 % YCbCrColorspace, YCCColorspace, YIQColorspace, YPbPrColorspace,
9281 % YPbPrColorspace, YUVColorspace, CMYKColorspace, sRGBColorspace,
9282 % HSLColorspace, or HWBColorspace.
9285 WandExport MagickBooleanType MagickSetImageColorspace(MagickWand *wand,
9286 const ColorspaceType colorspace)
9288 assert(wand != (MagickWand *) NULL);
9289 assert(wand->signature == MagickWandSignature);
9290 if (IfMagickTrue(wand->debug))
9291 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9292 if (wand->images == (Image *) NULL)
9293 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9294 return(SetImageColorspace(wand->images,colorspace,wand->exception));
9298 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9302 % M a g i c k S e t I m a g e C o m p o s e %
9306 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9308 % MagickSetImageCompose() sets the image composite operator, useful for
9309 % specifying how to composite the image thumbnail when using the
9310 % MagickMontageImage() method.
9312 % The format of the MagickSetImageCompose method is:
9314 % MagickBooleanType MagickSetImageCompose(MagickWand *wand,
9315 % const CompositeOperator compose)
9317 % A description of each parameter follows:
9319 % o wand: the magick wand.
9321 % o compose: the image composite operator.
9324 WandExport MagickBooleanType MagickSetImageCompose(MagickWand *wand,
9325 const CompositeOperator compose)
9327 assert(wand != (MagickWand *) NULL);
9328 assert(wand->signature == MagickWandSignature);
9329 if (IfMagickTrue(wand->debug))
9330 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9331 if (wand->images == (Image *) NULL)
9332 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9333 wand->images->compose=compose;
9338 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9342 % M a g i c k S e t I m a g e C o m p r e s s i o n %
9346 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9348 % MagickSetImageCompression() sets the image compression.
9350 % The format of the MagickSetImageCompression method is:
9352 % MagickBooleanType MagickSetImageCompression(MagickWand *wand,
9353 % const CompressionType compression)
9355 % A description of each parameter follows:
9357 % o wand: the magick wand.
9359 % o compression: the image compression type.
9362 WandExport MagickBooleanType MagickSetImageCompression(MagickWand *wand,
9363 const CompressionType compression)
9365 assert(wand != (MagickWand *) NULL);
9366 assert(wand->signature == MagickWandSignature);
9367 if (IfMagickTrue(wand->debug))
9368 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9369 if (wand->images == (Image *) NULL)
9370 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9371 wand->images->compression=compression;
9376 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9380 % M a g i c k S e t I m a g e C o m p r e s s i o n Q u a l i t y %
9384 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9386 % MagickSetImageCompressionQuality() sets the image compression quality.
9388 % The format of the MagickSetImageCompressionQuality method is:
9390 % MagickBooleanType MagickSetImageCompressionQuality(MagickWand *wand,
9391 % const size_t quality)
9393 % A description of each parameter follows:
9395 % o wand: the magick wand.
9397 % o quality: the image compression tlityype.
9400 WandExport MagickBooleanType MagickSetImageCompressionQuality(MagickWand *wand,
9401 const size_t quality)
9403 assert(wand != (MagickWand *) NULL);
9404 assert(wand->signature == MagickWandSignature);
9405 if (IfMagickTrue(wand->debug))
9406 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9407 if (wand->images == (Image *) NULL)
9408 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9409 wand->images->quality=quality;
9414 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9418 % M a g i c k S e t I m a g e D e l a y %
9422 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9424 % MagickSetImageDelay() sets the image delay.
9426 % The format of the MagickSetImageDelay method is:
9428 % MagickBooleanType MagickSetImageDelay(MagickWand *wand,
9429 % const size_t delay)
9431 % A description of each parameter follows:
9433 % o wand: the magick wand.
9435 % o delay: the image delay in ticks-per-second units.
9438 WandExport MagickBooleanType MagickSetImageDelay(MagickWand *wand,
9441 assert(wand != (MagickWand *) NULL);
9442 assert(wand->signature == MagickWandSignature);
9443 if (IfMagickTrue(wand->debug))
9444 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9445 if (wand->images == (Image *) NULL)
9446 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9447 wand->images->delay=delay;
9452 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9456 % M a g i c k S e t I m a g e D e p t h %
9460 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9462 % MagickSetImageDepth() sets the image depth.
9464 % The format of the MagickSetImageDepth method is:
9466 % MagickBooleanType MagickSetImageDepth(MagickWand *wand,
9467 % const size_t depth)
9469 % A description of each parameter follows:
9471 % o wand: the magick wand.
9473 % o depth: the image depth in bits: 8, 16, or 32.
9476 WandExport MagickBooleanType MagickSetImageDepth(MagickWand *wand,
9479 assert(wand != (MagickWand *) NULL);
9480 assert(wand->signature == MagickWandSignature);
9481 if (IfMagickTrue(wand->debug))
9482 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9483 if (wand->images == (Image *) NULL)
9484 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9485 return(SetImageDepth(wand->images,depth,wand->exception));
9489 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9493 % M a g i c k S e t I m a g e D i s p o s e %
9497 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9499 % MagickSetImageDispose() sets the image disposal method.
9501 % The format of the MagickSetImageDispose method is:
9503 % MagickBooleanType MagickSetImageDispose(MagickWand *wand,
9504 % const DisposeType dispose)
9506 % A description of each parameter follows:
9508 % o wand: the magick wand.
9510 % o dispose: the image disposeal type.
9513 WandExport MagickBooleanType MagickSetImageDispose(MagickWand *wand,
9514 const DisposeType dispose)
9516 assert(wand != (MagickWand *) NULL);
9517 assert(wand->signature == MagickWandSignature);
9518 if (IfMagickTrue(wand->debug))
9519 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9520 if (wand->images == (Image *) NULL)
9521 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9522 wand->images->dispose=dispose;
9527 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9531 % M a g i c k S e t I m a g e E n d i a n %
9535 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9537 % MagickSetImageEndian() sets the image endian method.
9539 % The format of the MagickSetImageEndian method is:
9541 % MagickBooleanType MagickSetImageEndian(MagickWand *wand,
9542 % const EndianType endian)
9544 % A description of each parameter follows:
9546 % o wand: the magick wand.
9548 % o endian: the image endian type.
9551 WandExport MagickBooleanType MagickSetImageEndian(MagickWand *wand,
9552 const EndianType endian)
9554 assert(wand != (MagickWand *) NULL);
9555 assert(wand->signature == MagickWandSignature);
9556 if (wand->debug != MagickFalse)
9557 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9558 if (wand->images == (Image *) NULL)
9559 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9560 wand->images->endian=endian;
9565 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9569 % M a g i c k S e t I m a g e E x t e n t %
9573 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9575 % MagickSetImageExtent() sets the image size (i.e. columns & rows).
9577 % The format of the MagickSetImageExtent method is:
9579 % MagickBooleanType MagickSetImageExtent(MagickWand *wand,
9580 % const size_t columns,const unsigned rows)
9582 % A description of each parameter follows:
9584 % o wand: the magick wand.
9586 % o columns: The image width in pixels.
9588 % o rows: The image height in pixels.
9591 WandExport MagickBooleanType MagickSetImageExtent(MagickWand *wand,
9592 const size_t columns,const size_t rows)
9594 assert(wand != (MagickWand *) NULL);
9595 assert(wand->signature == MagickWandSignature);
9596 if (IfMagickTrue(wand->debug))
9597 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9598 if (wand->images == (Image *) NULL)
9599 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9600 return(SetImageExtent(wand->images,columns,rows,wand->exception));
9604 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9608 % M a g i c k S e t I m a g e F i l e n a m e %
9612 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9614 % MagickSetImageFilename() sets the filename of a particular image in a
9617 % The format of the MagickSetImageFilename method is:
9619 % MagickBooleanType MagickSetImageFilename(MagickWand *wand,
9620 % const char *filename)
9622 % A description of each parameter follows:
9624 % o wand: the magick wand.
9626 % o filename: the image filename.
9629 WandExport MagickBooleanType MagickSetImageFilename(MagickWand *wand,
9630 const char *filename)
9632 assert(wand != (MagickWand *) NULL);
9633 assert(wand->signature == MagickWandSignature);
9634 if (IfMagickTrue(wand->debug))
9635 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9636 if (wand->images == (Image *) NULL)
9637 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9638 if (filename != (const char *) NULL)
9639 (void) CopyMagickString(wand->images->filename,filename,MagickPathExtent);
9644 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9648 % M a g i c k S e t I m a g e F o r m a t %
9652 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9654 % MagickSetImageFormat() sets the format of a particular image in a
9657 % The format of the MagickSetImageFormat method is:
9659 % MagickBooleanType MagickSetImageFormat(MagickWand *wand,
9660 % const char *format)
9662 % A description of each parameter follows:
9664 % o wand: the magick wand.
9666 % o format: the image format.
9669 WandExport MagickBooleanType MagickSetImageFormat(MagickWand *wand,
9675 assert(wand != (MagickWand *) NULL);
9676 assert(wand->signature == MagickWandSignature);
9677 if (IfMagickTrue(wand->debug))
9678 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9679 if (wand->images == (Image *) NULL)
9680 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9681 if ((format == (char *) NULL) || (*format == '\0'))
9683 *wand->images->magick='\0';
9686 magick_info=GetMagickInfo(format,wand->exception);
9687 if (magick_info == (const MagickInfo *) NULL)
9688 return(MagickFalse);
9689 ClearMagickException(wand->exception);
9690 (void) CopyMagickString(wand->images->magick,format,MagickPathExtent);
9695 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9699 % M a g i c k S e t I m a g e F u z z %
9703 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9705 % MagickSetImageFuzz() sets the image fuzz.
9707 % The format of the MagickSetImageFuzz method is:
9709 % MagickBooleanType MagickSetImageFuzz(MagickWand *wand,
9710 % const double fuzz)
9712 % A description of each parameter follows:
9714 % o wand: the magick wand.
9716 % o fuzz: the image fuzz.
9719 WandExport MagickBooleanType MagickSetImageFuzz(MagickWand *wand,
9722 assert(wand != (MagickWand *) NULL);
9723 assert(wand->signature == MagickWandSignature);
9724 if (IfMagickTrue(wand->debug))
9725 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9726 if (wand->images == (Image *) NULL)
9727 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9728 wand->images->fuzz=fuzz;
9733 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9737 % M a g i c k S e t I m a g e G a m m a %
9741 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9743 % MagickSetImageGamma() sets the image gamma.
9745 % The format of the MagickSetImageGamma method is:
9747 % MagickBooleanType MagickSetImageGamma(MagickWand *wand,
9748 % const double gamma)
9750 % A description of each parameter follows:
9752 % o wand: the magick wand.
9754 % o gamma: the image gamma.
9757 WandExport MagickBooleanType MagickSetImageGamma(MagickWand *wand,
9760 assert(wand != (MagickWand *) NULL);
9761 assert(wand->signature == MagickWandSignature);
9762 if (IfMagickTrue(wand->debug))
9763 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9764 if (wand->images == (Image *) NULL)
9765 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9766 wand->images->gamma=gamma;
9771 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9775 % M a g i c k S e t I m a g e G r a v i t y %
9779 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9781 % MagickSetImageGravity() sets the image gravity type.
9783 % The format of the MagickSetImageGravity method is:
9785 % MagickBooleanType MagickSetImageGravity(MagickWand *wand,
9786 % const GravityType gravity)
9788 % A description of each parameter follows:
9790 % o wand: the magick wand.
9792 % o gravity: positioning gravity (NorthWestGravity, NorthGravity,
9793 % NorthEastGravity, WestGravity, CenterGravity,
9794 % EastGravity, SouthWestGravity, SouthGravity,
9798 WandExport MagickBooleanType MagickSetImageGravity(MagickWand *wand,
9799 const GravityType gravity)
9801 assert(wand != (MagickWand *) NULL);
9802 assert(wand->signature == MagickWandSignature);
9803 if (IfMagickTrue(wand->debug))
9804 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9805 if (wand->images == (Image *) NULL)
9806 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9807 wand->images->gravity=gravity;
9812 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9816 % M a g i c k S e t I m a g e G r e e n P r i m a r y %
9820 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9822 % MagickSetImageGreenPrimary() sets the image chromaticity green primary
9825 % The format of the MagickSetImageGreenPrimary method is:
9827 % MagickBooleanType MagickSetImageGreenPrimary(MagickWand *wand,
9828 % const double x,const double y)
9830 % A description of each parameter follows:
9832 % o wand: the magick wand.
9834 % o x: the green primary x-point.
9836 % o y: the green primary y-point.
9840 WandExport MagickBooleanType MagickSetImageGreenPrimary(MagickWand *wand,
9841 const double x,const double y)
9843 assert(wand != (MagickWand *) NULL);
9844 assert(wand->signature == MagickWandSignature);
9845 if (IfMagickTrue(wand->debug))
9846 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9847 if (wand->images == (Image *) NULL)
9848 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9849 wand->images->chromaticity.green_primary.x=x;
9850 wand->images->chromaticity.green_primary.y=y;
9855 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9859 % M a g i c k S e t I m a g e I n t e r l a c e S c h e m e %
9863 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9865 % MagickSetImageInterlaceScheme() sets the image interlace scheme.
9867 % The format of the MagickSetImageInterlaceScheme method is:
9869 % MagickBooleanType MagickSetImageInterlaceScheme(MagickWand *wand,
9870 % const InterlaceType interlace)
9872 % A description of each parameter follows:
9874 % o wand: the magick wand.
9876 % o interlace: the image interlace scheme: NoInterlace, LineInterlace,
9877 % PlaneInterlace, PartitionInterlace.
9880 WandExport MagickBooleanType MagickSetImageInterlaceScheme(MagickWand *wand,
9881 const InterlaceType interlace)
9883 assert(wand != (MagickWand *) NULL);
9884 assert(wand->signature == MagickWandSignature);
9885 if (IfMagickTrue(wand->debug))
9886 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9887 if (wand->images == (Image *) NULL)
9888 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9889 wand->images->interlace=interlace;
9894 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9898 % M a g i c k S e t I m a g e I n t e r p o l a t e M e t h o d %
9902 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9904 % MagickSetImagePixelInterpolateMethod() sets the image interpolate pixel
9907 % The format of the MagickSetImagePixelInterpolateMethod method is:
9909 % MagickBooleanType MagickSetImagePixelInterpolateMethod(MagickWand *wand,
9910 % const PixelInterpolateMethod method)
9912 % A description of each parameter follows:
9914 % o wand: the magick wand.
9916 % o method: the image interpole pixel methods: choose from Undefined,
9917 % Average, Bicubic, Bilinear, Filter, Integer, Mesh, NearestNeighbor.
9920 WandExport MagickBooleanType MagickSetImagePixelInterpolateMethod(
9921 MagickWand *wand,const PixelInterpolateMethod method)
9923 assert(wand != (MagickWand *) NULL);
9924 assert(wand->signature == MagickWandSignature);
9925 if (IfMagickTrue(wand->debug))
9926 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9927 if (wand->images == (Image *) NULL)
9928 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9929 wand->images->interpolate=method;
9934 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9938 % M a g i c k S e t I m a g e I t e r a t i o n s %
9942 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9944 % MagickSetImageIterations() sets the image iterations.
9946 % The format of the MagickSetImageIterations method is:
9948 % MagickBooleanType MagickSetImageIterations(MagickWand *wand,
9949 % const size_t iterations)
9951 % A description of each parameter follows:
9953 % o wand: the magick wand.
9955 % o delay: the image delay in 1/100th of a second.
9958 WandExport MagickBooleanType MagickSetImageIterations(MagickWand *wand,
9959 const size_t iterations)
9961 assert(wand != (MagickWand *) NULL);
9962 assert(wand->signature == MagickWandSignature);
9963 if (IfMagickTrue(wand->debug))
9964 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
9965 if (wand->images == (Image *) NULL)
9966 ThrowWandException(WandError,"ContainsNoImages",wand->name);
9967 wand->images->iterations=iterations;
9972 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9976 % M a g i c k S e t I m a g e M a t t e %
9980 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9982 % MagickSetImageMatte() sets the image matte channel.
9984 % The format of the MagickSetImageMatteColor method is:
9986 % MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
9987 % const MagickBooleanType *matte)
9989 % A description of each parameter follows:
9991 % o wand: the magick wand.
9993 % o matte: Set to MagickTrue to enable the image matte channel otherwise
9997 WandExport MagickBooleanType MagickSetImageMatte(MagickWand *wand,
9998 const MagickBooleanType matte)
10000 assert(wand != (MagickWand *) NULL);
10001 assert(wand->signature == MagickWandSignature);
10002 if (IfMagickTrue(wand->debug))
10003 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10004 if (wand->images == (Image *) NULL)
10005 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10006 if (matte == MagickFalse)
10007 wand->images->alpha_trait=UndefinedPixelTrait;
10010 if (wand->images->alpha_trait == UndefinedPixelTrait)
10011 (void) SetImageAlpha(wand->images,OpaqueAlpha,wand->exception);
10012 wand->images->alpha_trait=BlendPixelTrait;
10014 return(MagickTrue);
10018 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10022 % M a g i c k S e t I m a g e M a t t e C o l o r %
10026 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10028 % MagickSetImageMatteColor() sets the image matte color.
10030 % The format of the MagickSetImageMatteColor method is:
10032 % MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
10033 % const PixelWand *matte)
10035 % A description of each parameter follows:
10037 % o wand: the magick wand.
10039 % o matte: the matte pixel wand.
10042 WandExport MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
10043 const PixelWand *matte)
10045 assert(wand != (MagickWand *) NULL);
10046 assert(wand->signature == MagickWandSignature);
10047 if (IfMagickTrue(wand->debug))
10048 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10049 if (wand->images == (Image *) NULL)
10050 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10051 PixelGetQuantumPacket(matte,&wand->images->matte_color);
10052 return(MagickTrue);
10056 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10060 % M a g i c k S e t I m a g e O p a c i t y %
10064 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10066 % MagickSetImageAlpha() sets the image to the specified alpha level.
10068 % The format of the MagickSetImageAlpha method is:
10070 % MagickBooleanType MagickSetImageAlpha(MagickWand *wand,
10071 % const double alpha)
10073 % A description of each parameter follows:
10075 % o wand: the magick wand.
10077 % o alpha: the level of transparency: 1.0 is fully opaque and 0.0 is fully
10081 WandExport MagickBooleanType MagickSetImageAlpha(MagickWand *wand,
10082 const double alpha)
10087 assert(wand != (MagickWand *) NULL);
10088 assert(wand->signature == MagickWandSignature);
10089 if (IfMagickTrue(wand->debug))
10090 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10091 if (wand->images == (Image *) NULL)
10092 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10093 status=SetImageAlpha(wand->images,ClampToQuantum(QuantumRange*alpha),
10099 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10103 % M a g i c k S e t I m a g e O r i e n t a t i o n %
10107 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10109 % MagickSetImageOrientation() sets the image orientation.
10111 % The format of the MagickSetImageOrientation method is:
10113 % MagickBooleanType MagickSetImageOrientation(MagickWand *wand,
10114 % const OrientationType orientation)
10116 % A description of each parameter follows:
10118 % o wand: the magick wand.
10120 % o orientation: the image orientation type.
10123 WandExport MagickBooleanType MagickSetImageOrientation(MagickWand *wand,
10124 const OrientationType orientation)
10126 assert(wand != (MagickWand *) NULL);
10127 assert(wand->signature == MagickWandSignature);
10128 if (IfMagickTrue(wand->debug))
10129 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10130 if (wand->images == (Image *) NULL)
10131 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10132 wand->images->orientation=orientation;
10133 return(MagickTrue);
10137 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10141 % M a g i c k S e t I m a g e P a g e %
10145 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10147 % MagickSetImagePage() sets the page geometry of the image.
10149 % The format of the MagickSetImagePage method is:
10151 % MagickBooleanType MagickSetImagePage(MagickWand *wand,const size_t width,% const size_t height,const ssize_t x,const ssize_t y)
10153 % A description of each parameter follows:
10155 % o wand: the magick wand.
10157 % o width: the page width.
10159 % o height: the page height.
10161 % o x: the page x-offset.
10163 % o y: the page y-offset.
10166 WandExport MagickBooleanType MagickSetImagePage(MagickWand *wand,
10167 const size_t width,const size_t height,const ssize_t x,
10170 assert(wand != (MagickWand *) NULL);
10171 assert(wand->signature == MagickWandSignature);
10172 if (IfMagickTrue(wand->debug))
10173 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10174 if (wand->images == (Image *) NULL)
10175 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10176 wand->images->page.width=width;
10177 wand->images->page.height=height;
10178 wand->images->page.x=x;
10179 wand->images->page.y=y;
10180 return(MagickTrue);
10184 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10188 % M a g i c k S e t I m a g e P r o g r e s s M o n i t o r %
10192 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10194 % MagickSetImageProgressMonitor() sets the wand image progress monitor to the
10195 % specified method and returns the previous progress monitor if any. The
10196 % progress monitor method looks like this:
10198 % MagickBooleanType MagickProgressMonitor(const char *text,
10199 % const MagickOffsetType offset,const MagickSizeType span,
10200 % void *client_data)
10202 % If the progress monitor returns MagickFalse, the current operation is
10205 % The format of the MagickSetImageProgressMonitor method is:
10207 % MagickProgressMonitor MagickSetImageProgressMonitor(MagickWand *wand
10208 % const MagickProgressMonitor progress_monitor,void *client_data)
10210 % A description of each parameter follows:
10212 % o wand: the magick wand.
10214 % o progress_monitor: Specifies a pointer to a method to monitor progress
10215 % of an image operation.
10217 % o client_data: Specifies a pointer to any client data.
10220 WandExport MagickProgressMonitor MagickSetImageProgressMonitor(MagickWand *wand,
10221 const MagickProgressMonitor progress_monitor,void *client_data)
10223 MagickProgressMonitor
10226 assert(wand != (MagickWand *) NULL);
10227 assert(wand->signature == MagickWandSignature);
10228 if (IfMagickTrue(wand->debug))
10229 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10230 if (wand->images == (Image *) NULL)
10232 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
10233 "ContainsNoImages","`%s'",wand->name);
10234 return((MagickProgressMonitor) NULL);
10236 previous_monitor=SetImageProgressMonitor(wand->images,
10237 progress_monitor,client_data);
10238 return(previous_monitor);
10242 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10246 % M a g i c k S e t I m a g e R e d P r i m a r y %
10250 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10252 % MagickSetImageRedPrimary() sets the image chromaticity red primary point.
10254 % The format of the MagickSetImageRedPrimary method is:
10256 % MagickBooleanType MagickSetImageRedPrimary(MagickWand *wand,
10257 % const double x,const double y)
10259 % A description of each parameter follows:
10261 % o wand: the magick wand.
10263 % o x: the red primary x-point.
10265 % o y: the red primary y-point.
10268 WandExport MagickBooleanType MagickSetImageRedPrimary(MagickWand *wand,
10269 const double x,const double y)
10271 assert(wand != (MagickWand *) NULL);
10272 assert(wand->signature == MagickWandSignature);
10273 if (IfMagickTrue(wand->debug))
10274 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10275 if (wand->images == (Image *) NULL)
10276 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10277 wand->images->chromaticity.red_primary.x=x;
10278 wand->images->chromaticity.red_primary.y=y;
10279 return(MagickTrue);
10283 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10287 % M a g i c k S e t I m a g e R e n d e r i n g I n t e n t %
10291 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10293 % MagickSetImageRenderingIntent() sets the image rendering intent.
10295 % The format of the MagickSetImageRenderingIntent method is:
10297 % MagickBooleanType MagickSetImageRenderingIntent(MagickWand *wand,
10298 % const RenderingIntent rendering_intent)
10300 % A description of each parameter follows:
10302 % o wand: the magick wand.
10304 % o rendering_intent: the image rendering intent: UndefinedIntent,
10305 % SaturationIntent, PerceptualIntent, AbsoluteIntent, or RelativeIntent.
10308 WandExport MagickBooleanType MagickSetImageRenderingIntent(MagickWand *wand,
10309 const RenderingIntent rendering_intent)
10311 assert(wand != (MagickWand *) NULL);
10312 assert(wand->signature == MagickWandSignature);
10313 if (IfMagickTrue(wand->debug))
10314 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10315 if (wand->images == (Image *) NULL)
10316 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10317 wand->images->rendering_intent=rendering_intent;
10318 return(MagickTrue);
10322 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10326 % M a g i c k S e t I m a g e R e s o l u t i o n %
10330 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10332 % MagickSetImageResolution() sets the image resolution.
10334 % The format of the MagickSetImageResolution method is:
10336 % MagickBooleanType MagickSetImageResolution(MagickWand *wand,
10337 % const double x_resolution,const double y_resolution)
10339 % A description of each parameter follows:
10341 % o wand: the magick wand.
10343 % o x_resolution: the image x resolution.
10345 % o y_resolution: the image y resolution.
10348 WandExport MagickBooleanType MagickSetImageResolution(MagickWand *wand,
10349 const double x_resolution,const double y_resolution)
10351 assert(wand != (MagickWand *) NULL);
10352 assert(wand->signature == MagickWandSignature);
10353 if (IfMagickTrue(wand->debug))
10354 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10355 if (wand->images == (Image *) NULL)
10356 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10357 wand->images->resolution.x=x_resolution;
10358 wand->images->resolution.y=y_resolution;
10359 return(MagickTrue);
10363 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10367 % M a g i c k S e t I m a g e S c e n e %
10371 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10373 % MagickSetImageScene() sets the image scene.
10375 % The format of the MagickSetImageScene method is:
10377 % MagickBooleanType MagickSetImageScene(MagickWand *wand,
10378 % const size_t scene)
10380 % A description of each parameter follows:
10382 % o wand: the magick wand.
10384 % o delay: the image scene number.
10387 WandExport MagickBooleanType MagickSetImageScene(MagickWand *wand,
10388 const size_t scene)
10390 assert(wand != (MagickWand *) NULL);
10391 assert(wand->signature == MagickWandSignature);
10392 if (IfMagickTrue(wand->debug))
10393 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10394 if (wand->images == (Image *) NULL)
10395 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10396 wand->images->scene=scene;
10397 return(MagickTrue);
10401 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10405 % M a g i c k S e t I m a g e T i c k s P e r S e c o n d %
10409 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10411 % MagickSetImageTicksPerSecond() sets the image ticks-per-second.
10413 % The format of the MagickSetImageTicksPerSecond method is:
10415 % MagickBooleanType MagickSetImageTicksPerSecond(MagickWand *wand,
10416 % const ssize_t ticks_per-second)
10418 % A description of each parameter follows:
10420 % o wand: the magick wand.
10422 % o ticks_per_second: the units to use for the image delay.
10425 WandExport MagickBooleanType MagickSetImageTicksPerSecond(MagickWand *wand,
10426 const ssize_t ticks_per_second)
10428 assert(wand != (MagickWand *) NULL);
10429 assert(wand->signature == MagickWandSignature);
10430 if (IfMagickTrue(wand->debug))
10431 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10432 if (wand->images == (Image *) NULL)
10433 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10434 wand->images->ticks_per_second=ticks_per_second;
10435 return(MagickTrue);
10439 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10443 % M a g i c k S e t I m a g e T y p e %
10447 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10449 % MagickSetImageType() sets the image type.
10451 % The format of the MagickSetImageType method is:
10453 % MagickBooleanType MagickSetImageType(MagickWand *wand,
10454 % const ImageType image_type)
10456 % A description of each parameter follows:
10458 % o wand: the magick wand.
10460 % o image_type: the image type: UndefinedType, BilevelType, GrayscaleType,
10461 % GrayscaleAlphaType, PaletteType, PaletteAlphaType, TrueColorType,
10462 % TrueColorAlphaType, ColorSeparationType, ColorSeparationAlphaType,
10466 WandExport MagickBooleanType MagickSetImageType(MagickWand *wand,
10467 const ImageType image_type)
10469 assert(wand != (MagickWand *) NULL);
10470 assert(wand->signature == MagickWandSignature);
10471 if (IfMagickTrue(wand->debug))
10472 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10473 if (wand->images == (Image *) NULL)
10474 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10475 return(SetImageType(wand->images,image_type,wand->exception));
10479 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10483 % M a g i c k S e t I m a g e U n i t s %
10487 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10489 % MagickSetImageUnits() sets the image units of resolution.
10491 % The format of the MagickSetImageUnits method is:
10493 % MagickBooleanType MagickSetImageUnits(MagickWand *wand,
10494 % const ResolutionType units)
10496 % A description of each parameter follows:
10498 % o wand: the magick wand.
10500 % o units: the image units of resolution : UndefinedResolution,
10501 % PixelsPerInchResolution, or PixelsPerCentimeterResolution.
10504 WandExport MagickBooleanType MagickSetImageUnits(MagickWand *wand,
10505 const ResolutionType units)
10507 assert(wand != (MagickWand *) NULL);
10508 assert(wand->signature == MagickWandSignature);
10509 if (IfMagickTrue(wand->debug))
10510 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10511 if (wand->images == (Image *) NULL)
10512 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10513 wand->images->units=units;
10514 return(MagickTrue);
10518 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10522 % M a g i c k S e t I m a g e V i r t u a l P i x e l M e t h o d %
10526 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10528 % MagickSetImageVirtualPixelMethod() sets the image virtual pixel method.
10530 % The format of the MagickSetImageVirtualPixelMethod method is:
10532 % VirtualPixelMethod MagickSetImageVirtualPixelMethod(MagickWand *wand,
10533 % const VirtualPixelMethod method)
10535 % A description of each parameter follows:
10537 % o wand: the magick wand.
10539 % o method: the image virtual pixel method : UndefinedVirtualPixelMethod,
10540 % ConstantVirtualPixelMethod, EdgeVirtualPixelMethod,
10541 % MirrorVirtualPixelMethod, or TileVirtualPixelMethod.
10544 WandExport VirtualPixelMethod MagickSetImageVirtualPixelMethod(MagickWand *wand,
10545 const VirtualPixelMethod method)
10547 assert(wand != (MagickWand *) NULL);
10548 assert(wand->signature == MagickWandSignature);
10549 if (IfMagickTrue(wand->debug))
10550 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10551 if (wand->images == (Image *) NULL)
10552 return(UndefinedVirtualPixelMethod);
10553 return(SetImageVirtualPixelMethod(wand->images,method,wand->exception));
10557 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10561 % M a g i c k S e t I m a g e W h i t e P o i n t %
10565 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10567 % MagickSetImageWhitePoint() sets the image chromaticity white point.
10569 % The format of the MagickSetImageWhitePoint method is:
10571 % MagickBooleanType MagickSetImageWhitePoint(MagickWand *wand,
10572 % const double x,const double y)
10574 % A description of each parameter follows:
10576 % o wand: the magick wand.
10578 % o x: the white x-point.
10580 % o y: the white y-point.
10583 WandExport MagickBooleanType MagickSetImageWhitePoint(MagickWand *wand,
10584 const double x,const double y)
10586 assert(wand != (MagickWand *) NULL);
10587 assert(wand->signature == MagickWandSignature);
10588 if (IfMagickTrue(wand->debug))
10589 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10590 if (wand->images == (Image *) NULL)
10591 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10592 wand->images->chromaticity.white_point.x=x;
10593 wand->images->chromaticity.white_point.y=y;
10594 return(MagickTrue);
10598 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10602 % M a g i c k S h a d e I m a g e C h a n n e l %
10606 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10608 % MagickShadeImage() shines a distant light on an image to create a
10609 % three-dimensional effect. You control the positioning of the light with
10610 % azimuth and elevation; azimuth is measured in degrees off the x axis
10611 % and elevation is measured in pixels above the Z axis.
10613 % The format of the MagickShadeImage method is:
10615 % MagickBooleanType MagickShadeImage(MagickWand *wand,
10616 % const MagickBooleanType gray,const double azimuth,
10617 % const double elevation)
10619 % A description of each parameter follows:
10621 % o wand: the magick wand.
10623 % o gray: A value other than zero shades the intensity of each pixel.
10625 % o azimuth, elevation: Define the light source direction.
10628 WandExport MagickBooleanType MagickShadeImage(MagickWand *wand,
10629 const MagickBooleanType gray,const double asimuth,const double elevation)
10634 assert(wand != (MagickWand *) NULL);
10635 assert(wand->signature == MagickWandSignature);
10636 if (IfMagickTrue(wand->debug))
10637 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10638 if (wand->images == (Image *) NULL)
10639 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10640 shade_image=ShadeImage(wand->images,gray,asimuth,elevation,wand->exception);
10641 if (shade_image == (Image *) NULL)
10642 return(MagickFalse);
10643 ReplaceImageInList(&wand->images,shade_image);
10644 return(MagickTrue);
10648 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10652 % M a g i c k S h a d o w I m a g e %
10656 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10658 % MagickShadowImage() simulates an image shadow.
10660 % The format of the MagickShadowImage method is:
10662 % MagickBooleanType MagickShadowImage(MagickWand *wand,const double alpha,
10663 % const double sigma,const ssize_t x,const ssize_t y)
10665 % A description of each parameter follows:
10667 % o wand: the magick wand.
10669 % o alpha: percentage transparency.
10671 % o sigma: the standard deviation of the Gaussian, in pixels.
10673 % o x: the shadow x-offset.
10675 % o y: the shadow y-offset.
10678 WandExport MagickBooleanType MagickShadowImage(MagickWand *wand,
10679 const double alpha,const double sigma,const ssize_t x,const ssize_t y)
10684 assert(wand != (MagickWand *) NULL);
10685 assert(wand->signature == MagickWandSignature);
10686 if (IfMagickTrue(wand->debug))
10687 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10688 if (wand->images == (Image *) NULL)
10689 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10690 shadow_image=ShadowImage(wand->images,alpha,sigma,x,y,wand->exception);
10691 if (shadow_image == (Image *) NULL)
10692 return(MagickFalse);
10693 ReplaceImageInList(&wand->images,shadow_image);
10694 return(MagickTrue);
10698 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10702 % M a g i c k S h a r p e n I m a g e %
10706 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10708 % MagickSharpenImage() sharpens an image. We convolve the image with a
10709 % Gaussian operator of the given radius and standard deviation (sigma).
10710 % For reasonable results, the radius should be larger than sigma. Use a
10711 % radius of 0 and MagickSharpenImage() selects a suitable radius for you.
10713 % The format of the MagickSharpenImage method is:
10715 % MagickBooleanType MagickSharpenImage(MagickWand *wand,
10716 % const double radius,const double sigma)
10718 % A description of each parameter follows:
10720 % o wand: the magick wand.
10722 % o radius: the radius of the Gaussian, in pixels, not counting the center
10725 % o sigma: the standard deviation of the Gaussian, in pixels.
10728 WandExport MagickBooleanType MagickSharpenImage(MagickWand *wand,
10729 const double radius,const double sigma)
10734 assert(wand != (MagickWand *) NULL);
10735 assert(wand->signature == MagickWandSignature);
10736 if (IfMagickTrue(wand->debug))
10737 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10738 if (wand->images == (Image *) NULL)
10739 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10740 sharp_image=SharpenImage(wand->images,radius,sigma,wand->exception);
10741 if (sharp_image == (Image *) NULL)
10742 return(MagickFalse);
10743 ReplaceImageInList(&wand->images,sharp_image);
10744 return(MagickTrue);
10748 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10752 % M a g i c k S h a v e I m a g e %
10756 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10758 % MagickShaveImage() shaves pixels from the image edges. It allocates the
10759 % memory necessary for the new Image structure and returns a pointer to the
10762 % The format of the MagickShaveImage method is:
10764 % MagickBooleanType MagickShaveImage(MagickWand *wand,
10765 % const size_t columns,const size_t rows)
10767 % A description of each parameter follows:
10769 % o wand: the magick wand.
10771 % o columns: the number of columns in the scaled image.
10773 % o rows: the number of rows in the scaled image.
10777 WandExport MagickBooleanType MagickShaveImage(MagickWand *wand,
10778 const size_t columns,const size_t rows)
10786 assert(wand != (MagickWand *) NULL);
10787 assert(wand->signature == MagickWandSignature);
10788 if (IfMagickTrue(wand->debug))
10789 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10790 if (wand->images == (Image *) NULL)
10791 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10792 shave_info.width=columns;
10793 shave_info.height=rows;
10796 shave_image=ShaveImage(wand->images,&shave_info,wand->exception);
10797 if (shave_image == (Image *) NULL)
10798 return(MagickFalse);
10799 ReplaceImageInList(&wand->images,shave_image);
10800 return(MagickTrue);
10804 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10808 % M a g i c k S h e a r I m a g e %
10812 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10814 % MagickShearImage() slides one edge of an image along the X or Y axis,
10815 % creating a parallelogram. An X direction shear slides an edge along the X
10816 % axis, while a Y direction shear slides an edge along the Y axis. The amount
10817 % of the shear is controlled by a shear angle. For X direction shears, x_shear
10818 % is measured relative to the Y axis, and similarly, for Y direction shears
10819 % y_shear is measured relative to the X axis. Empty triangles left over from
10820 % shearing the image are filled with the background color.
10822 % The format of the MagickShearImage method is:
10824 % MagickBooleanType MagickShearImage(MagickWand *wand,
10825 % const PixelWand *background,const double x_shear,const double y_shear)
10827 % A description of each parameter follows:
10829 % o wand: the magick wand.
10831 % o background: the background pixel wand.
10833 % o x_shear: the number of degrees to shear the image.
10835 % o y_shear: the number of degrees to shear the image.
10838 WandExport MagickBooleanType MagickShearImage(MagickWand *wand,
10839 const PixelWand *background,const double x_shear,const double y_shear)
10844 assert(wand != (MagickWand *) NULL);
10845 assert(wand->signature == MagickWandSignature);
10846 if (IfMagickTrue(wand->debug))
10847 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10848 if (wand->images == (Image *) NULL)
10849 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10850 PixelGetQuantumPacket(background,&wand->images->background_color);
10851 shear_image=ShearImage(wand->images,x_shear,y_shear,wand->exception);
10852 if (shear_image == (Image *) NULL)
10853 return(MagickFalse);
10854 ReplaceImageInList(&wand->images,shear_image);
10855 return(MagickTrue);
10859 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10863 % M a g i c k S i g m o i d a l C o n t r a s t I m a g e %
10867 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10869 % MagickSigmoidalContrastImage() adjusts the contrast of an image with a
10870 % non-linear sigmoidal contrast algorithm. Increase the contrast of the
10871 % image using a sigmoidal transfer function without saturating highlights or
10872 % shadows. Contrast indicates how much to increase the contrast (0 is none;
10873 % 3 is typical; 20 is pushing it); mid-point indicates where midtones fall in
10874 % the resultant image (0 is white; 50% is middle-gray; 100% is black). Set
10875 % sharpen to MagickTrue to increase the image contrast otherwise the contrast
10878 % The format of the MagickSigmoidalContrastImage method is:
10880 % MagickBooleanType MagickSigmoidalContrastImage(MagickWand *wand,
10881 % const MagickBooleanType sharpen,const double alpha,const double beta)
10883 % A description of each parameter follows:
10885 % o wand: the magick wand.
10887 % o sharpen: Increase or decrease image contrast.
10889 % o alpha: strength of the contrast, the larger the number the more
10890 % 'threshold-like' it becomes.
10892 % o beta: midpoint of the function as a color value 0 to QuantumRange.
10895 WandExport MagickBooleanType MagickSigmoidalContrastImage(
10896 MagickWand *wand,const MagickBooleanType sharpen,const double alpha,
10902 assert(wand != (MagickWand *) NULL);
10903 assert(wand->signature == MagickWandSignature);
10904 if (IfMagickTrue(wand->debug))
10905 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10906 if (wand->images == (Image *) NULL)
10907 ThrowWandException(WandError,"ContainsNoImages",wand->name);
10908 status=SigmoidalContrastImage(wand->images,sharpen,alpha,beta,
10914 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10918 % M a g i c k S i m i l a r i t y I m a g e %
10922 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10924 % MagickSimilarityImage() compares the reference image of the image and
10925 % returns the best match offset. In addition, it returns a similarity image
10926 % such that an exact match location is completely white and if none of the
10927 % pixels match, black, otherwise some gray level in-between.
10929 % The format of the MagickSimilarityImage method is:
10931 % MagickWand *MagickSimilarityImage(MagickWand *wand,
10932 % const MagickWand *reference,const MetricType metric,
10933 % const double similarity_threshold,RectangeInfo *offset,
10934 % double *similarity)
10936 % A description of each parameter follows:
10938 % o wand: the magick wand.
10940 % o reference: the reference wand.
10942 % o metric: the metric.
10944 % o similarity_threshold: minimum distortion for (sub)image match.
10946 % o offset: the best match offset of the reference image within the image.
10948 % o similarity: the computed similarity between the images.
10951 WandExport MagickWand *MagickSimilarityImage(MagickWand *wand,
10952 const MagickWand *reference,const MetricType metric,
10953 const double similarity_threshold,RectangleInfo *offset,double *similarity)
10958 assert(wand != (MagickWand *) NULL);
10959 assert(wand->signature == MagickWandSignature);
10960 if (IfMagickTrue(wand->debug))
10961 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
10962 if ((wand->images == (Image *) NULL) || (reference->images == (Image *) NULL))
10964 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
10965 "ContainsNoImages","`%s'",wand->name);
10966 return((MagickWand *) NULL);
10968 similarity_image=SimilarityImage(wand->images,reference->images,metric,
10969 similarity_threshold,offset,similarity,wand->exception);
10970 if (similarity_image == (Image *) NULL)
10971 return((MagickWand *) NULL);
10972 return(CloneMagickWandFromImages(wand,similarity_image));
10976 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10980 % M a g i c k S k e t c h I m a g e %
10984 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10986 % MagickSketchImage() simulates a pencil sketch. We convolve the image with
10987 % a Gaussian operator of the given radius and standard deviation (sigma).
10988 % For reasonable results, radius should be larger than sigma. Use a
10989 % radius of 0 and SketchImage() selects a suitable radius for you.
10990 % Angle gives the angle of the blurring motion.
10992 % The format of the MagickSketchImage method is:
10994 % MagickBooleanType MagickSketchImage(MagickWand *wand,
10995 % const double radius,const double sigma,const double angle)
10997 % A description of each parameter follows:
10999 % o wand: the magick wand.
11001 % o radius: the radius of the Gaussian, in pixels, not counting
11002 % the center pixel.
11004 % o sigma: the standard deviation of the Gaussian, in pixels.
11006 % o angle: apply the effect along this angle.
11009 WandExport MagickBooleanType MagickSketchImage(MagickWand *wand,
11010 const double radius,const double sigma,const double angle)
11015 assert(wand != (MagickWand *) NULL);
11016 assert(wand->signature == MagickWandSignature);
11017 if (IfMagickTrue(wand->debug))
11018 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11019 if (wand->images == (Image *) NULL)
11020 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11021 sketch_image=SketchImage(wand->images,radius,sigma,angle,wand->exception);
11022 if (sketch_image == (Image *) NULL)
11023 return(MagickFalse);
11024 ReplaceImageInList(&wand->images,sketch_image);
11025 return(MagickTrue);
11029 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11033 % M a g i c k S m u s h I m a g e s %
11037 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11039 % MagickSmushImages() takes all images from the current image pointer to the
11040 % end of the image list and smushs them to each other top-to-bottom if the
11041 % stack parameter is true, otherwise left-to-right.
11043 % The format of the MagickSmushImages method is:
11045 % MagickWand *MagickSmushImages(MagickWand *wand,
11046 % const MagickBooleanType stack,const ssize_t offset)
11048 % A description of each parameter follows:
11050 % o wand: the magick wand.
11052 % o stack: By default, images are stacked left-to-right. Set stack to
11053 % MagickTrue to stack them top-to-bottom.
11055 % o offset: minimum distance in pixels between images.
11058 WandExport MagickWand *MagickSmushImages(MagickWand *wand,
11059 const MagickBooleanType stack,const ssize_t offset)
11064 assert(wand != (MagickWand *) NULL);
11065 assert(wand->signature == MagickWandSignature);
11066 if (IfMagickTrue(wand->debug))
11067 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11068 if (wand->images == (Image *) NULL)
11069 return((MagickWand *) NULL);
11070 smush_image=SmushImages(wand->images,stack,offset,wand->exception);
11071 if (smush_image == (Image *) NULL)
11072 return((MagickWand *) NULL);
11073 return(CloneMagickWandFromImages(wand,smush_image));
11077 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11081 % M a g i c k S o l a r i z e I m a g e %
11085 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11087 % MagickSolarizeImage() applies a special effect to the image, similar to the
11088 % effect achieved in a photo darkroom by selectively exposing areas of photo
11089 % sensitive paper to light. Threshold ranges from 0 to QuantumRange and is a
11090 % measure of the extent of the solarization.
11092 % The format of the MagickSolarizeImage method is:
11094 % MagickBooleanType MagickSolarizeImage(MagickWand *wand,
11095 % const double threshold)
11097 % A description of each parameter follows:
11099 % o wand: the magick wand.
11101 % o threshold: Define the extent of the solarization.
11104 WandExport MagickBooleanType MagickSolarizeImage(MagickWand *wand,
11105 const double threshold)
11110 assert(wand != (MagickWand *) NULL);
11111 assert(wand->signature == MagickWandSignature);
11112 if (IfMagickTrue(wand->debug))
11113 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11114 if (wand->images == (Image *) NULL)
11115 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11116 status=SolarizeImage(wand->images,threshold,wand->exception);
11121 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11125 % M a g i c k S p a r s e C o l o r I m a g e %
11129 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11131 % MagickSparseColorImage(), given a set of coordinates, interpolates the
11132 % colors found at those coordinates, across the whole image, using various
11135 % The format of the MagickSparseColorImage method is:
11137 % MagickBooleanType MagickSparseColorImage(MagickWand *wand,
11138 % const SparseColorMethod method,const size_t number_arguments,
11139 % const double *arguments)
11141 % A description of each parameter follows:
11143 % o image: the image to be sparseed.
11145 % o method: the method of image sparseion.
11147 % ArcSparseColorion will always ignore source image offset, and always
11148 % 'bestfit' the destination image with the top left corner offset
11149 % relative to the polar mapping center.
11151 % Bilinear has no simple inverse mapping so will not allow 'bestfit'
11152 % style of image sparseion.
11154 % Affine, Perspective, and Bilinear, will do least squares fitting of
11155 % the distrotion when more than the minimum number of control point
11156 % pairs are provided.
11158 % Perspective, and Bilinear, will fall back to a Affine sparseion when
11159 % less than 4 control point pairs are provided. While Affine sparseions
11160 % will let you use any number of control point pairs, that is Zero pairs
11161 % is a No-Op (viewport only) distrotion, one pair is a translation and
11162 % two pairs of control points will do a scale-rotate-translate, without
11165 % o number_arguments: the number of arguments given for this sparseion
11168 % o arguments: the arguments for this sparseion method.
11171 WandExport MagickBooleanType MagickSparseColorImage(MagickWand *wand,
11172 const SparseColorMethod method,const size_t number_arguments,
11173 const double *arguments)
11178 assert(wand != (MagickWand *) NULL);
11179 assert(wand->signature == MagickWandSignature);
11180 if (IfMagickTrue(wand->debug))
11181 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11182 if (wand->images == (Image *) NULL)
11183 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11184 sparse_image=SparseColorImage(wand->images,method,number_arguments,arguments,
11186 if (sparse_image == (Image *) NULL)
11187 return(MagickFalse);
11188 ReplaceImageInList(&wand->images,sparse_image);
11189 return(MagickTrue);
11193 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11197 % M a g i c k S p l i c e I m a g e %
11201 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11203 % MagickSpliceImage() splices a solid color into the image.
11205 % The format of the MagickSpliceImage method is:
11207 % MagickBooleanType MagickSpliceImage(MagickWand *wand,
11208 % const size_t width,const size_t height,const ssize_t x,
11211 % A description of each parameter follows:
11213 % o wand: the magick wand.
11215 % o width: the region width.
11217 % o height: the region height.
11219 % o x: the region x offset.
11221 % o y: the region y offset.
11224 WandExport MagickBooleanType MagickSpliceImage(MagickWand *wand,
11225 const size_t width,const size_t height,const ssize_t x,
11234 assert(wand != (MagickWand *) NULL);
11235 assert(wand->signature == MagickWandSignature);
11236 if (IfMagickTrue(wand->debug))
11237 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11238 if (wand->images == (Image *) NULL)
11239 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11240 splice.width=width;
11241 splice.height=height;
11244 splice_image=SpliceImage(wand->images,&splice,wand->exception);
11245 if (splice_image == (Image *) NULL)
11246 return(MagickFalse);
11247 ReplaceImageInList(&wand->images,splice_image);
11248 return(MagickTrue);
11252 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11256 % M a g i c k S p r e a d I m a g e %
11260 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11262 % MagickSpreadImage() is a special effects method that randomly displaces each
11263 % pixel in a block defined by the radius parameter.
11265 % The format of the MagickSpreadImage method is:
11267 % MagickBooleanType MagickSpreadImage(MagickWand *wand,const double radius)
11269 % A description of each parameter follows:
11271 % o wand: the magick wand.
11273 % o radius: Choose a random pixel in a neighborhood of this extent.
11276 WandExport MagickBooleanType MagickSpreadImage(MagickWand *wand,
11277 const double radius)
11282 assert(wand != (MagickWand *) NULL);
11283 assert(wand->signature == MagickWandSignature);
11284 if (IfMagickTrue(wand->debug))
11285 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11286 if (wand->images == (Image *) NULL)
11287 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11288 spread_image=SpreadImage(wand->images,radius,wand->exception);
11289 if (spread_image == (Image *) NULL)
11290 return(MagickFalse);
11291 ReplaceImageInList(&wand->images,spread_image);
11292 return(MagickTrue);
11296 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11300 % M a g i c k S t a t i s t i c I m a g e %
11304 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11306 % MagickStatisticImage() replace each pixel with corresponding statistic from
11307 % the neighborhood of the specified width and height.
11309 % The format of the MagickStatisticImage method is:
11311 % MagickBooleanType MagickStatisticImage(MagickWand *wand,
11312 % const StatisticType type,const double width,const size_t height)
11314 % A description of each parameter follows:
11316 % o wand: the magick wand.
11318 % o type: the statistic type (e.g. median, mode, etc.).
11320 % o width: the width of the pixel neighborhood.
11322 % o height: the height of the pixel neighborhood.
11325 WandExport MagickBooleanType MagickStatisticImage(MagickWand *wand,
11326 const StatisticType type,const size_t width,const size_t height)
11331 assert(wand != (MagickWand *) NULL);
11332 assert(wand->signature == MagickWandSignature);
11333 if (IfMagickTrue(wand->debug))
11334 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11335 if (wand->images == (Image *) NULL)
11336 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11337 statistic_image=StatisticImage(wand->images,type,width,height,
11339 if (statistic_image == (Image *) NULL)
11340 return(MagickFalse);
11341 ReplaceImageInList(&wand->images,statistic_image);
11342 return(MagickTrue);
11346 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11350 % M a g i c k S t e g a n o I m a g e %
11354 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11356 % MagickSteganoImage() hides a digital watermark within the image.
11357 % Recover the hidden watermark later to prove that the authenticity of
11358 % an image. Offset defines the start position within the image to hide
11361 % The format of the MagickSteganoImage method is:
11363 % MagickWand *MagickSteganoImage(MagickWand *wand,
11364 % const MagickWand *watermark_wand,const ssize_t offset)
11366 % A description of each parameter follows:
11368 % o wand: the magick wand.
11370 % o watermark_wand: the watermark wand.
11372 % o offset: Start hiding at this offset into the image.
11375 WandExport MagickWand *MagickSteganoImage(MagickWand *wand,
11376 const MagickWand *watermark_wand,const ssize_t offset)
11381 assert(wand != (MagickWand *) NULL);
11382 assert(wand->signature == MagickWandSignature);
11383 if (IfMagickTrue(wand->debug))
11384 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11385 if ((wand->images == (Image *) NULL) ||
11386 (watermark_wand->images == (Image *) NULL))
11388 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
11389 "ContainsNoImages","`%s'",wand->name);
11390 return((MagickWand *) NULL);
11392 wand->images->offset=offset;
11393 stegano_image=SteganoImage(wand->images,watermark_wand->images,
11395 if (stegano_image == (Image *) NULL)
11396 return((MagickWand *) NULL);
11397 return(CloneMagickWandFromImages(wand,stegano_image));
11401 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11405 % M a g i c k S t e r e o I m a g e %
11409 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11411 % MagickStereoImage() composites two images and produces a single image that
11412 % is the composite of a left and right image of a stereo pair
11414 % The format of the MagickStereoImage method is:
11416 % MagickWand *MagickStereoImage(MagickWand *wand,
11417 % const MagickWand *offset_wand)
11419 % A description of each parameter follows:
11421 % o wand: the magick wand.
11423 % o offset_wand: Another image wand.
11426 WandExport MagickWand *MagickStereoImage(MagickWand *wand,
11427 const MagickWand *offset_wand)
11432 assert(wand != (MagickWand *) NULL);
11433 assert(wand->signature == MagickWandSignature);
11434 if (IfMagickTrue(wand->debug))
11435 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11436 if ((wand->images == (Image *) NULL) ||
11437 (offset_wand->images == (Image *) NULL))
11439 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
11440 "ContainsNoImages","`%s'",wand->name);
11441 return((MagickWand *) NULL);
11443 stereo_image=StereoImage(wand->images,offset_wand->images,wand->exception);
11444 if (stereo_image == (Image *) NULL)
11445 return((MagickWand *) NULL);
11446 return(CloneMagickWandFromImages(wand,stereo_image));
11450 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11454 % M a g i c k S t r i p I m a g e %
11458 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11460 % MagickStripImage() strips an image of all profiles and comments.
11462 % The format of the MagickStripImage method is:
11464 % MagickBooleanType MagickStripImage(MagickWand *wand)
11466 % A description of each parameter follows:
11468 % o wand: the magick wand.
11471 WandExport MagickBooleanType MagickStripImage(MagickWand *wand)
11473 assert(wand != (MagickWand *) NULL);
11474 assert(wand->signature == MagickWandSignature);
11475 if (IfMagickTrue(wand->debug))
11476 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11477 if (wand->images == (Image *) NULL)
11478 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11479 return(StripImage(wand->images,wand->exception));
11483 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11487 % M a g i c k S w i r l I m a g e %
11491 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11493 % MagickSwirlImage() swirls the pixels about the center of the image, where
11494 % degrees indicates the sweep of the arc through which each pixel is moved.
11495 % You get a more dramatic effect as the degrees move from 1 to 360.
11497 % The format of the MagickSwirlImage method is:
11499 % MagickBooleanType MagickSwirlImage(MagickWand *wand,const double degrees,
11500 % const PixelInterpolateMethod method)
11502 % A description of each parameter follows:
11504 % o wand: the magick wand.
11506 % o degrees: Define the tightness of the swirling effect.
11508 % o method: the pixel interpolation method.
11511 WandExport MagickBooleanType MagickSwirlImage(MagickWand *wand,
11512 const double degrees,const PixelInterpolateMethod method)
11517 assert(wand != (MagickWand *) NULL);
11518 assert(wand->signature == MagickWandSignature);
11519 if (IfMagickTrue(wand->debug))
11520 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11521 if (wand->images == (Image *) NULL)
11522 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11523 swirl_image=SwirlImage(wand->images,degrees,method,wand->exception);
11524 if (swirl_image == (Image *) NULL)
11525 return(MagickFalse);
11526 ReplaceImageInList(&wand->images,swirl_image);
11527 return(MagickTrue);
11531 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11535 % M a g i c k T e x t u r e I m a g e %
11539 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11541 % MagickTextureImage() repeatedly tiles the texture image across and down the
11544 % The format of the MagickTextureImage method is:
11546 % MagickWand *MagickTextureImage(MagickWand *wand,
11547 % const MagickWand *texture_wand)
11549 % A description of each parameter follows:
11551 % o wand: the magick wand.
11553 % o texture_wand: the texture wand
11556 WandExport MagickWand *MagickTextureImage(MagickWand *wand,
11557 const MagickWand *texture_wand)
11565 assert(wand != (MagickWand *) NULL);
11566 assert(wand->signature == MagickWandSignature);
11567 if (IfMagickTrue(wand->debug))
11568 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11569 if ((wand->images == (Image *) NULL) ||
11570 (texture_wand->images == (Image *) NULL))
11572 (void) ThrowMagickException(wand->exception,GetMagickModule(),WandError,
11573 "ContainsNoImages","`%s'",wand->name);
11574 return((MagickWand *) NULL);
11576 texture_image=CloneImage(wand->images,0,0,MagickTrue,wand->exception);
11577 if (texture_image == (Image *) NULL)
11578 return((MagickWand *) NULL);
11579 status=TextureImage(texture_image,texture_wand->images,wand->exception);
11580 if (IfMagickFalse(status))
11582 texture_image=DestroyImage(texture_image);
11583 return((MagickWand *) NULL);
11585 return(CloneMagickWandFromImages(wand,texture_image));
11589 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11593 % M a g i c k T h r e s h o l d I m a g e %
11597 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11599 % MagickThresholdImage() changes the value of individual pixels based on
11600 % the intensity of each pixel compared to threshold. The result is a
11601 % high-contrast, two color image.
11603 % The format of the MagickThresholdImage method is:
11605 % MagickBooleanType MagickThresholdImage(MagickWand *wand,
11606 % const double threshold)
11607 % MagickBooleanType MagickThresholdImageChannel(MagickWand *wand,
11608 % const ChannelType channel,const double threshold)
11610 % A description of each parameter follows:
11612 % o wand: the magick wand.
11614 % o channel: the image channel(s).
11616 % o threshold: Define the threshold value.
11619 WandExport MagickBooleanType MagickThresholdImage(MagickWand *wand,
11620 const double threshold)
11625 status=MagickThresholdImageChannel(wand,DefaultChannels,threshold);
11629 WandExport MagickBooleanType MagickThresholdImageChannel(MagickWand *wand,
11630 const ChannelType channel,const double threshold)
11635 assert(wand != (MagickWand *) NULL);
11636 assert(wand->signature == MagickWandSignature);
11637 if (IfMagickTrue(wand->debug))
11638 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11639 if (wand->images == (Image *) NULL)
11640 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11641 status=BilevelImage(wand->images,threshold,wand->exception);
11646 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11650 % M a g i c k T h u m b n a i l I m a g e %
11654 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11656 % MagickThumbnailImage() changes the size of an image to the given dimensions
11657 % and removes any associated profiles. The goal is to produce small low cost
11658 % thumbnail images suited for display on the Web.
11660 % The format of the MagickThumbnailImage method is:
11662 % MagickBooleanType MagickThumbnailImage(MagickWand *wand,
11663 % const size_t columns,const size_t rows)
11665 % A description of each parameter follows:
11667 % o wand: the magick wand.
11669 % o columns: the number of columns in the scaled image.
11671 % o rows: the number of rows in the scaled image.
11674 WandExport MagickBooleanType MagickThumbnailImage(MagickWand *wand,
11675 const size_t columns,const size_t rows)
11680 assert(wand != (MagickWand *) NULL);
11681 assert(wand->signature == MagickWandSignature);
11682 if (IfMagickTrue(wand->debug))
11683 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11684 if (wand->images == (Image *) NULL)
11685 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11686 thumbnail_image=ThumbnailImage(wand->images,columns,rows,wand->exception);
11687 if (thumbnail_image == (Image *) NULL)
11688 return(MagickFalse);
11689 ReplaceImageInList(&wand->images,thumbnail_image);
11690 return(MagickTrue);
11694 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11698 % M a g i c k T i n t I m a g e %
11702 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11704 % MagickTintImage() applies a color vector to each pixel in the image. The
11705 % length of the vector is 0 for black and white and at its maximum for the
11706 % midtones. The vector weighting function is
11707 % f(x)=(1-(4.0*((x-0.5)*(x-0.5)))).
11709 % The format of the MagickTintImage method is:
11711 % MagickBooleanType MagickTintImage(MagickWand *wand,
11712 % const PixelWand *tint,const PixelWand *blend)
11714 % A description of each parameter follows:
11716 % o wand: the magick wand.
11718 % o tint: the tint pixel wand.
11720 % o alpha: the alpha pixel wand.
11723 WandExport MagickBooleanType MagickTintImage(MagickWand *wand,
11724 const PixelWand *tint,const PixelWand *blend)
11727 percent_blend[MagickPathExtent];
11735 assert(wand != (MagickWand *) NULL);
11736 assert(wand->signature == MagickWandSignature);
11737 if (IfMagickTrue(wand->debug))
11738 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11739 if (wand->images == (Image *) NULL)
11740 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11741 if (wand->images->colorspace != CMYKColorspace)
11742 (void) FormatLocaleString(percent_blend,MagickPathExtent,
11743 "%g,%g,%g,%g",(double) (100.0*QuantumScale*
11744 PixelGetRedQuantum(blend)),(double) (100.0*QuantumScale*
11745 PixelGetGreenQuantum(blend)),(double) (100.0*QuantumScale*
11746 PixelGetBlueQuantum(blend)),(double) (100.0*QuantumScale*
11747 PixelGetAlphaQuantum(blend)));
11749 (void) FormatLocaleString(percent_blend,MagickPathExtent,
11750 "%g,%g,%g,%g,%g",(double) (100.0*QuantumScale*
11751 PixelGetCyanQuantum(blend)),(double) (100.0*QuantumScale*
11752 PixelGetMagentaQuantum(blend)),(double) (100.0*QuantumScale*
11753 PixelGetYellowQuantum(blend)),(double) (100.0*QuantumScale*
11754 PixelGetBlackQuantum(blend)),(double) (100.0*QuantumScale*
11755 PixelGetAlphaQuantum(blend)));
11756 target=PixelGetPixel(tint);
11757 tint_image=TintImage(wand->images,percent_blend,&target,wand->exception);
11758 if (tint_image == (Image *) NULL)
11759 return(MagickFalse);
11760 ReplaceImageInList(&wand->images,tint_image);
11761 return(MagickTrue);
11765 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11769 % M a g i c k T r a n s f o r m I m a g e %
11773 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11775 % MagickTransformImage() is a convenience method that behaves like
11776 % MagickResizeImage() or MagickCropImage() but accepts scaling and/or cropping
11777 % information as a region geometry specification. If the operation fails,
11778 % a NULL image handle is returned.
11780 % The format of the MagickTransformImage method is:
11782 % MagickWand *MagickTransformImage(MagickWand *wand,const char *crop,
11783 % const char *geometry)
11785 % A description of each parameter follows:
11787 % o wand: the magick wand.
11789 % o crop: A crop geometry string. This geometry defines a subregion of the
11792 % o geometry: An image geometry string. This geometry defines the final
11793 % size of the image.
11796 WandExport MagickWand *MagickTransformImage(MagickWand *wand,
11797 const char *crop,const char *geometry)
11805 assert(wand != (MagickWand *) NULL);
11806 assert(wand->signature == MagickWandSignature);
11807 if (IfMagickTrue(wand->debug))
11808 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11809 if (wand->images == (Image *) NULL)
11810 return((MagickWand *) NULL);
11811 transform_image=CloneImage(wand->images,0,0,MagickTrue,wand->exception);
11812 if (transform_image == (Image *) NULL)
11813 return((MagickWand *) NULL);
11814 status=TransformImage(&transform_image,crop,geometry,wand->exception);
11815 if (IfMagickFalse(status))
11817 transform_image=DestroyImage(transform_image);
11818 return((MagickWand *) NULL);
11820 return(CloneMagickWandFromImages(wand,transform_image));
11824 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11828 % M a g i c k T r a n s f o r m I m a g e C o l o r s p a c e %
11832 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11834 % MagickTransformImageColorspace() transform the image colorspace, setting
11835 % the images colorspace while transforming the images data to that
11838 % The format of the MagickTransformImageColorspace method is:
11840 % MagickBooleanType MagickTransformImageColorspace(MagickWand *wand,
11841 % const ColorspaceType colorspace)
11843 % A description of each parameter follows:
11845 % o wand: the magick wand.
11847 % o colorspace: the image colorspace: UndefinedColorspace,
11848 % sRGBColorspace, RGBColorspace, GRAYColorspace,
11849 % OHTAColorspace, XYZColorspace, YCbCrColorspace,
11850 % YCCColorspace, YIQColorspace, YPbPrColorspace,
11851 % YPbPrColorspace, YUVColorspace, CMYKColorspace,
11852 % HSLColorspace, HWBColorspace.
11855 WandExport MagickBooleanType MagickTransformImageColorspace(MagickWand *wand,
11856 const ColorspaceType colorspace)
11858 assert(wand != (MagickWand *) NULL);
11859 assert(wand->signature == MagickWandSignature);
11860 if (IfMagickTrue(wand->debug))
11861 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11862 if (wand->images == (Image *) NULL)
11863 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11864 return(TransformImageColorspace(wand->images,colorspace,wand->exception));
11868 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11872 % M a g i c k T r a n s p a r e n t P a i n t I m a g e %
11876 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11878 % MagickTransparentPaintImage() changes any pixel that matches color with the
11879 % color defined by fill.
11881 % The format of the MagickTransparentPaintImage method is:
11883 % MagickBooleanType MagickTransparentPaintImage(MagickWand *wand,
11884 % const PixelWand *target,const double alpha,const double fuzz,
11885 % const MagickBooleanType invert)
11887 % A description of each parameter follows:
11889 % o wand: the magick wand.
11891 % o target: Change this target color to specified alpha value within
11894 % o alpha: the level of transparency: 1.0 is fully opaque and 0.0 is fully
11897 % o fuzz: By default target must match a particular pixel color
11898 % exactly. However, in many cases two colors may differ by a small amount.
11899 % The fuzz member of image defines how much tolerance is acceptable to
11900 % consider two colors as the same. For example, set fuzz to 10 and the
11901 % color red at intensities of 100 and 102 respectively are now interpreted
11902 % as the same color for the purposes of the floodfill.
11904 % o invert: paint any pixel that does not match the target color.
11907 WandExport MagickBooleanType MagickTransparentPaintImage(MagickWand *wand,
11908 const PixelWand *target,const double alpha,const double fuzz,
11909 const MagickBooleanType invert)
11917 assert(wand != (MagickWand *) NULL);
11918 assert(wand->signature == MagickWandSignature);
11919 if (IfMagickTrue(wand->debug))
11920 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11921 if (wand->images == (Image *) NULL)
11922 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11923 PixelGetMagickColor(target,&target_pixel);
11924 wand->images->fuzz=fuzz;
11925 status=TransparentPaintImage(wand->images,&target_pixel,ClampToQuantum(
11926 QuantumRange*alpha),invert,wand->exception);
11931 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11935 % M a g i c k T r a n s p o s e I m a g e %
11939 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11941 % MagickTransposeImage() creates a vertical mirror image by reflecting the
11942 % pixels around the central x-axis while rotating them 90-degrees.
11944 % The format of the MagickTransposeImage method is:
11946 % MagickBooleanType MagickTransposeImage(MagickWand *wand)
11948 % A description of each parameter follows:
11950 % o wand: the magick wand.
11953 WandExport MagickBooleanType MagickTransposeImage(MagickWand *wand)
11958 assert(wand != (MagickWand *) NULL);
11959 assert(wand->signature == MagickWandSignature);
11960 if (IfMagickTrue(wand->debug))
11961 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
11962 if (wand->images == (Image *) NULL)
11963 ThrowWandException(WandError,"ContainsNoImages",wand->name);
11964 transpose_image=TransposeImage(wand->images,wand->exception);
11965 if (transpose_image == (Image *) NULL)
11966 return(MagickFalse);
11967 ReplaceImageInList(&wand->images,transpose_image);
11968 return(MagickTrue);
11972 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11976 % M a g i c k T r a n s v e r s e I m a g e %
11980 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11982 % MagickTransverseImage() creates a horizontal mirror image by reflecting the
11983 % pixels around the central y-axis while rotating them 270-degrees.
11985 % The format of the MagickTransverseImage method is:
11987 % MagickBooleanType MagickTransverseImage(MagickWand *wand)
11989 % A description of each parameter follows:
11991 % o wand: the magick wand.
11994 WandExport MagickBooleanType MagickTransverseImage(MagickWand *wand)
11999 assert(wand != (MagickWand *) NULL);
12000 assert(wand->signature == MagickWandSignature);
12001 if (IfMagickTrue(wand->debug))
12002 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12003 if (wand->images == (Image *) NULL)
12004 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12005 transverse_image=TransverseImage(wand->images,wand->exception);
12006 if (transverse_image == (Image *) NULL)
12007 return(MagickFalse);
12008 ReplaceImageInList(&wand->images,transverse_image);
12009 return(MagickTrue);
12013 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12017 % M a g i c k T r i m I m a g e %
12021 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12023 % MagickTrimImage() remove edges that are the background color from the image.
12025 % The format of the MagickTrimImage method is:
12027 % MagickBooleanType MagickTrimImage(MagickWand *wand,const double fuzz)
12029 % A description of each parameter follows:
12031 % o wand: the magick wand.
12033 % o fuzz: By default target must match a particular pixel color
12034 % exactly. However, in many cases two colors may differ by a small amount.
12035 % The fuzz member of image defines how much tolerance is acceptable to
12036 % consider two colors as the same. For example, set fuzz to 10 and the
12037 % color red at intensities of 100 and 102 respectively are now interpreted
12038 % as the same color for the purposes of the floodfill.
12041 WandExport MagickBooleanType MagickTrimImage(MagickWand *wand,const double fuzz)
12046 assert(wand != (MagickWand *) NULL);
12047 assert(wand->signature == MagickWandSignature);
12048 if (IfMagickTrue(wand->debug))
12049 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12050 if (wand->images == (Image *) NULL)
12051 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12052 wand->images->fuzz=fuzz;
12053 trim_image=TrimImage(wand->images,wand->exception);
12054 if (trim_image == (Image *) NULL)
12055 return(MagickFalse);
12056 ReplaceImageInList(&wand->images,trim_image);
12057 return(MagickTrue);
12061 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12065 % M a g i c k U n i q u e I m a g e C o l o r s %
12069 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12071 % MagickUniqueImageColors() discards all but one of any pixel color.
12073 % The format of the MagickUniqueImageColors method is:
12075 % MagickBooleanType MagickUniqueImageColors(MagickWand *wand)
12077 % A description of each parameter follows:
12079 % o wand: the magick wand.
12082 WandExport MagickBooleanType MagickUniqueImageColors(MagickWand *wand)
12087 assert(wand != (MagickWand *) NULL);
12088 assert(wand->signature == MagickWandSignature);
12089 if (IfMagickTrue(wand->debug))
12090 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12091 if (wand->images == (Image *) NULL)
12092 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12093 unique_image=UniqueImageColors(wand->images,wand->exception);
12094 if (unique_image == (Image *) NULL)
12095 return(MagickFalse);
12096 ReplaceImageInList(&wand->images,unique_image);
12097 return(MagickTrue);
12101 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12105 % M a g i c k U n s h a r p M a s k I m a g e %
12109 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12111 % MagickUnsharpMaskImage() sharpens an image. We convolve the image with a
12112 % Gaussian operator of the given radius and standard deviation (sigma).
12113 % For reasonable results, radius should be larger than sigma. Use a radius
12114 % of 0 and UnsharpMaskImage() selects a suitable radius for you.
12116 % The format of the MagickUnsharpMaskImage method is:
12118 % MagickBooleanType MagickUnsharpMaskImage(MagickWand *wand,
12119 % const double radius,const double sigma,const double gain,
12120 % const double threshold)
12122 % A description of each parameter follows:
12124 % o wand: the magick wand.
12126 % o radius: the radius of the Gaussian, in pixels, not counting the center
12129 % o sigma: the standard deviation of the Gaussian, in pixels.
12131 % o gain: the percentage of the difference between the original and the
12132 % blur image that is added back into the original.
12134 % o threshold: the threshold in pixels needed to apply the diffence gain.
12137 WandExport MagickBooleanType MagickUnsharpMaskImage(MagickWand *wand,
12138 const double radius,const double sigma,const double gain,
12139 const double threshold)
12144 assert(wand != (MagickWand *) NULL);
12145 assert(wand->signature == MagickWandSignature);
12146 if (IfMagickTrue(wand->debug))
12147 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12148 if (wand->images == (Image *) NULL)
12149 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12150 unsharp_image=UnsharpMaskImage(wand->images,radius,sigma,gain,threshold,
12152 if (unsharp_image == (Image *) NULL)
12153 return(MagickFalse);
12154 ReplaceImageInList(&wand->images,unsharp_image);
12155 return(MagickTrue);
12159 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12163 % M a g i c k V i g n e t t e I m a g e %
12167 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12169 % MagickVignetteImage() softens the edges of the image in vignette style.
12171 % The format of the MagickVignetteImage method is:
12173 % MagickBooleanType MagickVignetteImage(MagickWand *wand,
12174 % const double radius,const double sigma,const ssize_t x,
12177 % A description of each parameter follows:
12179 % o wand: the magick wand.
12181 % o radius: the radius.
12183 % o sigma: the sigma.
12185 % o x, y: Define the x and y ellipse offset.
12188 WandExport MagickBooleanType MagickVignetteImage(MagickWand *wand,
12189 const double radius,const double sigma,const ssize_t x,const ssize_t y)
12194 assert(wand != (MagickWand *) NULL);
12195 assert(wand->signature == MagickWandSignature);
12196 if (IfMagickTrue(wand->debug))
12197 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12198 if (wand->images == (Image *) NULL)
12199 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12200 vignette_image=VignetteImage(wand->images,radius,sigma,x,y,wand->exception);
12201 if (vignette_image == (Image *) NULL)
12202 return(MagickFalse);
12203 ReplaceImageInList(&wand->images,vignette_image);
12204 return(MagickTrue);
12208 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12212 % M a g i c k W a v e I m a g e %
12216 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12218 % MagickWaveImage() creates a "ripple" effect in the image by shifting
12219 % the pixels vertically along a sine wave whose amplitude and wavelength
12220 % is specified by the given parameters.
12222 % The format of the MagickWaveImage method is:
12224 % MagickBooleanType MagickWaveImage(MagickWand *wand,
12225 % const double amplitude,const double wave_length,
12226 % const PixelInterpolateMethod method)
12228 % A description of each parameter follows:
12230 % o wand: the magick wand.
12232 % o amplitude, wave_length: Define the amplitude and wave length of the
12235 % o method: the pixel interpolation method.
12238 WandExport MagickBooleanType MagickWaveImage(MagickWand *wand,
12239 const double amplitude,const double wave_length,
12240 const PixelInterpolateMethod method)
12245 assert(wand != (MagickWand *) NULL);
12246 assert(wand->signature == MagickWandSignature);
12247 if (IfMagickTrue(wand->debug))
12248 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12249 if (wand->images == (Image *) NULL)
12250 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12251 wave_image=WaveImage(wand->images,amplitude,wave_length,method,
12253 if (wave_image == (Image *) NULL)
12254 return(MagickFalse);
12255 ReplaceImageInList(&wand->images,wave_image);
12256 return(MagickTrue);
12260 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12264 % M a g i c k W h i t e T h r e s h o l d I m a g e %
12268 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12270 % MagickWhiteThresholdImage() is like ThresholdImage() but force all pixels
12271 % above the threshold into white while leaving all pixels below the threshold
12274 % The format of the MagickWhiteThresholdImage method is:
12276 % MagickBooleanType MagickWhiteThresholdImage(MagickWand *wand,
12277 % const PixelWand *threshold)
12279 % A description of each parameter follows:
12281 % o wand: the magick wand.
12283 % o threshold: the pixel wand.
12286 WandExport MagickBooleanType MagickWhiteThresholdImage(MagickWand *wand,
12287 const PixelWand *threshold)
12290 thresholds[MagickPathExtent];
12292 assert(wand != (MagickWand *) NULL);
12293 assert(wand->signature == MagickWandSignature);
12294 if (IfMagickTrue(wand->debug))
12295 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12296 if (wand->images == (Image *) NULL)
12297 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12298 (void) FormatLocaleString(thresholds,MagickPathExtent,
12299 QuantumFormat "," QuantumFormat "," QuantumFormat "," QuantumFormat,
12300 PixelGetRedQuantum(threshold),PixelGetGreenQuantum(threshold),
12301 PixelGetBlueQuantum(threshold),PixelGetAlphaQuantum(threshold));
12302 return(WhiteThresholdImage(wand->images,thresholds,wand->exception));
12306 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12310 % M a g i c k W r i t e I m a g e %
12314 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12316 % MagickWriteImage() writes an image to the specified filename. If the
12317 % filename parameter is NULL, the image is written to the filename set
12318 % by MagickReadImage() or MagickSetImageFilename().
12320 % The format of the MagickWriteImage method is:
12322 % MagickBooleanType MagickWriteImage(MagickWand *wand,
12323 % const char *filename)
12325 % A description of each parameter follows:
12327 % o wand: the magick wand.
12329 % o filename: the image filename.
12333 WandExport MagickBooleanType MagickWriteImage(MagickWand *wand,
12334 const char *filename)
12345 assert(wand != (MagickWand *) NULL);
12346 assert(wand->signature == MagickWandSignature);
12347 if (IfMagickTrue(wand->debug))
12348 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12349 if (wand->images == (Image *) NULL)
12350 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12351 if (filename != (const char *) NULL)
12352 (void) CopyMagickString(wand->images->filename,filename,MagickPathExtent);
12353 image=CloneImage(wand->images,0,0,MagickTrue,wand->exception);
12354 if (image == (Image *) NULL)
12355 return(MagickFalse);
12356 write_info=CloneImageInfo(wand->image_info);
12357 write_info->adjoin=MagickTrue;
12358 status=WriteImage(write_info,image,wand->exception);
12359 image=DestroyImage(image);
12360 write_info=DestroyImageInfo(write_info);
12365 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12369 % M a g i c k W r i t e I m a g e F i l e %
12373 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12375 % MagickWriteImageFile() writes an image to an open file descriptor.
12377 % The format of the MagickWriteImageFile method is:
12379 % MagickBooleanType MagickWriteImageFile(MagickWand *wand,FILE *file)
12381 % A description of each parameter follows:
12383 % o wand: the magick wand.
12385 % o file: the file descriptor.
12388 WandExport MagickBooleanType MagickWriteImageFile(MagickWand *wand,FILE *file)
12399 assert(wand != (MagickWand *) NULL);
12400 assert(wand->signature == MagickWandSignature);
12401 assert(file != (FILE *) NULL);
12402 if (IfMagickTrue(wand->debug))
12403 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12404 if (wand->images == (Image *) NULL)
12405 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12406 image=CloneImage(wand->images,0,0,MagickTrue,wand->exception);
12407 if (image == (Image *) NULL)
12408 return(MagickFalse);
12409 write_info=CloneImageInfo(wand->image_info);
12410 SetImageInfoFile(write_info,file);
12411 write_info->adjoin=MagickTrue;
12412 status=WriteImage(write_info,image,wand->exception);
12413 write_info=DestroyImageInfo(write_info);
12414 image=DestroyImage(image);
12419 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12423 % M a g i c k W r i t e I m a g e s %
12427 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12429 % MagickWriteImages() writes an image or image sequence.
12431 % The format of the MagickWriteImages method is:
12433 % MagickBooleanType MagickWriteImages(MagickWand *wand,
12434 % const char *filename,const MagickBooleanType adjoin)
12436 % A description of each parameter follows:
12438 % o wand: the magick wand.
12440 % o filename: the image filename.
12442 % o adjoin: join images into a single multi-image file.
12445 WandExport MagickBooleanType MagickWriteImages(MagickWand *wand,
12446 const char *filename,const MagickBooleanType adjoin)
12454 assert(wand != (MagickWand *) NULL);
12455 assert(wand->signature == MagickWandSignature);
12456 if (IfMagickTrue(wand->debug))
12457 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12458 if (wand->images == (Image *) NULL)
12459 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12460 write_info=CloneImageInfo(wand->image_info);
12461 write_info->adjoin=adjoin;
12462 status=WriteImages(write_info,wand->images,filename,wand->exception);
12463 write_info=DestroyImageInfo(write_info);
12468 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12472 % M a g i c k W r i t e I m a g e s F i l e %
12476 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12478 % MagickWriteImagesFile() writes an image sequence to an open file descriptor.
12480 % The format of the MagickWriteImagesFile method is:
12482 % MagickBooleanType MagickWriteImagesFile(MagickWand *wand,FILE *file)
12484 % A description of each parameter follows:
12486 % o wand: the magick wand.
12488 % o file: the file descriptor.
12491 WandExport MagickBooleanType MagickWriteImagesFile(MagickWand *wand,FILE *file)
12499 assert(wand != (MagickWand *) NULL);
12500 assert(wand->signature == MagickWandSignature);
12501 if (IfMagickTrue(wand->debug))
12502 (void) LogMagickEvent(WandEvent,GetMagickModule(),"%s",wand->name);
12503 if (wand->images == (Image *) NULL)
12504 ThrowWandException(WandError,"ContainsNoImages",wand->name);
12505 write_info=CloneImageInfo(wand->image_info);
12506 SetImageInfoFile(write_info,file);
12507 write_info->adjoin=MagickTrue;
12508 status=WriteImages(write_info,wand->images,(const char *) NULL,
12510 write_info=DestroyImageInfo(write_info);