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=(double *) kernel_;
764 MagickCore::Image* newImage =
765 ConvolveImage ( image(), kernel_info, &exceptionInfo );
766 kernel_info->values=(double *) 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 RectangleInfo geometry;
963 SetGeometry(image(), &geometry);
964 GravityAdjustGeometry(image()->columns, image()->rows, gravity_, &geometry);
965 extent ( geometry_ );
967 void Magick::Image::extent ( const Geometry &geometry_, const Color &backgroundColor_, const GravityType gravity_ )
969 image()->gravity = gravity_;
970 backgroundColor ( backgroundColor_ );
971 extent ( geometry_ );
974 // Flip image (reflect each scanline in the vertical direction)
975 void Magick::Image::flip ( void )
977 ExceptionInfo exceptionInfo;
978 GetExceptionInfo( &exceptionInfo );
979 MagickCore::Image* newImage =
980 FlipImage( image(), &exceptionInfo );
981 replaceImage( newImage );
982 throwException( exceptionInfo );
983 (void) DestroyExceptionInfo( &exceptionInfo );
986 // Flood-fill color across pixels that match the color of the
987 // target pixel and are neighbors of the target pixel.
988 // Uses current fuzz setting when determining color match.
989 void Magick::Image::floodFillColor( const ssize_t x_,
991 const Magick::Color &fillColor_ )
993 floodFillTexture( x_, y_, Image( Geometry( 1, 1), fillColor_ ) );
995 void Magick::Image::floodFillColor( const Geometry &point_,
996 const Magick::Color &fillColor_ )
998 floodFillTexture( point_, Image( Geometry( 1, 1), fillColor_) );
1001 // Flood-fill color across pixels starting at target-pixel and
1002 // stopping at pixels matching specified border color.
1003 // Uses current fuzz setting when determining color match.
1004 void Magick::Image::floodFillColor( const ssize_t x_,
1006 const Magick::Color &fillColor_,
1007 const Magick::Color &borderColor_ )
1009 floodFillTexture( x_, y_, Image( Geometry( 1, 1), fillColor_),
1012 void Magick::Image::floodFillColor( const Geometry &point_,
1013 const Magick::Color &fillColor_,
1014 const Magick::Color &borderColor_ )
1016 floodFillTexture( point_, Image( Geometry( 1, 1), fillColor_),
1020 // Floodfill pixels matching color (within fuzz factor) of target
1021 // pixel(x,y) with replacement alpha value using method.
1022 void Magick::Image::floodFillAlpha( const ssize_t x_,
1024 const unsigned int alpha_,
1025 const PaintMethod method_ )
1029 GetPixelInfo(image(),&target);
1030 PixelInfo pixel=static_cast<PixelInfo>(pixelColor(x_,y_));
1031 target.red=pixel.red;
1032 target.green=pixel.green;
1033 target.blue=pixel.blue;
1034 target.alpha=alpha_;
1035 ExceptionInfo exceptionInfo;
1036 GetExceptionInfo( &exceptionInfo );
1037 FloodfillPaintImage ( image(),
1038 options()->drawInfo(), // const DrawInfo *draw_info
1040 static_cast<ssize_t>(x_), static_cast<ssize_t>(y_),
1041 method_ == FloodfillMethod ? MagickFalse : MagickTrue,
1043 throwException( exceptionInfo );
1044 (void) DestroyExceptionInfo( &exceptionInfo );
1047 // Flood-fill texture across pixels that match the color of the
1048 // target pixel and are neighbors of the target pixel.
1049 // Uses current fuzz setting when determining color match.
1050 void Magick::Image::floodFillTexture( const ssize_t x_,
1052 const Magick::Image &texture_ )
1056 // Set drawing pattern
1057 options()->fillPattern(texture_.constImage());
1060 Pixels pixels(*this);
1062 Quantum *p = pixels.get(x_, y_, 1, 1 );
1064 GetPixelInfo(constImage(),&target);
1065 target.red=GetPixelRed(constImage(),p);
1066 target.green=GetPixelGreen(constImage(),p);
1067 target.blue=GetPixelBlue(constImage(),p);
1068 ExceptionInfo exceptionInfo;
1069 GetExceptionInfo( &exceptionInfo );
1071 FloodfillPaintImage ( image(), // Image *image
1072 options()->drawInfo(), // const DrawInfo *draw_info
1073 &target, // const MagickPacket target
1074 static_cast<ssize_t>(x_), // const ssize_t x_offset
1075 static_cast<ssize_t>(y_), // const ssize_t y_offset
1076 MagickFalse, // const PaintMethod method
1078 throwException( exceptionInfo );
1079 (void) DestroyExceptionInfo( &exceptionInfo );
1082 void Magick::Image::floodFillTexture( const Magick::Geometry &point_,
1083 const Magick::Image &texture_ )
1085 floodFillTexture( point_.xOff(), point_.yOff(), texture_ );
1088 // Flood-fill texture across pixels starting at target-pixel and
1089 // stopping at pixels matching specified border color.
1090 // Uses current fuzz setting when determining color match.
1091 void Magick::Image::floodFillTexture( const ssize_t x_,
1093 const Magick::Image &texture_,
1094 const Magick::Color &borderColor_ )
1098 // Set drawing fill pattern
1099 options()->fillPattern(texture_.constImage());
1102 GetPixelInfo(constImage(),&target);
1103 target.red=static_cast<PixelInfo>(borderColor_).red;
1104 target.green=static_cast<PixelInfo>(borderColor_).green;
1105 target.blue=static_cast<PixelInfo>(borderColor_).blue;
1106 ExceptionInfo exceptionInfo;
1107 GetExceptionInfo( &exceptionInfo );
1108 FloodfillPaintImage ( image(),
1109 options()->drawInfo(),
1111 static_cast<ssize_t>(x_),
1112 static_cast<ssize_t>(y_),
1113 MagickTrue, &exceptionInfo);
1115 throwException( exceptionInfo );
1116 (void) DestroyExceptionInfo( &exceptionInfo );
1118 void Magick::Image::floodFillTexture( const Magick::Geometry &point_,
1119 const Magick::Image &texture_,
1120 const Magick::Color &borderColor_ )
1122 floodFillTexture( point_.xOff(), point_.yOff(), texture_, borderColor_ );
1125 // Flop image (reflect each scanline in the horizontal direction)
1126 void Magick::Image::flop ( void )
1128 ExceptionInfo exceptionInfo;
1129 GetExceptionInfo( &exceptionInfo );
1130 MagickCore::Image* newImage =
1131 FlopImage( image(), &exceptionInfo );
1132 replaceImage( newImage );
1133 throwException( exceptionInfo );
1134 (void) DestroyExceptionInfo( &exceptionInfo );
1138 void Magick::Image::frame ( const Geometry &geometry_ )
1142 info.x = static_cast<ssize_t>(geometry_.width());
1143 info.y = static_cast<ssize_t>(geometry_.height());
1144 info.width = columns() + ( static_cast<size_t>(info.x) << 1 );
1145 info.height = rows() + ( static_cast<size_t>(info.y) << 1 );
1146 info.outer_bevel = geometry_.xOff();
1147 info.inner_bevel = geometry_.yOff();
1149 ExceptionInfo exceptionInfo;
1150 GetExceptionInfo( &exceptionInfo );
1151 MagickCore::Image* newImage =
1152 FrameImage( image(), &info, image()->compose, &exceptionInfo );
1153 replaceImage( newImage );
1154 throwException( exceptionInfo );
1155 (void) DestroyExceptionInfo( &exceptionInfo );
1157 void Magick::Image::frame ( const size_t width_,
1158 const size_t height_,
1159 const ssize_t outerBevel_, const ssize_t innerBevel_ )
1162 info.x = static_cast<ssize_t>(width_);
1163 info.y = static_cast<ssize_t>(height_);
1164 info.width = columns() + ( static_cast<size_t>(info.x) << 1 );
1165 info.height = rows() + ( static_cast<size_t>(info.y) << 1 );
1166 info.outer_bevel = static_cast<ssize_t>(outerBevel_);
1167 info.inner_bevel = static_cast<ssize_t>(innerBevel_);
1169 ExceptionInfo exceptionInfo;
1170 GetExceptionInfo( &exceptionInfo );
1171 MagickCore::Image* newImage =
1172 FrameImage( image(), &info, image()->compose, &exceptionInfo );
1173 replaceImage( newImage );
1174 throwException( exceptionInfo );
1175 (void) DestroyExceptionInfo( &exceptionInfo );
1178 // Fx image. Applies a mathematical expression to the image.
1179 void Magick::Image::fx ( const std::string expression )
1181 ExceptionInfo exceptionInfo;
1182 GetExceptionInfo( &exceptionInfo );
1183 MagickCore::Image* newImage =
1184 FxImage ( image(), expression.c_str(), &exceptionInfo );
1185 replaceImage( newImage );
1186 throwException( exceptionInfo );
1187 (void) DestroyExceptionInfo( &exceptionInfo );
1189 void Magick::Image::fx ( const std::string expression,
1190 const Magick::ChannelType channel )
1192 ExceptionInfo exceptionInfo;
1193 GetExceptionInfo( &exceptionInfo );
1194 ChannelType channel_mask = SetPixelChannelMask( image(), channel );
1195 MagickCore::Image* newImage =
1196 FxImage ( image(), expression.c_str(), &exceptionInfo );
1197 (void) SetPixelChannelMapMask( image(), channel_mask );
1198 replaceImage( newImage );
1199 throwException( exceptionInfo );
1200 (void) DestroyExceptionInfo( &exceptionInfo );
1203 // Gamma correct image
1204 void Magick::Image::gamma ( const double gamma_ )
1206 ExceptionInfo exceptionInfo;
1207 GetExceptionInfo( &exceptionInfo );
1209 GammaImage ( image(), gamma_, &exceptionInfo );
1210 throwException( exceptionInfo );
1211 (void) DestroyExceptionInfo( &exceptionInfo );
1214 void Magick::Image::gamma ( const double gammaRed_,
1215 const double gammaGreen_,
1216 const double gammaBlue_ )
1218 char gamma[MaxTextExtent + 1];
1219 FormatLocaleString( gamma, MaxTextExtent, "%3.6f/%3.6f/%3.6f/",
1220 gammaRed_, gammaGreen_, gammaBlue_);
1222 ExceptionInfo exceptionInfo;
1223 GetExceptionInfo( &exceptionInfo );
1225 GammaImage ( image(), atof(gamma), &exceptionInfo );
1226 throwException( exceptionInfo );
1227 (void) DestroyExceptionInfo( &exceptionInfo );
1230 // Gaussian blur image
1231 // The number of neighbor pixels to be included in the convolution
1232 // mask is specified by 'width_'. The standard deviation of the
1233 // gaussian bell curve is specified by 'sigma_'.
1234 void Magick::Image::gaussianBlur ( const double width_, const double sigma_ )
1236 ExceptionInfo exceptionInfo;
1237 GetExceptionInfo( &exceptionInfo );
1238 MagickCore::Image* newImage =
1239 GaussianBlurImage( image(), width_, sigma_, &exceptionInfo );
1240 replaceImage( newImage );
1241 throwException( exceptionInfo );
1242 (void) DestroyExceptionInfo( &exceptionInfo );
1245 void Magick::Image::gaussianBlurChannel ( const ChannelType channel_,
1246 const double width_,
1247 const double sigma_ )
1249 ExceptionInfo exceptionInfo;
1250 GetExceptionInfo( &exceptionInfo );
1251 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1252 MagickCore::Image* newImage =
1253 GaussianBlurImage( image(), width_, sigma_, &exceptionInfo );
1254 (void) SetPixelChannelMapMask( image(), channel_mask );
1255 replaceImage( newImage );
1256 throwException( exceptionInfo );
1257 (void) DestroyExceptionInfo( &exceptionInfo );
1260 // Apply a color lookup table (Hald CLUT) to the image.
1261 void Magick::Image::haldClut ( const Image &clutImage_ )
1263 ExceptionInfo exceptionInfo;
1264 GetExceptionInfo( &exceptionInfo );
1266 (void) HaldClutImage( image(), clutImage_.constImage(), &exceptionInfo );
1267 throwException( exceptionInfo );
1268 (void) DestroyExceptionInfo( &exceptionInfo );
1272 void Magick::Image::implode ( const double factor_ )
1274 ExceptionInfo exceptionInfo;
1275 GetExceptionInfo( &exceptionInfo );
1276 MagickCore::Image* newImage =
1277 ImplodeImage( image(), factor_, image()->interpolate, &exceptionInfo );
1278 replaceImage( newImage );
1279 throwException( exceptionInfo );
1280 (void) DestroyExceptionInfo( &exceptionInfo );
1283 // implements the inverse discrete Fourier transform (IFT) of the image either
1284 // as a magnitude / phase or real / imaginary image pair.
1285 void Magick::Image::inverseFourierTransform ( const Image &phase_ )
1287 ExceptionInfo exceptionInfo;
1288 GetExceptionInfo( &exceptionInfo );
1289 MagickCore::Image* newImage = InverseFourierTransformImage( image(),
1290 phase_.constImage(), MagickTrue, &exceptionInfo);
1291 replaceImage( newImage );
1292 throwException( exceptionInfo );
1293 (void) DestroyExceptionInfo( &exceptionInfo );
1295 void Magick::Image::inverseFourierTransform ( const Image &phase_,
1296 const bool magnitude_ )
1298 ExceptionInfo exceptionInfo;
1299 GetExceptionInfo( &exceptionInfo );
1300 MagickCore::Image* newImage = InverseFourierTransformImage( image(),
1301 phase_.constImage(), magnitude_ == true ? MagickTrue : MagickFalse,
1303 replaceImage( newImage );
1304 throwException( exceptionInfo );
1305 (void) DestroyExceptionInfo( &exceptionInfo );
1308 // Level image. Adjust the levels of the image by scaling the colors
1309 // falling between specified white and black points to the full
1310 // available quantum range. The parameters provided represent the
1311 // black, mid (gamma), and white points. The black point specifies
1312 // the darkest color in the image. Colors darker than the black point
1313 // are set to zero. Mid point (gamma) specifies a gamma correction to
1314 // apply to the image. White point specifies the lightest color in the
1315 // image. Colors brighter than the white point are set to the maximum
1316 // quantum value. The black and white point have the valid range 0 to
1317 // QuantumRange while gamma has a useful range of 0 to ten.
1318 void Magick::Image::level ( const double black_point,
1319 const double white_point,
1320 const double gamma )
1322 ExceptionInfo exceptionInfo;
1323 GetExceptionInfo( &exceptionInfo );
1325 (void) LevelImage( image(), black_point, white_point, gamma, &exceptionInfo );
1326 throwException( exceptionInfo );
1327 (void) DestroyExceptionInfo( &exceptionInfo );
1330 // Magnify image by integral size
1331 void Magick::Image::magnify ( void )
1333 ExceptionInfo exceptionInfo;
1334 GetExceptionInfo( &exceptionInfo );
1335 MagickCore::Image* newImage =
1336 MagnifyImage( image(), &exceptionInfo );
1337 replaceImage( newImage );
1338 throwException( exceptionInfo );
1339 (void) DestroyExceptionInfo( &exceptionInfo );
1342 // Remap image colors with closest color from reference image
1343 void Magick::Image::map ( const Image &mapImage_ , const bool dither_ )
1345 ExceptionInfo exceptionInfo;
1346 GetExceptionInfo( &exceptionInfo );
1348 options()->quantizeDither( dither_ );
1349 RemapImage ( options()->quantizeInfo(), image(),
1350 mapImage_.constImage(), &exceptionInfo);
1351 throwException( exceptionInfo );
1352 (void) DestroyExceptionInfo( &exceptionInfo );
1354 // Floodfill designated area with replacement alpha value
1355 void Magick::Image::matteFloodfill ( const Color &target_ ,
1356 const unsigned int alpha_,
1357 const ssize_t x_, const ssize_t y_,
1358 const Magick::PaintMethod method_ )
1362 GetPixelInfo(constImage(),&target);
1363 target.red=static_cast<PixelInfo>(target_).red;
1364 target.green=static_cast<PixelInfo>(target_).green;
1365 target.blue=static_cast<PixelInfo>(target_).blue;
1366 target.alpha=alpha_;
1367 ChannelType channel_mask = SetPixelChannelMask( image(), AlphaChannel );
1368 ExceptionInfo exceptionInfo;
1369 GetExceptionInfo( &exceptionInfo );
1370 FloodfillPaintImage ( image(), options()->drawInfo(), &target, x_, y_,
1371 method_ == FloodfillMethod ? MagickFalse : MagickTrue, &exceptionInfo);
1372 (void) SetPixelChannelMapMask( image(), channel_mask );
1373 throwException( exceptionInfo );
1374 (void) DestroyExceptionInfo( &exceptionInfo );
1377 // Filter image by replacing each pixel component with the median
1378 // color in a circular neighborhood
1379 void Magick::Image::medianFilter ( const double radius_ )
1381 ExceptionInfo exceptionInfo;
1382 GetExceptionInfo( &exceptionInfo );
1383 MagickCore::Image* newImage =
1384 StatisticImage ( image(), MedianStatistic, (size_t) radius_, (size_t)
1385 radius_,&exceptionInfo );
1386 replaceImage( newImage );
1387 throwException( exceptionInfo );
1388 (void) DestroyExceptionInfo( &exceptionInfo );
1391 // Reduce image by integral size
1392 void Magick::Image::minify ( void )
1394 ExceptionInfo exceptionInfo;
1395 GetExceptionInfo( &exceptionInfo );
1396 MagickCore::Image* newImage =
1397 MinifyImage( image(), &exceptionInfo );
1398 replaceImage( newImage );
1399 throwException( exceptionInfo );
1400 (void) DestroyExceptionInfo( &exceptionInfo );
1403 // Modulate percent hue, saturation, and brightness of an image
1404 void Magick::Image::modulate ( const double brightness_,
1405 const double saturation_,
1408 char modulate[MaxTextExtent + 1];
1409 FormatLocaleString( modulate, MaxTextExtent, "%3.6f,%3.6f,%3.6f",
1410 brightness_, saturation_, hue_);
1412 ExceptionInfo exceptionInfo;
1413 GetExceptionInfo( &exceptionInfo );
1415 ModulateImage( image(), modulate, &exceptionInfo );
1416 throwException( exceptionInfo );
1417 (void) DestroyExceptionInfo( &exceptionInfo );
1420 // Motion blur image with specified blur factor
1421 // The radius_ parameter specifies the radius of the Gaussian, in
1422 // pixels, not counting the center pixel. The sigma_ parameter
1423 // specifies the standard deviation of the Laplacian, in pixels.
1424 // The angle_ parameter specifies the angle the object appears
1425 // to be comming from (zero degrees is from the right).
1426 void Magick::Image::motionBlur ( const double radius_,
1427 const double sigma_,
1428 const double angle_ )
1430 ExceptionInfo exceptionInfo;
1431 GetExceptionInfo( &exceptionInfo );
1432 MagickCore::Image* newImage =
1433 MotionBlurImage( image(), radius_, sigma_, angle_, &exceptionInfo);
1434 replaceImage( newImage );
1435 throwException( exceptionInfo );
1436 (void) DestroyExceptionInfo( &exceptionInfo );
1439 // Negate image. Set grayscale_ to true to effect grayscale values
1441 void Magick::Image::negate ( const bool grayscale_ )
1443 ExceptionInfo exceptionInfo;
1444 GetExceptionInfo( &exceptionInfo );
1446 NegateImage ( image(), grayscale_ == true ? MagickTrue : MagickFalse,
1448 throwException( exceptionInfo );
1449 (void) DestroyExceptionInfo( &exceptionInfo );
1453 void Magick::Image::normalize ( void )
1456 ExceptionInfo exceptionInfo;
1457 GetExceptionInfo( &exceptionInfo );
1458 NormalizeImage ( image(), &exceptionInfo );
1459 throwException( exceptionInfo );
1460 (void) DestroyExceptionInfo( &exceptionInfo );
1464 void Magick::Image::oilPaint ( const double radius_, const double sigma_ )
1466 ExceptionInfo exceptionInfo;
1467 GetExceptionInfo( &exceptionInfo );
1468 MagickCore::Image* newImage =
1469 OilPaintImage( image(), radius_, sigma_, &exceptionInfo );
1470 replaceImage( newImage );
1471 throwException( exceptionInfo );
1472 (void) DestroyExceptionInfo( &exceptionInfo );
1475 // Set or attenuate the alpha channel. If the image pixels are
1476 // opaque then they are set to the specified alpha value, otherwise
1477 // they are blended with the supplied alpha value. The value of
1478 // alpha_ ranges from 0 (completely opaque) to QuantumRange. The defines
1479 // OpaqueAlpha and TransparentAlpha are available to specify
1480 // completely opaque or completely transparent, respectively.
1481 void Magick::Image::alpha ( const unsigned int alpha_ )
1484 ExceptionInfo exceptionInfo;
1485 GetExceptionInfo( &exceptionInfo );
1486 SetImageAlpha( image(), alpha_, &exceptionInfo );
1487 throwException( exceptionInfo );
1488 (void) DestroyExceptionInfo( &exceptionInfo );
1491 // Change the color of an opaque pixel to the pen color.
1492 void Magick::Image::opaque ( const Color &opaqueColor_,
1493 const Color &penColor_ )
1495 if ( !opaqueColor_.isValid() )
1497 throwExceptionExplicit( OptionError,
1498 "Opaque color argument is invalid" );
1500 if ( !penColor_.isValid() )
1502 throwExceptionExplicit( OptionError,
1503 "Pen color argument is invalid" );
1507 std::string opaqueColor = opaqueColor_;
1508 std::string penColor = penColor_;
1512 ExceptionInfo exceptionInfo;
1513 GetExceptionInfo( &exceptionInfo );
1514 (void) QueryColorCompliance(std::string(opaqueColor_).c_str(),
1515 AllCompliance, &opaque, &exceptionInfo);
1516 (void) QueryColorCompliance(std::string(penColor_).c_str(),
1517 AllCompliance, &pen, &exceptionInfo);
1518 OpaquePaintImage ( image(), &opaque, &pen, MagickFalse, &exceptionInfo );
1519 throwException( exceptionInfo );
1520 (void) DestroyExceptionInfo( &exceptionInfo );
1523 // Ping is similar to read except only enough of the image is read to
1524 // determine the image columns, rows, and filesize. Access the
1525 // columns(), rows(), and fileSize() attributes after invoking ping.
1526 // The image data is not valid after calling ping.
1527 void Magick::Image::ping ( const std::string &imageSpec_ )
1529 options()->fileName( imageSpec_ );
1530 ExceptionInfo exceptionInfo;
1531 GetExceptionInfo( &exceptionInfo );
1532 MagickCore::Image* image =
1533 PingImage( imageInfo(), &exceptionInfo );
1534 replaceImage( image );
1535 throwException( exceptionInfo );
1536 (void) DestroyExceptionInfo( &exceptionInfo );
1539 // Ping is similar to read except only enough of the image is read
1540 // to determine the image columns, rows, and filesize. Access the
1541 // columns(), rows(), and fileSize() attributes after invoking
1542 // ping. The image data is not valid after calling ping.
1543 void Magick::Image::ping ( const Blob& blob_ )
1545 ExceptionInfo exceptionInfo;
1546 GetExceptionInfo( &exceptionInfo );
1547 MagickCore::Image* image =
1548 PingBlob( imageInfo(), blob_.data(), blob_.length(), &exceptionInfo );
1549 replaceImage( image );
1550 throwException( exceptionInfo );
1551 (void) DestroyExceptionInfo( &exceptionInfo );
1554 // Execute a named process module using an argc/argv syntax similar to
1555 // that accepted by a C 'main' routine. An exception is thrown if the
1556 // requested process module doesn't exist, fails to load, or fails during
1558 void Magick::Image::process( std::string name_, const ssize_t argc, const char **argv )
1562 ExceptionInfo exceptionInfo;
1563 GetExceptionInfo( &exceptionInfo );
1565 InvokeDynamicImageFilter( name_.c_str(), &image(), argc, argv,
1568 throwException( exceptionInfo );
1569 (void) DestroyExceptionInfo( &exceptionInfo );
1572 // Quantize colors in image using current quantization settings
1573 // Set measureError_ to true in order to measure quantization error
1574 void Magick::Image::quantize ( const bool measureError_ )
1579 options()->quantizeInfo()->measure_error=MagickTrue;
1581 options()->quantizeInfo()->measure_error=MagickFalse;
1583 ExceptionInfo exceptionInfo;
1584 GetExceptionInfo( &exceptionInfo );
1585 QuantizeImage( options()->quantizeInfo(), image(), &exceptionInfo );
1587 throwException( exceptionInfo );
1588 (void) DestroyExceptionInfo( &exceptionInfo );
1591 // Apply an arithmetic or bitwise operator to the image pixel quantums.
1592 void Magick::Image::quantumOperator ( const ChannelType channel_,
1593 const MagickEvaluateOperator operator_,
1596 ExceptionInfo exceptionInfo;
1597 GetExceptionInfo( &exceptionInfo );
1598 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1599 EvaluateImage( image(), operator_, rvalue_, &exceptionInfo);
1600 (void) SetPixelChannelMapMask( image(), channel_mask );
1601 throwException( exceptionInfo );
1602 (void) DestroyExceptionInfo( &exceptionInfo );
1605 void Magick::Image::quantumOperator ( const ssize_t x_,const ssize_t y_,
1606 const size_t columns_,
1608 const ChannelType channel_,
1609 const MagickEvaluateOperator operator_,
1610 const double rvalue_)
1612 ExceptionInfo exceptionInfo;
1613 GetExceptionInfo( &exceptionInfo );
1614 RectangleInfo geometry;
1615 geometry.width = columns_;
1616 geometry.height = rows_;
1619 MagickCore::Image *crop_image = CropImage( image(), &geometry,
1621 ChannelType channel_mask = SetPixelChannelMask( image(), channel_);
1622 EvaluateImage( crop_image, operator_, rvalue_, &exceptionInfo );
1623 (void) SetPixelChannelMapMask( image(), channel_mask );
1624 (void) CompositeImage( image(), crop_image, image()->matte != MagickFalse ?
1625 OverCompositeOp : CopyCompositeOp, MagickFalse, geometry.x, geometry.y,
1627 crop_image = DestroyImageList(crop_image);
1628 throwException( exceptionInfo );
1629 (void) DestroyExceptionInfo( &exceptionInfo );
1632 // Raise image (lighten or darken the edges of an image to give a 3-D
1633 // raised or lowered effect)
1634 void Magick::Image::raise ( const Geometry &geometry_ ,
1635 const bool raisedFlag_ )
1637 ExceptionInfo exceptionInfo;
1638 GetExceptionInfo( &exceptionInfo );
1639 RectangleInfo raiseInfo = geometry_;
1641 RaiseImage ( image(), &raiseInfo, raisedFlag_ == true ? MagickTrue : MagickFalse, &exceptionInfo );
1642 throwException( exceptionInfo );
1643 (void) DestroyExceptionInfo( &exceptionInfo );
1647 // Random threshold image.
1649 // Changes the value of individual pixels based on the intensity
1650 // of each pixel compared to a random threshold. The result is a
1651 // low-contrast, two color image. The thresholds_ argument is a
1652 // geometry containing LOWxHIGH thresholds. If the string
1653 // contains 2x2, 3x3, or 4x4, then an ordered dither of order 2,
1654 // 3, or 4 will be performed instead. If a channel_ argument is
1655 // specified then only the specified channel is altered. This is
1656 // a very fast alternative to 'quantize' based dithering.
1657 void Magick::Image::randomThreshold( const Geometry &thresholds_ )
1659 randomThresholdChannel(thresholds_,DefaultChannels);
1661 void Magick::Image::randomThresholdChannel( const Geometry &thresholds_,
1662 const ChannelType channel_ )
1664 ExceptionInfo exceptionInfo;
1665 GetExceptionInfo( &exceptionInfo );
1667 ChannelType channel_mask = SetPixelChannelMask( image(), channel_);
1668 (void) RandomThresholdImage( image(),
1669 static_cast<std::string>(thresholds_).c_str(),
1671 (void) SetPixelChannelMapMask( image(), channel_mask );
1672 throwImageException();
1673 (void) DestroyExceptionInfo( &exceptionInfo );
1676 // Read image into current object
1677 void Magick::Image::read ( const std::string &imageSpec_ )
1679 options()->fileName( imageSpec_ );
1681 ExceptionInfo exceptionInfo;
1682 GetExceptionInfo( &exceptionInfo );
1683 MagickCore::Image* image =
1684 ReadImage( imageInfo(), &exceptionInfo );
1686 // Ensure that multiple image frames were not read.
1687 if ( image && image->next )
1689 // Destroy any extra image frames
1690 MagickCore::Image* next = image->next;
1693 DestroyImageList( next );
1696 replaceImage( image );
1697 throwException( exceptionInfo );
1698 (void) DestroyExceptionInfo( &exceptionInfo );
1701 // Read image of specified size into current object
1702 void Magick::Image::read ( const Geometry &size_,
1703 const std::string &imageSpec_ )
1709 // Read image from in-memory BLOB
1710 void Magick::Image::read ( const Blob &blob_ )
1712 ExceptionInfo exceptionInfo;
1713 GetExceptionInfo( &exceptionInfo );
1714 MagickCore::Image* image =
1715 BlobToImage( imageInfo(),
1716 static_cast<const void *>(blob_.data()),
1717 blob_.length(), &exceptionInfo );
1718 replaceImage( image );
1719 throwException( exceptionInfo );
1720 (void) DestroyExceptionInfo( &exceptionInfo );
1723 // Read image of specified size from in-memory BLOB
1724 void Magick::Image::read ( const Blob &blob_,
1725 const Geometry &size_ )
1733 // Read image of specified size and depth from in-memory BLOB
1734 void Magick::Image::read ( const Blob &blob_,
1735 const Geometry &size_,
1736 const size_t depth_ )
1746 // Read image of specified size, depth, and format from in-memory BLOB
1747 void Magick::Image::read ( const Blob &blob_,
1748 const Geometry &size_,
1749 const size_t depth_,
1750 const std::string &magick_ )
1758 // Set explicit image format
1759 fileName( magick_ + ':');
1764 // Read image of specified size, and format from in-memory BLOB
1765 void Magick::Image::read ( const Blob &blob_,
1766 const Geometry &size_,
1767 const std::string &magick_ )
1773 // Set explicit image format
1774 fileName( magick_ + ':');
1779 // Read image based on raw pixels in memory (ConstituteImage)
1780 void Magick::Image::read ( const size_t width_,
1781 const size_t height_,
1782 const std::string &map_,
1783 const StorageType type_,
1784 const void *pixels_ )
1786 ExceptionInfo exceptionInfo;
1787 GetExceptionInfo( &exceptionInfo );
1788 MagickCore::Image* image =
1789 ConstituteImage( width_, height_, map_.c_str(), type_, pixels_,
1791 replaceImage( image );
1792 throwException( exceptionInfo );
1793 (void) DestroyExceptionInfo( &exceptionInfo );
1796 // Reduce noise in image
1797 void Magick::Image::reduceNoise ( const double order_ )
1799 ExceptionInfo exceptionInfo;
1800 GetExceptionInfo( &exceptionInfo );
1801 MagickCore::Image* newImage =
1802 StatisticImage( image(), NonpeakStatistic, (size_t) order_, (size_t) order_,
1804 replaceImage( newImage );
1805 throwException( exceptionInfo );
1806 (void) DestroyExceptionInfo( &exceptionInfo );
1810 void Magick::Image::resize( const Geometry &geometry_ )
1812 // Calculate new size. This code should be supported using binary arguments
1813 // in the ImageMagick library.
1816 size_t width = columns();
1817 size_t height = rows();
1819 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1823 ExceptionInfo exceptionInfo;
1824 GetExceptionInfo( &exceptionInfo );
1825 MagickCore::Image* newImage =
1826 ResizeImage( image(),
1831 replaceImage( newImage );
1832 throwException( exceptionInfo );
1833 (void) DestroyExceptionInfo( &exceptionInfo );
1837 void Magick::Image::roll ( const Geometry &roll_ )
1839 ssize_t xOff = roll_.xOff();
1840 if ( roll_.xNegative() )
1842 ssize_t yOff = roll_.yOff();
1843 if ( roll_.yNegative() )
1846 ExceptionInfo exceptionInfo;
1847 GetExceptionInfo( &exceptionInfo );
1848 MagickCore::Image* newImage =
1849 RollImage( image(), xOff, yOff, &exceptionInfo );
1850 replaceImage( newImage );
1851 throwException( exceptionInfo );
1852 (void) DestroyExceptionInfo( &exceptionInfo );
1854 void Magick::Image::roll ( const size_t columns_,
1855 const size_t rows_ )
1857 ExceptionInfo exceptionInfo;
1858 GetExceptionInfo( &exceptionInfo );
1859 MagickCore::Image* newImage =
1861 static_cast<ssize_t>(columns_),
1862 static_cast<ssize_t>(rows_), &exceptionInfo );
1863 replaceImage( newImage );
1864 throwException( exceptionInfo );
1865 (void) DestroyExceptionInfo( &exceptionInfo );
1869 void Magick::Image::rotate ( const double degrees_ )
1871 ExceptionInfo exceptionInfo;
1872 GetExceptionInfo( &exceptionInfo );
1873 MagickCore::Image* newImage =
1874 RotateImage( image(), degrees_, &exceptionInfo);
1875 replaceImage( newImage );
1876 throwException( exceptionInfo );
1877 (void) DestroyExceptionInfo( &exceptionInfo );
1881 void Magick::Image::sample ( const Geometry &geometry_ )
1885 size_t width = columns();
1886 size_t height = rows();
1888 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1892 ExceptionInfo exceptionInfo;
1893 GetExceptionInfo( &exceptionInfo );
1894 MagickCore::Image* newImage =
1895 SampleImage( image(), width, height, &exceptionInfo );
1896 replaceImage( newImage );
1897 throwException( exceptionInfo );
1898 (void) DestroyExceptionInfo( &exceptionInfo );
1902 void Magick::Image::scale ( const Geometry &geometry_ )
1906 size_t width = columns();
1907 size_t height = rows();
1909 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1913 ExceptionInfo exceptionInfo;
1914 GetExceptionInfo( &exceptionInfo );
1915 MagickCore::Image* newImage =
1916 ScaleImage( image(), width, height, &exceptionInfo );
1917 replaceImage( newImage );
1918 throwException( exceptionInfo );
1919 (void) DestroyExceptionInfo( &exceptionInfo );
1922 // Segment (coalesce similar image components) by analyzing the
1923 // histograms of the color components and identifying units that are
1924 // homogeneous with the fuzzy c-means technique.
1925 void Magick::Image::segment ( const double clusterThreshold_,
1926 const double smoothingThreshold_ )
1928 ExceptionInfo exceptionInfo;
1929 GetExceptionInfo( &exceptionInfo );
1931 SegmentImage ( image(),
1932 options()->quantizeColorSpace(),
1933 (MagickBooleanType) options()->verbose(),
1935 smoothingThreshold_, &exceptionInfo );
1936 SyncImage( image(), &exceptionInfo );
1937 throwException( exceptionInfo );
1938 (void) DestroyExceptionInfo( &exceptionInfo );
1941 // Shade image using distant light source
1942 void Magick::Image::shade ( const double azimuth_,
1943 const double elevation_,
1944 const bool colorShading_ )
1946 ExceptionInfo exceptionInfo;
1947 GetExceptionInfo( &exceptionInfo );
1948 MagickCore::Image* newImage =
1949 ShadeImage( image(),
1950 colorShading_ == true ? MagickTrue : MagickFalse,
1954 replaceImage( newImage );
1955 throwException( exceptionInfo );
1956 (void) DestroyExceptionInfo( &exceptionInfo );
1959 // Simulate an image shadow
1960 void Magick::Image::shadow( const double percent_opacity_, const double sigma_,
1961 const ssize_t x_, const ssize_t y_ )
1963 ExceptionInfo exceptionInfo;
1964 GetExceptionInfo( &exceptionInfo );
1965 MagickCore::Image* newImage = ShadowImage( image(), percent_opacity_, sigma_,
1966 x_, y_, &exceptionInfo );
1967 replaceImage( newImage );
1968 throwException( exceptionInfo );
1969 (void) DestroyExceptionInfo( &exceptionInfo );
1972 // Sharpen pixels in image
1973 void Magick::Image::sharpen ( const double radius_, const double sigma_ )
1975 ExceptionInfo exceptionInfo;
1976 GetExceptionInfo( &exceptionInfo );
1977 MagickCore::Image* newImage =
1978 SharpenImage( image(),
1982 replaceImage( newImage );
1983 throwException( exceptionInfo );
1984 (void) DestroyExceptionInfo( &exceptionInfo );
1987 void Magick::Image::sharpenChannel ( const ChannelType channel_,
1988 const double radius_, const double sigma_ )
1990 ExceptionInfo exceptionInfo;
1991 GetExceptionInfo( &exceptionInfo );
1992 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1993 MagickCore::Image* newImage =
1994 SharpenImage( image(),
1998 (void) SetPixelChannelMapMask( image(), channel_mask );
1999 replaceImage( newImage );
2000 throwException( exceptionInfo );
2001 (void) DestroyExceptionInfo( &exceptionInfo );
2004 // Shave pixels from image edges.
2005 void Magick::Image::shave ( const Geometry &geometry_ )
2007 RectangleInfo shaveInfo = geometry_;
2008 ExceptionInfo exceptionInfo;
2009 GetExceptionInfo( &exceptionInfo );
2010 MagickCore::Image* newImage =
2011 ShaveImage( image(),
2014 replaceImage( newImage );
2015 throwException( exceptionInfo );
2016 (void) DestroyExceptionInfo( &exceptionInfo );
2020 void Magick::Image::shear ( const double xShearAngle_,
2021 const double yShearAngle_ )
2023 ExceptionInfo exceptionInfo;
2024 GetExceptionInfo( &exceptionInfo );
2025 MagickCore::Image* newImage =
2026 ShearImage( image(),
2030 replaceImage( newImage );
2031 throwException( exceptionInfo );
2032 (void) DestroyExceptionInfo( &exceptionInfo );
2036 void Magick::Image::sigmoidalContrast ( const size_t sharpen_, const double contrast, const double midpoint )
2038 ExceptionInfo exceptionInfo;
2039 GetExceptionInfo( &exceptionInfo );
2041 (void) SigmoidalContrastImage( image(), (MagickBooleanType) sharpen_, contrast, midpoint, &exceptionInfo );
2042 throwException( exceptionInfo );
2043 (void) DestroyExceptionInfo( &exceptionInfo );
2046 // Solarize image (similar to effect seen when exposing a photographic
2047 // film to light during the development process)
2048 void Magick::Image::solarize ( const double factor_ )
2050 ExceptionInfo exceptionInfo;
2051 GetExceptionInfo( &exceptionInfo );
2053 SolarizeImage ( image(), factor_, &exceptionInfo );
2054 throwException( exceptionInfo );
2055 (void) DestroyExceptionInfo( &exceptionInfo );
2058 // Sparse color image, given a set of coordinates, interpolates the colors
2059 // found at those coordinates, across the whole image, using various methods.
2061 void Magick::Image::sparseColor ( const ChannelType channel,
2062 const SparseColorMethod method,
2063 const size_t number_arguments,
2064 const double *arguments )
2066 ExceptionInfo exceptionInfo;
2067 GetExceptionInfo( &exceptionInfo );
2069 ChannelType channel_mask = SetPixelChannelMask( image(), channel );
2070 MagickCore::Image* newImage = SparseColorImage ( image(), method,
2071 number_arguments, arguments, &exceptionInfo );
2072 (void) SetPixelChannelMapMask( image(), channel_mask );
2073 replaceImage( newImage );
2074 throwException( exceptionInfo );
2075 (void) DestroyExceptionInfo( &exceptionInfo );
2078 // Spread pixels randomly within image by specified ammount
2079 void Magick::Image::spread ( const size_t amount_ )
2081 ExceptionInfo exceptionInfo;
2082 GetExceptionInfo( &exceptionInfo );
2083 MagickCore::Image* newImage =
2084 SpreadImage( image(),
2086 image()->interpolate,
2088 replaceImage( newImage );
2089 throwException( exceptionInfo );
2090 (void) DestroyExceptionInfo( &exceptionInfo );
2093 // Add a digital watermark to the image (based on second image)
2094 void Magick::Image::stegano ( const Image &watermark_ )
2096 ExceptionInfo exceptionInfo;
2097 GetExceptionInfo( &exceptionInfo );
2098 MagickCore::Image* newImage =
2099 SteganoImage( image(),
2100 watermark_.constImage(),
2102 replaceImage( newImage );
2103 throwException( exceptionInfo );
2104 (void) DestroyExceptionInfo( &exceptionInfo );
2107 // Stereo image (left image is current image)
2108 void Magick::Image::stereo ( const Image &rightImage_ )
2110 ExceptionInfo exceptionInfo;
2111 GetExceptionInfo( &exceptionInfo );
2112 MagickCore::Image* newImage =
2113 StereoImage( image(),
2114 rightImage_.constImage(),
2116 replaceImage( newImage );
2117 throwException( exceptionInfo );
2118 (void) DestroyExceptionInfo( &exceptionInfo );
2122 void Magick::Image::swirl ( const double degrees_ )
2124 ExceptionInfo exceptionInfo;
2125 GetExceptionInfo( &exceptionInfo );
2126 MagickCore::Image* newImage =
2127 SwirlImage( image(), degrees_, image()->interpolate,
2129 replaceImage( newImage );
2130 throwException( exceptionInfo );
2131 (void) DestroyExceptionInfo( &exceptionInfo );
2135 void Magick::Image::texture ( const Image &texture_ )
2138 ExceptionInfo exceptionInfo;
2139 GetExceptionInfo( &exceptionInfo );
2140 TextureImage( image(), texture_.constImage(), &exceptionInfo );
2141 throwException( exceptionInfo );
2142 (void) DestroyExceptionInfo( &exceptionInfo );
2146 void Magick::Image::threshold ( const double threshold_ )
2149 ExceptionInfo exceptionInfo;
2150 GetExceptionInfo( &exceptionInfo );
2151 BilevelImage( image(), threshold_, &exceptionInfo );
2152 throwException( exceptionInfo );
2153 (void) DestroyExceptionInfo( &exceptionInfo );
2156 // Transform image based on image geometry only
2157 void Magick::Image::transform ( const Geometry &imageGeometry_ )
2160 ExceptionInfo exceptionInfo;
2161 GetExceptionInfo( &exceptionInfo );
2162 TransformImage ( &(image()), 0,
2163 std::string(imageGeometry_).c_str(), &exceptionInfo );
2164 throwException( exceptionInfo );
2165 (void) DestroyExceptionInfo( &exceptionInfo );
2167 // Transform image based on image and crop geometries
2168 void Magick::Image::transform ( const Geometry &imageGeometry_,
2169 const Geometry &cropGeometry_ )
2172 ExceptionInfo exceptionInfo;
2173 GetExceptionInfo( &exceptionInfo );
2174 TransformImage ( &(image()), std::string(cropGeometry_).c_str(),
2175 std::string(imageGeometry_).c_str(), &exceptionInfo );
2176 throwException( exceptionInfo );
2177 (void) DestroyExceptionInfo( &exceptionInfo );
2180 // Add matte image to image, setting pixels matching color to transparent
2181 void Magick::Image::transparent ( const Color &color_ )
2183 if ( !color_.isValid() )
2185 throwExceptionExplicit( OptionError,
2186 "Color argument is invalid" );
2189 std::string color = color_;
2192 ExceptionInfo exceptionInfo;
2193 GetExceptionInfo( &exceptionInfo );
2194 (void) QueryColorCompliance(std::string(color_).c_str(),AllCompliance,
2195 &target,&exceptionInfo);
2197 TransparentPaintImage ( image(), &target, TransparentAlpha, MagickFalse,
2199 throwException( exceptionInfo );
2200 (void) DestroyExceptionInfo( &exceptionInfo );
2203 // Add matte image to image, setting pixels matching color to transparent
2204 void Magick::Image::transparentChroma(const Color &colorLow_,
2205 const Color &colorHigh_)
2207 if ( !colorLow_.isValid() || !colorHigh_.isValid() )
2209 throwExceptionExplicit( OptionError,
2210 "Color argument is invalid" );
2213 std::string colorLow = colorLow_;
2214 std::string colorHigh = colorHigh_;
2216 PixelInfo targetLow;
2217 PixelInfo targetHigh;
2218 ExceptionInfo exceptionInfo;
2219 GetExceptionInfo( &exceptionInfo );
2220 (void) QueryColorCompliance(std::string(colorLow_).c_str(),
2221 AllCompliance,&targetLow,&exceptionInfo);
2222 (void) QueryColorCompliance(std::string(colorHigh_).c_str(),
2223 AllCompliance,&targetHigh,&exceptionInfo);
2225 TransparentPaintImageChroma ( image(), &targetLow, &targetHigh,
2226 TransparentAlpha, MagickFalse, &exceptionInfo );
2227 throwException( exceptionInfo );
2228 (void) DestroyExceptionInfo( &exceptionInfo );
2232 // Trim edges that are the background color from the image
2233 void Magick::Image::trim ( void )
2235 ExceptionInfo exceptionInfo;
2236 GetExceptionInfo( &exceptionInfo );
2237 MagickCore::Image* newImage =
2238 TrimImage( image(), &exceptionInfo);
2239 replaceImage( newImage );
2240 throwException( exceptionInfo );
2241 (void) DestroyExceptionInfo( &exceptionInfo );
2244 // Replace image with a sharpened version of the original image
2245 // using the unsharp mask algorithm.
2247 // the radius of the Gaussian, in pixels, not counting the
2250 // the standard deviation of the Gaussian, in pixels.
2252 // the percentage of the difference between the original and
2253 // the blur image that is added back into the original.
2255 // the threshold in pixels needed to apply the diffence amount.
2256 void Magick::Image::unsharpmask ( const double radius_,
2257 const double sigma_,
2258 const double amount_,
2259 const double threshold_ )
2261 ExceptionInfo exceptionInfo;
2262 GetExceptionInfo( &exceptionInfo );
2263 MagickCore::Image* newImage =
2264 UnsharpMaskImage( image(),
2270 replaceImage( newImage );
2271 throwException( exceptionInfo );
2272 (void) DestroyExceptionInfo( &exceptionInfo );
2275 void Magick::Image::unsharpmaskChannel ( const ChannelType channel_,
2276 const double radius_,
2277 const double sigma_,
2278 const double amount_,
2279 const double threshold_ )
2281 ExceptionInfo exceptionInfo;
2282 GetExceptionInfo( &exceptionInfo );
2283 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
2284 MagickCore::Image* newImage =
2285 UnsharpMaskImage( image(),
2291 (void) SetPixelChannelMapMask( image(), channel_mask );
2292 replaceImage( newImage );
2293 throwException( exceptionInfo );
2294 (void) DestroyExceptionInfo( &exceptionInfo );
2297 // Map image pixels to a sine wave
2298 void Magick::Image::wave ( const double amplitude_, const double wavelength_ )
2300 ExceptionInfo exceptionInfo;
2301 GetExceptionInfo( &exceptionInfo );
2302 MagickCore::Image* newImage =
2306 image()->interpolate,
2308 replaceImage( newImage );
2309 throwException( exceptionInfo );
2310 (void) DestroyExceptionInfo( &exceptionInfo );
2313 // Write image to file
2314 void Magick::Image::write( const std::string &imageSpec_ )
2316 ExceptionInfo exceptionInfo;
2317 GetExceptionInfo( &exceptionInfo );
2319 fileName( imageSpec_ );
2320 WriteImage( imageInfo(), image(), &exceptionInfo );
2321 throwException( exceptionInfo );
2322 (void) DestroyExceptionInfo( &exceptionInfo );
2325 // Write image to in-memory BLOB
2326 void Magick::Image::write ( Blob *blob_ )
2329 size_t length = 2048; // Efficient size for small images
2330 ExceptionInfo exceptionInfo;
2331 GetExceptionInfo( &exceptionInfo );
2332 void* data = ImageToBlob( imageInfo(),
2336 throwException( exceptionInfo );
2337 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2338 throwImageException();
2339 (void) DestroyExceptionInfo( &exceptionInfo );
2341 void Magick::Image::write ( Blob *blob_,
2342 const std::string &magick_ )
2346 size_t length = 2048; // Efficient size for small images
2347 ExceptionInfo exceptionInfo;
2348 GetExceptionInfo( &exceptionInfo );
2349 void* data = ImageToBlob( imageInfo(),
2353 throwException( exceptionInfo );
2354 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2355 throwImageException();
2356 (void) DestroyExceptionInfo( &exceptionInfo );
2358 void Magick::Image::write ( Blob *blob_,
2359 const std::string &magick_,
2360 const size_t depth_ )
2365 size_t length = 2048; // Efficient size for small images
2366 ExceptionInfo exceptionInfo;
2367 GetExceptionInfo( &exceptionInfo );
2368 void* data = ImageToBlob( imageInfo(),
2372 throwException( exceptionInfo );
2373 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2374 throwImageException();
2375 (void) DestroyExceptionInfo( &exceptionInfo );
2378 // Write image to an array of pixels with storage type specified
2379 // by user (ExportImagePixels), e.g.
2380 // image.write( 0, 0, 640, 1, "RGB", 0, pixels );
2381 void Magick::Image::write ( const ssize_t x_,
2383 const size_t columns_,
2385 const std::string &map_,
2386 const StorageType type_,
2389 ExceptionInfo exceptionInfo;
2390 GetExceptionInfo( &exceptionInfo );
2391 ExportImagePixels( image(), x_, y_, columns_, rows_, map_.c_str(), type_,
2394 throwException( exceptionInfo );
2395 (void) DestroyExceptionInfo( &exceptionInfo );
2399 void Magick::Image::zoom( const Geometry &geometry_ )
2401 // Calculate new size. This code should be supported using binary arguments
2402 // in the ImageMagick library.
2405 size_t width = columns();
2406 size_t height = rows();
2408 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
2412 ExceptionInfo exceptionInfo;
2413 GetExceptionInfo( &exceptionInfo );
2414 MagickCore::Image* newImage =
2415 ResizeImage( image(),
2420 replaceImage( newImage );
2421 throwException( exceptionInfo );
2422 (void) DestroyExceptionInfo( &exceptionInfo );
2426 * Methods for setting image attributes
2430 // Join images into a single multi-image file
2431 void Magick::Image::adjoin ( const bool flag_ )
2434 options()->adjoin( flag_ );
2436 bool Magick::Image::adjoin ( void ) const
2438 return constOptions()->adjoin();
2441 // Remove pixel aliasing
2442 void Magick::Image::antiAlias( const bool flag_ )
2445 options()->antiAlias( static_cast<size_t>(flag_) );
2447 bool Magick::Image::antiAlias( void )
2449 return static_cast<bool>( options()->antiAlias( ) );
2452 // Animation inter-frame delay
2453 void Magick::Image::animationDelay ( const size_t delay_ )
2456 image()->delay = delay_;
2458 size_t Magick::Image::animationDelay ( void ) const
2460 return constImage()->delay;
2463 // Number of iterations to play animation
2464 void Magick::Image::animationIterations ( const size_t iterations_ )
2467 image()->iterations = iterations_;
2469 size_t Magick::Image::animationIterations ( void ) const
2471 return constImage()->iterations;
2474 // Access/Update a named image attribute
2475 void Magick::Image::attribute ( const std::string name_,
2476 const std::string value_ )
2479 ExceptionInfo exceptionInfo;
2480 GetExceptionInfo( &exceptionInfo );
2481 SetImageProperty( image(), name_.c_str(), value_.c_str(), &exceptionInfo );
2482 throwException( exceptionInfo );
2483 (void) DestroyExceptionInfo( &exceptionInfo );
2485 std::string Magick::Image::attribute ( const std::string name_ )
2487 ExceptionInfo exceptionInfo;
2488 GetExceptionInfo( &exceptionInfo );
2489 const char *value = GetImageProperty( constImage(), name_.c_str(),
2491 throwException( exceptionInfo );
2492 (void) DestroyExceptionInfo( &exceptionInfo );
2495 return std::string( value );
2497 return std::string(); // Intentionally no exception
2501 void Magick::Image::backgroundColor ( const Color &backgroundColor_ )
2505 if ( backgroundColor_.isValid() )
2507 image()->background_color = backgroundColor_;
2511 image()->background_color = Color();
2514 options()->backgroundColor( backgroundColor_ );
2516 Magick::Color Magick::Image::backgroundColor ( void ) const
2518 return constOptions()->backgroundColor( );
2521 // Background fill texture
2522 void Magick::Image::backgroundTexture ( const std::string &backgroundTexture_ )
2525 options()->backgroundTexture( backgroundTexture_ );
2527 std::string Magick::Image::backgroundTexture ( void ) const
2529 return constOptions()->backgroundTexture( );
2532 // Original image columns
2533 size_t Magick::Image::baseColumns ( void ) const
2535 return constImage()->magick_columns;
2538 // Original image name
2539 std::string Magick::Image::baseFilename ( void ) const
2541 return std::string(constImage()->magick_filename);
2544 // Original image rows
2545 size_t Magick::Image::baseRows ( void ) const
2547 return constImage()->magick_rows;
2551 void Magick::Image::borderColor ( const Color &borderColor_ )
2555 if ( borderColor_.isValid() )
2557 image()->border_color = borderColor_;
2561 image()->border_color = Color();
2564 options()->borderColor( borderColor_ );
2566 Magick::Color Magick::Image::borderColor ( void ) const
2568 return constOptions()->borderColor( );
2571 // Return smallest bounding box enclosing non-border pixels. The
2572 // current fuzz value is used when discriminating between pixels.
2573 // This is the crop bounding box used by crop(Geometry(0,0));
2574 Magick::Geometry Magick::Image::boundingBox ( void ) const
2576 ExceptionInfo exceptionInfo;
2577 GetExceptionInfo( &exceptionInfo );
2578 RectangleInfo bbox = GetImageBoundingBox( constImage(), &exceptionInfo);
2579 throwException( exceptionInfo );
2580 (void) DestroyExceptionInfo( &exceptionInfo );
2581 return Geometry( bbox );
2584 // Text bounding-box base color
2585 void Magick::Image::boxColor ( const Color &boxColor_ )
2588 options()->boxColor( boxColor_ );
2590 Magick::Color Magick::Image::boxColor ( void ) const
2592 return constOptions()->boxColor( );
2595 // Pixel cache threshold. Once this threshold is exceeded, all
2596 // subsequent pixels cache operations are to/from disk.
2597 // This setting is shared by all Image objects.
2599 void Magick::Image::cacheThreshold ( const size_t threshold_ )
2601 SetMagickResourceLimit( MemoryResource, threshold_ );
2604 void Magick::Image::chromaBluePrimary ( const double x_, const double y_ )
2607 image()->chromaticity.blue_primary.x = x_;
2608 image()->chromaticity.blue_primary.y = y_;
2610 void Magick::Image::chromaBluePrimary ( double *x_, double *y_ ) const
2612 *x_ = constImage()->chromaticity.blue_primary.x;
2613 *y_ = constImage()->chromaticity.blue_primary.y;
2616 void Magick::Image::chromaGreenPrimary ( const double x_, const double y_ )
2619 image()->chromaticity.green_primary.x = x_;
2620 image()->chromaticity.green_primary.y = y_;
2622 void Magick::Image::chromaGreenPrimary ( double *x_, double *y_ ) const
2624 *x_ = constImage()->chromaticity.green_primary.x;
2625 *y_ = constImage()->chromaticity.green_primary.y;
2628 void Magick::Image::chromaRedPrimary ( const double x_, const double y_ )
2631 image()->chromaticity.red_primary.x = x_;
2632 image()->chromaticity.red_primary.y = y_;
2634 void Magick::Image::chromaRedPrimary ( double *x_, double *y_ ) const
2636 *x_ = constImage()->chromaticity.red_primary.x;
2637 *y_ = constImage()->chromaticity.red_primary.y;
2640 void Magick::Image::chromaWhitePoint ( const double x_, const double y_ )
2643 image()->chromaticity.white_point.x = x_;
2644 image()->chromaticity.white_point.y = y_;
2646 void Magick::Image::chromaWhitePoint ( double *x_, double *y_ ) const
2648 *x_ = constImage()->chromaticity.white_point.x;
2649 *y_ = constImage()->chromaticity.white_point.y;
2652 // Set image storage class
2653 void Magick::Image::classType ( const ClassType class_ )
2655 if ( classType() == PseudoClass && class_ == DirectClass )
2657 // Use SyncImage to synchronize the DirectClass pixels with the
2658 // color map and then set to DirectClass type.
2660 ExceptionInfo exceptionInfo;
2661 GetExceptionInfo( &exceptionInfo );
2662 SyncImage( image(), &exceptionInfo );
2663 throwException( exceptionInfo );
2664 (void) DestroyExceptionInfo( &exceptionInfo );
2665 image()->colormap = (PixelInfo *)
2666 RelinquishMagickMemory( image()->colormap );
2667 image()->storage_class = static_cast<MagickCore::ClassType>(DirectClass);
2671 if ( classType() == DirectClass && class_ == PseudoClass )
2673 // Quantize to create PseudoClass color map
2675 quantizeColors(MaxColormapSize);
2677 image()->storage_class = static_cast<MagickCore::ClassType>(PseudoClass);
2681 // Associate a clip mask with the image. The clip mask must be the
2682 // same dimensions as the image. Pass an invalid image to unset an
2683 // existing clip mask.
2684 void Magick::Image::clipMask ( const Magick::Image & clipMask_ )
2688 ExceptionInfo exceptionInfo;
2689 GetExceptionInfo( &exceptionInfo );
2690 if( clipMask_.isValid() )
2693 SetImageMask( image(), clipMask_.constImage(), &exceptionInfo );
2697 // Unset existing clip mask
2698 SetImageMask( image(), 0, &exceptionInfo );
2700 throwException( exceptionInfo );
2701 (void) DestroyExceptionInfo( &exceptionInfo );
2703 Magick::Image Magick::Image::clipMask ( void ) const
2705 ExceptionInfo exceptionInfo;
2706 GetExceptionInfo( &exceptionInfo );
2707 MagickCore::Image* image = GetImageMask( constImage(), &exceptionInfo );
2708 throwException( exceptionInfo );
2709 (void) DestroyExceptionInfo( &exceptionInfo );
2710 return Magick::Image( image );
2713 void Magick::Image::colorFuzz ( const double fuzz_ )
2716 image()->fuzz = fuzz_;
2717 options()->colorFuzz( fuzz_ );
2719 double Magick::Image::colorFuzz ( void ) const
2721 return constOptions()->colorFuzz( );
2724 // Set color in colormap at index
2725 void Magick::Image::colorMap ( const size_t index_,
2726 const Color &color_ )
2728 MagickCore::Image* imageptr = image();
2730 if (index_ > (MaxColormapSize-1) )
2731 throwExceptionExplicit( OptionError,
2732 "Colormap index must be less than MaxColormapSize" );
2734 if ( !color_.isValid() )
2735 throwExceptionExplicit( OptionError,
2736 "Color argument is invalid");
2739 // Ensure that colormap size is large enough
2740 if ( colorMapSize() < (index_+1) )
2741 colorMapSize( index_ + 1 );
2743 // Set color at index in colormap
2744 (imageptr->colormap)[index_] = color_;
2746 // Return color in colormap at index
2747 Magick::Color Magick::Image::colorMap ( const size_t index_ ) const
2749 const MagickCore::Image* imageptr = constImage();
2751 if ( !imageptr->colormap )
2752 throwExceptionExplicit( OptionError,
2753 "Image does not contain a colormap");
2755 if ( index_ > imageptr->colors-1 )
2756 throwExceptionExplicit( OptionError,
2757 "Index out of range");
2759 return Magick::Color( (imageptr->colormap)[index_] );
2762 // Colormap size (number of colormap entries)
2763 void Magick::Image::colorMapSize ( const size_t entries_ )
2765 if (entries_ >MaxColormapSize )
2766 throwExceptionExplicit( OptionError,
2767 "Colormap entries must not exceed MaxColormapSize" );
2771 MagickCore::Image* imageptr = image();
2773 if( !imageptr->colormap )
2775 // Allocate colormap
2776 imageptr->colormap =
2777 static_cast<PixelInfo*>(AcquireMagickMemory(entries_*sizeof(PixelInfo)));
2778 imageptr->colors = 0;
2780 else if ( entries_ > imageptr->colors )
2782 // Re-allocate colormap
2783 imageptr->colormap=(PixelInfo *)
2784 ResizeMagickMemory(imageptr->colormap,(entries_)*sizeof(PixelInfo));
2787 // Initialize any new colormap entries as all black
2789 for( size_t i=imageptr->colors; i<(entries_-1); i++ )
2790 (imageptr->colormap)[i] = black;
2792 imageptr->colors = entries_;
2794 size_t Magick::Image::colorMapSize ( void )
2796 const MagickCore::Image* imageptr = constImage();
2798 if ( !imageptr->colormap )
2799 throwExceptionExplicit( OptionError,
2800 "Image does not contain a colormap");
2802 return imageptr->colors;
2806 void Magick::Image::colorSpace( const ColorspaceType colorSpace_ )
2808 if ( image()->colorspace == colorSpace_ )
2812 ExceptionInfo exceptionInfo;
2813 GetExceptionInfo( &exceptionInfo );
2814 TransformImageColorspace(image(), colorSpace_, &exceptionInfo);
2815 throwException( exceptionInfo );
2816 (void) DestroyExceptionInfo( &exceptionInfo );
2818 Magick::ColorspaceType Magick::Image::colorSpace ( void ) const
2820 return constImage()->colorspace;
2823 // Set image colorspace type.
2824 void Magick::Image::colorspaceType( const ColorspaceType colorSpace_ )
2827 options()->colorspaceType( colorSpace_ );
2829 Magick::ColorspaceType Magick::Image::colorspaceType ( void ) const
2831 return constOptions()->colorspaceType();
2836 void Magick::Image::comment ( const std::string &comment_ )
2839 ExceptionInfo exceptionInfo;
2840 GetExceptionInfo( &exceptionInfo );
2841 SetImageProperty( image(), "Comment", NULL, &exceptionInfo );
2842 if ( comment_.length() > 0 )
2843 SetImageProperty( image(), "Comment", comment_.c_str(), &exceptionInfo );
2844 throwException( exceptionInfo );
2845 (void) DestroyExceptionInfo( &exceptionInfo );
2847 std::string Magick::Image::comment ( void ) const
2849 ExceptionInfo exceptionInfo;
2850 GetExceptionInfo( &exceptionInfo );
2851 const char *value = GetImageProperty( constImage(), "Comment",
2853 throwException( exceptionInfo );
2854 (void) DestroyExceptionInfo( &exceptionInfo );
2857 return std::string( value );
2859 return std::string(); // Intentionally no exception
2862 // Composition operator to be used when composition is implicitly used
2863 // (such as for image flattening).
2864 void Magick::Image::compose (const CompositeOperator compose_)
2866 image()->compose=compose_;
2869 Magick::CompositeOperator Magick::Image::compose ( void ) const
2871 return constImage()->compose;
2874 // Compression algorithm
2875 void Magick::Image::compressType ( const CompressionType compressType_ )
2878 image()->compression = compressType_;
2879 options()->compressType( compressType_ );
2881 Magick::CompressionType Magick::Image::compressType ( void ) const
2883 return constImage()->compression;
2886 // Enable printing of debug messages from ImageMagick
2887 void Magick::Image::debug ( const bool flag_ )
2890 options()->debug( flag_ );
2892 bool Magick::Image::debug ( void ) const
2894 return constOptions()->debug();
2897 // Tagged image format define (set/access coder-specific option) The
2898 // magick_ option specifies the coder the define applies to. The key_
2899 // option provides the key specific to that coder. The value_ option
2900 // provides the value to set (if any). See the defineSet() method if the
2901 // key must be removed entirely.
2902 void Magick::Image::defineValue ( const std::string &magick_,
2903 const std::string &key_,
2904 const std::string &value_ )
2907 std::string format = magick_ + ":" + key_;
2908 std::string option = value_;
2909 (void) SetImageOption ( imageInfo(), format.c_str(), option.c_str() );
2911 std::string Magick::Image::defineValue ( const std::string &magick_,
2912 const std::string &key_ ) const
2914 std::string definition = magick_ + ":" + key_;
2915 const char *option =
2916 GetImageOption ( constImageInfo(), definition.c_str() );
2918 return std::string( option );
2919 return std::string( );
2922 // Tagged image format define. Similar to the defineValue() method
2923 // except that passing the flag_ value 'true' creates a value-less
2924 // define with that format and key. Passing the flag_ value 'false'
2925 // removes any existing matching definition. The method returns 'true'
2926 // if a matching key exists, and 'false' if no matching key exists.
2927 void Magick::Image::defineSet ( const std::string &magick_,
2928 const std::string &key_,
2932 std::string definition = magick_ + ":" + key_;
2935 (void) SetImageOption ( imageInfo(), definition.c_str(), "" );
2939 DeleteImageOption( imageInfo(), definition.c_str() );
2942 bool Magick::Image::defineSet ( const std::string &magick_,
2943 const std::string &key_ ) const
2945 std::string key = magick_ + ":" + key_;
2946 const char *option =
2947 GetImageOption ( constImageInfo(), key.c_str() );
2954 void Magick::Image::density ( const Geometry &density_ )
2957 options()->density( density_ );
2958 if ( density_.isValid() )
2960 image()->resolution.x = density_.width();
2961 if ( density_.height() != 0 )
2963 image()->resolution.y = density_.height();
2967 image()->resolution.y = density_.width();
2973 image()->resolution.x = 0;
2974 image()->resolution.y = 0;
2977 Magick::Geometry Magick::Image::density ( void ) const
2981 ssize_t x_resolution=72;
2982 ssize_t y_resolution=72;
2984 if (constImage()->resolution.x > 0.0)
2985 x_resolution=static_cast<ssize_t>(constImage()->resolution.x + 0.5);
2987 if (constImage()->resolution.y > 0.0)
2988 y_resolution=static_cast<ssize_t>(constImage()->resolution.y + 0.5);
2990 return Geometry(x_resolution,y_resolution);
2993 return constOptions()->density( );
2996 // Image depth (bits allocated to red/green/blue components)
2997 void Magick::Image::depth ( const size_t depth_ )
2999 size_t depth = depth_;
3001 if (depth > MAGICKCORE_QUANTUM_DEPTH)
3002 depth=MAGICKCORE_QUANTUM_DEPTH;
3005 image()->depth=depth;
3006 options()->depth( depth );
3008 size_t Magick::Image::depth ( void ) const
3010 return constImage()->depth;
3013 std::string Magick::Image::directory ( void ) const
3015 if ( constImage()->directory )
3016 return std::string( constImage()->directory );
3018 throwExceptionExplicit( CorruptImageWarning,
3019 "Image does not contain a directory");
3021 return std::string();
3024 // Endianness (little like Intel or big like SPARC) for image
3025 // formats which support endian-specific options.
3026 void Magick::Image::endian ( const Magick::EndianType endian_ )
3029 options()->endian( endian_ );
3030 image()->endian = endian_;
3032 Magick::EndianType Magick::Image::endian ( void ) const
3034 return constImage()->endian;
3037 // EXIF profile (BLOB)
3038 void Magick::Image::exifProfile( const Magick::Blob &exifProfile_ )
3041 if ( exifProfile_.data() != 0 )
3043 StringInfo * exif_profile = AcquireStringInfo( exifProfile_.length() );
3044 SetStringInfoDatum(exif_profile ,(unsigned char *) exifProfile_.data());
3045 ExceptionInfo exceptionInfo;
3046 GetExceptionInfo( &exceptionInfo );
3047 (void) SetImageProfile( image(), "exif", exif_profile, &exceptionInfo);
3048 exif_profile =DestroyStringInfo( exif_profile );
3049 throwException( exceptionInfo );
3050 (void) DestroyExceptionInfo( &exceptionInfo );
3053 Magick::Blob Magick::Image::exifProfile( void ) const
3055 const StringInfo * exif_profile = GetImageProfile( constImage(), "exif" );
3056 if ( exif_profile == (StringInfo *) NULL)
3057 return Blob( 0, 0 );
3058 return Blob(GetStringInfoDatum(exif_profile),GetStringInfoLength(exif_profile));
3062 void Magick::Image::fileName ( const std::string &fileName_ )
3066 fileName_.copy( image()->filename,
3067 sizeof(image()->filename) - 1 );
3068 image()->filename[ fileName_.length() ] = 0; // Null terminate
3070 options()->fileName( fileName_ );
3073 std::string Magick::Image::fileName ( void ) const
3075 return constOptions()->fileName( );
3079 off_t Magick::Image::fileSize ( void ) const
3081 return (off_t) GetBlobSize( constImage() );
3084 // Color to use when drawing inside an object
3085 void Magick::Image::fillColor ( const Magick::Color &fillColor_ )
3088 options()->fillColor(fillColor_);
3090 Magick::Color Magick::Image::fillColor ( void ) const
3092 return constOptions()->fillColor();
3095 // Rule to use when filling drawn objects
3096 void Magick::Image::fillRule ( const Magick::FillRule &fillRule_ )
3099 options()->fillRule(fillRule_);
3101 Magick::FillRule Magick::Image::fillRule ( void ) const
3103 return constOptions()->fillRule();
3106 // Pattern to use while filling drawn objects.
3107 void Magick::Image::fillPattern ( const Image &fillPattern_ )
3110 if(fillPattern_.isValid())
3111 options()->fillPattern( fillPattern_.constImage() );
3113 options()->fillPattern( static_cast<MagickCore::Image*>(NULL) );
3115 Magick::Image Magick::Image::fillPattern ( void ) const
3117 // FIXME: This is inordinately innefficient
3120 const MagickCore::Image* tmpTexture = constOptions()->fillPattern( );
3124 ExceptionInfo exceptionInfo;
3125 GetExceptionInfo( &exceptionInfo );
3126 MagickCore::Image* image =
3127 CloneImage( tmpTexture,
3130 MagickTrue, // orphan
3132 texture.replaceImage( image );
3133 throwException( exceptionInfo );
3134 (void) DestroyExceptionInfo( &exceptionInfo );
3139 // Filter used by zoom
3140 void Magick::Image::filterType ( const Magick::FilterTypes filterType_ )
3143 image()->filter = filterType_;
3145 Magick::FilterTypes Magick::Image::filterType ( void ) const
3147 return constImage()->filter;
3151 void Magick::Image::font ( const std::string &font_ )
3154 options()->font( font_ );
3156 std::string Magick::Image::font ( void ) const
3158 return constOptions()->font( );
3162 void Magick::Image::fontPointsize ( const double pointSize_ )
3165 options()->fontPointsize( pointSize_ );
3167 double Magick::Image::fontPointsize ( void ) const
3169 return constOptions()->fontPointsize( );
3172 // Font type metrics
3173 void Magick::Image::fontTypeMetrics( const std::string &text_,
3174 TypeMetric *metrics )
3176 DrawInfo *drawInfo = options()->drawInfo();
3177 drawInfo->text = const_cast<char *>(text_.c_str());
3178 ExceptionInfo exceptionInfo;
3179 GetExceptionInfo( &exceptionInfo );
3180 GetTypeMetrics( image(), drawInfo, &(metrics->_typeMetric), &exceptionInfo );
3182 throwException( exceptionInfo );
3183 (void) DestroyExceptionInfo( &exceptionInfo );
3186 // Image format string
3187 std::string Magick::Image::format ( void ) const
3189 ExceptionInfo exceptionInfo;
3190 GetExceptionInfo( &exceptionInfo );
3191 const MagickInfo * magick_info
3192 = GetMagickInfo( constImage()->magick, &exceptionInfo);
3193 throwException( exceptionInfo );
3194 (void) DestroyExceptionInfo( &exceptionInfo );
3196 if (( magick_info != 0 ) &&
3197 ( *magick_info->description != '\0' ))
3198 return std::string(magick_info->description);
3200 throwExceptionExplicit( CorruptImageWarning,
3201 "Unrecognized image magick type" );
3202 return std::string();
3206 double Magick::Image::gamma ( void ) const
3208 return constImage()->gamma;
3211 Magick::Geometry Magick::Image::geometry ( void ) const
3213 if ( constImage()->geometry )
3215 return Geometry(constImage()->geometry);
3218 throwExceptionExplicit( OptionWarning,
3219 "Image does not contain a geometry");
3224 void Magick::Image::gifDisposeMethod ( const size_t disposeMethod_ )
3227 image()->dispose = (DisposeType) disposeMethod_;
3229 size_t Magick::Image::gifDisposeMethod ( void ) const
3231 // FIXME: It would be better to return an enumeration
3232 return constImage()->dispose;
3235 // ICC ICM color profile (BLOB)
3236 void Magick::Image::iccColorProfile( const Magick::Blob &colorProfile_ )
3238 profile("icm",colorProfile_);
3240 Magick::Blob Magick::Image::iccColorProfile( void ) const
3242 const StringInfo * color_profile = GetImageProfile( constImage(), "icc" );
3243 if ( color_profile == (StringInfo *) NULL)
3244 return Blob( 0, 0 );
3245 return Blob( GetStringInfoDatum(color_profile), GetStringInfoLength(color_profile) );
3248 void Magick::Image::interlaceType ( const Magick::InterlaceType interlace_ )
3251 image()->interlace = interlace_;
3252 options()->interlaceType ( interlace_ );
3254 Magick::InterlaceType Magick::Image::interlaceType ( void ) const
3256 return constImage()->interlace;
3259 // IPTC profile (BLOB)
3260 void Magick::Image::iptcProfile( const Magick::Blob &iptcProfile_ )
3263 if ( iptcProfile_.data() != 0 )
3265 StringInfo * iptc_profile = AcquireStringInfo( iptcProfile_.length() );
3266 SetStringInfoDatum(iptc_profile ,(unsigned char *) iptcProfile_.data());
3267 ExceptionInfo exceptionInfo;
3268 GetExceptionInfo( &exceptionInfo );
3269 (void) SetImageProfile( image(), "iptc", iptc_profile, &exceptionInfo);
3270 iptc_profile =DestroyStringInfo( iptc_profile );
3271 throwException( exceptionInfo );
3272 (void) DestroyExceptionInfo( &exceptionInfo );
3275 Magick::Blob Magick::Image::iptcProfile( void ) const
3277 const StringInfo * iptc_profile = GetImageProfile( constImage(), "iptc" );
3278 if ( iptc_profile == (StringInfo *) NULL)
3279 return Blob( 0, 0 );
3280 return Blob( GetStringInfoDatum(iptc_profile), GetStringInfoLength(iptc_profile));
3283 // Does object contain valid image?
3284 void Magick::Image::isValid ( const bool isValid_ )
3289 _imgRef = new ImageRef;
3291 else if ( !isValid() )
3293 // Construct with single-pixel black image to make
3294 // image valid. This is an obvious hack.
3295 size( Geometry(1,1) );
3296 read( "xc:#000000" );
3300 bool Magick::Image::isValid ( void ) const
3302 if ( rows() && columns() )
3309 void Magick::Image::label ( const std::string &label_ )
3312 ExceptionInfo exceptionInfo;
3313 GetExceptionInfo( &exceptionInfo );
3314 SetImageProperty ( image(), "Label", NULL, &exceptionInfo );
3315 if ( label_.length() > 0 )
3316 SetImageProperty ( image(), "Label", label_.c_str(), &exceptionInfo );
3317 throwException( exceptionInfo );
3318 (void) DestroyExceptionInfo( &exceptionInfo );
3320 std::string Magick::Image::label ( void ) const
3322 ExceptionInfo exceptionInfo;
3323 GetExceptionInfo( &exceptionInfo );
3324 const char *value = GetImageProperty( constImage(), "Label", &exceptionInfo );
3325 throwException( exceptionInfo );
3326 (void) DestroyExceptionInfo( &exceptionInfo );
3329 return std::string( value );
3331 return std::string();
3334 void Magick::Image::magick ( const std::string &magick_ )
3338 magick_.copy( image()->magick,
3339 sizeof(image()->magick) - 1 );
3340 image()->magick[ magick_.length() ] = 0;
3342 options()->magick( magick_ );
3344 std::string Magick::Image::magick ( void ) const
3346 if ( *(constImage()->magick) != '\0' )
3347 return std::string(constImage()->magick);
3349 return constOptions()->magick( );
3352 void Magick::Image::matte ( const bool matteFlag_ )
3356 // If matte channel is requested, but image doesn't already have a
3357 // matte channel, then create an opaque matte channel. Likewise, if
3358 // the image already has a matte channel but a matte channel is not
3359 // desired, then set the matte channel to opaque.
3360 ExceptionInfo exceptionInfo;
3361 GetExceptionInfo( &exceptionInfo );
3362 if ((matteFlag_ && !constImage()->matte) ||
3363 (constImage()->matte && !matteFlag_))
3364 SetImageAlpha(image(),OpaqueAlpha,&exceptionInfo);
3365 throwException( exceptionInfo );
3366 (void) DestroyExceptionInfo( &exceptionInfo );
3368 image()->matte = (MagickBooleanType) matteFlag_;
3370 bool Magick::Image::matte ( void ) const
3372 if ( constImage()->matte )
3378 void Magick::Image::matteColor ( const Color &matteColor_ )
3382 if ( matteColor_.isValid() )
3384 image()->matte_color = matteColor_;
3385 options()->matteColor( matteColor_ );
3389 // Set to default matte color
3390 Color tmpColor( "#BDBDBD" );
3391 image()->matte_color = tmpColor;
3392 options()->matteColor( tmpColor );
3395 Magick::Color Magick::Image::matteColor ( void ) const
3397 return Color( ClampToQuantum( constImage()->matte_color.red ),
3398 ClampToQuantum( constImage()->matte_color.green ),
3399 ClampToQuantum( constImage()->matte_color.blue ) );
3402 double Magick::Image::meanErrorPerPixel ( void ) const
3404 return(constImage()->error.mean_error_per_pixel);
3407 // Image modulus depth (minimum number of bits required to support
3408 // red/green/blue components without loss of accuracy)
3409 void Magick::Image::modulusDepth ( const size_t depth_ )
3412 ExceptionInfo exceptionInfo;
3413 GetExceptionInfo( &exceptionInfo );
3414 SetImageDepth( image(), depth_, &exceptionInfo );
3415 throwException( exceptionInfo );
3416 (void) DestroyExceptionInfo( &exceptionInfo );
3417 options()->depth( depth_ );
3419 size_t Magick::Image::modulusDepth ( void ) const
3421 ExceptionInfo exceptionInfo;
3422 GetExceptionInfo( &exceptionInfo );
3423 size_t depth=GetImageDepth( constImage(), &exceptionInfo );
3424 throwException( exceptionInfo );
3425 (void) DestroyExceptionInfo( &exceptionInfo );
3429 void Magick::Image::monochrome ( const bool monochromeFlag_ )
3432 options()->monochrome( monochromeFlag_ );
3434 bool Magick::Image::monochrome ( void ) const
3436 return constOptions()->monochrome( );
3439 Magick::Geometry Magick::Image::montageGeometry ( void ) const
3441 if ( constImage()->montage )
3442 return Magick::Geometry(constImage()->montage);
3444 throwExceptionExplicit( CorruptImageWarning,
3445 "Image does not contain a montage" );
3447 return Magick::Geometry();
3450 double Magick::Image::normalizedMaxError ( void ) const
3452 return(constImage()->error.normalized_maximum_error);
3455 double Magick::Image::normalizedMeanError ( void ) const
3457 return constImage()->error.normalized_mean_error;
3460 // Image orientation
3461 void Magick::Image::orientation ( const Magick::OrientationType orientation_ )
3464 image()->orientation = orientation_;
3466 Magick::OrientationType Magick::Image::orientation ( void ) const
3468 return constImage()->orientation;
3471 void Magick::Image::penColor ( const Color &penColor_ )
3474 options()->fillColor(penColor_);
3475 options()->strokeColor(penColor_);
3477 Magick::Color Magick::Image::penColor ( void ) const
3479 return constOptions()->fillColor();
3482 void Magick::Image::penTexture ( const Image &penTexture_ )
3485 if(penTexture_.isValid())
3486 options()->fillPattern( penTexture_.constImage() );
3488 options()->fillPattern( static_cast<MagickCore::Image*>(NULL) );
3491 Magick::Image Magick::Image::penTexture ( void ) const
3493 // FIXME: This is inordinately innefficient
3496 const MagickCore::Image* tmpTexture = constOptions()->fillPattern( );
3500 ExceptionInfo exceptionInfo;
3501 GetExceptionInfo( &exceptionInfo );
3502 MagickCore::Image* image =
3503 CloneImage( tmpTexture,
3506 MagickTrue, // orphan
3508 texture.replaceImage( image );
3509 throwException( exceptionInfo );
3510 (void) DestroyExceptionInfo( &exceptionInfo );
3515 // Set the color of a pixel.
3516 void Magick::Image::pixelColor ( const ssize_t x_, const ssize_t y_,
3517 const Color &color_ )
3519 // Test arguments to ensure they are within the image.
3520 if ( y_ > (ssize_t) rows() || x_ > (ssize_t) columns() )
3521 throwExceptionExplicit( OptionError,
3522 "Access outside of image boundary" );
3526 // Set image to DirectClass
3527 classType( DirectClass );
3530 Pixels pixels(*this);
3532 Quantum *pixel = pixels.get(x_, y_, 1, 1 );
3533 PixelInfo packet = color_;
3534 MagickCore::SetPixelInfoPixel(constImage(),&packet,pixel);
3535 // Tell ImageMagick that pixels have been updated
3541 // Get the color of a pixel
3542 Magick::Color Magick::Image::pixelColor ( const ssize_t x_,
3543 const ssize_t y_ ) const
3545 const Quantum* pixel = getConstPixels( x_, y_, 1, 1 );
3549 MagickCore::GetPixelInfoPixel(constImage(),pixel,&packet);
3550 return Color( packet );
3553 return Color(); // invalid
3556 // Preferred size and location of an image canvas.
3557 void Magick::Image::page ( const Magick::Geometry &pageSize_ )
3560 options()->page( pageSize_ );
3561 image()->page = pageSize_;
3563 Magick::Geometry Magick::Image::page ( void ) const
3565 return Geometry( constImage()->page.width,
3566 constImage()->page.height,
3567 AbsoluteValue(constImage()->page.x),
3568 AbsoluteValue(constImage()->page.y),
3569 constImage()->page.x < 0 ? true : false,
3570 constImage()->page.y < 0 ? true : false);
3573 // Add a named profile to an image or remove a named profile by
3574 // passing an empty Blob (use default Blob constructor).
3576 // "*", "8BIM", "ICM", "IPTC", or a generic profile name.
3577 void Magick::Image::profile( const std::string name_,
3578 const Magick::Blob &profile_ )
3581 ExceptionInfo exceptionInfo;
3582 GetExceptionInfo( &exceptionInfo );
3583 ssize_t result = ProfileImage( image(), name_.c_str(),
3584 (unsigned char *)profile_.data(),
3585 profile_.length(), &exceptionInfo);
3587 throwException( exceptionInfo );
3588 (void) DestroyExceptionInfo( &exceptionInfo );
3592 // Retrieve a named profile from the image.
3594 // "8BIM", "8BIMTEXT", "APP1", "APP1JPEG", "ICC", "ICM", & "IPTC" or
3595 // an existing generic profile name.
3596 Magick::Blob Magick::Image::profile( const std::string name_ ) const
3598 const MagickCore::Image* image = constImage();
3600 const StringInfo * profile = GetImageProfile( image, name_.c_str() );
3602 if ( profile != (StringInfo *) NULL)
3603 return Blob( (void*) GetStringInfoDatum(profile), GetStringInfoLength(profile));
3606 Image temp_image = *this;
3607 temp_image.write( &blob, name_ );
3611 void Magick::Image::quality ( const size_t quality_ )
3614 image()->quality = quality_;
3615 options()->quality( quality_ );
3617 size_t Magick::Image::quality ( void ) const
3619 return constImage()->quality;
3622 void Magick::Image::quantizeColors ( const size_t colors_ )
3625 options()->quantizeColors( colors_ );
3627 size_t Magick::Image::quantizeColors ( void ) const
3629 return constOptions()->quantizeColors( );
3632 void Magick::Image::quantizeColorSpace
3633 ( const Magick::ColorspaceType colorSpace_ )
3636 options()->quantizeColorSpace( colorSpace_ );
3638 Magick::ColorspaceType Magick::Image::quantizeColorSpace ( void ) const
3640 return constOptions()->quantizeColorSpace( );
3643 void Magick::Image::quantizeDither ( const bool ditherFlag_ )
3646 options()->quantizeDither( ditherFlag_ );
3648 bool Magick::Image::quantizeDither ( void ) const
3650 return constOptions()->quantizeDither( );
3653 void Magick::Image::quantizeTreeDepth ( const size_t treeDepth_ )
3656 options()->quantizeTreeDepth( treeDepth_ );
3658 size_t Magick::Image::quantizeTreeDepth ( void ) const
3660 return constOptions()->quantizeTreeDepth( );
3663 void Magick::Image::renderingIntent
3664 ( const Magick::RenderingIntent renderingIntent_ )
3667 image()->rendering_intent = renderingIntent_;
3669 Magick::RenderingIntent Magick::Image::renderingIntent ( void ) const
3671 return static_cast<Magick::RenderingIntent>(constImage()->rendering_intent);
3674 void Magick::Image::resolutionUnits
3675 ( const Magick::ResolutionType resolutionUnits_ )
3678 image()->units = resolutionUnits_;
3679 options()->resolutionUnits( resolutionUnits_ );
3681 Magick::ResolutionType Magick::Image::resolutionUnits ( void ) const
3683 return constOptions()->resolutionUnits( );
3686 void Magick::Image::scene ( const size_t scene_ )
3689 image()->scene = scene_;
3691 size_t Magick::Image::scene ( void ) const
3693 return constImage()->scene;
3696 std::string Magick::Image::signature ( const bool force_ ) const
3698 Lock( &_imgRef->_mutexLock );
3700 // Re-calculate image signature if necessary
3701 ExceptionInfo exceptionInfo;
3702 GetExceptionInfo( &exceptionInfo );
3704 !GetImageProperty(constImage(), "Signature", &exceptionInfo) ||
3705 constImage()->taint )
3707 SignatureImage( const_cast<MagickCore::Image *>(constImage()), &exceptionInfo );
3710 const char *property = GetImageProperty(constImage(), "Signature",
3712 throwException( exceptionInfo );
3713 (void) DestroyExceptionInfo( &exceptionInfo );
3715 return std::string( property );
3718 void Magick::Image::size ( const Geometry &geometry_ )
3721 options()->size( geometry_ );
3722 image()->rows = geometry_.height();
3723 image()->columns = geometry_.width();
3725 Magick::Geometry Magick::Image::size ( void ) const
3727 return Magick::Geometry( constImage()->columns, constImage()->rows );
3731 void Magick::Image::splice( const Geometry &geometry_ )
3733 RectangleInfo spliceInfo = geometry_;
3734 ExceptionInfo exceptionInfo;
3735 GetExceptionInfo( &exceptionInfo );
3736 MagickCore::Image* newImage =
3737 SpliceImage( image(), &spliceInfo, &exceptionInfo);
3738 replaceImage( newImage );
3739 throwException( exceptionInfo );
3740 (void) DestroyExceptionInfo( &exceptionInfo );
3743 // Obtain image statistics. Statistics are normalized to the range of
3744 // 0.0 to 1.0 and are output to the specified ImageStatistics
3746 void Magick::Image::statistics ( ImageStatistics *statistics )
3752 ExceptionInfo exceptionInfo;
3753 GetExceptionInfo( &exceptionInfo );
3755 ChannelType channel_mask = SetPixelChannelMask( image(), RedChannel);
3756 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3757 statistics->red.minimum=minimum;
3758 statistics->red.maximum=maximum;
3759 (void) GetImageMean( image(),&statistics->red.mean,
3760 &statistics->red.standard_deviation,&exceptionInfo);
3761 (void) GetImageKurtosis( image(),&statistics->red.kurtosis,
3762 &statistics->red.skewness,&exceptionInfo);
3763 (void) SetPixelChannelMapMask( image(), channel_mask );
3765 channel_mask = SetPixelChannelMask( image(), GreenChannel);
3766 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3767 statistics->green.minimum=minimum;
3768 statistics->green.maximum=maximum;
3769 (void) GetImageMean( image(),&statistics->green.mean,
3770 &statistics->green.standard_deviation,&exceptionInfo);
3771 (void) GetImageKurtosis( image(),&statistics->green.kurtosis,
3772 &statistics->green.skewness,&exceptionInfo);
3773 (void) SetPixelChannelMapMask( image(), channel_mask );
3775 channel_mask = SetPixelChannelMask( image(), GreenChannel);
3776 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3777 statistics->blue.minimum=minimum;
3778 statistics->blue.maximum=maximum;
3779 (void) GetImageMean( image(),&statistics->blue.mean,
3780 &statistics->blue.standard_deviation,&exceptionInfo);
3781 (void) GetImageKurtosis( image(),&statistics->blue.kurtosis,
3782 &statistics->blue.skewness,&exceptionInfo);
3783 (void) SetPixelChannelMapMask( image(), channel_mask );
3785 channel_mask = SetPixelChannelMask( image(), AlphaChannel);
3786 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3787 statistics->alpha.minimum=minimum;
3788 statistics->alpha.maximum=maximum;
3789 (void) GetImageMean( image(),&statistics->alpha.mean,
3790 &statistics->alpha.standard_deviation,&exceptionInfo);
3791 (void) GetImageKurtosis( image(),&statistics->alpha.kurtosis,
3792 &statistics->alpha.skewness,&exceptionInfo);
3793 (void) SetPixelChannelMapMask( image(), channel_mask );
3795 throwException( exceptionInfo );
3796 (void) DestroyExceptionInfo( &exceptionInfo );
3799 // Strip strips an image of all profiles and comments.
3800 void Magick::Image::strip ( void )
3803 ExceptionInfo exceptionInfo;
3804 GetExceptionInfo( &exceptionInfo );
3805 StripImage( image(), &exceptionInfo );
3806 throwException( exceptionInfo );
3807 (void) DestroyExceptionInfo( &exceptionInfo );
3810 // enabled/disable stroke anti-aliasing
3811 void Magick::Image::strokeAntiAlias ( const bool flag_ )
3814 options()->strokeAntiAlias(flag_);
3816 bool Magick::Image::strokeAntiAlias ( void ) const
3818 return constOptions()->strokeAntiAlias();
3821 // Color to use when drawing object outlines
3822 void Magick::Image::strokeColor ( const Magick::Color &strokeColor_ )
3825 options()->strokeColor(strokeColor_);
3827 Magick::Color Magick::Image::strokeColor ( void ) const
3829 return constOptions()->strokeColor();
3832 // dash pattern for drawing vector objects (default one)
3833 void Magick::Image::strokeDashArray ( const double* strokeDashArray_ )
3836 options()->strokeDashArray( strokeDashArray_ );
3839 const double* Magick::Image::strokeDashArray ( void ) const
3841 return constOptions()->strokeDashArray( );
3844 // dash offset for drawing vector objects (default one)
3845 void Magick::Image::strokeDashOffset ( const double strokeDashOffset_ )
3848 options()->strokeDashOffset( strokeDashOffset_ );
3851 double Magick::Image::strokeDashOffset ( void ) const
3853 return constOptions()->strokeDashOffset( );
3856 // Specify the shape to be used at the end of open subpaths when they
3857 // are stroked. Values of LineCap are UndefinedCap, ButtCap, RoundCap,
3859 void Magick::Image::strokeLineCap ( const Magick::LineCap lineCap_ )
3862 options()->strokeLineCap( lineCap_ );
3864 Magick::LineCap Magick::Image::strokeLineCap ( void ) const
3866 return constOptions()->strokeLineCap( );
3869 // Specify the shape to be used at the corners of paths (or other
3870 // vector shapes) when they are stroked. Values of LineJoin are
3871 // UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.
3872 void Magick::Image::strokeLineJoin ( const Magick::LineJoin lineJoin_ )
3875 options()->strokeLineJoin( lineJoin_ );
3877 Magick::LineJoin Magick::Image::strokeLineJoin ( void ) const
3879 return constOptions()->strokeLineJoin( );
3882 // Specify miter limit. When two line segments meet at a sharp angle
3883 // and miter joins have been specified for 'lineJoin', it is possible
3884 // for the miter to extend far beyond the thickness of the line
3885 // stroking the path. The miterLimit' imposes a limit on the ratio of
3886 // the miter length to the 'lineWidth'. The default value of this
3888 void Magick::Image::strokeMiterLimit ( const size_t strokeMiterLimit_ )
3891 options()->strokeMiterLimit( strokeMiterLimit_ );
3893 size_t Magick::Image::strokeMiterLimit ( void ) const
3895 return constOptions()->strokeMiterLimit( );
3898 // Pattern to use while stroking drawn objects.
3899 void Magick::Image::strokePattern ( const Image &strokePattern_ )
3902 if(strokePattern_.isValid())
3903 options()->strokePattern( strokePattern_.constImage() );
3905 options()->strokePattern( static_cast<MagickCore::Image*>(NULL) );
3907 Magick::Image Magick::Image::strokePattern ( void ) const
3909 // FIXME: This is inordinately innefficient
3912 const MagickCore::Image* tmpTexture = constOptions()->strokePattern( );
3916 ExceptionInfo exceptionInfo;
3917 GetExceptionInfo( &exceptionInfo );
3918 MagickCore::Image* image =
3919 CloneImage( tmpTexture,
3922 MagickTrue, // orphan
3924 throwException( exceptionInfo );
3925 (void) DestroyExceptionInfo( &exceptionInfo );
3926 texture.replaceImage( image );
3931 // Stroke width for drawing lines, circles, ellipses, etc.
3932 void Magick::Image::strokeWidth ( const double strokeWidth_ )
3935 options()->strokeWidth( strokeWidth_ );
3937 double Magick::Image::strokeWidth ( void ) const
3939 return constOptions()->strokeWidth( );
3942 void Magick::Image::subImage ( const size_t subImage_ )
3945 options()->subImage( subImage_ );
3947 size_t Magick::Image::subImage ( void ) const
3949 return constOptions()->subImage( );
3952 void Magick::Image::subRange ( const size_t subRange_ )
3955 options()->subRange( subRange_ );
3957 size_t Magick::Image::subRange ( void ) const
3959 return constOptions()->subRange( );
3962 // Annotation text encoding (e.g. "UTF-16")
3963 void Magick::Image::textEncoding ( const std::string &encoding_ )
3966 options()->textEncoding( encoding_ );
3968 std::string Magick::Image::textEncoding ( void ) const
3970 return constOptions()->textEncoding( );
3973 size_t Magick::Image::totalColors ( void )
3975 ExceptionInfo exceptionInfo;
3976 GetExceptionInfo( &exceptionInfo );
3977 size_t colors = GetNumberColors( image(), 0, &exceptionInfo);
3978 throwException( exceptionInfo );
3979 (void) DestroyExceptionInfo( &exceptionInfo );
3983 // Origin of coordinate system to use when annotating with text or drawing
3984 void Magick::Image::transformOrigin ( const double x_, const double y_ )
3987 options()->transformOrigin( x_, y_ );
3990 // Rotation to use when annotating with text or drawing
3991 void Magick::Image::transformRotation ( const double angle_ )
3994 options()->transformRotation( angle_ );
3997 // Reset transformation parameters to default
3998 void Magick::Image::transformReset ( void )
4001 options()->transformReset();
4004 // Scale to use when annotating with text or drawing
4005 void Magick::Image::transformScale ( const double sx_, const double sy_ )
4008 options()->transformScale( sx_, sy_ );
4011 // Skew to use in X axis when annotating with text or drawing
4012 void Magick::Image::transformSkewX ( const double skewx_ )
4015 options()->transformSkewX( skewx_ );
4018 // Skew to use in Y axis when annotating with text or drawing
4019 void Magick::Image::transformSkewY ( const double skewy_ )
4022 options()->transformSkewY( skewy_ );
4025 // Image representation type
4026 Magick::ImageType Magick::Image::type ( void ) const
4029 ExceptionInfo exceptionInfo;
4030 GetExceptionInfo( &exceptionInfo );
4031 ImageType image_type = constOptions()->type();
4032 if ( image_type == UndefinedType )
4033 image_type= GetImageType( constImage(), &exceptionInfo);
4034 throwException( exceptionInfo );
4035 (void) DestroyExceptionInfo( &exceptionInfo );
4038 void Magick::Image::type ( const Magick::ImageType type_)
4040 ExceptionInfo exceptionInfo;
4041 GetExceptionInfo( &exceptionInfo );
4043 options()->type( type_ );
4044 SetImageType( image(), type_, &exceptionInfo );
4045 throwException( exceptionInfo );
4046 (void) DestroyExceptionInfo( &exceptionInfo );
4049 void Magick::Image::verbose ( const bool verboseFlag_ )
4052 options()->verbose( verboseFlag_ );
4054 bool Magick::Image::verbose ( void ) const
4056 return constOptions()->verbose( );
4059 void Magick::Image::view ( const std::string &view_ )
4062 options()->view( view_ );
4064 std::string Magick::Image::view ( void ) const
4066 return constOptions()->view( );
4069 // Virtual pixel method
4070 void Magick::Image::virtualPixelMethod ( const VirtualPixelMethod virtual_pixel_method_ )
4073 ExceptionInfo exceptionInfo;
4074 GetExceptionInfo( &exceptionInfo );
4075 SetImageVirtualPixelMethod( image(), virtual_pixel_method_, &exceptionInfo );
4076 throwException( exceptionInfo );
4077 (void) DestroyExceptionInfo( &exceptionInfo );
4079 Magick::VirtualPixelMethod Magick::Image::virtualPixelMethod ( void ) const
4081 return GetImageVirtualPixelMethod( constImage() );
4084 void Magick::Image::x11Display ( const std::string &display_ )
4087 options()->x11Display( display_ );
4089 std::string Magick::Image::x11Display ( void ) const
4091 return constOptions()->x11Display( );
4094 double Magick::Image::xResolution ( void ) const
4096 return constImage()->resolution.x;
4098 double Magick::Image::yResolution ( void ) const
4100 return constImage()->resolution.y;
4104 Magick::Image::Image( const Image & image_ )
4105 : _imgRef(image_._imgRef)
4107 Lock( &_imgRef->_mutexLock );
4109 // Increase reference count
4110 ++_imgRef->_refCount;
4113 // Assignment operator
4114 Magick::Image& Magick::Image::operator=( const Magick::Image &image_ )
4116 if( this != &image_ )
4119 Lock( &image_._imgRef->_mutexLock );
4120 ++image_._imgRef->_refCount;
4123 bool doDelete = false;
4125 Lock( &_imgRef->_mutexLock );
4126 if ( --_imgRef->_refCount == 0 )
4132 // Delete old image reference with associated image and options.
4136 // Use new image reference
4137 _imgRef = image_._imgRef;
4143 //////////////////////////////////////////////////////////////////////
4145 // Low-level Pixel Access Routines
4147 // Also see the Pixels class, which provides support for multiple
4148 // cache views. The low-level pixel access routines in the Image
4149 // class are provided in order to support backward compatability.
4151 //////////////////////////////////////////////////////////////////////
4153 // Transfers read-only pixels from the image to the pixel cache as
4154 // defined by the specified region
4155 const Magick::Quantum* Magick::Image::getConstPixels
4156 ( const ssize_t x_, const ssize_t y_,
4157 const size_t columns_,
4158 const size_t rows_ ) const
4160 ExceptionInfo exceptionInfo;
4161 GetExceptionInfo( &exceptionInfo );
4162 const Quantum* p = (*GetVirtualPixels)( constImage(),
4166 throwException( exceptionInfo );
4167 (void) DestroyExceptionInfo( &exceptionInfo );
4171 // Obtain read-only pixel associated pixels channels
4172 const void* Magick::Image::getConstMetacontent ( void ) const
4174 const void* result = GetVirtualMetacontent( constImage() );
4177 throwImageException();
4182 // Obtain image pixel associated pixels channels
4183 void* Magick::Image::getMetacontent ( void )
4185 void* result = GetAuthenticMetacontent( image() );
4188 throwImageException();
4193 // Transfers pixels from the image to the pixel cache as defined
4194 // by the specified region. Modified pixels may be subsequently
4195 // transferred back to the image via syncPixels.
4196 Magick::Quantum* Magick::Image::getPixels ( const ssize_t x_, const ssize_t y_,
4197 const size_t columns_,
4198 const size_t rows_ )
4201 ExceptionInfo exceptionInfo;
4202 GetExceptionInfo( &exceptionInfo );
4203 Quantum* result = (*GetAuthenticPixels)( image(),
4205 columns_, rows_, &exceptionInfo );
4206 throwException( exceptionInfo );
4207 (void) DestroyExceptionInfo( &exceptionInfo );
4212 // Allocates a pixel cache region to store image pixels as defined
4213 // by the region rectangle. This area is subsequently transferred
4214 // from the pixel cache to the image via syncPixels.
4215 Magick::Quantum* Magick::Image::setPixels ( const ssize_t x_, const ssize_t y_,
4216 const size_t columns_,
4217 const size_t rows_ )
4220 ExceptionInfo exceptionInfo;
4221 GetExceptionInfo( &exceptionInfo );
4222 Quantum* result = (*QueueAuthenticPixels)( image(),
4224 columns_, rows_, &exceptionInfo );
4225 throwException( exceptionInfo );
4226 (void) DestroyExceptionInfo( &exceptionInfo );
4231 // Transfers the image cache pixels to the image.
4232 void Magick::Image::syncPixels ( void )
4234 ExceptionInfo exceptionInfo;
4235 GetExceptionInfo( &exceptionInfo );
4236 (*SyncAuthenticPixels)( image(), &exceptionInfo );
4237 throwException( exceptionInfo );
4238 (void) DestroyExceptionInfo( &exceptionInfo );
4241 // Transfers one or more pixel components from a buffer or file
4242 // into the image pixel cache of an image.
4243 // Used to support image decoders.
4244 void Magick::Image::readPixels ( const Magick::QuantumType quantum_,
4245 const unsigned char *source_ )
4250 quantum_info=AcquireQuantumInfo(imageInfo(),image());
4251 ExceptionInfo exceptionInfo;
4252 GetExceptionInfo( &exceptionInfo );
4253 ImportQuantumPixels(image(),(MagickCore::CacheView *) NULL,quantum_info,
4254 quantum_,source_, &exceptionInfo);
4255 throwException( exceptionInfo );
4256 (void) DestroyExceptionInfo( &exceptionInfo );
4257 quantum_info=DestroyQuantumInfo(quantum_info);
4260 // Transfers one or more pixel components from the image pixel
4261 // cache to a buffer or file.
4262 // Used to support image encoders.
4263 void Magick::Image::writePixels ( const Magick::QuantumType quantum_,
4264 unsigned char *destination_ )
4269 quantum_info=AcquireQuantumInfo(imageInfo(),image());
4270 ExceptionInfo exceptionInfo;
4271 GetExceptionInfo( &exceptionInfo );
4272 ExportQuantumPixels(image(),(MagickCore::CacheView *) NULL,quantum_info,
4273 quantum_,destination_, &exceptionInfo);
4274 quantum_info=DestroyQuantumInfo(quantum_info);
4275 throwException( exceptionInfo );
4276 (void) DestroyExceptionInfo( &exceptionInfo );
4279 /////////////////////////////////////////////////////////////////////
4281 // No end-user methods beyond this point
4283 /////////////////////////////////////////////////////////////////////
4287 // Construct using existing image and default options
4289 Magick::Image::Image ( MagickCore::Image* image_ )
4290 : _imgRef(new ImageRef( image_))
4294 // Get Magick::Options*
4295 Magick::Options* Magick::Image::options( void )
4297 return _imgRef->options();
4299 const Magick::Options* Magick::Image::constOptions( void ) const
4301 return _imgRef->options();
4304 // Get MagickCore::Image*
4305 MagickCore::Image*& Magick::Image::image( void )
4307 return _imgRef->image();
4309 const MagickCore::Image* Magick::Image::constImage( void ) const
4311 return _imgRef->image();
4315 MagickCore::ImageInfo* Magick::Image::imageInfo( void )
4317 return _imgRef->options()->imageInfo();
4319 const MagickCore::ImageInfo * Magick::Image::constImageInfo( void ) const
4321 return _imgRef->options()->imageInfo();
4324 // Get QuantizeInfo *
4325 MagickCore::QuantizeInfo* Magick::Image::quantizeInfo( void )
4327 return _imgRef->options()->quantizeInfo();
4329 const MagickCore::QuantizeInfo * Magick::Image::constQuantizeInfo( void ) const
4331 return _imgRef->options()->quantizeInfo();
4335 // Replace current image
4337 MagickCore::Image * Magick::Image::replaceImage
4338 ( MagickCore::Image* replacement_ )
4340 MagickCore::Image* image;
4343 image = replacement_;
4346 ExceptionInfo exceptionInfo;
4347 GetExceptionInfo( &exceptionInfo );
4348 image = AcquireImage(constImageInfo(), &exceptionInfo);
4349 throwException( exceptionInfo );
4350 (void) DestroyExceptionInfo( &exceptionInfo );
4354 Lock( &_imgRef->_mutexLock );
4356 if ( _imgRef->_refCount == 1 )
4358 // We own the image, just replace it, and de-register
4360 _imgRef->image(image);
4364 // We don't own the image, dereference and replace with copy
4365 --_imgRef->_refCount;
4366 _imgRef = new ImageRef( image, constOptions() );
4370 return _imgRef->_image;
4374 // Prepare to modify image or image options
4375 // Replace current image and options with copy if reference count > 1
4377 void Magick::Image::modifyImage( void )
4380 Lock( &_imgRef->_mutexLock );
4381 if ( _imgRef->_refCount == 1 )
4383 // De-register image and return
4389 ExceptionInfo exceptionInfo;
4390 GetExceptionInfo( &exceptionInfo );
4391 replaceImage( CloneImage( image(),
4394 MagickTrue, // orphan
4396 throwException( exceptionInfo );
4397 (void) DestroyExceptionInfo( &exceptionInfo );
4402 // Test for an ImageMagick reported error and throw exception if one
4403 // has been reported. Secretly resets image->exception back to default
4404 // state even though this method is const.
4406 void Magick::Image::throwImageException( void ) const
4408 // Throw C++ exception while resetting Image exception to default state
4411 // Register image with image registry or obtain registration id
4412 ssize_t Magick::Image::registerId( void )
4414 Lock( &_imgRef->_mutexLock );
4415 if( _imgRef->id() < 0 )
4417 char id[MaxTextExtent];
4418 ExceptionInfo exceptionInfo;
4419 GetExceptionInfo( &exceptionInfo );
4420 _imgRef->id(_imgRef->id()+1);
4421 sprintf(id,"%.20g\n",(double) _imgRef->id());
4422 SetImageRegistry(ImageRegistryType, id, image(), &exceptionInfo);
4423 throwException( exceptionInfo );
4424 (void) DestroyExceptionInfo( &exceptionInfo );
4426 return _imgRef->id();
4429 // Unregister image from image registry
4430 void Magick::Image::unregisterId( void )
4437 // Create a local wrapper around MagickCoreTerminus
4442 void MagickPlusPlusDestroyMagick(void);
4446 void Magick::MagickPlusPlusDestroyMagick(void)
4448 if (magick_initialized)
4450 magick_initialized=false;
4451 MagickCore::MagickCoreTerminus();
4455 // C library initialization routine
4456 void MagickPPExport Magick::InitializeMagick(const char *path_)
4458 MagickCore::MagickCoreGenesis(path_,MagickFalse);
4459 if (!magick_initialized)
4460 magick_initialized=true;
4464 // Cleanup class to ensure that ImageMagick singletons are destroyed
4465 // so as to avoid any resemblence to a memory leak (which seems to
4474 MagickCleanUp( void );
4475 ~MagickCleanUp( void );
4478 // The destructor for this object is invoked when the destructors for
4479 // static objects in this translation unit are invoked.
4480 static MagickCleanUp magickCleanUpGuard;
4483 Magick::MagickCleanUp::MagickCleanUp ( void )
4485 // Don't even think about invoking InitializeMagick here!
4488 Magick::MagickCleanUp::~MagickCleanUp ( void )
4490 MagickPlusPlusDestroyMagick();