1 // This may look like C code, but it is really -*- C++ -*-
3 // Copyright Bob Friesenhahn, 1999, 2000, 2001, 2002, 2003
5 // Implementation of Image
8 #define MAGICKCORE_IMPLEMENTATION 1
9 #define MAGICK_PLUSPLUS_IMPLEMENTATION 1
16 #include "Magick++/Include.h"
20 #include "Magick++/Image.h"
21 #include "Magick++/Functions.h"
22 #include "Magick++/Pixels.h"
23 #include "Magick++/Options.h"
24 #include "Magick++/ImageRef.h"
26 #define AbsoluteValue(x) ((x) < 0 ? -(x) : (x))
27 #define DegreesToRadians(x) (MagickPI*(x)/180.0)
29 MagickPPExport const char *Magick::borderGeometryDefault = "6x6+0+0";
30 MagickPPExport const char *Magick::frameGeometryDefault = "25x25+6+6";
31 MagickPPExport const char *Magick::raiseGeometryDefault = "6x6+0+0";
33 static bool magick_initialized=false;
36 // Explicit template instantiations
40 // Friend functions to compare Image objects
43 MagickPPExport int Magick::operator == ( const Magick::Image& left_,
44 const Magick::Image& right_ )
46 // If image pixels and signature are the same, then the image is identical
47 return ( ( left_.rows() == right_.rows() ) &&
48 ( left_.columns() == right_.columns() ) &&
49 ( left_.signature() == right_.signature() )
52 MagickPPExport int Magick::operator != ( const Magick::Image& left_,
53 const Magick::Image& right_ )
55 return ( ! (left_ == right_) );
57 MagickPPExport int Magick::operator > ( const Magick::Image& left_,
58 const Magick::Image& right_ )
60 return ( !( left_ < right_ ) && ( left_ != right_ ) );
62 MagickPPExport int Magick::operator < ( const Magick::Image& left_,
63 const Magick::Image& right_ )
65 // If image pixels are less, then image is smaller
66 return ( ( left_.rows() * left_.columns() ) <
67 ( right_.rows() * right_.columns() )
70 MagickPPExport int Magick::operator >= ( const Magick::Image& left_,
71 const Magick::Image& right_ )
73 return ( ( left_ > right_ ) || ( left_ == right_ ) );
75 MagickPPExport int Magick::operator <= ( const Magick::Image& left_,
76 const Magick::Image& right_ )
78 return ( ( left_ < right_ ) || ( left_ == right_ ) );
82 // Image object implementation
85 // Construct from image file or image specification
86 Magick::Image::Image( const std::string &imageSpec_ )
87 : _imgRef(new ImageRef)
91 // Initialize, Allocate and Read images
94 catch ( const Warning & /*warning_*/ )
96 // FIXME: need a way to report warnings in constructor
98 catch ( const Error & /*error_*/ )
106 // Construct a blank image canvas of specified size and color
107 Magick::Image::Image( const Geometry &size_,
108 const Color &color_ )
109 : _imgRef(new ImageRef)
111 // xc: prefix specifies an X11 color string
112 std::string imageSpec("xc:");
120 // Initialize, Allocate and Read images
123 catch ( const Warning & /*warning_*/ )
125 // FIXME: need a way to report warnings in constructor
127 catch ( const Error & /*error_*/ )
135 // Construct Image from in-memory BLOB
136 Magick::Image::Image ( const Blob &blob_ )
137 : _imgRef(new ImageRef)
141 // Initialize, Allocate and Read images
144 catch ( const Warning & /*warning_*/ )
146 // FIXME: need a way to report warnings in constructor
148 catch ( const Error & /*error_*/ )
156 // Construct Image of specified size from in-memory BLOB
157 Magick::Image::Image ( const Blob &blob_,
158 const Geometry &size_ )
159 : _imgRef(new ImageRef)
164 read( blob_, size_ );
166 catch ( const Warning & /*warning_*/ )
168 // FIXME: need a way to report warnings in constructor
170 catch ( const Error & /*error_*/ )
178 // Construct Image of specified size and depth from in-memory BLOB
179 Magick::Image::Image ( const Blob &blob_,
180 const Geometry &size_,
181 const size_t depth_ )
182 : _imgRef(new ImageRef)
187 read( blob_, size_, depth_ );
189 catch ( const Warning & /*warning_*/ )
191 // FIXME: need a way to report warnings in constructor
193 catch ( const Error & /*error_*/ )
201 // Construct Image of specified size, depth, and format from in-memory BLOB
202 Magick::Image::Image ( const Blob &blob_,
203 const Geometry &size_,
205 const std::string &magick_ )
206 : _imgRef(new ImageRef)
211 read( blob_, size_, depth_, magick_ );
213 catch ( const Warning & /*warning_*/ )
215 // FIXME: need a way to report warnings in constructor
217 catch ( const Error & /*error_*/ )
225 // Construct Image of specified size, and format from in-memory BLOB
226 Magick::Image::Image ( const Blob &blob_,
227 const Geometry &size_,
228 const std::string &magick_ )
229 : _imgRef(new ImageRef)
234 read( blob_, size_, magick_ );
236 catch ( const Warning & /*warning_*/ )
238 // FIXME: need a way to report warnings in constructor
240 catch ( const Error & /*error_*/ )
248 // Construct an image based on an array of raw pixels, of specified
249 // type and mapping, in memory
250 Magick::Image::Image ( const size_t width_,
251 const size_t height_,
252 const std::string &map_,
253 const StorageType type_,
254 const void *pixels_ )
255 : _imgRef(new ImageRef)
259 read( width_, height_, map_.c_str(), type_, pixels_ );
261 catch ( const Warning & /*warning_*/ )
263 // FIXME: need a way to report warnings in constructor
265 catch ( const Error & /*error_*/ )
273 // Default constructor
274 Magick::Image::Image( void )
275 : _imgRef(new ImageRef)
281 Magick::Image::~Image()
283 bool doDelete = false;
285 Lock( &_imgRef->_mutexLock );
286 if ( --_imgRef->_refCount == 0 )
297 // Adaptive-blur image
298 void Magick::Image::adaptiveBlur( const double radius_, const double sigma_ )
300 ExceptionInfo exceptionInfo;
301 GetExceptionInfo( &exceptionInfo );
302 MagickCore::Image* newImage =
303 AdaptiveBlurImage( image(), radius_, sigma_, &exceptionInfo);
304 replaceImage( newImage );
305 throwException( exceptionInfo );
306 (void) DestroyExceptionInfo( &exceptionInfo );
309 // Local adaptive threshold image
310 // http://www.dai.ed.ac.uk/HIPR2/adpthrsh.htm
311 // Width x height define the size of the pixel neighborhood
312 // offset = constant to subtract from pixel neighborhood mean
313 void Magick::Image::adaptiveThreshold ( const size_t width_,
314 const size_t height_,
315 const ssize_t offset_ )
317 ExceptionInfo exceptionInfo;
318 GetExceptionInfo( &exceptionInfo );
319 MagickCore::Image* newImage =
320 AdaptiveThresholdImage( constImage(), width_, height_, offset_, &exceptionInfo );
321 replaceImage( newImage );
322 throwException( exceptionInfo );
323 (void) DestroyExceptionInfo( &exceptionInfo );
326 // Add noise to image
327 void Magick::Image::addNoise( const NoiseType noiseType_ )
329 ExceptionInfo exceptionInfo;
330 GetExceptionInfo( &exceptionInfo );
331 MagickCore::Image* newImage =
332 AddNoiseImage ( image(),
335 replaceImage( newImage );
336 throwException( exceptionInfo );
337 (void) DestroyExceptionInfo( &exceptionInfo );
340 void Magick::Image::addNoiseChannel( const ChannelType channel_,
341 const NoiseType noiseType_ )
343 ExceptionInfo exceptionInfo;
344 GetExceptionInfo( &exceptionInfo );
345 ChannelType channel_mask = SetPixelChannelMask( image(), channel_);
346 MagickCore::Image* newImage =
347 AddNoiseImage ( image(),
350 (void) SetPixelChannelMapMask( image(), channel_mask );
351 replaceImage( newImage );
352 throwException( exceptionInfo );
353 (void) DestroyExceptionInfo( &exceptionInfo );
356 // Affine Transform image
357 void Magick::Image::affineTransform ( const DrawableAffine &affine_ )
359 ExceptionInfo exceptionInfo;
360 GetExceptionInfo( &exceptionInfo );
362 AffineMatrix _affine;
363 _affine.sx = affine_.sx();
364 _affine.sy = affine_.sy();
365 _affine.rx = affine_.rx();
366 _affine.ry = affine_.ry();
367 _affine.tx = affine_.tx();
368 _affine.ty = affine_.ty();
370 MagickCore::Image* newImage =
371 AffineTransformImage( image(), &_affine, &exceptionInfo);
372 replaceImage( newImage );
373 throwException( exceptionInfo );
374 (void) DestroyExceptionInfo( &exceptionInfo );
377 // Annotate using specified text, and placement location
378 void Magick::Image::annotate ( const std::string &text_,
379 const Geometry &location_ )
381 annotate ( text_, location_, NorthWestGravity, 0.0 );
383 // Annotate using specified text, bounding area, and placement gravity
384 void Magick::Image::annotate ( const std::string &text_,
385 const Geometry &boundingArea_,
386 const GravityType gravity_ )
388 annotate ( text_, boundingArea_, gravity_, 0.0 );
390 // Annotate with text using specified text, bounding area, placement
391 // gravity, and rotation.
392 void Magick::Image::annotate ( const std::string &text_,
393 const Geometry &boundingArea_,
394 const GravityType gravity_,
395 const double degrees_ )
400 = options()->drawInfo();
402 drawInfo->text = const_cast<char *>(text_.c_str());
404 char boundingArea[MaxTextExtent];
406 drawInfo->geometry = 0;
407 if ( boundingArea_.isValid() ){
408 if ( boundingArea_.width() == 0 || boundingArea_.height() == 0 )
410 FormatLocaleString( boundingArea, MaxTextExtent, "%+.20g%+.20g",
411 (double) boundingArea_.xOff(), (double) boundingArea_.yOff() );
415 (void) CopyMagickString( boundingArea, string(boundingArea_).c_str(),
418 drawInfo->geometry = boundingArea;
421 drawInfo->gravity = gravity_;
423 AffineMatrix oaffine = drawInfo->affine;
424 if ( degrees_ != 0.0)
434 AffineMatrix current = drawInfo->affine;
435 affine.sx=cos(DegreesToRadians(fmod(degrees_,360.0)));
436 affine.rx=sin(DegreesToRadians(fmod(degrees_,360.0)));
437 affine.ry=(-sin(DegreesToRadians(fmod(degrees_,360.0))));
438 affine.sy=cos(DegreesToRadians(fmod(degrees_,360.0)));
440 drawInfo->affine.sx=current.sx*affine.sx+current.ry*affine.rx;
441 drawInfo->affine.rx=current.rx*affine.sx+current.sy*affine.rx;
442 drawInfo->affine.ry=current.sx*affine.ry+current.ry*affine.sy;
443 drawInfo->affine.sy=current.rx*affine.ry+current.sy*affine.sy;
444 drawInfo->affine.tx=current.sx*affine.tx+current.ry*affine.ty
448 ExceptionInfo exceptionInfo;
449 GetExceptionInfo( &exceptionInfo );
450 AnnotateImage( image(), drawInfo, &exceptionInfo );
452 // Restore original values
453 drawInfo->affine = oaffine;
455 drawInfo->geometry = 0;
457 throwException( exceptionInfo );
458 (void) DestroyExceptionInfo( &exceptionInfo );
460 // Annotate with text (bounding area is entire image) and placement gravity.
461 void Magick::Image::annotate ( const std::string &text_,
462 const GravityType gravity_ )
467 = options()->drawInfo();
469 drawInfo->text = const_cast<char *>(text_.c_str());
471 drawInfo->gravity = gravity_;
473 ExceptionInfo exceptionInfo;
474 GetExceptionInfo( &exceptionInfo );
475 AnnotateImage( image(), drawInfo, &exceptionInfo );
477 drawInfo->gravity = NorthWestGravity;
480 throwException( exceptionInfo );
481 (void) DestroyExceptionInfo( &exceptionInfo );
485 void Magick::Image::blur( const double radius_, const double sigma_ )
487 ExceptionInfo exceptionInfo;
488 GetExceptionInfo( &exceptionInfo );
489 MagickCore::Image* newImage =
490 BlurImage( image(), radius_, sigma_, &exceptionInfo);
491 replaceImage( newImage );
492 throwException( exceptionInfo );
493 (void) DestroyExceptionInfo( &exceptionInfo );
496 void Magick::Image::blurChannel( const ChannelType channel_,
497 const double radius_, const double sigma_ )
499 ExceptionInfo exceptionInfo;
500 GetExceptionInfo( &exceptionInfo );
501 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
502 MagickCore::Image* newImage =
503 BlurImage( image(), radius_, sigma_, &exceptionInfo);
504 (void) SetPixelChannelMapMask( image(), channel_mask );
505 replaceImage( newImage );
506 throwException( exceptionInfo );
507 (void) DestroyExceptionInfo( &exceptionInfo );
510 // Add border to image
511 // Only uses width & height
512 void Magick::Image::border( const Geometry &geometry_ )
514 RectangleInfo borderInfo = geometry_;
515 ExceptionInfo exceptionInfo;
516 GetExceptionInfo( &exceptionInfo );
517 MagickCore::Image* newImage =
518 BorderImage( image(), &borderInfo, image()->compose, &exceptionInfo);
519 replaceImage( newImage );
520 throwException( exceptionInfo );
521 (void) DestroyExceptionInfo( &exceptionInfo );
524 // Extract channel from image
525 void Magick::Image::channel ( const ChannelType channel_ )
528 ExceptionInfo exceptionInfo;
529 GetExceptionInfo( &exceptionInfo );
530 MagickCore::Image* newImage =
531 SeparateImage( image(), channel_, &exceptionInfo);
532 replaceImage( newImage );
533 throwException( exceptionInfo );
534 (void) DestroyExceptionInfo( &exceptionInfo );
537 // Set or obtain modulus channel depth
538 void Magick::Image::channelDepth ( const size_t depth_ )
541 ExceptionInfo exceptionInfo;
542 GetExceptionInfo( &exceptionInfo );
543 SetImageDepth( image(), depth_, &exceptionInfo);
544 throwException( exceptionInfo );
545 (void) DestroyExceptionInfo( &exceptionInfo );
547 size_t Magick::Image::channelDepth ( )
549 size_t channel_depth;
551 ExceptionInfo exceptionInfo;
552 GetExceptionInfo( &exceptionInfo );
553 channel_depth=GetImageDepth( constImage(), &exceptionInfo );
554 throwException( exceptionInfo );
555 (void) DestroyExceptionInfo( &exceptionInfo );
556 return channel_depth;
560 // Charcoal-effect image
561 void Magick::Image::charcoal( const double radius_, const double sigma_ )
563 ExceptionInfo exceptionInfo;
564 GetExceptionInfo( &exceptionInfo );
565 MagickCore::Image* newImage =
566 CharcoalImage( image(), radius_, sigma_, &exceptionInfo );
567 replaceImage( newImage );
568 throwException( exceptionInfo );
569 (void) DestroyExceptionInfo( &exceptionInfo );
573 void Magick::Image::chop( const Geometry &geometry_ )
575 RectangleInfo chopInfo = geometry_;
576 ExceptionInfo exceptionInfo;
577 GetExceptionInfo( &exceptionInfo );
578 MagickCore::Image* newImage =
579 ChopImage( image(), &chopInfo, &exceptionInfo);
580 replaceImage( newImage );
581 throwException( exceptionInfo );
582 (void) DestroyExceptionInfo( &exceptionInfo );
585 // contains one or more color corrections and applies the correction to the
587 void Magick::Image::cdl ( const std::string &cdl_ )
590 ExceptionInfo exceptionInfo;
591 GetExceptionInfo( &exceptionInfo );
592 (void) ColorDecisionListImage( image(), cdl_.c_str(), &exceptionInfo );
593 throwException( exceptionInfo );
594 (void) DestroyExceptionInfo( &exceptionInfo );
598 void Magick::Image::colorize ( const unsigned int alphaRed_,
599 const unsigned int alphaGreen_,
600 const unsigned int alphaBlue_,
601 const Color &penColor_ )
603 if ( !penColor_.isValid() )
605 throwExceptionExplicit( OptionError,
606 "Pen color argument is invalid");
609 char blend[MaxTextExtent];
610 FormatLocaleString(blend,MaxTextExtent,"%u/%u/%u",alphaRed_,alphaGreen_,alphaBlue_);
612 ExceptionInfo exceptionInfo;
613 GetExceptionInfo( &exceptionInfo );
615 GetPixelInfo(image(),&target);
616 PixelInfo pixel=static_cast<PixelInfo>(penColor_);
617 target.red=pixel.red;
618 target.green=pixel.green;
619 target.blue=pixel.blue;
620 target.alpha=pixel.alpha;
621 MagickCore::Image* newImage =
622 ColorizeImage ( image(), blend, &target, &exceptionInfo );
623 replaceImage( newImage );
624 throwException( exceptionInfo );
625 (void) DestroyExceptionInfo( &exceptionInfo );
627 void Magick::Image::colorize ( const unsigned int alpha_,
628 const Color &penColor_ )
630 colorize( alpha_, alpha_, alpha_, penColor_ );
633 // Apply a color matrix to the image channels. The user supplied
634 // matrix may be of order 1 to 6 (1x1 through 6x6).
635 void Magick::Image::colorMatrix (const size_t order_,
636 const double *color_matrix_)
641 ExceptionInfo exceptionInfo;
642 GetExceptionInfo( &exceptionInfo );
643 kernel_info=AcquireKernelInfo((const char *) NULL);
644 kernel_info->width=order_;
645 kernel_info->height=order_;
646 kernel_info->values=(double *) color_matrix_;
647 MagickCore::Image* newImage =
648 ColorMatrixImage( image(), kernel_info, &exceptionInfo );
649 kernel_info->values=(double *) NULL;
650 kernel_info=DestroyKernelInfo(kernel_info);
651 replaceImage( newImage );
652 throwException( exceptionInfo );
653 (void) DestroyExceptionInfo( &exceptionInfo );
656 // Compare current image with another image
657 // Sets meanErrorPerPixel, normalizedMaxError, and normalizedMeanError
658 // in the current image. False is returned if the images are identical.
659 bool Magick::Image::compare ( const Image &reference_ )
661 ExceptionInfo exceptionInfo;
662 GetExceptionInfo( &exceptionInfo );
664 Image ref = reference_;
667 static_cast<bool>(IsImagesEqual(image(), ref.image(), &exceptionInfo));
668 throwException( exceptionInfo );
669 (void) DestroyExceptionInfo( &exceptionInfo );
673 // Composite two images
674 void Magick::Image::composite ( const Image &compositeImage_,
675 const ssize_t xOffset_,
676 const ssize_t yOffset_,
677 const CompositeOperator compose_ )
679 // Image supplied as compositeImage is composited with current image and
680 // results in updating current image.
683 ExceptionInfo exceptionInfo;
684 GetExceptionInfo( &exceptionInfo );
685 CompositeImage( image(),
686 compositeImage_.constImage(),
687 compose_, MagickFalse,
689 yOffset_, &exceptionInfo );
690 throwException( exceptionInfo );
691 (void) DestroyExceptionInfo( &exceptionInfo );
693 void Magick::Image::composite ( const Image &compositeImage_,
694 const Geometry &offset_,
695 const CompositeOperator compose_ )
699 ssize_t x = offset_.xOff();
700 ssize_t y = offset_.yOff();
701 size_t width = columns();
702 size_t height = rows();
704 ParseMetaGeometry (static_cast<std::string>(offset_).c_str(),
708 ExceptionInfo exceptionInfo;
709 GetExceptionInfo( &exceptionInfo );
710 CompositeImage( image(),
711 compositeImage_.constImage(),
712 compose_, MagickFalse,
713 x, y, &exceptionInfo );
714 throwException( exceptionInfo );
715 (void) DestroyExceptionInfo( &exceptionInfo );
717 void Magick::Image::composite ( const Image &compositeImage_,
718 const GravityType gravity_,
719 const CompositeOperator compose_ )
723 RectangleInfo geometry;
725 SetGeometry(compositeImage_.constImage(), &geometry);
726 GravityAdjustGeometry(columns(), rows(), gravity_, &geometry);
728 ExceptionInfo exceptionInfo;
729 GetExceptionInfo( &exceptionInfo );
730 CompositeImage( image(),
731 compositeImage_.constImage(),
732 compose_, MagickFalse,
733 geometry.x, geometry.y, &exceptionInfo );
734 throwException( exceptionInfo );
735 (void) DestroyExceptionInfo( &exceptionInfo );
739 void Magick::Image::contrast ( const size_t sharpen_ )
742 ExceptionInfo exceptionInfo;
743 GetExceptionInfo( &exceptionInfo );
744 ContrastImage ( image(), (MagickBooleanType) sharpen_, &exceptionInfo );
745 throwException( exceptionInfo );
746 (void) DestroyExceptionInfo( &exceptionInfo );
749 // Convolve image. Applies a general image convolution kernel to the image.
750 // order_ represents the number of columns and rows in the filter kernel.
751 // kernel_ is an array of doubles representing the convolution kernel.
752 void Magick::Image::convolve ( const size_t order_,
753 const double *kernel_ )
758 ExceptionInfo exceptionInfo;
759 GetExceptionInfo( &exceptionInfo );
760 kernel_info=AcquireKernelInfo((const char *) NULL);
761 kernel_info->width=order_;
762 kernel_info->height=order_;
763 kernel_info->values=(MagickRealType *) kernel_;
764 MagickCore::Image* newImage =
765 ConvolveImage ( image(), kernel_info, &exceptionInfo );
766 kernel_info->values=(MagickRealType *) NULL;
767 kernel_info=DestroyKernelInfo(kernel_info);
768 replaceImage( newImage );
769 throwException( exceptionInfo );
770 (void) DestroyExceptionInfo( &exceptionInfo );
774 void Magick::Image::crop ( const Geometry &geometry_ )
776 RectangleInfo cropInfo = geometry_;
777 ExceptionInfo exceptionInfo;
778 GetExceptionInfo( &exceptionInfo );
779 MagickCore::Image* newImage =
783 replaceImage( newImage );
784 throwException( exceptionInfo );
785 (void) DestroyExceptionInfo( &exceptionInfo );
789 void Magick::Image::cycleColormap ( const ssize_t amount_ )
791 ExceptionInfo exceptionInfo;
792 GetExceptionInfo( &exceptionInfo );
794 CycleColormapImage( image(), amount_, &exceptionInfo );
795 throwException( exceptionInfo );
796 (void) DestroyExceptionInfo( &exceptionInfo );
800 void Magick::Image::despeckle ( void )
802 ExceptionInfo exceptionInfo;
803 GetExceptionInfo( &exceptionInfo );
804 MagickCore::Image* newImage =
805 DespeckleImage( image(), &exceptionInfo );
806 replaceImage( newImage );
807 throwException( exceptionInfo );
808 (void) DestroyExceptionInfo( &exceptionInfo );
812 void Magick::Image::display( void )
814 ExceptionInfo exceptionInfo;
815 GetExceptionInfo( &exceptionInfo );
816 DisplayImages( imageInfo(), image(), &exceptionInfo );
817 throwException( exceptionInfo );
818 (void) DestroyExceptionInfo( &exceptionInfo );
821 // Distort image. distorts an image using various distortion methods, by
822 // mapping color lookups of the source image to a new destination image
823 // usally of the same size as the source image, unless 'bestfit' is set to
825 void Magick::Image::distort ( const DistortImageMethod method_,
826 const size_t number_arguments_,
827 const double *arguments_,
828 const bool bestfit_ )
830 ExceptionInfo exceptionInfo;
831 GetExceptionInfo( &exceptionInfo );
832 MagickCore::Image* newImage = DistortImage ( image(), method_,
833 number_arguments_, arguments_, bestfit_ == true ? MagickTrue : MagickFalse,
835 replaceImage( newImage );
836 throwException( exceptionInfo );
837 (void) DestroyExceptionInfo( &exceptionInfo );
840 // Draw on image using single drawable
841 void Magick::Image::draw ( const Magick::Drawable &drawable_ )
845 DrawingWand *wand = DrawAllocateWand( options()->drawInfo(), image());
849 drawable_.operator()(wand);
853 wand=DestroyDrawingWand(wand);
856 throwImageException();
859 // Draw on image using a drawable list
860 void Magick::Image::draw ( const std::list<Magick::Drawable> &drawable_ )
864 DrawingWand *wand = DrawAllocateWand( options()->drawInfo(), image());
868 for( std::list<Magick::Drawable>::const_iterator p = drawable_.begin();
869 p != drawable_.end(); p++ )
876 wand=DestroyDrawingWand(wand);
879 throwImageException();
882 // Hilight edges in image
883 void Magick::Image::edge ( const double radius_, const double sigma_ )
885 ExceptionInfo exceptionInfo;
886 GetExceptionInfo( &exceptionInfo );
887 MagickCore::Image* newImage =
888 EdgeImage( image(), radius_, sigma_, &exceptionInfo );
889 replaceImage( newImage );
890 throwException( exceptionInfo );
891 (void) DestroyExceptionInfo( &exceptionInfo );
894 // Emboss image (hilight edges)
895 void Magick::Image::emboss ( const double radius_, const double sigma_ )
897 ExceptionInfo exceptionInfo;
898 GetExceptionInfo( &exceptionInfo );
899 MagickCore::Image* newImage =
900 EmbossImage( image(), radius_, sigma_, &exceptionInfo );
901 replaceImage( newImage );
902 throwException( exceptionInfo );
903 (void) DestroyExceptionInfo( &exceptionInfo );
906 // Enhance image (minimize noise)
907 void Magick::Image::enhance ( void )
909 ExceptionInfo exceptionInfo;
910 GetExceptionInfo( &exceptionInfo );
911 MagickCore::Image* newImage =
912 EnhanceImage( image(), &exceptionInfo );
913 replaceImage( newImage );
914 throwException( exceptionInfo );
915 (void) DestroyExceptionInfo( &exceptionInfo );
918 // Equalize image (histogram equalization)
919 void Magick::Image::equalize ( void )
921 ExceptionInfo exceptionInfo;
922 GetExceptionInfo( &exceptionInfo );
924 EqualizeImage( image(), &exceptionInfo );
925 throwException( exceptionInfo );
926 (void) DestroyExceptionInfo( &exceptionInfo );
929 // Erase image to current "background color"
930 void Magick::Image::erase ( void )
933 ExceptionInfo exceptionInfo;
934 GetExceptionInfo( &exceptionInfo );
935 SetImageBackgroundColor( image(), &exceptionInfo );
936 throwException( exceptionInfo );
937 (void) DestroyExceptionInfo( &exceptionInfo );
940 // Extends image as defined by the geometry.
942 void Magick::Image::extent ( const Geometry &geometry_ )
944 RectangleInfo extentInfo = geometry_;
946 ExceptionInfo exceptionInfo;
947 GetExceptionInfo( &exceptionInfo );
948 MagickCore::Image* newImage =
949 ExtentImage ( image(), &extentInfo, &exceptionInfo );
950 replaceImage( newImage );
951 throwException( exceptionInfo );
952 (void) DestroyExceptionInfo( &exceptionInfo );
954 void Magick::Image::extent ( const Geometry &geometry_, const Color &backgroundColor_ )
956 backgroundColor ( backgroundColor_ );
957 extent ( geometry_ );
959 void Magick::Image::extent ( const Geometry &geometry_, const GravityType gravity_ )
961 image()->gravity = gravity_;
962 extent ( geometry_ );
964 void Magick::Image::extent ( const Geometry &geometry_, const Color &backgroundColor_, const GravityType gravity_ )
966 image()->gravity = gravity_;
967 backgroundColor ( backgroundColor_ );
968 extent ( geometry_ );
971 // Flip image (reflect each scanline in the vertical direction)
972 void Magick::Image::flip ( void )
974 ExceptionInfo exceptionInfo;
975 GetExceptionInfo( &exceptionInfo );
976 MagickCore::Image* newImage =
977 FlipImage( image(), &exceptionInfo );
978 replaceImage( newImage );
979 throwException( exceptionInfo );
980 (void) DestroyExceptionInfo( &exceptionInfo );
983 // Flood-fill color across pixels that match the color of the
984 // target pixel and are neighbors of the target pixel.
985 // Uses current fuzz setting when determining color match.
986 void Magick::Image::floodFillColor( const ssize_t x_,
988 const Magick::Color &fillColor_ )
990 floodFillTexture( x_, y_, Image( Geometry( 1, 1), fillColor_ ) );
992 void Magick::Image::floodFillColor( const Geometry &point_,
993 const Magick::Color &fillColor_ )
995 floodFillTexture( point_, Image( Geometry( 1, 1), fillColor_) );
998 // Flood-fill color across pixels starting at target-pixel and
999 // stopping at pixels matching specified border color.
1000 // Uses current fuzz setting when determining color match.
1001 void Magick::Image::floodFillColor( const ssize_t x_,
1003 const Magick::Color &fillColor_,
1004 const Magick::Color &borderColor_ )
1006 floodFillTexture( x_, y_, Image( Geometry( 1, 1), fillColor_),
1009 void Magick::Image::floodFillColor( const Geometry &point_,
1010 const Magick::Color &fillColor_,
1011 const Magick::Color &borderColor_ )
1013 floodFillTexture( point_, Image( Geometry( 1, 1), fillColor_),
1017 // Floodfill pixels matching color (within fuzz factor) of target
1018 // pixel(x,y) with replacement alpha value using method.
1019 void Magick::Image::floodFillAlpha( const ssize_t x_,
1021 const unsigned int alpha_,
1022 const PaintMethod method_ )
1026 GetPixelInfo(image(),&target);
1027 PixelInfo pixel=static_cast<PixelInfo>(pixelColor(x_,y_));
1028 target.red=pixel.red;
1029 target.green=pixel.green;
1030 target.blue=pixel.blue;
1031 target.alpha=alpha_;
1032 ExceptionInfo exceptionInfo;
1033 GetExceptionInfo( &exceptionInfo );
1034 FloodfillPaintImage ( image(),
1035 options()->drawInfo(), // const DrawInfo *draw_info
1037 static_cast<ssize_t>(x_), static_cast<ssize_t>(y_),
1038 method_ == FloodfillMethod ? MagickFalse : MagickTrue,
1040 throwException( exceptionInfo );
1041 (void) DestroyExceptionInfo( &exceptionInfo );
1044 // Flood-fill texture across pixels that match the color of the
1045 // target pixel and are neighbors of the target pixel.
1046 // Uses current fuzz setting when determining color match.
1047 void Magick::Image::floodFillTexture( const ssize_t x_,
1049 const Magick::Image &texture_ )
1053 // Set drawing pattern
1054 options()->fillPattern(texture_.constImage());
1057 Pixels pixels(*this);
1059 Quantum *p = pixels.get(x_, y_, 1, 1 );
1061 GetPixelInfo(constImage(),&target);
1062 target.red=GetPixelRed(constImage(),p);
1063 target.green=GetPixelGreen(constImage(),p);
1064 target.blue=GetPixelBlue(constImage(),p);
1065 ExceptionInfo exceptionInfo;
1066 GetExceptionInfo( &exceptionInfo );
1068 FloodfillPaintImage ( image(), // Image *image
1069 options()->drawInfo(), // const DrawInfo *draw_info
1070 &target, // const MagickPacket target
1071 static_cast<ssize_t>(x_), // const ssize_t x_offset
1072 static_cast<ssize_t>(y_), // const ssize_t y_offset
1073 MagickFalse, // const PaintMethod method
1075 throwException( exceptionInfo );
1076 (void) DestroyExceptionInfo( &exceptionInfo );
1079 void Magick::Image::floodFillTexture( const Magick::Geometry &point_,
1080 const Magick::Image &texture_ )
1082 floodFillTexture( point_.xOff(), point_.yOff(), texture_ );
1085 // Flood-fill texture across pixels starting at target-pixel and
1086 // stopping at pixels matching specified border color.
1087 // Uses current fuzz setting when determining color match.
1088 void Magick::Image::floodFillTexture( const ssize_t x_,
1090 const Magick::Image &texture_,
1091 const Magick::Color &borderColor_ )
1095 // Set drawing fill pattern
1096 options()->fillPattern(texture_.constImage());
1099 GetPixelInfo(constImage(),&target);
1100 target.red=static_cast<PixelInfo>(borderColor_).red;
1101 target.green=static_cast<PixelInfo>(borderColor_).green;
1102 target.blue=static_cast<PixelInfo>(borderColor_).blue;
1103 ExceptionInfo exceptionInfo;
1104 GetExceptionInfo( &exceptionInfo );
1105 FloodfillPaintImage ( image(),
1106 options()->drawInfo(),
1108 static_cast<ssize_t>(x_),
1109 static_cast<ssize_t>(y_),
1110 MagickTrue, &exceptionInfo);
1112 throwException( exceptionInfo );
1113 (void) DestroyExceptionInfo( &exceptionInfo );
1115 void Magick::Image::floodFillTexture( const Magick::Geometry &point_,
1116 const Magick::Image &texture_,
1117 const Magick::Color &borderColor_ )
1119 floodFillTexture( point_.xOff(), point_.yOff(), texture_, borderColor_ );
1122 // Flop image (reflect each scanline in the horizontal direction)
1123 void Magick::Image::flop ( void )
1125 ExceptionInfo exceptionInfo;
1126 GetExceptionInfo( &exceptionInfo );
1127 MagickCore::Image* newImage =
1128 FlopImage( image(), &exceptionInfo );
1129 replaceImage( newImage );
1130 throwException( exceptionInfo );
1131 (void) DestroyExceptionInfo( &exceptionInfo );
1135 void Magick::Image::frame ( const Geometry &geometry_ )
1139 info.x = static_cast<ssize_t>(geometry_.width());
1140 info.y = static_cast<ssize_t>(geometry_.height());
1141 info.width = columns() + ( static_cast<size_t>(info.x) << 1 );
1142 info.height = rows() + ( static_cast<size_t>(info.y) << 1 );
1143 info.outer_bevel = geometry_.xOff();
1144 info.inner_bevel = geometry_.yOff();
1146 ExceptionInfo exceptionInfo;
1147 GetExceptionInfo( &exceptionInfo );
1148 MagickCore::Image* newImage =
1149 FrameImage( image(), &info, image()->compose, &exceptionInfo );
1150 replaceImage( newImage );
1151 throwException( exceptionInfo );
1152 (void) DestroyExceptionInfo( &exceptionInfo );
1154 void Magick::Image::frame ( const size_t width_,
1155 const size_t height_,
1156 const ssize_t outerBevel_, const ssize_t innerBevel_ )
1159 info.x = static_cast<ssize_t>(width_);
1160 info.y = static_cast<ssize_t>(height_);
1161 info.width = columns() + ( static_cast<size_t>(info.x) << 1 );
1162 info.height = rows() + ( static_cast<size_t>(info.y) << 1 );
1163 info.outer_bevel = static_cast<ssize_t>(outerBevel_);
1164 info.inner_bevel = static_cast<ssize_t>(innerBevel_);
1166 ExceptionInfo exceptionInfo;
1167 GetExceptionInfo( &exceptionInfo );
1168 MagickCore::Image* newImage =
1169 FrameImage( image(), &info, image()->compose, &exceptionInfo );
1170 replaceImage( newImage );
1171 throwException( exceptionInfo );
1172 (void) DestroyExceptionInfo( &exceptionInfo );
1175 // Fx image. Applies a mathematical expression to the image.
1176 void Magick::Image::fx ( const std::string expression )
1178 ExceptionInfo exceptionInfo;
1179 GetExceptionInfo( &exceptionInfo );
1180 MagickCore::Image* newImage =
1181 FxImage ( image(), expression.c_str(), &exceptionInfo );
1182 replaceImage( newImage );
1183 throwException( exceptionInfo );
1184 (void) DestroyExceptionInfo( &exceptionInfo );
1186 void Magick::Image::fx ( const std::string expression,
1187 const Magick::ChannelType channel )
1189 ExceptionInfo exceptionInfo;
1190 GetExceptionInfo( &exceptionInfo );
1191 ChannelType channel_mask = SetPixelChannelMask( image(), channel );
1192 MagickCore::Image* newImage =
1193 FxImage ( image(), expression.c_str(), &exceptionInfo );
1194 (void) SetPixelChannelMapMask( image(), channel_mask );
1195 replaceImage( newImage );
1196 throwException( exceptionInfo );
1197 (void) DestroyExceptionInfo( &exceptionInfo );
1200 // Gamma correct image
1201 void Magick::Image::gamma ( const double gamma_ )
1203 ExceptionInfo exceptionInfo;
1204 GetExceptionInfo( &exceptionInfo );
1206 GammaImage ( image(), gamma_, &exceptionInfo );
1207 throwException( exceptionInfo );
1208 (void) DestroyExceptionInfo( &exceptionInfo );
1211 void Magick::Image::gamma ( const double gammaRed_,
1212 const double gammaGreen_,
1213 const double gammaBlue_ )
1215 char gamma[MaxTextExtent + 1];
1216 FormatLocaleString( gamma, MaxTextExtent, "%3.6f/%3.6f/%3.6f/",
1217 gammaRed_, gammaGreen_, gammaBlue_);
1219 ExceptionInfo exceptionInfo;
1220 GetExceptionInfo( &exceptionInfo );
1222 GammaImage ( image(), atof(gamma), &exceptionInfo );
1223 throwException( exceptionInfo );
1224 (void) DestroyExceptionInfo( &exceptionInfo );
1227 // Gaussian blur image
1228 // The number of neighbor pixels to be included in the convolution
1229 // mask is specified by 'width_'. The standard deviation of the
1230 // gaussian bell curve is specified by 'sigma_'.
1231 void Magick::Image::gaussianBlur ( const double width_, const double sigma_ )
1233 ExceptionInfo exceptionInfo;
1234 GetExceptionInfo( &exceptionInfo );
1235 MagickCore::Image* newImage =
1236 GaussianBlurImage( image(), width_, sigma_, &exceptionInfo );
1237 replaceImage( newImage );
1238 throwException( exceptionInfo );
1239 (void) DestroyExceptionInfo( &exceptionInfo );
1242 void Magick::Image::gaussianBlurChannel ( const ChannelType channel_,
1243 const double width_,
1244 const double sigma_ )
1246 ExceptionInfo exceptionInfo;
1247 GetExceptionInfo( &exceptionInfo );
1248 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1249 MagickCore::Image* newImage =
1250 GaussianBlurImage( image(), width_, sigma_, &exceptionInfo );
1251 (void) SetPixelChannelMapMask( image(), channel_mask );
1252 replaceImage( newImage );
1253 throwException( exceptionInfo );
1254 (void) DestroyExceptionInfo( &exceptionInfo );
1257 // Apply a color lookup table (Hald CLUT) to the image.
1258 void Magick::Image::haldClut ( const Image &clutImage_ )
1260 ExceptionInfo exceptionInfo;
1261 GetExceptionInfo( &exceptionInfo );
1263 (void) HaldClutImage( image(), clutImage_.constImage(), &exceptionInfo );
1264 throwException( exceptionInfo );
1265 (void) DestroyExceptionInfo( &exceptionInfo );
1269 void Magick::Image::implode ( const double factor_ )
1271 ExceptionInfo exceptionInfo;
1272 GetExceptionInfo( &exceptionInfo );
1273 MagickCore::Image* newImage =
1274 ImplodeImage( image(), factor_, image()->interpolate, &exceptionInfo );
1275 replaceImage( newImage );
1276 throwException( exceptionInfo );
1277 (void) DestroyExceptionInfo( &exceptionInfo );
1280 // implements the inverse discrete Fourier transform (IFT) of the image either
1281 // as a magnitude / phase or real / imaginary image pair.
1282 void Magick::Image::inverseFourierTransform ( const Image &phase_ )
1284 ExceptionInfo exceptionInfo;
1285 GetExceptionInfo( &exceptionInfo );
1286 MagickCore::Image* newImage = InverseFourierTransformImage( image(),
1287 phase_.constImage(), MagickTrue, &exceptionInfo);
1288 replaceImage( newImage );
1289 throwException( exceptionInfo );
1290 (void) DestroyExceptionInfo( &exceptionInfo );
1292 void Magick::Image::inverseFourierTransform ( const Image &phase_,
1293 const bool magnitude_ )
1295 ExceptionInfo exceptionInfo;
1296 GetExceptionInfo( &exceptionInfo );
1297 MagickCore::Image* newImage = InverseFourierTransformImage( image(),
1298 phase_.constImage(), magnitude_ == true ? MagickTrue : MagickFalse,
1300 replaceImage( newImage );
1301 throwException( exceptionInfo );
1302 (void) DestroyExceptionInfo( &exceptionInfo );
1305 // Level image. Adjust the levels of the image by scaling the colors
1306 // falling between specified white and black points to the full
1307 // available quantum range. The parameters provided represent the
1308 // black, mid (gamma), and white points. The black point specifies
1309 // the darkest color in the image. Colors darker than the black point
1310 // are set to zero. Mid point (gamma) specifies a gamma correction to
1311 // apply to the image. White point specifies the lightest color in the
1312 // image. Colors brighter than the white point are set to the maximum
1313 // quantum value. The black and white point have the valid range 0 to
1314 // QuantumRange while gamma has a useful range of 0 to ten.
1315 void Magick::Image::level ( const double black_point,
1316 const double white_point,
1317 const double gamma )
1319 ExceptionInfo exceptionInfo;
1320 GetExceptionInfo( &exceptionInfo );
1322 (void) LevelImage( image(), black_point, white_point, gamma, &exceptionInfo );
1323 throwException( exceptionInfo );
1324 (void) DestroyExceptionInfo( &exceptionInfo );
1327 // Magnify image by integral size
1328 void Magick::Image::magnify ( void )
1330 ExceptionInfo exceptionInfo;
1331 GetExceptionInfo( &exceptionInfo );
1332 MagickCore::Image* newImage =
1333 MagnifyImage( image(), &exceptionInfo );
1334 replaceImage( newImage );
1335 throwException( exceptionInfo );
1336 (void) DestroyExceptionInfo( &exceptionInfo );
1339 // Remap image colors with closest color from reference image
1340 void Magick::Image::map ( const Image &mapImage_ , const bool dither_ )
1342 ExceptionInfo exceptionInfo;
1343 GetExceptionInfo( &exceptionInfo );
1345 options()->quantizeDither( dither_ );
1346 RemapImage ( options()->quantizeInfo(), image(),
1347 mapImage_.constImage(), &exceptionInfo);
1348 throwException( exceptionInfo );
1349 (void) DestroyExceptionInfo( &exceptionInfo );
1351 // Floodfill designated area with replacement alpha value
1352 void Magick::Image::matteFloodfill ( const Color &target_ ,
1353 const unsigned int alpha_,
1354 const ssize_t x_, const ssize_t y_,
1355 const Magick::PaintMethod method_ )
1359 GetPixelInfo(constImage(),&target);
1360 target.red=static_cast<PixelInfo>(target_).red;
1361 target.green=static_cast<PixelInfo>(target_).green;
1362 target.blue=static_cast<PixelInfo>(target_).blue;
1363 target.alpha=alpha_;
1364 ChannelType channel_mask = SetPixelChannelMask( image(), AlphaChannel );
1365 ExceptionInfo exceptionInfo;
1366 GetExceptionInfo( &exceptionInfo );
1367 FloodfillPaintImage ( image(), options()->drawInfo(), &target, x_, y_,
1368 method_ == FloodfillMethod ? MagickFalse : MagickTrue, &exceptionInfo);
1369 (void) SetPixelChannelMapMask( image(), channel_mask );
1370 throwException( exceptionInfo );
1371 (void) DestroyExceptionInfo( &exceptionInfo );
1374 // Filter image by replacing each pixel component with the median
1375 // color in a circular neighborhood
1376 void Magick::Image::medianFilter ( const double radius_ )
1378 ExceptionInfo exceptionInfo;
1379 GetExceptionInfo( &exceptionInfo );
1380 MagickCore::Image* newImage =
1381 StatisticImage ( image(), MedianStatistic, (size_t) radius_, (size_t)
1382 radius_,&exceptionInfo );
1383 replaceImage( newImage );
1384 throwException( exceptionInfo );
1385 (void) DestroyExceptionInfo( &exceptionInfo );
1388 // Reduce image by integral size
1389 void Magick::Image::minify ( void )
1391 ExceptionInfo exceptionInfo;
1392 GetExceptionInfo( &exceptionInfo );
1393 MagickCore::Image* newImage =
1394 MinifyImage( image(), &exceptionInfo );
1395 replaceImage( newImage );
1396 throwException( exceptionInfo );
1397 (void) DestroyExceptionInfo( &exceptionInfo );
1400 // Modulate percent hue, saturation, and brightness of an image
1401 void Magick::Image::modulate ( const double brightness_,
1402 const double saturation_,
1405 char modulate[MaxTextExtent + 1];
1406 FormatLocaleString( modulate, MaxTextExtent, "%3.6f,%3.6f,%3.6f",
1407 brightness_, saturation_, hue_);
1409 ExceptionInfo exceptionInfo;
1410 GetExceptionInfo( &exceptionInfo );
1412 ModulateImage( image(), modulate, &exceptionInfo );
1413 throwException( exceptionInfo );
1414 (void) DestroyExceptionInfo( &exceptionInfo );
1417 // Motion blur image with specified blur factor
1418 // The radius_ parameter specifies the radius of the Gaussian, in
1419 // pixels, not counting the center pixel. The sigma_ parameter
1420 // specifies the standard deviation of the Laplacian, in pixels.
1421 // The angle_ parameter specifies the angle the object appears
1422 // to be comming from (zero degrees is from the right).
1423 void Magick::Image::motionBlur ( const double radius_,
1424 const double sigma_,
1425 const double angle_ )
1427 ExceptionInfo exceptionInfo;
1428 GetExceptionInfo( &exceptionInfo );
1429 MagickCore::Image* newImage =
1430 MotionBlurImage( image(), radius_, sigma_, angle_, &exceptionInfo);
1431 replaceImage( newImage );
1432 throwException( exceptionInfo );
1433 (void) DestroyExceptionInfo( &exceptionInfo );
1436 // Negate image. Set grayscale_ to true to effect grayscale values
1438 void Magick::Image::negate ( const bool grayscale_ )
1440 ExceptionInfo exceptionInfo;
1441 GetExceptionInfo( &exceptionInfo );
1443 NegateImage ( image(), grayscale_ == true ? MagickTrue : MagickFalse,
1445 throwException( exceptionInfo );
1446 (void) DestroyExceptionInfo( &exceptionInfo );
1450 void Magick::Image::normalize ( void )
1453 ExceptionInfo exceptionInfo;
1454 GetExceptionInfo( &exceptionInfo );
1455 NormalizeImage ( image(), &exceptionInfo );
1456 throwException( exceptionInfo );
1457 (void) DestroyExceptionInfo( &exceptionInfo );
1461 void Magick::Image::oilPaint ( const double radius_, const double sigma_ )
1463 ExceptionInfo exceptionInfo;
1464 GetExceptionInfo( &exceptionInfo );
1465 MagickCore::Image* newImage =
1466 OilPaintImage( image(), radius_, sigma_, &exceptionInfo );
1467 replaceImage( newImage );
1468 throwException( exceptionInfo );
1469 (void) DestroyExceptionInfo( &exceptionInfo );
1472 // Set or attenuate the alpha channel. If the image pixels are
1473 // opaque then they are set to the specified alpha value, otherwise
1474 // they are blended with the supplied alpha value. The value of
1475 // alpha_ ranges from 0 (completely opaque) to QuantumRange. The defines
1476 // OpaqueAlpha and TransparentAlpha are available to specify
1477 // completely opaque or completely transparent, respectively.
1478 void Magick::Image::alpha ( const unsigned int alpha_ )
1481 ExceptionInfo exceptionInfo;
1482 GetExceptionInfo( &exceptionInfo );
1483 SetImageAlpha( image(), alpha_, &exceptionInfo );
1484 throwException( exceptionInfo );
1485 (void) DestroyExceptionInfo( &exceptionInfo );
1488 // Change the color of an opaque pixel to the pen color.
1489 void Magick::Image::opaque ( const Color &opaqueColor_,
1490 const Color &penColor_ )
1492 if ( !opaqueColor_.isValid() )
1494 throwExceptionExplicit( OptionError,
1495 "Opaque color argument is invalid" );
1497 if ( !penColor_.isValid() )
1499 throwExceptionExplicit( OptionError,
1500 "Pen color argument is invalid" );
1504 std::string opaqueColor = opaqueColor_;
1505 std::string penColor = penColor_;
1509 ExceptionInfo exceptionInfo;
1510 GetExceptionInfo( &exceptionInfo );
1511 (void) QueryColorCompliance(std::string(opaqueColor_).c_str(),
1512 AllCompliance, &opaque, &exceptionInfo);
1513 (void) QueryColorCompliance(std::string(penColor_).c_str(),
1514 AllCompliance, &pen, &exceptionInfo);
1515 OpaquePaintImage ( image(), &opaque, &pen, MagickFalse, &exceptionInfo );
1516 throwException( exceptionInfo );
1517 (void) DestroyExceptionInfo( &exceptionInfo );
1520 // Ping is similar to read except only enough of the image is read to
1521 // determine the image columns, rows, and filesize. Access the
1522 // columns(), rows(), and fileSize() attributes after invoking ping.
1523 // The image data is not valid after calling ping.
1524 void Magick::Image::ping ( const std::string &imageSpec_ )
1526 options()->fileName( imageSpec_ );
1527 ExceptionInfo exceptionInfo;
1528 GetExceptionInfo( &exceptionInfo );
1529 MagickCore::Image* image =
1530 PingImage( imageInfo(), &exceptionInfo );
1531 replaceImage( image );
1532 throwException( exceptionInfo );
1533 (void) DestroyExceptionInfo( &exceptionInfo );
1536 // Ping is similar to read except only enough of the image is read
1537 // to determine the image columns, rows, and filesize. Access the
1538 // columns(), rows(), and fileSize() attributes after invoking
1539 // ping. The image data is not valid after calling ping.
1540 void Magick::Image::ping ( const Blob& blob_ )
1542 ExceptionInfo exceptionInfo;
1543 GetExceptionInfo( &exceptionInfo );
1544 MagickCore::Image* image =
1545 PingBlob( imageInfo(), blob_.data(), blob_.length(), &exceptionInfo );
1546 replaceImage( image );
1547 throwException( exceptionInfo );
1548 (void) DestroyExceptionInfo( &exceptionInfo );
1551 // Execute a named process module using an argc/argv syntax similar to
1552 // that accepted by a C 'main' routine. An exception is thrown if the
1553 // requested process module doesn't exist, fails to load, or fails during
1555 void Magick::Image::process( std::string name_, const ssize_t argc, const char **argv )
1559 ExceptionInfo exceptionInfo;
1560 GetExceptionInfo( &exceptionInfo );
1562 InvokeDynamicImageFilter( name_.c_str(), &image(), argc, argv,
1564 throwException( exceptionInfo );
1565 (void) DestroyExceptionInfo( &exceptionInfo );
1568 // Quantize colors in image using current quantization settings
1569 // Set measureError_ to true in order to measure quantization error
1570 void Magick::Image::quantize ( const bool measureError_ )
1575 options()->quantizeInfo()->measure_error=MagickTrue;
1577 options()->quantizeInfo()->measure_error=MagickFalse;
1579 ExceptionInfo exceptionInfo;
1580 GetExceptionInfo( &exceptionInfo );
1581 QuantizeImage( options()->quantizeInfo(), image(), &exceptionInfo );
1583 throwException( exceptionInfo );
1584 (void) DestroyExceptionInfo( &exceptionInfo );
1587 // Apply an arithmetic or bitwise operator to the image pixel quantums.
1588 void Magick::Image::quantumOperator ( const ChannelType channel_,
1589 const MagickEvaluateOperator operator_,
1592 ExceptionInfo exceptionInfo;
1593 GetExceptionInfo( &exceptionInfo );
1594 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1595 EvaluateImage( image(), operator_, rvalue_, &exceptionInfo);
1596 (void) SetPixelChannelMapMask( image(), channel_mask );
1597 throwException( exceptionInfo );
1598 (void) DestroyExceptionInfo( &exceptionInfo );
1601 void Magick::Image::quantumOperator ( const ssize_t x_,const ssize_t y_,
1602 const size_t columns_,
1604 const ChannelType channel_,
1605 const MagickEvaluateOperator operator_,
1606 const double rvalue_)
1608 ExceptionInfo exceptionInfo;
1609 GetExceptionInfo( &exceptionInfo );
1610 RectangleInfo geometry;
1611 geometry.width = columns_;
1612 geometry.height = rows_;
1615 MagickCore::Image *crop_image = CropImage( image(), &geometry,
1617 ChannelType channel_mask = SetPixelChannelMask( image(), channel_);
1618 EvaluateImage( crop_image, operator_, rvalue_, &exceptionInfo );
1619 (void) SetPixelChannelMapMask( image(), channel_mask );
1620 (void) CompositeImage( image(), crop_image, image()->matte != MagickFalse ?
1621 OverCompositeOp : CopyCompositeOp, MagickFalse, geometry.x, geometry.y,
1623 crop_image = DestroyImageList(crop_image);
1624 throwException( exceptionInfo );
1625 (void) DestroyExceptionInfo( &exceptionInfo );
1628 // Raise image (lighten or darken the edges of an image to give a 3-D
1629 // raised or lowered effect)
1630 void Magick::Image::raise ( const Geometry &geometry_ ,
1631 const bool raisedFlag_ )
1633 ExceptionInfo exceptionInfo;
1634 GetExceptionInfo( &exceptionInfo );
1635 RectangleInfo raiseInfo = geometry_;
1637 RaiseImage ( image(), &raiseInfo, raisedFlag_ == true ? MagickTrue : MagickFalse, &exceptionInfo );
1638 throwException( exceptionInfo );
1639 (void) DestroyExceptionInfo( &exceptionInfo );
1643 // Random threshold image.
1645 // Changes the value of individual pixels based on the intensity
1646 // of each pixel compared to a random threshold. The result is a
1647 // low-contrast, two color image. The thresholds_ argument is a
1648 // geometry containing LOWxHIGH thresholds. If the string
1649 // contains 2x2, 3x3, or 4x4, then an ordered dither of order 2,
1650 // 3, or 4 will be performed instead. If a channel_ argument is
1651 // specified then only the specified channel is altered. This is
1652 // a very fast alternative to 'quantize' based dithering.
1653 void Magick::Image::randomThreshold( const Geometry &thresholds_ )
1655 randomThresholdChannel(thresholds_,DefaultChannels);
1657 void Magick::Image::randomThresholdChannel( const Geometry &thresholds_,
1658 const ChannelType channel_ )
1660 ExceptionInfo exceptionInfo;
1661 GetExceptionInfo( &exceptionInfo );
1663 ChannelType channel_mask = SetPixelChannelMask( image(), channel_);
1664 (void) RandomThresholdImage( image(),
1665 static_cast<std::string>(thresholds_).c_str(),
1667 (void) SetPixelChannelMapMask( image(), channel_mask );
1668 throwImageException();
1669 (void) DestroyExceptionInfo( &exceptionInfo );
1672 // Read image into current object
1673 void Magick::Image::read ( const std::string &imageSpec_ )
1675 options()->fileName( imageSpec_ );
1677 ExceptionInfo exceptionInfo;
1678 GetExceptionInfo( &exceptionInfo );
1679 MagickCore::Image* image =
1680 ReadImage( imageInfo(), &exceptionInfo );
1682 // Ensure that multiple image frames were not read.
1683 if ( image && image->next )
1685 // Destroy any extra image frames
1686 MagickCore::Image* next = image->next;
1689 DestroyImageList( next );
1692 replaceImage( image );
1693 throwException( exceptionInfo );
1694 (void) DestroyExceptionInfo( &exceptionInfo );
1697 // Read image of specified size into current object
1698 void Magick::Image::read ( const Geometry &size_,
1699 const std::string &imageSpec_ )
1705 // Read image from in-memory BLOB
1706 void Magick::Image::read ( const Blob &blob_ )
1708 ExceptionInfo exceptionInfo;
1709 GetExceptionInfo( &exceptionInfo );
1710 MagickCore::Image* image =
1711 BlobToImage( imageInfo(),
1712 static_cast<const void *>(blob_.data()),
1713 blob_.length(), &exceptionInfo );
1714 replaceImage( image );
1715 throwException( exceptionInfo );
1716 (void) DestroyExceptionInfo( &exceptionInfo );
1719 // Read image of specified size from in-memory BLOB
1720 void Magick::Image::read ( const Blob &blob_,
1721 const Geometry &size_ )
1729 // Read image of specified size and depth from in-memory BLOB
1730 void Magick::Image::read ( const Blob &blob_,
1731 const Geometry &size_,
1732 const size_t depth_ )
1742 // Read image of specified size, depth, and format from in-memory BLOB
1743 void Magick::Image::read ( const Blob &blob_,
1744 const Geometry &size_,
1745 const size_t depth_,
1746 const std::string &magick_ )
1754 // Set explicit image format
1755 fileName( magick_ + ':');
1760 // Read image of specified size, and format from in-memory BLOB
1761 void Magick::Image::read ( const Blob &blob_,
1762 const Geometry &size_,
1763 const std::string &magick_ )
1769 // Set explicit image format
1770 fileName( magick_ + ':');
1775 // Read image based on raw pixels in memory (ConstituteImage)
1776 void Magick::Image::read ( const size_t width_,
1777 const size_t height_,
1778 const std::string &map_,
1779 const StorageType type_,
1780 const void *pixels_ )
1782 ExceptionInfo exceptionInfo;
1783 GetExceptionInfo( &exceptionInfo );
1784 MagickCore::Image* image =
1785 ConstituteImage( width_, height_, map_.c_str(), type_, pixels_,
1787 replaceImage( image );
1788 throwException( exceptionInfo );
1789 (void) DestroyExceptionInfo( &exceptionInfo );
1792 // Reduce noise in image
1793 void Magick::Image::reduceNoise ( const double order_ )
1795 ExceptionInfo exceptionInfo;
1796 GetExceptionInfo( &exceptionInfo );
1797 MagickCore::Image* newImage =
1798 StatisticImage( image(), NonpeakStatistic, (size_t) order_, (size_t) order_,
1800 replaceImage( newImage );
1801 throwException( exceptionInfo );
1802 (void) DestroyExceptionInfo( &exceptionInfo );
1806 void Magick::Image::resize( const Geometry &geometry_ )
1808 // Calculate new size. This code should be supported using binary arguments
1809 // in the ImageMagick library.
1812 size_t width = columns();
1813 size_t height = rows();
1815 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1819 ExceptionInfo exceptionInfo;
1820 GetExceptionInfo( &exceptionInfo );
1821 MagickCore::Image* newImage =
1822 ResizeImage( image(),
1827 replaceImage( newImage );
1828 throwException( exceptionInfo );
1829 (void) DestroyExceptionInfo( &exceptionInfo );
1833 void Magick::Image::roll ( const Geometry &roll_ )
1835 ssize_t xOff = roll_.xOff();
1836 if ( roll_.xNegative() )
1838 ssize_t yOff = roll_.yOff();
1839 if ( roll_.yNegative() )
1842 ExceptionInfo exceptionInfo;
1843 GetExceptionInfo( &exceptionInfo );
1844 MagickCore::Image* newImage =
1845 RollImage( image(), xOff, yOff, &exceptionInfo );
1846 replaceImage( newImage );
1847 throwException( exceptionInfo );
1848 (void) DestroyExceptionInfo( &exceptionInfo );
1850 void Magick::Image::roll ( const size_t columns_,
1851 const size_t rows_ )
1853 ExceptionInfo exceptionInfo;
1854 GetExceptionInfo( &exceptionInfo );
1855 MagickCore::Image* newImage =
1857 static_cast<ssize_t>(columns_),
1858 static_cast<ssize_t>(rows_), &exceptionInfo );
1859 replaceImage( newImage );
1860 throwException( exceptionInfo );
1861 (void) DestroyExceptionInfo( &exceptionInfo );
1865 void Magick::Image::rotate ( const double degrees_ )
1867 ExceptionInfo exceptionInfo;
1868 GetExceptionInfo( &exceptionInfo );
1869 MagickCore::Image* newImage =
1870 RotateImage( image(), degrees_, &exceptionInfo);
1871 replaceImage( newImage );
1872 throwException( exceptionInfo );
1873 (void) DestroyExceptionInfo( &exceptionInfo );
1877 void Magick::Image::sample ( const Geometry &geometry_ )
1881 size_t width = columns();
1882 size_t height = rows();
1884 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1888 ExceptionInfo exceptionInfo;
1889 GetExceptionInfo( &exceptionInfo );
1890 MagickCore::Image* newImage =
1891 SampleImage( image(), width, height, &exceptionInfo );
1892 replaceImage( newImage );
1893 throwException( exceptionInfo );
1894 (void) DestroyExceptionInfo( &exceptionInfo );
1898 void Magick::Image::scale ( const Geometry &geometry_ )
1902 size_t width = columns();
1903 size_t height = rows();
1905 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1909 ExceptionInfo exceptionInfo;
1910 GetExceptionInfo( &exceptionInfo );
1911 MagickCore::Image* newImage =
1912 ScaleImage( image(), width, height, &exceptionInfo );
1913 replaceImage( newImage );
1914 throwException( exceptionInfo );
1915 (void) DestroyExceptionInfo( &exceptionInfo );
1918 // Segment (coalesce similar image components) by analyzing the
1919 // histograms of the color components and identifying units that are
1920 // homogeneous with the fuzzy c-means technique.
1921 void Magick::Image::segment ( const double clusterThreshold_,
1922 const double smoothingThreshold_ )
1924 ExceptionInfo exceptionInfo;
1925 GetExceptionInfo( &exceptionInfo );
1927 SegmentImage ( image(),
1928 options()->quantizeColorSpace(),
1929 (MagickBooleanType) options()->verbose(),
1931 smoothingThreshold_, &exceptionInfo );
1932 SyncImage( image(), &exceptionInfo );
1933 throwException( exceptionInfo );
1934 (void) DestroyExceptionInfo( &exceptionInfo );
1937 // Shade image using distant light source
1938 void Magick::Image::shade ( const double azimuth_,
1939 const double elevation_,
1940 const bool colorShading_ )
1942 ExceptionInfo exceptionInfo;
1943 GetExceptionInfo( &exceptionInfo );
1944 MagickCore::Image* newImage =
1945 ShadeImage( image(),
1946 colorShading_ == true ? MagickTrue : MagickFalse,
1950 replaceImage( newImage );
1951 throwException( exceptionInfo );
1952 (void) DestroyExceptionInfo( &exceptionInfo );
1955 // Simulate an image shadow
1956 void Magick::Image::shadow( const double percent_opacity_, const double sigma_,
1957 const ssize_t x_, const ssize_t y_ )
1959 ExceptionInfo exceptionInfo;
1960 GetExceptionInfo( &exceptionInfo );
1961 MagickCore::Image* newImage = ShadowImage( image(), percent_opacity_, sigma_,
1962 x_, y_, &exceptionInfo );
1963 replaceImage( newImage );
1964 throwException( exceptionInfo );
1965 (void) DestroyExceptionInfo( &exceptionInfo );
1968 // Sharpen pixels in image
1969 void Magick::Image::sharpen ( const double radius_, const double sigma_ )
1971 ExceptionInfo exceptionInfo;
1972 GetExceptionInfo( &exceptionInfo );
1973 MagickCore::Image* newImage =
1974 SharpenImage( image(),
1978 replaceImage( newImage );
1979 throwException( exceptionInfo );
1980 (void) DestroyExceptionInfo( &exceptionInfo );
1983 void Magick::Image::sharpenChannel ( const ChannelType channel_,
1984 const double radius_, const double sigma_ )
1986 ExceptionInfo exceptionInfo;
1987 GetExceptionInfo( &exceptionInfo );
1988 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1989 MagickCore::Image* newImage =
1990 SharpenImage( image(),
1994 (void) SetPixelChannelMapMask( image(), channel_mask );
1995 replaceImage( newImage );
1996 throwException( exceptionInfo );
1997 (void) DestroyExceptionInfo( &exceptionInfo );
2000 // Shave pixels from image edges.
2001 void Magick::Image::shave ( const Geometry &geometry_ )
2003 RectangleInfo shaveInfo = geometry_;
2004 ExceptionInfo exceptionInfo;
2005 GetExceptionInfo( &exceptionInfo );
2006 MagickCore::Image* newImage =
2007 ShaveImage( image(),
2010 replaceImage( newImage );
2011 throwException( exceptionInfo );
2012 (void) DestroyExceptionInfo( &exceptionInfo );
2016 void Magick::Image::shear ( const double xShearAngle_,
2017 const double yShearAngle_ )
2019 ExceptionInfo exceptionInfo;
2020 GetExceptionInfo( &exceptionInfo );
2021 MagickCore::Image* newImage =
2022 ShearImage( image(),
2026 replaceImage( newImage );
2027 throwException( exceptionInfo );
2028 (void) DestroyExceptionInfo( &exceptionInfo );
2032 void Magick::Image::sigmoidalContrast ( const size_t sharpen_, const double contrast, const double midpoint )
2034 ExceptionInfo exceptionInfo;
2035 GetExceptionInfo( &exceptionInfo );
2037 (void) SigmoidalContrastImage( image(), (MagickBooleanType) sharpen_, contrast, midpoint, &exceptionInfo );
2038 throwException( exceptionInfo );
2039 (void) DestroyExceptionInfo( &exceptionInfo );
2042 // Solarize image (similar to effect seen when exposing a photographic
2043 // film to light during the development process)
2044 void Magick::Image::solarize ( const double factor_ )
2046 ExceptionInfo exceptionInfo;
2047 GetExceptionInfo( &exceptionInfo );
2049 SolarizeImage ( image(), factor_, &exceptionInfo );
2050 throwException( exceptionInfo );
2051 (void) DestroyExceptionInfo( &exceptionInfo );
2054 // Sparse color image, given a set of coordinates, interpolates the colors
2055 // found at those coordinates, across the whole image, using various methods.
2057 void Magick::Image::sparseColor ( const ChannelType channel,
2058 const SparseColorMethod method,
2059 const size_t number_arguments,
2060 const double *arguments )
2062 ExceptionInfo exceptionInfo;
2063 GetExceptionInfo( &exceptionInfo );
2065 ChannelType channel_mask = SetPixelChannelMask( image(), channel );
2066 MagickCore::Image* newImage = SparseColorImage ( image(), method,
2067 number_arguments, arguments, &exceptionInfo );
2068 (void) SetPixelChannelMapMask( image(), channel_mask );
2069 replaceImage( newImage );
2070 throwException( exceptionInfo );
2071 (void) DestroyExceptionInfo( &exceptionInfo );
2074 // Spread pixels randomly within image by specified ammount
2075 void Magick::Image::spread ( const size_t amount_ )
2077 ExceptionInfo exceptionInfo;
2078 GetExceptionInfo( &exceptionInfo );
2079 MagickCore::Image* newImage =
2080 SpreadImage( image(),
2082 image()->interpolate,
2084 replaceImage( newImage );
2085 throwException( exceptionInfo );
2086 (void) DestroyExceptionInfo( &exceptionInfo );
2089 // Add a digital watermark to the image (based on second image)
2090 void Magick::Image::stegano ( const Image &watermark_ )
2092 ExceptionInfo exceptionInfo;
2093 GetExceptionInfo( &exceptionInfo );
2094 MagickCore::Image* newImage =
2095 SteganoImage( image(),
2096 watermark_.constImage(),
2098 replaceImage( newImage );
2099 throwException( exceptionInfo );
2100 (void) DestroyExceptionInfo( &exceptionInfo );
2103 // Stereo image (left image is current image)
2104 void Magick::Image::stereo ( const Image &rightImage_ )
2106 ExceptionInfo exceptionInfo;
2107 GetExceptionInfo( &exceptionInfo );
2108 MagickCore::Image* newImage =
2109 StereoImage( image(),
2110 rightImage_.constImage(),
2112 replaceImage( newImage );
2113 throwException( exceptionInfo );
2114 (void) DestroyExceptionInfo( &exceptionInfo );
2118 void Magick::Image::swirl ( const double degrees_ )
2120 ExceptionInfo exceptionInfo;
2121 GetExceptionInfo( &exceptionInfo );
2122 MagickCore::Image* newImage =
2123 SwirlImage( image(), degrees_, image()->interpolate,
2125 replaceImage( newImage );
2126 throwException( exceptionInfo );
2127 (void) DestroyExceptionInfo( &exceptionInfo );
2131 void Magick::Image::texture ( const Image &texture_ )
2134 ExceptionInfo exceptionInfo;
2135 GetExceptionInfo( &exceptionInfo );
2136 TextureImage( image(), texture_.constImage(), &exceptionInfo );
2137 throwException( exceptionInfo );
2138 (void) DestroyExceptionInfo( &exceptionInfo );
2142 void Magick::Image::threshold ( const double threshold_ )
2145 ExceptionInfo exceptionInfo;
2146 GetExceptionInfo( &exceptionInfo );
2147 BilevelImage( image(), threshold_, &exceptionInfo );
2148 throwException( exceptionInfo );
2149 (void) DestroyExceptionInfo( &exceptionInfo );
2152 // Transform image based on image geometry only
2153 void Magick::Image::transform ( const Geometry &imageGeometry_ )
2156 ExceptionInfo exceptionInfo;
2157 GetExceptionInfo( &exceptionInfo );
2158 TransformImage ( &(image()), 0,
2159 std::string(imageGeometry_).c_str(), &exceptionInfo );
2160 throwException( exceptionInfo );
2161 (void) DestroyExceptionInfo( &exceptionInfo );
2163 // Transform image based on image and crop geometries
2164 void Magick::Image::transform ( const Geometry &imageGeometry_,
2165 const Geometry &cropGeometry_ )
2168 ExceptionInfo exceptionInfo;
2169 GetExceptionInfo( &exceptionInfo );
2170 TransformImage ( &(image()), std::string(cropGeometry_).c_str(),
2171 std::string(imageGeometry_).c_str(), &exceptionInfo );
2172 throwException( exceptionInfo );
2173 (void) DestroyExceptionInfo( &exceptionInfo );
2176 // Add matte image to image, setting pixels matching color to transparent
2177 void Magick::Image::transparent ( const Color &color_ )
2179 if ( !color_.isValid() )
2181 throwExceptionExplicit( OptionError,
2182 "Color argument is invalid" );
2185 std::string color = color_;
2188 ExceptionInfo exceptionInfo;
2189 GetExceptionInfo( &exceptionInfo );
2190 (void) QueryColorCompliance(std::string(color_).c_str(),AllCompliance,
2191 &target,&exceptionInfo);
2193 TransparentPaintImage ( image(), &target, TransparentAlpha, MagickFalse,
2195 throwException( exceptionInfo );
2196 (void) DestroyExceptionInfo( &exceptionInfo );
2199 // Add matte image to image, setting pixels matching color to transparent
2200 void Magick::Image::transparentChroma(const Color &colorLow_,
2201 const Color &colorHigh_)
2203 if ( !colorLow_.isValid() || !colorHigh_.isValid() )
2205 throwExceptionExplicit( OptionError,
2206 "Color argument is invalid" );
2209 std::string colorLow = colorLow_;
2210 std::string colorHigh = colorHigh_;
2212 PixelInfo targetLow;
2213 PixelInfo targetHigh;
2214 ExceptionInfo exceptionInfo;
2215 GetExceptionInfo( &exceptionInfo );
2216 (void) QueryColorCompliance(std::string(colorLow_).c_str(),
2217 AllCompliance,&targetLow,&exceptionInfo);
2218 (void) QueryColorCompliance(std::string(colorHigh_).c_str(),
2219 AllCompliance,&targetHigh,&exceptionInfo);
2221 TransparentPaintImageChroma ( image(), &targetLow, &targetHigh,
2222 TransparentAlpha, MagickFalse, &exceptionInfo );
2223 throwException( exceptionInfo );
2224 (void) DestroyExceptionInfo( &exceptionInfo );
2228 // Trim edges that are the background color from the image
2229 void Magick::Image::trim ( void )
2231 ExceptionInfo exceptionInfo;
2232 GetExceptionInfo( &exceptionInfo );
2233 MagickCore::Image* newImage =
2234 TrimImage( image(), &exceptionInfo);
2235 replaceImage( newImage );
2236 throwException( exceptionInfo );
2237 (void) DestroyExceptionInfo( &exceptionInfo );
2240 // Replace image with a sharpened version of the original image
2241 // using the unsharp mask algorithm.
2243 // the radius of the Gaussian, in pixels, not counting the
2246 // the standard deviation of the Gaussian, in pixels.
2248 // the percentage of the difference between the original and
2249 // the blur image that is added back into the original.
2251 // the threshold in pixels needed to apply the diffence amount.
2252 void Magick::Image::unsharpmask ( const double radius_,
2253 const double sigma_,
2254 const double amount_,
2255 const double threshold_ )
2257 ExceptionInfo exceptionInfo;
2258 GetExceptionInfo( &exceptionInfo );
2259 MagickCore::Image* newImage =
2260 UnsharpMaskImage( image(),
2266 replaceImage( newImage );
2267 throwException( exceptionInfo );
2268 (void) DestroyExceptionInfo( &exceptionInfo );
2271 void Magick::Image::unsharpmaskChannel ( const ChannelType channel_,
2272 const double radius_,
2273 const double sigma_,
2274 const double amount_,
2275 const double threshold_ )
2277 ExceptionInfo exceptionInfo;
2278 GetExceptionInfo( &exceptionInfo );
2279 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
2280 MagickCore::Image* newImage =
2281 UnsharpMaskImage( image(),
2287 (void) SetPixelChannelMapMask( image(), channel_mask );
2288 replaceImage( newImage );
2289 throwException( exceptionInfo );
2290 (void) DestroyExceptionInfo( &exceptionInfo );
2293 // Map image pixels to a sine wave
2294 void Magick::Image::wave ( const double amplitude_, const double wavelength_ )
2296 ExceptionInfo exceptionInfo;
2297 GetExceptionInfo( &exceptionInfo );
2298 MagickCore::Image* newImage =
2302 image()->interpolate,
2304 replaceImage( newImage );
2305 throwException( exceptionInfo );
2306 (void) DestroyExceptionInfo( &exceptionInfo );
2309 // Write image to file
2310 void Magick::Image::write( const std::string &imageSpec_ )
2312 ExceptionInfo exceptionInfo;
2313 GetExceptionInfo( &exceptionInfo );
2315 fileName( imageSpec_ );
2316 WriteImage( imageInfo(), image(), &exceptionInfo );
2317 throwException( exceptionInfo );
2318 (void) DestroyExceptionInfo( &exceptionInfo );
2321 // Write image to in-memory BLOB
2322 void Magick::Image::write ( Blob *blob_ )
2325 size_t length = 2048; // Efficient size for small images
2326 ExceptionInfo exceptionInfo;
2327 GetExceptionInfo( &exceptionInfo );
2328 void* data = ImageToBlob( imageInfo(),
2332 throwException( exceptionInfo );
2333 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2334 throwImageException();
2335 (void) DestroyExceptionInfo( &exceptionInfo );
2337 void Magick::Image::write ( Blob *blob_,
2338 const std::string &magick_ )
2342 size_t length = 2048; // Efficient size for small images
2343 ExceptionInfo exceptionInfo;
2344 GetExceptionInfo( &exceptionInfo );
2345 void* data = ImageToBlob( imageInfo(),
2349 throwException( exceptionInfo );
2350 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2351 throwImageException();
2352 (void) DestroyExceptionInfo( &exceptionInfo );
2354 void Magick::Image::write ( Blob *blob_,
2355 const std::string &magick_,
2356 const size_t depth_ )
2361 size_t length = 2048; // Efficient size for small images
2362 ExceptionInfo exceptionInfo;
2363 GetExceptionInfo( &exceptionInfo );
2364 void* data = ImageToBlob( imageInfo(),
2368 throwException( exceptionInfo );
2369 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2370 throwImageException();
2371 (void) DestroyExceptionInfo( &exceptionInfo );
2374 // Write image to an array of pixels with storage type specified
2375 // by user (ExportImagePixels), e.g.
2376 // image.write( 0, 0, 640, 1, "RGB", 0, pixels );
2377 void Magick::Image::write ( const ssize_t x_,
2379 const size_t columns_,
2381 const std::string &map_,
2382 const StorageType type_,
2385 ExceptionInfo exceptionInfo;
2386 GetExceptionInfo( &exceptionInfo );
2387 ExportImagePixels( image(), x_, y_, columns_, rows_, map_.c_str(), type_,
2390 throwException( exceptionInfo );
2391 (void) DestroyExceptionInfo( &exceptionInfo );
2395 void Magick::Image::zoom( const Geometry &geometry_ )
2397 // Calculate new size. This code should be supported using binary arguments
2398 // in the ImageMagick library.
2401 size_t width = columns();
2402 size_t height = rows();
2404 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
2408 ExceptionInfo exceptionInfo;
2409 GetExceptionInfo( &exceptionInfo );
2410 MagickCore::Image* newImage =
2411 ResizeImage( image(),
2416 replaceImage( newImage );
2417 throwException( exceptionInfo );
2418 (void) DestroyExceptionInfo( &exceptionInfo );
2422 * Methods for setting image attributes
2426 // Join images into a single multi-image file
2427 void Magick::Image::adjoin ( const bool flag_ )
2430 options()->adjoin( flag_ );
2432 bool Magick::Image::adjoin ( void ) const
2434 return constOptions()->adjoin();
2437 // Remove pixel aliasing
2438 void Magick::Image::antiAlias( const bool flag_ )
2441 options()->antiAlias( static_cast<size_t>(flag_) );
2443 bool Magick::Image::antiAlias( void )
2445 return static_cast<bool>( options()->antiAlias( ) );
2448 // Animation inter-frame delay
2449 void Magick::Image::animationDelay ( const size_t delay_ )
2452 image()->delay = delay_;
2454 size_t Magick::Image::animationDelay ( void ) const
2456 return constImage()->delay;
2459 // Number of iterations to play animation
2460 void Magick::Image::animationIterations ( const size_t iterations_ )
2463 image()->iterations = iterations_;
2465 size_t Magick::Image::animationIterations ( void ) const
2467 return constImage()->iterations;
2470 // Access/Update a named image attribute
2471 void Magick::Image::attribute ( const std::string name_,
2472 const std::string value_ )
2475 ExceptionInfo exceptionInfo;
2476 GetExceptionInfo( &exceptionInfo );
2477 SetImageProperty( image(), name_.c_str(), value_.c_str(), &exceptionInfo );
2478 throwException( exceptionInfo );
2479 (void) DestroyExceptionInfo( &exceptionInfo );
2481 std::string Magick::Image::attribute ( const std::string name_ )
2483 ExceptionInfo exceptionInfo;
2484 GetExceptionInfo( &exceptionInfo );
2485 const char *value = GetImageProperty( constImage(), name_.c_str(),
2487 throwException( exceptionInfo );
2488 (void) DestroyExceptionInfo( &exceptionInfo );
2491 return std::string( value );
2493 return std::string(); // Intentionally no exception
2497 void Magick::Image::backgroundColor ( const Color &backgroundColor_ )
2501 if ( backgroundColor_.isValid() )
2503 image()->background_color = backgroundColor_;
2507 image()->background_color = Color();
2510 options()->backgroundColor( backgroundColor_ );
2512 Magick::Color Magick::Image::backgroundColor ( void ) const
2514 return constOptions()->backgroundColor( );
2517 // Background fill texture
2518 void Magick::Image::backgroundTexture ( const std::string &backgroundTexture_ )
2521 options()->backgroundTexture( backgroundTexture_ );
2523 std::string Magick::Image::backgroundTexture ( void ) const
2525 return constOptions()->backgroundTexture( );
2528 // Original image columns
2529 size_t Magick::Image::baseColumns ( void ) const
2531 return constImage()->magick_columns;
2534 // Original image name
2535 std::string Magick::Image::baseFilename ( void ) const
2537 return std::string(constImage()->magick_filename);
2540 // Original image rows
2541 size_t Magick::Image::baseRows ( void ) const
2543 return constImage()->magick_rows;
2547 void Magick::Image::borderColor ( const Color &borderColor_ )
2551 if ( borderColor_.isValid() )
2553 image()->border_color = borderColor_;
2557 image()->border_color = Color();
2560 options()->borderColor( borderColor_ );
2562 Magick::Color Magick::Image::borderColor ( void ) const
2564 return constOptions()->borderColor( );
2567 // Return smallest bounding box enclosing non-border pixels. The
2568 // current fuzz value is used when discriminating between pixels.
2569 // This is the crop bounding box used by crop(Geometry(0,0));
2570 Magick::Geometry Magick::Image::boundingBox ( void ) const
2572 ExceptionInfo exceptionInfo;
2573 GetExceptionInfo( &exceptionInfo );
2574 RectangleInfo bbox = GetImageBoundingBox( constImage(), &exceptionInfo);
2575 throwException( exceptionInfo );
2576 (void) DestroyExceptionInfo( &exceptionInfo );
2577 return Geometry( bbox );
2580 // Text bounding-box base color
2581 void Magick::Image::boxColor ( const Color &boxColor_ )
2584 options()->boxColor( boxColor_ );
2586 Magick::Color Magick::Image::boxColor ( void ) const
2588 return constOptions()->boxColor( );
2591 // Pixel cache threshold. Once this threshold is exceeded, all
2592 // subsequent pixels cache operations are to/from disk.
2593 // This setting is shared by all Image objects.
2595 void Magick::Image::cacheThreshold ( const size_t threshold_ )
2597 SetMagickResourceLimit( MemoryResource, threshold_ );
2600 void Magick::Image::chromaBluePrimary ( const double x_, const double y_ )
2603 image()->chromaticity.blue_primary.x = x_;
2604 image()->chromaticity.blue_primary.y = y_;
2606 void Magick::Image::chromaBluePrimary ( double *x_, double *y_ ) const
2608 *x_ = constImage()->chromaticity.blue_primary.x;
2609 *y_ = constImage()->chromaticity.blue_primary.y;
2612 void Magick::Image::chromaGreenPrimary ( const double x_, const double y_ )
2615 image()->chromaticity.green_primary.x = x_;
2616 image()->chromaticity.green_primary.y = y_;
2618 void Magick::Image::chromaGreenPrimary ( double *x_, double *y_ ) const
2620 *x_ = constImage()->chromaticity.green_primary.x;
2621 *y_ = constImage()->chromaticity.green_primary.y;
2624 void Magick::Image::chromaRedPrimary ( const double x_, const double y_ )
2627 image()->chromaticity.red_primary.x = x_;
2628 image()->chromaticity.red_primary.y = y_;
2630 void Magick::Image::chromaRedPrimary ( double *x_, double *y_ ) const
2632 *x_ = constImage()->chromaticity.red_primary.x;
2633 *y_ = constImage()->chromaticity.red_primary.y;
2636 void Magick::Image::chromaWhitePoint ( const double x_, const double y_ )
2639 image()->chromaticity.white_point.x = x_;
2640 image()->chromaticity.white_point.y = y_;
2642 void Magick::Image::chromaWhitePoint ( double *x_, double *y_ ) const
2644 *x_ = constImage()->chromaticity.white_point.x;
2645 *y_ = constImage()->chromaticity.white_point.y;
2648 // Set image storage class
2649 void Magick::Image::classType ( const ClassType class_ )
2651 if ( classType() == PseudoClass && class_ == DirectClass )
2653 // Use SyncImage to synchronize the DirectClass pixels with the
2654 // color map and then set to DirectClass type.
2656 ExceptionInfo exceptionInfo;
2657 GetExceptionInfo( &exceptionInfo );
2658 SyncImage( image(), &exceptionInfo );
2659 throwException( exceptionInfo );
2660 (void) DestroyExceptionInfo( &exceptionInfo );
2661 image()->colormap = (PixelInfo *)
2662 RelinquishMagickMemory( image()->colormap );
2663 image()->storage_class = static_cast<MagickCore::ClassType>(DirectClass);
2667 if ( classType() == DirectClass && class_ == PseudoClass )
2669 // Quantize to create PseudoClass color map
2671 quantizeColors(MaxColormapSize);
2673 image()->storage_class = static_cast<MagickCore::ClassType>(PseudoClass);
2677 // Associate a clip mask with the image. The clip mask must be the
2678 // same dimensions as the image. Pass an invalid image to unset an
2679 // existing clip mask.
2680 void Magick::Image::clipMask ( const Magick::Image & clipMask_ )
2684 ExceptionInfo exceptionInfo;
2685 GetExceptionInfo( &exceptionInfo );
2686 if( clipMask_.isValid() )
2689 SetImageMask( image(), clipMask_.constImage(), &exceptionInfo );
2693 // Unset existing clip mask
2694 SetImageMask( image(), 0, &exceptionInfo );
2696 throwException( exceptionInfo );
2697 (void) DestroyExceptionInfo( &exceptionInfo );
2699 Magick::Image Magick::Image::clipMask ( void ) const
2701 ExceptionInfo exceptionInfo;
2702 GetExceptionInfo( &exceptionInfo );
2703 MagickCore::Image* image = GetImageMask( constImage(), &exceptionInfo );
2704 throwException( exceptionInfo );
2705 (void) DestroyExceptionInfo( &exceptionInfo );
2706 return Magick::Image( image );
2709 void Magick::Image::colorFuzz ( const double fuzz_ )
2712 image()->fuzz = fuzz_;
2713 options()->colorFuzz( fuzz_ );
2715 double Magick::Image::colorFuzz ( void ) const
2717 return constOptions()->colorFuzz( );
2720 // Set color in colormap at index
2721 void Magick::Image::colorMap ( const size_t index_,
2722 const Color &color_ )
2724 MagickCore::Image* imageptr = image();
2726 if (index_ > (MaxColormapSize-1) )
2727 throwExceptionExplicit( OptionError,
2728 "Colormap index must be less than MaxColormapSize" );
2730 if ( !color_.isValid() )
2731 throwExceptionExplicit( OptionError,
2732 "Color argument is invalid");
2735 // Ensure that colormap size is large enough
2736 if ( colorMapSize() < (index_+1) )
2737 colorMapSize( index_ + 1 );
2739 // Set color at index in colormap
2740 (imageptr->colormap)[index_] = color_;
2742 // Return color in colormap at index
2743 Magick::Color Magick::Image::colorMap ( const size_t index_ ) const
2745 const MagickCore::Image* imageptr = constImage();
2747 if ( !imageptr->colormap )
2748 throwExceptionExplicit( OptionError,
2749 "Image does not contain a colormap");
2751 if ( index_ > imageptr->colors-1 )
2752 throwExceptionExplicit( OptionError,
2753 "Index out of range");
2755 return Magick::Color( (imageptr->colormap)[index_] );
2758 // Colormap size (number of colormap entries)
2759 void Magick::Image::colorMapSize ( const size_t entries_ )
2761 if (entries_ >MaxColormapSize )
2762 throwExceptionExplicit( OptionError,
2763 "Colormap entries must not exceed MaxColormapSize" );
2767 MagickCore::Image* imageptr = image();
2769 if( !imageptr->colormap )
2771 // Allocate colormap
2772 imageptr->colormap =
2773 static_cast<PixelInfo*>(AcquireMagickMemory(entries_*sizeof(PixelInfo)));
2774 imageptr->colors = 0;
2776 else if ( entries_ > imageptr->colors )
2778 // Re-allocate colormap
2779 imageptr->colormap=(PixelInfo *)
2780 ResizeMagickMemory(imageptr->colormap,(entries_)*sizeof(PixelInfo));
2783 // Initialize any new colormap entries as all black
2785 for( size_t i=imageptr->colors; i<(entries_-1); i++ )
2786 (imageptr->colormap)[i] = black;
2788 imageptr->colors = entries_;
2790 size_t Magick::Image::colorMapSize ( void )
2792 const MagickCore::Image* imageptr = constImage();
2794 if ( !imageptr->colormap )
2795 throwExceptionExplicit( OptionError,
2796 "Image does not contain a colormap");
2798 return imageptr->colors;
2802 void Magick::Image::colorSpace( const ColorspaceType colorSpace_ )
2805 if ( image()->colorspace == colorSpace_ )
2810 ExceptionInfo exceptionInfo;
2811 GetExceptionInfo( &exceptionInfo );
2812 if ( colorSpace_ != RGBColorspace &&
2813 colorSpace_ != sRGBColorspace &&
2814 colorSpace_ != TransparentColorspace &&
2815 colorSpace_ != GRAYColorspace )
2817 if (image()->colorspace != RGBColorspace &&
2818 image()->colorspace != sRGBColorspace &&
2819 image()->colorspace != TransparentColorspace &&
2820 image()->colorspace != GRAYColorspace)
2822 /* Transform to RGB colorspace as intermediate step */
2823 TransformRGBImage( image(), image()->colorspace, &exceptionInfo );
2824 throwImageException();
2826 /* Transform to final non-RGB colorspace */
2827 RGBTransformImage( image(), colorSpace_, &exceptionInfo );
2828 throwException( exceptionInfo );
2829 (void) DestroyExceptionInfo( &exceptionInfo );
2833 if ( colorSpace_ == RGBColorspace ||
2834 colorSpace_ == sRGBColorspace ||
2835 colorSpace_ == TransparentColorspace ||
2836 colorSpace_ == GRAYColorspace )
2838 /* Transform to a RGB-type colorspace */
2839 TransformRGBImage( image(), image()->colorspace, &exceptionInfo );
2840 throwException( exceptionInfo );
2841 (void) DestroyExceptionInfo( &exceptionInfo );
2844 throwException( exceptionInfo );
2845 (void) DestroyExceptionInfo( &exceptionInfo );
2847 Magick::ColorspaceType Magick::Image::colorSpace ( void ) const
2849 return constImage()->colorspace;
2852 // Set image colorspace type.
2853 void Magick::Image::colorspaceType( const ColorspaceType colorSpace_ )
2856 options()->colorspaceType( colorSpace_ );
2858 Magick::ColorspaceType Magick::Image::colorspaceType ( void ) const
2860 return constOptions()->colorspaceType();
2865 void Magick::Image::comment ( const std::string &comment_ )
2868 ExceptionInfo exceptionInfo;
2869 GetExceptionInfo( &exceptionInfo );
2870 SetImageProperty( image(), "Comment", NULL, &exceptionInfo );
2871 if ( comment_.length() > 0 )
2872 SetImageProperty( image(), "Comment", comment_.c_str(), &exceptionInfo );
2873 throwException( exceptionInfo );
2874 (void) DestroyExceptionInfo( &exceptionInfo );
2876 std::string Magick::Image::comment ( void ) const
2878 ExceptionInfo exceptionInfo;
2879 GetExceptionInfo( &exceptionInfo );
2880 const char *value = GetImageProperty( constImage(), "Comment",
2882 throwException( exceptionInfo );
2883 (void) DestroyExceptionInfo( &exceptionInfo );
2886 return std::string( value );
2888 return std::string(); // Intentionally no exception
2891 // Composition operator to be used when composition is implicitly used
2892 // (such as for image flattening).
2893 void Magick::Image::compose (const CompositeOperator compose_)
2895 image()->compose=compose_;
2898 Magick::CompositeOperator Magick::Image::compose ( void ) const
2900 return constImage()->compose;
2903 // Compression algorithm
2904 void Magick::Image::compressType ( const CompressionType compressType_ )
2907 image()->compression = compressType_;
2908 options()->compressType( compressType_ );
2910 Magick::CompressionType Magick::Image::compressType ( void ) const
2912 return constImage()->compression;
2915 // Enable printing of debug messages from ImageMagick
2916 void Magick::Image::debug ( const bool flag_ )
2919 options()->debug( flag_ );
2921 bool Magick::Image::debug ( void ) const
2923 return constOptions()->debug();
2926 // Tagged image format define (set/access coder-specific option) The
2927 // magick_ option specifies the coder the define applies to. The key_
2928 // option provides the key specific to that coder. The value_ option
2929 // provides the value to set (if any). See the defineSet() method if the
2930 // key must be removed entirely.
2931 void Magick::Image::defineValue ( const std::string &magick_,
2932 const std::string &key_,
2933 const std::string &value_ )
2936 std::string format = magick_ + ":" + key_;
2937 std::string option = value_;
2938 (void) SetImageOption ( imageInfo(), format.c_str(), option.c_str() );
2940 std::string Magick::Image::defineValue ( const std::string &magick_,
2941 const std::string &key_ ) const
2943 std::string definition = magick_ + ":" + key_;
2944 const char *option =
2945 GetImageOption ( constImageInfo(), definition.c_str() );
2947 return std::string( option );
2948 return std::string( );
2951 // Tagged image format define. Similar to the defineValue() method
2952 // except that passing the flag_ value 'true' creates a value-less
2953 // define with that format and key. Passing the flag_ value 'false'
2954 // removes any existing matching definition. The method returns 'true'
2955 // if a matching key exists, and 'false' if no matching key exists.
2956 void Magick::Image::defineSet ( const std::string &magick_,
2957 const std::string &key_,
2961 std::string definition = magick_ + ":" + key_;
2964 (void) SetImageOption ( imageInfo(), definition.c_str(), "" );
2968 DeleteImageOption( imageInfo(), definition.c_str() );
2971 bool Magick::Image::defineSet ( const std::string &magick_,
2972 const std::string &key_ ) const
2974 std::string key = magick_ + ":" + key_;
2975 const char *option =
2976 GetImageOption ( constImageInfo(), key.c_str() );
2983 void Magick::Image::density ( const Geometry &density_ )
2986 options()->density( density_ );
2987 if ( density_.isValid() )
2989 image()->resolution.x = density_.width();
2990 if ( density_.height() != 0 )
2992 image()->resolution.y = density_.height();
2996 image()->resolution.y = density_.width();
3002 image()->resolution.x = 0;
3003 image()->resolution.y = 0;
3006 Magick::Geometry Magick::Image::density ( void ) const
3010 ssize_t x_resolution=72;
3011 ssize_t y_resolution=72;
3013 if (constImage()->resolution.x > 0.0)
3014 x_resolution=static_cast<ssize_t>(constImage()->resolution.x + 0.5);
3016 if (constImage()->resolution.y > 0.0)
3017 y_resolution=static_cast<ssize_t>(constImage()->resolution.y + 0.5);
3019 return Geometry(x_resolution,y_resolution);
3022 return constOptions()->density( );
3025 // Image depth (bits allocated to red/green/blue components)
3026 void Magick::Image::depth ( const size_t depth_ )
3028 size_t depth = depth_;
3030 if (depth > MAGICKCORE_QUANTUM_DEPTH)
3031 depth=MAGICKCORE_QUANTUM_DEPTH;
3034 image()->depth=depth;
3035 options()->depth( depth );
3037 size_t Magick::Image::depth ( void ) const
3039 return constImage()->depth;
3042 std::string Magick::Image::directory ( void ) const
3044 if ( constImage()->directory )
3045 return std::string( constImage()->directory );
3047 throwExceptionExplicit( CorruptImageWarning,
3048 "Image does not contain a directory");
3050 return std::string();
3053 // Endianness (little like Intel or big like SPARC) for image
3054 // formats which support endian-specific options.
3055 void Magick::Image::endian ( const Magick::EndianType endian_ )
3058 options()->endian( endian_ );
3059 image()->endian = endian_;
3061 Magick::EndianType Magick::Image::endian ( void ) const
3063 return constImage()->endian;
3066 // EXIF profile (BLOB)
3067 void Magick::Image::exifProfile( const Magick::Blob &exifProfile_ )
3070 if ( exifProfile_.data() != 0 )
3072 StringInfo * exif_profile = AcquireStringInfo( exifProfile_.length() );
3073 SetStringInfoDatum(exif_profile ,(unsigned char *) exifProfile_.data());
3074 ExceptionInfo exceptionInfo;
3075 GetExceptionInfo( &exceptionInfo );
3076 (void) SetImageProfile( image(), "exif", exif_profile, &exceptionInfo);
3077 exif_profile =DestroyStringInfo( exif_profile );
3078 throwException( exceptionInfo );
3079 (void) DestroyExceptionInfo( &exceptionInfo );
3082 Magick::Blob Magick::Image::exifProfile( void ) const
3084 const StringInfo * exif_profile = GetImageProfile( constImage(), "exif" );
3085 if ( exif_profile == (StringInfo *) NULL)
3086 return Blob( 0, 0 );
3087 return Blob(GetStringInfoDatum(exif_profile),GetStringInfoLength(exif_profile));
3091 void Magick::Image::fileName ( const std::string &fileName_ )
3095 fileName_.copy( image()->filename,
3096 sizeof(image()->filename) - 1 );
3097 image()->filename[ fileName_.length() ] = 0; // Null terminate
3099 options()->fileName( fileName_ );
3102 std::string Magick::Image::fileName ( void ) const
3104 return constOptions()->fileName( );
3108 off_t Magick::Image::fileSize ( void ) const
3110 return (off_t) GetBlobSize( constImage() );
3113 // Color to use when drawing inside an object
3114 void Magick::Image::fillColor ( const Magick::Color &fillColor_ )
3117 options()->fillColor(fillColor_);
3119 Magick::Color Magick::Image::fillColor ( void ) const
3121 return constOptions()->fillColor();
3124 // Rule to use when filling drawn objects
3125 void Magick::Image::fillRule ( const Magick::FillRule &fillRule_ )
3128 options()->fillRule(fillRule_);
3130 Magick::FillRule Magick::Image::fillRule ( void ) const
3132 return constOptions()->fillRule();
3135 // Pattern to use while filling drawn objects.
3136 void Magick::Image::fillPattern ( const Image &fillPattern_ )
3139 if(fillPattern_.isValid())
3140 options()->fillPattern( fillPattern_.constImage() );
3142 options()->fillPattern( static_cast<MagickCore::Image*>(NULL) );
3144 Magick::Image Magick::Image::fillPattern ( void ) const
3146 // FIXME: This is inordinately innefficient
3149 const MagickCore::Image* tmpTexture = constOptions()->fillPattern( );
3153 ExceptionInfo exceptionInfo;
3154 GetExceptionInfo( &exceptionInfo );
3155 MagickCore::Image* image =
3156 CloneImage( tmpTexture,
3159 MagickTrue, // orphan
3161 texture.replaceImage( image );
3162 throwException( exceptionInfo );
3163 (void) DestroyExceptionInfo( &exceptionInfo );
3168 // Filter used by zoom
3169 void Magick::Image::filterType ( const Magick::FilterTypes filterType_ )
3172 image()->filter = filterType_;
3174 Magick::FilterTypes Magick::Image::filterType ( void ) const
3176 return constImage()->filter;
3180 void Magick::Image::font ( const std::string &font_ )
3183 options()->font( font_ );
3185 std::string Magick::Image::font ( void ) const
3187 return constOptions()->font( );
3191 void Magick::Image::fontPointsize ( const double pointSize_ )
3194 options()->fontPointsize( pointSize_ );
3196 double Magick::Image::fontPointsize ( void ) const
3198 return constOptions()->fontPointsize( );
3201 // Font type metrics
3202 void Magick::Image::fontTypeMetrics( const std::string &text_,
3203 TypeMetric *metrics )
3205 DrawInfo *drawInfo = options()->drawInfo();
3206 drawInfo->text = const_cast<char *>(text_.c_str());
3207 ExceptionInfo exceptionInfo;
3208 GetExceptionInfo( &exceptionInfo );
3209 GetTypeMetrics( image(), drawInfo, &(metrics->_typeMetric), &exceptionInfo );
3211 throwException( exceptionInfo );
3212 (void) DestroyExceptionInfo( &exceptionInfo );
3215 // Image format string
3216 std::string Magick::Image::format ( void ) const
3218 ExceptionInfo exceptionInfo;
3219 GetExceptionInfo( &exceptionInfo );
3220 const MagickInfo * magick_info
3221 = GetMagickInfo( constImage()->magick, &exceptionInfo);
3222 throwException( exceptionInfo );
3223 (void) DestroyExceptionInfo( &exceptionInfo );
3225 if (( magick_info != 0 ) &&
3226 ( *magick_info->description != '\0' ))
3227 return std::string(magick_info->description);
3229 throwExceptionExplicit( CorruptImageWarning,
3230 "Unrecognized image magick type" );
3231 return std::string();
3235 double Magick::Image::gamma ( void ) const
3237 return constImage()->gamma;
3240 Magick::Geometry Magick::Image::geometry ( void ) const
3242 if ( constImage()->geometry )
3244 return Geometry(constImage()->geometry);
3247 throwExceptionExplicit( OptionWarning,
3248 "Image does not contain a geometry");
3253 void Magick::Image::gifDisposeMethod ( const size_t disposeMethod_ )
3256 image()->dispose = (DisposeType) disposeMethod_;
3258 size_t Magick::Image::gifDisposeMethod ( void ) const
3260 // FIXME: It would be better to return an enumeration
3261 return constImage()->dispose;
3264 // ICC ICM color profile (BLOB)
3265 void Magick::Image::iccColorProfile( const Magick::Blob &colorProfile_ )
3267 profile("icm",colorProfile_);
3269 Magick::Blob Magick::Image::iccColorProfile( void ) const
3271 const StringInfo * color_profile = GetImageProfile( constImage(), "icc" );
3272 if ( color_profile == (StringInfo *) NULL)
3273 return Blob( 0, 0 );
3274 return Blob( GetStringInfoDatum(color_profile), GetStringInfoLength(color_profile) );
3277 void Magick::Image::interlaceType ( const Magick::InterlaceType interlace_ )
3280 image()->interlace = interlace_;
3281 options()->interlaceType ( interlace_ );
3283 Magick::InterlaceType Magick::Image::interlaceType ( void ) const
3285 return constImage()->interlace;
3288 // IPTC profile (BLOB)
3289 void Magick::Image::iptcProfile( const Magick::Blob &iptcProfile_ )
3292 if ( iptcProfile_.data() != 0 )
3294 StringInfo * iptc_profile = AcquireStringInfo( iptcProfile_.length() );
3295 SetStringInfoDatum(iptc_profile ,(unsigned char *) iptcProfile_.data());
3296 ExceptionInfo exceptionInfo;
3297 GetExceptionInfo( &exceptionInfo );
3298 (void) SetImageProfile( image(), "iptc", iptc_profile, &exceptionInfo);
3299 iptc_profile =DestroyStringInfo( iptc_profile );
3300 throwException( exceptionInfo );
3301 (void) DestroyExceptionInfo( &exceptionInfo );
3304 Magick::Blob Magick::Image::iptcProfile( void ) const
3306 const StringInfo * iptc_profile = GetImageProfile( constImage(), "iptc" );
3307 if ( iptc_profile == (StringInfo *) NULL)
3308 return Blob( 0, 0 );
3309 return Blob( GetStringInfoDatum(iptc_profile), GetStringInfoLength(iptc_profile));
3312 // Does object contain valid image?
3313 void Magick::Image::isValid ( const bool isValid_ )
3318 _imgRef = new ImageRef;
3320 else if ( !isValid() )
3322 // Construct with single-pixel black image to make
3323 // image valid. This is an obvious hack.
3324 size( Geometry(1,1) );
3325 read( "xc:#000000" );
3329 bool Magick::Image::isValid ( void ) const
3331 if ( rows() && columns() )
3338 void Magick::Image::label ( const std::string &label_ )
3341 ExceptionInfo exceptionInfo;
3342 GetExceptionInfo( &exceptionInfo );
3343 SetImageProperty ( image(), "Label", NULL, &exceptionInfo );
3344 if ( label_.length() > 0 )
3345 SetImageProperty ( image(), "Label", label_.c_str(), &exceptionInfo );
3346 throwException( exceptionInfo );
3347 (void) DestroyExceptionInfo( &exceptionInfo );
3349 std::string Magick::Image::label ( void ) const
3351 ExceptionInfo exceptionInfo;
3352 GetExceptionInfo( &exceptionInfo );
3353 const char *value = GetImageProperty( constImage(), "Label", &exceptionInfo );
3354 throwException( exceptionInfo );
3355 (void) DestroyExceptionInfo( &exceptionInfo );
3358 return std::string( value );
3360 return std::string();
3363 void Magick::Image::magick ( const std::string &magick_ )
3367 magick_.copy( image()->magick,
3368 sizeof(image()->magick) - 1 );
3369 image()->magick[ magick_.length() ] = 0;
3371 options()->magick( magick_ );
3373 std::string Magick::Image::magick ( void ) const
3375 if ( *(constImage()->magick) != '\0' )
3376 return std::string(constImage()->magick);
3378 return constOptions()->magick( );
3381 void Magick::Image::matte ( const bool matteFlag_ )
3385 // If matte channel is requested, but image doesn't already have a
3386 // matte channel, then create an opaque matte channel. Likewise, if
3387 // the image already has a matte channel but a matte channel is not
3388 // desired, then set the matte channel to opaque.
3389 ExceptionInfo exceptionInfo;
3390 GetExceptionInfo( &exceptionInfo );
3391 if ((matteFlag_ && !constImage()->matte) ||
3392 (constImage()->matte && !matteFlag_))
3393 SetImageAlpha(image(),OpaqueAlpha,&exceptionInfo);
3394 throwException( exceptionInfo );
3395 (void) DestroyExceptionInfo( &exceptionInfo );
3397 image()->matte = (MagickBooleanType) matteFlag_;
3399 bool Magick::Image::matte ( void ) const
3401 if ( constImage()->matte )
3407 void Magick::Image::matteColor ( const Color &matteColor_ )
3411 if ( matteColor_.isValid() )
3413 image()->matte_color = matteColor_;
3414 options()->matteColor( matteColor_ );
3418 // Set to default matte color
3419 Color tmpColor( "#BDBDBD" );
3420 image()->matte_color = tmpColor;
3421 options()->matteColor( tmpColor );
3424 Magick::Color Magick::Image::matteColor ( void ) const
3426 return Color( ClampToQuantum( constImage()->matte_color.red ),
3427 ClampToQuantum( constImage()->matte_color.green ),
3428 ClampToQuantum( constImage()->matte_color.blue ) );
3431 double Magick::Image::meanErrorPerPixel ( void ) const
3433 return(constImage()->error.mean_error_per_pixel);
3436 // Image modulus depth (minimum number of bits required to support
3437 // red/green/blue components without loss of accuracy)
3438 void Magick::Image::modulusDepth ( const size_t depth_ )
3441 ExceptionInfo exceptionInfo;
3442 GetExceptionInfo( &exceptionInfo );
3443 SetImageDepth( image(), depth_, &exceptionInfo );
3444 throwException( exceptionInfo );
3445 (void) DestroyExceptionInfo( &exceptionInfo );
3446 options()->depth( depth_ );
3448 size_t Magick::Image::modulusDepth ( void ) const
3450 ExceptionInfo exceptionInfo;
3451 GetExceptionInfo( &exceptionInfo );
3452 size_t depth=GetImageDepth( constImage(), &exceptionInfo );
3453 throwException( exceptionInfo );
3454 (void) DestroyExceptionInfo( &exceptionInfo );
3458 void Magick::Image::monochrome ( const bool monochromeFlag_ )
3461 options()->monochrome( monochromeFlag_ );
3463 bool Magick::Image::monochrome ( void ) const
3465 return constOptions()->monochrome( );
3468 Magick::Geometry Magick::Image::montageGeometry ( void ) const
3470 if ( constImage()->montage )
3471 return Magick::Geometry(constImage()->montage);
3473 throwExceptionExplicit( CorruptImageWarning,
3474 "Image does not contain a montage" );
3476 return Magick::Geometry();
3479 double Magick::Image::normalizedMaxError ( void ) const
3481 return(constImage()->error.normalized_maximum_error);
3484 double Magick::Image::normalizedMeanError ( void ) const
3486 return constImage()->error.normalized_mean_error;
3489 // Image orientation
3490 void Magick::Image::orientation ( const Magick::OrientationType orientation_ )
3493 image()->orientation = orientation_;
3495 Magick::OrientationType Magick::Image::orientation ( void ) const
3497 return constImage()->orientation;
3500 void Magick::Image::penColor ( const Color &penColor_ )
3503 options()->fillColor(penColor_);
3504 options()->strokeColor(penColor_);
3506 Magick::Color Magick::Image::penColor ( void ) const
3508 return constOptions()->fillColor();
3511 void Magick::Image::penTexture ( const Image &penTexture_ )
3514 if(penTexture_.isValid())
3515 options()->fillPattern( penTexture_.constImage() );
3517 options()->fillPattern( static_cast<MagickCore::Image*>(NULL) );
3520 Magick::Image Magick::Image::penTexture ( void ) const
3522 // FIXME: This is inordinately innefficient
3525 const MagickCore::Image* tmpTexture = constOptions()->fillPattern( );
3529 ExceptionInfo exceptionInfo;
3530 GetExceptionInfo( &exceptionInfo );
3531 MagickCore::Image* image =
3532 CloneImage( tmpTexture,
3535 MagickTrue, // orphan
3537 texture.replaceImage( image );
3538 throwException( exceptionInfo );
3539 (void) DestroyExceptionInfo( &exceptionInfo );
3544 // Set the color of a pixel.
3545 void Magick::Image::pixelColor ( const ssize_t x_, const ssize_t y_,
3546 const Color &color_ )
3548 // Test arguments to ensure they are within the image.
3549 if ( y_ > (ssize_t) rows() || x_ > (ssize_t) columns() )
3550 throwExceptionExplicit( OptionError,
3551 "Access outside of image boundary" );
3555 // Set image to DirectClass
3556 classType( DirectClass );
3559 Pixels pixels(*this);
3561 Quantum *pixel = pixels.get(x_, y_, 1, 1 );
3562 PixelInfo packet = color_;
3563 MagickCore::SetPixelInfoPixel(constImage(),&packet,pixel);
3564 // Tell ImageMagick that pixels have been updated
3570 // Get the color of a pixel
3571 Magick::Color Magick::Image::pixelColor ( const ssize_t x_,
3572 const ssize_t y_ ) const
3574 ClassType storage_class;
3575 storage_class = classType();
3577 const Quantum* pixel = getConstPixels( x_, y_, 1, 1 );
3581 MagickCore::GetPixelInfoPixel(constImage(),pixel,&packet);
3582 return Color( packet );
3585 return Color(); // invalid
3588 // Preferred size and location of an image canvas.
3589 void Magick::Image::page ( const Magick::Geometry &pageSize_ )
3592 options()->page( pageSize_ );
3593 image()->page = pageSize_;
3595 Magick::Geometry Magick::Image::page ( void ) const
3597 return Geometry( constImage()->page.width,
3598 constImage()->page.height,
3599 AbsoluteValue(constImage()->page.x),
3600 AbsoluteValue(constImage()->page.y),
3601 constImage()->page.x < 0 ? true : false,
3602 constImage()->page.y < 0 ? true : false);
3605 // Add a named profile to an image or remove a named profile by
3606 // passing an empty Blob (use default Blob constructor).
3608 // "*", "8BIM", "ICM", "IPTC", or a generic profile name.
3609 void Magick::Image::profile( const std::string name_,
3610 const Magick::Blob &profile_ )
3613 ExceptionInfo exceptionInfo;
3614 GetExceptionInfo( &exceptionInfo );
3615 ssize_t result = ProfileImage( image(), name_.c_str(),
3616 (unsigned char *)profile_.data(),
3617 profile_.length(), &exceptionInfo);
3618 throwException( exceptionInfo );
3619 (void) DestroyExceptionInfo( &exceptionInfo );
3623 // Retrieve a named profile from the image.
3625 // "8BIM", "8BIMTEXT", "APP1", "APP1JPEG", "ICC", "ICM", & "IPTC" or
3626 // an existing generic profile name.
3627 Magick::Blob Magick::Image::profile( const std::string name_ ) const
3629 const MagickCore::Image* image = constImage();
3631 const StringInfo * profile = GetImageProfile( image, name_.c_str() );
3633 if ( profile != (StringInfo *) NULL)
3634 return Blob( (void*) GetStringInfoDatum(profile), GetStringInfoLength(profile));
3637 Image temp_image = *this;
3638 temp_image.write( &blob, name_ );
3642 void Magick::Image::quality ( const size_t quality_ )
3645 image()->quality = quality_;
3646 options()->quality( quality_ );
3648 size_t Magick::Image::quality ( void ) const
3650 return constImage()->quality;
3653 void Magick::Image::quantizeColors ( const size_t colors_ )
3656 options()->quantizeColors( colors_ );
3658 size_t Magick::Image::quantizeColors ( void ) const
3660 return constOptions()->quantizeColors( );
3663 void Magick::Image::quantizeColorSpace
3664 ( const Magick::ColorspaceType colorSpace_ )
3667 options()->quantizeColorSpace( colorSpace_ );
3669 Magick::ColorspaceType Magick::Image::quantizeColorSpace ( void ) const
3671 return constOptions()->quantizeColorSpace( );
3674 void Magick::Image::quantizeDither ( const bool ditherFlag_ )
3677 options()->quantizeDither( ditherFlag_ );
3679 bool Magick::Image::quantizeDither ( void ) const
3681 return constOptions()->quantizeDither( );
3684 void Magick::Image::quantizeTreeDepth ( const size_t treeDepth_ )
3687 options()->quantizeTreeDepth( treeDepth_ );
3689 size_t Magick::Image::quantizeTreeDepth ( void ) const
3691 return constOptions()->quantizeTreeDepth( );
3694 void Magick::Image::renderingIntent
3695 ( const Magick::RenderingIntent renderingIntent_ )
3698 image()->rendering_intent = renderingIntent_;
3700 Magick::RenderingIntent Magick::Image::renderingIntent ( void ) const
3702 return static_cast<Magick::RenderingIntent>(constImage()->rendering_intent);
3705 void Magick::Image::resolutionUnits
3706 ( const Magick::ResolutionType resolutionUnits_ )
3709 image()->units = resolutionUnits_;
3710 options()->resolutionUnits( resolutionUnits_ );
3712 Magick::ResolutionType Magick::Image::resolutionUnits ( void ) const
3714 return constOptions()->resolutionUnits( );
3717 void Magick::Image::scene ( const size_t scene_ )
3720 image()->scene = scene_;
3722 size_t Magick::Image::scene ( void ) const
3724 return constImage()->scene;
3727 std::string Magick::Image::signature ( const bool force_ ) const
3729 Lock( &_imgRef->_mutexLock );
3731 // Re-calculate image signature if necessary
3732 ExceptionInfo exceptionInfo;
3733 GetExceptionInfo( &exceptionInfo );
3735 !GetImageProperty(constImage(), "Signature", &exceptionInfo) ||
3736 constImage()->taint )
3738 SignatureImage( const_cast<MagickCore::Image *>(constImage()), &exceptionInfo );
3741 const char *property = GetImageProperty(constImage(), "Signature",
3743 throwException( exceptionInfo );
3744 (void) DestroyExceptionInfo( &exceptionInfo );
3746 return std::string( property );
3749 void Magick::Image::size ( const Geometry &geometry_ )
3752 options()->size( geometry_ );
3753 image()->rows = geometry_.height();
3754 image()->columns = geometry_.width();
3756 Magick::Geometry Magick::Image::size ( void ) const
3758 return Magick::Geometry( constImage()->columns, constImage()->rows );
3762 void Magick::Image::splice( const Geometry &geometry_ )
3764 RectangleInfo spliceInfo = geometry_;
3765 ExceptionInfo exceptionInfo;
3766 GetExceptionInfo( &exceptionInfo );
3767 MagickCore::Image* newImage =
3768 SpliceImage( image(), &spliceInfo, &exceptionInfo);
3769 replaceImage( newImage );
3770 throwException( exceptionInfo );
3771 (void) DestroyExceptionInfo( &exceptionInfo );
3774 // Obtain image statistics. Statistics are normalized to the range of
3775 // 0.0 to 1.0 and are output to the specified ImageStatistics
3777 void Magick::Image::statistics ( ImageStatistics *statistics )
3783 ExceptionInfo exceptionInfo;
3784 GetExceptionInfo( &exceptionInfo );
3786 ChannelType channel_mask = SetPixelChannelMask( image(), RedChannel);
3787 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3788 statistics->red.minimum=minimum;
3789 statistics->red.maximum=maximum;
3790 (void) GetImageMean( image(),&statistics->red.mean,
3791 &statistics->red.standard_deviation,&exceptionInfo);
3792 (void) GetImageKurtosis( image(),&statistics->red.kurtosis,
3793 &statistics->red.skewness,&exceptionInfo);
3794 (void) SetPixelChannelMapMask( image(), channel_mask );
3796 channel_mask = SetPixelChannelMask( image(), GreenChannel);
3797 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3798 statistics->green.minimum=minimum;
3799 statistics->green.maximum=maximum;
3800 (void) GetImageMean( image(),&statistics->green.mean,
3801 &statistics->green.standard_deviation,&exceptionInfo);
3802 (void) GetImageKurtosis( image(),&statistics->green.kurtosis,
3803 &statistics->green.skewness,&exceptionInfo);
3804 (void) SetPixelChannelMapMask( image(), channel_mask );
3806 channel_mask = SetPixelChannelMask( image(), GreenChannel);
3807 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3808 statistics->blue.minimum=minimum;
3809 statistics->blue.maximum=maximum;
3810 (void) GetImageMean( image(),&statistics->blue.mean,
3811 &statistics->blue.standard_deviation,&exceptionInfo);
3812 (void) GetImageKurtosis( image(),&statistics->blue.kurtosis,
3813 &statistics->blue.skewness,&exceptionInfo);
3814 (void) SetPixelChannelMapMask( image(), channel_mask );
3816 channel_mask = SetPixelChannelMask( image(), AlphaChannel);
3817 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3818 statistics->alpha.minimum=minimum;
3819 statistics->alpha.maximum=maximum;
3820 (void) GetImageMean( image(),&statistics->alpha.mean,
3821 &statistics->alpha.standard_deviation,&exceptionInfo);
3822 (void) GetImageKurtosis( image(),&statistics->alpha.kurtosis,
3823 &statistics->alpha.skewness,&exceptionInfo);
3824 (void) SetPixelChannelMapMask( image(), channel_mask );
3826 throwException( exceptionInfo );
3827 (void) DestroyExceptionInfo( &exceptionInfo );
3830 // Strip strips an image of all profiles and comments.
3831 void Magick::Image::strip ( void )
3834 ExceptionInfo exceptionInfo;
3835 GetExceptionInfo( &exceptionInfo );
3836 StripImage( image(), &exceptionInfo );
3837 throwException( exceptionInfo );
3838 (void) DestroyExceptionInfo( &exceptionInfo );
3841 // enabled/disable stroke anti-aliasing
3842 void Magick::Image::strokeAntiAlias ( const bool flag_ )
3845 options()->strokeAntiAlias(flag_);
3847 bool Magick::Image::strokeAntiAlias ( void ) const
3849 return constOptions()->strokeAntiAlias();
3852 // Color to use when drawing object outlines
3853 void Magick::Image::strokeColor ( const Magick::Color &strokeColor_ )
3856 options()->strokeColor(strokeColor_);
3858 Magick::Color Magick::Image::strokeColor ( void ) const
3860 return constOptions()->strokeColor();
3863 // dash pattern for drawing vector objects (default one)
3864 void Magick::Image::strokeDashArray ( const double* strokeDashArray_ )
3867 options()->strokeDashArray( strokeDashArray_ );
3870 const double* Magick::Image::strokeDashArray ( void ) const
3872 return constOptions()->strokeDashArray( );
3875 // dash offset for drawing vector objects (default one)
3876 void Magick::Image::strokeDashOffset ( const double strokeDashOffset_ )
3879 options()->strokeDashOffset( strokeDashOffset_ );
3882 double Magick::Image::strokeDashOffset ( void ) const
3884 return constOptions()->strokeDashOffset( );
3887 // Specify the shape to be used at the end of open subpaths when they
3888 // are stroked. Values of LineCap are UndefinedCap, ButtCap, RoundCap,
3890 void Magick::Image::strokeLineCap ( const Magick::LineCap lineCap_ )
3893 options()->strokeLineCap( lineCap_ );
3895 Magick::LineCap Magick::Image::strokeLineCap ( void ) const
3897 return constOptions()->strokeLineCap( );
3900 // Specify the shape to be used at the corners of paths (or other
3901 // vector shapes) when they are stroked. Values of LineJoin are
3902 // UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.
3903 void Magick::Image::strokeLineJoin ( const Magick::LineJoin lineJoin_ )
3906 options()->strokeLineJoin( lineJoin_ );
3908 Magick::LineJoin Magick::Image::strokeLineJoin ( void ) const
3910 return constOptions()->strokeLineJoin( );
3913 // Specify miter limit. When two line segments meet at a sharp angle
3914 // and miter joins have been specified for 'lineJoin', it is possible
3915 // for the miter to extend far beyond the thickness of the line
3916 // stroking the path. The miterLimit' imposes a limit on the ratio of
3917 // the miter length to the 'lineWidth'. The default value of this
3919 void Magick::Image::strokeMiterLimit ( const size_t strokeMiterLimit_ )
3922 options()->strokeMiterLimit( strokeMiterLimit_ );
3924 size_t Magick::Image::strokeMiterLimit ( void ) const
3926 return constOptions()->strokeMiterLimit( );
3929 // Pattern to use while stroking drawn objects.
3930 void Magick::Image::strokePattern ( const Image &strokePattern_ )
3933 if(strokePattern_.isValid())
3934 options()->strokePattern( strokePattern_.constImage() );
3936 options()->strokePattern( static_cast<MagickCore::Image*>(NULL) );
3938 Magick::Image Magick::Image::strokePattern ( void ) const
3940 // FIXME: This is inordinately innefficient
3943 const MagickCore::Image* tmpTexture = constOptions()->strokePattern( );
3947 ExceptionInfo exceptionInfo;
3948 GetExceptionInfo( &exceptionInfo );
3949 MagickCore::Image* image =
3950 CloneImage( tmpTexture,
3953 MagickTrue, // orphan
3955 throwException( exceptionInfo );
3956 (void) DestroyExceptionInfo( &exceptionInfo );
3957 texture.replaceImage( image );
3962 // Stroke width for drawing lines, circles, ellipses, etc.
3963 void Magick::Image::strokeWidth ( const double strokeWidth_ )
3966 options()->strokeWidth( strokeWidth_ );
3968 double Magick::Image::strokeWidth ( void ) const
3970 return constOptions()->strokeWidth( );
3973 void Magick::Image::subImage ( const size_t subImage_ )
3976 options()->subImage( subImage_ );
3978 size_t Magick::Image::subImage ( void ) const
3980 return constOptions()->subImage( );
3983 void Magick::Image::subRange ( const size_t subRange_ )
3986 options()->subRange( subRange_ );
3988 size_t Magick::Image::subRange ( void ) const
3990 return constOptions()->subRange( );
3993 // Annotation text encoding (e.g. "UTF-16")
3994 void Magick::Image::textEncoding ( const std::string &encoding_ )
3997 options()->textEncoding( encoding_ );
3999 std::string Magick::Image::textEncoding ( void ) const
4001 return constOptions()->textEncoding( );
4004 size_t Magick::Image::totalColors ( void )
4006 ExceptionInfo exceptionInfo;
4007 GetExceptionInfo( &exceptionInfo );
4008 size_t colors = GetNumberColors( image(), 0, &exceptionInfo);
4009 throwException( exceptionInfo );
4010 (void) DestroyExceptionInfo( &exceptionInfo );
4014 // Origin of coordinate system to use when annotating with text or drawing
4015 void Magick::Image::transformOrigin ( const double x_, const double y_ )
4018 options()->transformOrigin( x_, y_ );
4021 // Rotation to use when annotating with text or drawing
4022 void Magick::Image::transformRotation ( const double angle_ )
4025 options()->transformRotation( angle_ );
4028 // Reset transformation parameters to default
4029 void Magick::Image::transformReset ( void )
4032 options()->transformReset();
4035 // Scale to use when annotating with text or drawing
4036 void Magick::Image::transformScale ( const double sx_, const double sy_ )
4039 options()->transformScale( sx_, sy_ );
4042 // Skew to use in X axis when annotating with text or drawing
4043 void Magick::Image::transformSkewX ( const double skewx_ )
4046 options()->transformSkewX( skewx_ );
4049 // Skew to use in Y axis when annotating with text or drawing
4050 void Magick::Image::transformSkewY ( const double skewy_ )
4053 options()->transformSkewY( skewy_ );
4056 // Image representation type
4057 Magick::ImageType Magick::Image::type ( void ) const
4060 ExceptionInfo exceptionInfo;
4061 GetExceptionInfo( &exceptionInfo );
4062 ImageType image_type = constOptions()->type();
4063 if ( image_type == UndefinedType )
4064 image_type= GetImageType( constImage(), &exceptionInfo);
4065 throwException( exceptionInfo );
4066 (void) DestroyExceptionInfo( &exceptionInfo );
4069 void Magick::Image::type ( const Magick::ImageType type_)
4071 ExceptionInfo exceptionInfo;
4072 GetExceptionInfo( &exceptionInfo );
4074 options()->type( type_ );
4075 SetImageType( image(), type_, &exceptionInfo );
4076 throwException( exceptionInfo );
4077 (void) DestroyExceptionInfo( &exceptionInfo );
4080 void Magick::Image::verbose ( const bool verboseFlag_ )
4083 options()->verbose( verboseFlag_ );
4085 bool Magick::Image::verbose ( void ) const
4087 return constOptions()->verbose( );
4090 void Magick::Image::view ( const std::string &view_ )
4093 options()->view( view_ );
4095 std::string Magick::Image::view ( void ) const
4097 return constOptions()->view( );
4100 // Virtual pixel method
4101 void Magick::Image::virtualPixelMethod ( const VirtualPixelMethod virtual_pixel_method_ )
4104 ExceptionInfo exceptionInfo;
4105 GetExceptionInfo( &exceptionInfo );
4106 SetImageVirtualPixelMethod( image(), virtual_pixel_method_, &exceptionInfo );
4107 throwException( exceptionInfo );
4108 (void) DestroyExceptionInfo( &exceptionInfo );
4110 Magick::VirtualPixelMethod Magick::Image::virtualPixelMethod ( void ) const
4112 return GetImageVirtualPixelMethod( constImage() );
4115 void Magick::Image::x11Display ( const std::string &display_ )
4118 options()->x11Display( display_ );
4120 std::string Magick::Image::x11Display ( void ) const
4122 return constOptions()->x11Display( );
4125 double Magick::Image::xResolution ( void ) const
4127 return constImage()->resolution.x;
4129 double Magick::Image::yResolution ( void ) const
4131 return constImage()->resolution.y;
4135 Magick::Image::Image( const Image & image_ )
4136 : _imgRef(image_._imgRef)
4138 Lock( &_imgRef->_mutexLock );
4140 // Increase reference count
4141 ++_imgRef->_refCount;
4144 // Assignment operator
4145 Magick::Image& Magick::Image::operator=( const Magick::Image &image_ )
4147 if( this != &image_ )
4150 Lock( &image_._imgRef->_mutexLock );
4151 ++image_._imgRef->_refCount;
4154 bool doDelete = false;
4156 Lock( &_imgRef->_mutexLock );
4157 if ( --_imgRef->_refCount == 0 )
4163 // Delete old image reference with associated image and options.
4167 // Use new image reference
4168 _imgRef = image_._imgRef;
4174 //////////////////////////////////////////////////////////////////////
4176 // Low-level Pixel Access Routines
4178 // Also see the Pixels class, which provides support for multiple
4179 // cache views. The low-level pixel access routines in the Image
4180 // class are provided in order to support backward compatability.
4182 //////////////////////////////////////////////////////////////////////
4184 // Transfers read-only pixels from the image to the pixel cache as
4185 // defined by the specified region
4186 const Magick::Quantum* Magick::Image::getConstPixels
4187 ( const ssize_t x_, const ssize_t y_,
4188 const size_t columns_,
4189 const size_t rows_ ) const
4191 ExceptionInfo exceptionInfo;
4192 GetExceptionInfo( &exceptionInfo );
4193 const Quantum* p = (*GetVirtualPixels)( constImage(),
4197 throwException( exceptionInfo );
4198 (void) DestroyExceptionInfo( &exceptionInfo );
4202 // Obtain read-only pixel associated pixels channels
4203 const void* Magick::Image::getConstMetacontent ( void ) const
4205 const void* result = GetVirtualMetacontent( constImage() );
4208 throwImageException();
4213 // Obtain image pixel associated pixels channels
4214 void* Magick::Image::getMetacontent ( void )
4216 void* result = GetAuthenticMetacontent( image() );
4219 throwImageException();
4224 // Transfers pixels from the image to the pixel cache as defined
4225 // by the specified region. Modified pixels may be subsequently
4226 // transferred back to the image via syncPixels.
4227 Magick::Quantum* Magick::Image::getPixels ( const ssize_t x_, const ssize_t y_,
4228 const size_t columns_,
4229 const size_t rows_ )
4232 ExceptionInfo exceptionInfo;
4233 GetExceptionInfo( &exceptionInfo );
4234 Quantum* result = (*GetAuthenticPixels)( image(),
4236 columns_, rows_, &exceptionInfo );
4237 throwException( exceptionInfo );
4238 (void) DestroyExceptionInfo( &exceptionInfo );
4243 // Allocates a pixel cache region to store image pixels as defined
4244 // by the region rectangle. This area is subsequently transferred
4245 // from the pixel cache to the image via syncPixels.
4246 Magick::Quantum* Magick::Image::setPixels ( const ssize_t x_, const ssize_t y_,
4247 const size_t columns_,
4248 const size_t rows_ )
4251 ExceptionInfo exceptionInfo;
4252 GetExceptionInfo( &exceptionInfo );
4253 Quantum* result = (*QueueAuthenticPixels)( image(),
4255 columns_, rows_, &exceptionInfo );
4256 throwException( exceptionInfo );
4257 (void) DestroyExceptionInfo( &exceptionInfo );
4262 // Transfers the image cache pixels to the image.
4263 void Magick::Image::syncPixels ( void )
4265 ExceptionInfo exceptionInfo;
4266 GetExceptionInfo( &exceptionInfo );
4267 (*SyncAuthenticPixels)( image(), &exceptionInfo );
4268 throwException( exceptionInfo );
4269 (void) DestroyExceptionInfo( &exceptionInfo );
4272 // Transfers one or more pixel components from a buffer or file
4273 // into the image pixel cache of an image.
4274 // Used to support image decoders.
4275 void Magick::Image::readPixels ( const Magick::QuantumType quantum_,
4276 const unsigned char *source_ )
4281 quantum_info=AcquireQuantumInfo(imageInfo(),image());
4282 ExceptionInfo exceptionInfo;
4283 GetExceptionInfo( &exceptionInfo );
4284 ImportQuantumPixels(image(),(MagickCore::CacheView *) NULL,quantum_info,
4285 quantum_,source_, &exceptionInfo);
4286 throwException( exceptionInfo );
4287 (void) DestroyExceptionInfo( &exceptionInfo );
4288 quantum_info=DestroyQuantumInfo(quantum_info);
4291 // Transfers one or more pixel components from the image pixel
4292 // cache to a buffer or file.
4293 // Used to support image encoders.
4294 void Magick::Image::writePixels ( const Magick::QuantumType quantum_,
4295 unsigned char *destination_ )
4300 quantum_info=AcquireQuantumInfo(imageInfo(),image());
4301 ExceptionInfo exceptionInfo;
4302 GetExceptionInfo( &exceptionInfo );
4303 ExportQuantumPixels(image(),(MagickCore::CacheView *) NULL,quantum_info,
4304 quantum_,destination_, &exceptionInfo);
4305 quantum_info=DestroyQuantumInfo(quantum_info);
4306 throwException( exceptionInfo );
4307 (void) DestroyExceptionInfo( &exceptionInfo );
4310 /////////////////////////////////////////////////////////////////////
4312 // No end-user methods beyond this point
4314 /////////////////////////////////////////////////////////////////////
4318 // Construct using existing image and default options
4320 Magick::Image::Image ( MagickCore::Image* image_ )
4321 : _imgRef(new ImageRef( image_))
4325 // Get Magick::Options*
4326 Magick::Options* Magick::Image::options( void )
4328 return _imgRef->options();
4330 const Magick::Options* Magick::Image::constOptions( void ) const
4332 return _imgRef->options();
4335 // Get MagickCore::Image*
4336 MagickCore::Image*& Magick::Image::image( void )
4338 return _imgRef->image();
4340 const MagickCore::Image* Magick::Image::constImage( void ) const
4342 return _imgRef->image();
4346 MagickCore::ImageInfo* Magick::Image::imageInfo( void )
4348 return _imgRef->options()->imageInfo();
4350 const MagickCore::ImageInfo * Magick::Image::constImageInfo( void ) const
4352 return _imgRef->options()->imageInfo();
4355 // Get QuantizeInfo *
4356 MagickCore::QuantizeInfo* Magick::Image::quantizeInfo( void )
4358 return _imgRef->options()->quantizeInfo();
4360 const MagickCore::QuantizeInfo * Magick::Image::constQuantizeInfo( void ) const
4362 return _imgRef->options()->quantizeInfo();
4366 // Replace current image
4368 MagickCore::Image * Magick::Image::replaceImage
4369 ( MagickCore::Image* replacement_ )
4371 MagickCore::Image* image;
4374 image = replacement_;
4377 ExceptionInfo exceptionInfo;
4378 GetExceptionInfo( &exceptionInfo );
4379 image = AcquireImage(constImageInfo(), &exceptionInfo);
4380 throwException( exceptionInfo );
4381 (void) DestroyExceptionInfo( &exceptionInfo );
4385 Lock( &_imgRef->_mutexLock );
4387 if ( _imgRef->_refCount == 1 )
4389 // We own the image, just replace it, and de-register
4391 _imgRef->image(image);
4395 // We don't own the image, dereference and replace with copy
4396 --_imgRef->_refCount;
4397 _imgRef = new ImageRef( image, constOptions() );
4401 return _imgRef->_image;
4405 // Prepare to modify image or image options
4406 // Replace current image and options with copy if reference count > 1
4408 void Magick::Image::modifyImage( void )
4411 Lock( &_imgRef->_mutexLock );
4412 if ( _imgRef->_refCount == 1 )
4414 // De-register image and return
4420 ExceptionInfo exceptionInfo;
4421 GetExceptionInfo( &exceptionInfo );
4422 replaceImage( CloneImage( image(),
4425 MagickTrue, // orphan
4427 throwException( exceptionInfo );
4428 (void) DestroyExceptionInfo( &exceptionInfo );
4433 // Test for an ImageMagick reported error and throw exception if one
4434 // has been reported. Secretly resets image->exception back to default
4435 // state even though this method is const.
4437 void Magick::Image::throwImageException( void ) const
4439 // Throw C++ exception while resetting Image exception to default state
4442 // Register image with image registry or obtain registration id
4443 ssize_t Magick::Image::registerId( void )
4445 Lock( &_imgRef->_mutexLock );
4446 if( _imgRef->id() < 0 )
4448 char id[MaxTextExtent];
4449 ExceptionInfo exceptionInfo;
4450 GetExceptionInfo( &exceptionInfo );
4451 _imgRef->id(_imgRef->id()+1);
4452 sprintf(id,"%.20g\n",(double) _imgRef->id());
4453 SetImageRegistry(ImageRegistryType, id, image(), &exceptionInfo);
4454 throwException( exceptionInfo );
4455 (void) DestroyExceptionInfo( &exceptionInfo );
4457 return _imgRef->id();
4460 // Unregister image from image registry
4461 void Magick::Image::unregisterId( void )
4468 // Create a local wrapper around MagickCoreTerminus
4473 void MagickPlusPlusDestroyMagick(void);
4477 void Magick::MagickPlusPlusDestroyMagick(void)
4479 if (magick_initialized)
4481 magick_initialized=false;
4482 MagickCore::MagickCoreTerminus();
4486 // C library initialization routine
4487 void MagickPPExport Magick::InitializeMagick(const char *path_)
4489 MagickCore::MagickCoreGenesis(path_,MagickFalse);
4490 if (!magick_initialized)
4491 magick_initialized=true;
4495 // Cleanup class to ensure that ImageMagick singletons are destroyed
4496 // so as to avoid any resemblence to a memory leak (which seems to
4505 MagickCleanUp( void );
4506 ~MagickCleanUp( void );
4509 // The destructor for this object is invoked when the destructors for
4510 // static objects in this translation unit are invoked.
4511 static MagickCleanUp magickCleanUpGuard;
4514 Magick::MagickCleanUp::MagickCleanUp ( void )
4516 // Don't even think about invoking InitializeMagick here!
4519 Magick::MagickCleanUp::~MagickCleanUp ( void )
4521 MagickPlusPlusDestroyMagick();