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
11 #include "Magick++/Include.h"
17 #if !defined(MAGICKCORE_WINDOWS_SUPPORT)
23 #include "Magick++/Image.h"
24 #include "Magick++/Functions.h"
25 #include "Magick++/Pixels.h"
26 #include "Magick++/Options.h"
27 #include "Magick++/ImageRef.h"
29 #define AbsoluteValue(x) ((x) < 0 ? -(x) : (x))
30 #define MagickPI 3.14159265358979323846264338327950288419716939937510
31 #define DegreesToRadians(x) (MagickPI*(x)/180.0)
33 MagickDLLDeclExtern const char *Magick::borderGeometryDefault = "6x6+0+0";
34 MagickDLLDeclExtern const char *Magick::frameGeometryDefault = "25x25+6+6";
35 MagickDLLDeclExtern const char *Magick::raiseGeometryDefault = "6x6+0+0";
37 static bool magick_initialized=false;
40 // Explicit template instantiations
44 // Friend functions to compare Image objects
47 MagickDLLDecl int Magick::operator == ( const Magick::Image& left_,
48 const Magick::Image& right_ )
50 // If image pixels and signature are the same, then the image is identical
51 return ( ( left_.rows() == right_.rows() ) &&
52 ( left_.columns() == right_.columns() ) &&
53 ( left_.signature() == right_.signature() )
56 MagickDLLDecl int Magick::operator != ( const Magick::Image& left_,
57 const Magick::Image& right_ )
59 return ( ! (left_ == right_) );
61 MagickDLLDecl int Magick::operator > ( const Magick::Image& left_,
62 const Magick::Image& right_ )
64 return ( !( left_ < right_ ) && ( left_ != right_ ) );
66 MagickDLLDecl int Magick::operator < ( const Magick::Image& left_,
67 const Magick::Image& right_ )
69 // If image pixels are less, then image is smaller
70 return ( ( left_.rows() * left_.columns() ) <
71 ( right_.rows() * right_.columns() )
74 MagickDLLDecl int Magick::operator >= ( const Magick::Image& left_,
75 const Magick::Image& right_ )
77 return ( ( left_ > right_ ) || ( left_ == right_ ) );
79 MagickDLLDecl int Magick::operator <= ( const Magick::Image& left_,
80 const Magick::Image& right_ )
82 return ( ( left_ < right_ ) || ( left_ == right_ ) );
86 // Image object implementation
89 // Construct from image file or image specification
90 Magick::Image::Image( const std::string &imageSpec_ )
91 : _imgRef(new ImageRef)
95 // Initialize, Allocate and Read images
98 catch ( const Warning & /*warning_*/ )
100 // FIXME: need a way to report warnings in constructor
102 catch ( const Error & /*error_*/ )
110 // Construct a blank image canvas of specified size and color
111 Magick::Image::Image( const Geometry &size_,
112 const Color &color_ )
113 : _imgRef(new ImageRef)
115 // xc: prefix specifies an X11 color string
116 std::string imageSpec("xc:");
124 // Initialize, Allocate and Read images
127 catch ( const Warning & /*warning_*/ )
129 // FIXME: need a way to report warnings in constructor
131 catch ( const Error & /*error_*/ )
139 // Construct Image from in-memory BLOB
140 Magick::Image::Image ( const Blob &blob_ )
141 : _imgRef(new ImageRef)
145 // Initialize, Allocate and Read images
148 catch ( const Warning & /*warning_*/ )
150 // FIXME: need a way to report warnings in constructor
152 catch ( const Error & /*error_*/ )
160 // Construct Image of specified size from in-memory BLOB
161 Magick::Image::Image ( const Blob &blob_,
162 const Geometry &size_ )
163 : _imgRef(new ImageRef)
168 read( blob_, size_ );
170 catch ( const Warning & /*warning_*/ )
172 // FIXME: need a way to report warnings in constructor
174 catch ( const Error & /*error_*/ )
182 // Construct Image of specified size and depth from in-memory BLOB
183 Magick::Image::Image ( const Blob &blob_,
184 const Geometry &size_,
185 const size_t depth_ )
186 : _imgRef(new ImageRef)
191 read( blob_, size_, depth_ );
193 catch ( const Warning & /*warning_*/ )
195 // FIXME: need a way to report warnings in constructor
197 catch ( const Error & /*error_*/ )
205 // Construct Image of specified size, depth, and format from in-memory BLOB
206 Magick::Image::Image ( const Blob &blob_,
207 const Geometry &size_,
209 const std::string &magick_ )
210 : _imgRef(new ImageRef)
215 read( blob_, size_, depth_, magick_ );
217 catch ( const Warning & /*warning_*/ )
219 // FIXME: need a way to report warnings in constructor
221 catch ( const Error & /*error_*/ )
229 // Construct Image of specified size, and format from in-memory BLOB
230 Magick::Image::Image ( const Blob &blob_,
231 const Geometry &size_,
232 const std::string &magick_ )
233 : _imgRef(new ImageRef)
238 read( blob_, size_, magick_ );
240 catch ( const Warning & /*warning_*/ )
242 // FIXME: need a way to report warnings in constructor
244 catch ( const Error & /*error_*/ )
252 // Construct an image based on an array of raw pixels, of specified
253 // type and mapping, in memory
254 Magick::Image::Image ( const size_t width_,
255 const size_t height_,
256 const std::string &map_,
257 const StorageType type_,
258 const void *pixels_ )
259 : _imgRef(new ImageRef)
263 read( width_, height_, map_.c_str(), type_, pixels_ );
265 catch ( const Warning & /*warning_*/ )
267 // FIXME: need a way to report warnings in constructor
269 catch ( const Error & /*error_*/ )
277 // Default constructor
278 Magick::Image::Image( void )
279 : _imgRef(new ImageRef)
285 Magick::Image::~Image()
287 bool doDelete = false;
289 Lock( &_imgRef->_mutexLock );
290 if ( --_imgRef->_refCount == 0 )
301 // Adaptive-blur image
302 void Magick::Image::adaptiveBlur( const double radius_, const double sigma_ )
304 ExceptionInfo exceptionInfo;
305 GetExceptionInfo( &exceptionInfo );
306 MagickCore::Image* newImage =
307 AdaptiveBlurImage( image(), radius_, sigma_, &exceptionInfo);
308 replaceImage( newImage );
309 throwException( exceptionInfo );
310 (void) DestroyExceptionInfo( &exceptionInfo );
313 // Local adaptive threshold image
314 // http://www.dai.ed.ac.uk/HIPR2/adpthrsh.htm
315 // Width x height define the size of the pixel neighborhood
316 // offset = constant to subtract from pixel neighborhood mean
317 void Magick::Image::adaptiveThreshold ( const size_t width_,
318 const size_t height_,
319 const ssize_t offset_ )
321 ExceptionInfo exceptionInfo;
322 GetExceptionInfo( &exceptionInfo );
323 MagickCore::Image* newImage =
324 AdaptiveThresholdImage( constImage(), width_, height_, offset_, &exceptionInfo );
325 replaceImage( newImage );
326 throwException( exceptionInfo );
327 (void) DestroyExceptionInfo( &exceptionInfo );
330 // Add noise to image
331 void Magick::Image::addNoise( const NoiseType noiseType_ )
333 ExceptionInfo exceptionInfo;
334 GetExceptionInfo( &exceptionInfo );
335 MagickCore::Image* newImage =
336 AddNoiseImage ( image(),
339 replaceImage( newImage );
340 throwException( exceptionInfo );
341 (void) DestroyExceptionInfo( &exceptionInfo );
344 void Magick::Image::addNoiseChannel( const ChannelType channel_,
345 const NoiseType noiseType_ )
347 ExceptionInfo exceptionInfo;
348 GetExceptionInfo( &exceptionInfo );
349 MagickCore::Image* newImage =
350 AddNoiseImageChannel ( image(),
354 replaceImage( newImage );
355 throwException( exceptionInfo );
356 (void) DestroyExceptionInfo( &exceptionInfo );
359 // Affine Transform image
360 void Magick::Image::affineTransform ( const DrawableAffine &affine_ )
362 ExceptionInfo exceptionInfo;
363 GetExceptionInfo( &exceptionInfo );
365 AffineMatrix _affine;
366 _affine.sx = affine_.sx();
367 _affine.sy = affine_.sy();
368 _affine.rx = affine_.rx();
369 _affine.ry = affine_.ry();
370 _affine.tx = affine_.tx();
371 _affine.ty = affine_.ty();
373 MagickCore::Image* newImage =
374 AffineTransformImage( image(), &_affine, &exceptionInfo);
375 replaceImage( newImage );
376 throwException( exceptionInfo );
377 (void) DestroyExceptionInfo( &exceptionInfo );
380 // Annotate using specified text, and placement location
381 void Magick::Image::annotate ( const std::string &text_,
382 const Geometry &location_ )
384 annotate ( text_, location_, NorthWestGravity, 0.0 );
386 // Annotate using specified text, bounding area, and placement gravity
387 void Magick::Image::annotate ( const std::string &text_,
388 const Geometry &boundingArea_,
389 const GravityType gravity_ )
391 annotate ( text_, boundingArea_, gravity_, 0.0 );
393 // Annotate with text using specified text, bounding area, placement
394 // gravity, and rotation.
395 void Magick::Image::annotate ( const std::string &text_,
396 const Geometry &boundingArea_,
397 const GravityType gravity_,
398 const double degrees_ )
403 = options()->drawInfo();
405 drawInfo->text = const_cast<char *>(text_.c_str());
407 char boundingArea[MaxTextExtent];
409 drawInfo->geometry = 0;
410 if ( boundingArea_.isValid() ){
411 if ( boundingArea_.width() == 0 || boundingArea_.height() == 0 )
413 FormatMagickString( boundingArea, MaxTextExtent, "%+.20g%+.20g",
414 (double) boundingArea_.xOff(), (double) boundingArea_.yOff() );
418 (void) CopyMagickString( boundingArea, string(boundingArea_).c_str(),
421 drawInfo->geometry = boundingArea;
424 drawInfo->gravity = gravity_;
426 AffineMatrix oaffine = drawInfo->affine;
427 if ( degrees_ != 0.0)
437 AffineMatrix current = drawInfo->affine;
438 affine.sx=cos(DegreesToRadians(fmod(degrees_,360.0)));
439 affine.rx=sin(DegreesToRadians(fmod(degrees_,360.0)));
440 affine.ry=(-sin(DegreesToRadians(fmod(degrees_,360.0))));
441 affine.sy=cos(DegreesToRadians(fmod(degrees_,360.0)));
443 drawInfo->affine.sx=current.sx*affine.sx+current.ry*affine.rx;
444 drawInfo->affine.rx=current.rx*affine.sx+current.sy*affine.rx;
445 drawInfo->affine.ry=current.sx*affine.ry+current.ry*affine.sy;
446 drawInfo->affine.sy=current.rx*affine.ry+current.sy*affine.sy;
447 drawInfo->affine.tx=current.sx*affine.tx+current.ry*affine.ty
451 AnnotateImage( image(), drawInfo );
453 // Restore original values
454 drawInfo->affine = oaffine;
456 drawInfo->geometry = 0;
458 throwImageException();
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 AnnotateImage( image(), drawInfo );
475 drawInfo->gravity = NorthWestGravity;
478 throwImageException();
482 void Magick::Image::blur( const double radius_, const double sigma_ )
484 ExceptionInfo exceptionInfo;
485 GetExceptionInfo( &exceptionInfo );
486 MagickCore::Image* newImage =
487 BlurImage( image(), radius_, sigma_, &exceptionInfo);
488 replaceImage( newImage );
489 throwException( exceptionInfo );
490 (void) DestroyExceptionInfo( &exceptionInfo );
493 void Magick::Image::blurChannel( const ChannelType channel_,
494 const double radius_, const double sigma_ )
496 ExceptionInfo exceptionInfo;
497 GetExceptionInfo( &exceptionInfo );
498 MagickCore::Image* newImage =
499 BlurImageChannel( image(), channel_,radius_, sigma_, &exceptionInfo);
500 replaceImage( newImage );
501 throwException( exceptionInfo );
502 (void) DestroyExceptionInfo( &exceptionInfo );
505 // Add border to image
506 // Only uses width & height
507 void Magick::Image::border( const Geometry &geometry_ )
509 RectangleInfo borderInfo = geometry_;
510 ExceptionInfo exceptionInfo;
511 GetExceptionInfo( &exceptionInfo );
512 MagickCore::Image* newImage =
513 BorderImage( image(), &borderInfo, &exceptionInfo);
514 replaceImage( newImage );
515 throwException( exceptionInfo );
516 (void) DestroyExceptionInfo( &exceptionInfo );
519 // Extract channel from image
520 void Magick::Image::channel ( const ChannelType channel_ )
523 SeparateImageChannel ( image(), channel_ );
524 throwImageException();
527 // Set or obtain modulus channel depth
528 void Magick::Image::channelDepth ( const ChannelType channel_,
532 SetImageChannelDepth( image(), channel_, depth_);
533 throwImageException();
535 size_t Magick::Image::channelDepth ( const ChannelType channel_ )
537 size_t channel_depth;
539 ExceptionInfo exceptionInfo;
540 GetExceptionInfo( &exceptionInfo );
541 channel_depth=GetImageChannelDepth( constImage(), channel_,
543 throwException( exceptionInfo );
544 (void) DestroyExceptionInfo( &exceptionInfo );
545 return channel_depth;
549 // Charcoal-effect image
550 void Magick::Image::charcoal( const double radius_, const double sigma_ )
552 ExceptionInfo exceptionInfo;
553 GetExceptionInfo( &exceptionInfo );
554 MagickCore::Image* newImage =
555 CharcoalImage( image(), radius_, sigma_, &exceptionInfo );
556 replaceImage( newImage );
557 throwException( exceptionInfo );
558 (void) DestroyExceptionInfo( &exceptionInfo );
562 void Magick::Image::chop( const Geometry &geometry_ )
564 RectangleInfo chopInfo = geometry_;
565 ExceptionInfo exceptionInfo;
566 GetExceptionInfo( &exceptionInfo );
567 MagickCore::Image* newImage =
568 ChopImage( image(), &chopInfo, &exceptionInfo);
569 replaceImage( newImage );
570 throwException( exceptionInfo );
571 (void) DestroyExceptionInfo( &exceptionInfo );
574 // contains one or more color corrections and applies the correction to the
576 void Magick::Image::cdl ( const std::string &cdl_ )
579 (void) ColorDecisionListImage( image(), cdl_.c_str() );
580 throwImageException();
584 void Magick::Image::colorize ( const unsigned int opacityRed_,
585 const unsigned int opacityGreen_,
586 const unsigned int opacityBlue_,
587 const Color &penColor_ )
589 if ( !penColor_.isValid() )
591 throwExceptionExplicit( OptionError,
592 "Pen color argument is invalid");
595 char opacity[MaxTextExtent];
596 FormatMagickString(opacity,MaxTextExtent,"%u/%u/%u",opacityRed_,opacityGreen_,opacityBlue_);
598 ExceptionInfo exceptionInfo;
599 GetExceptionInfo( &exceptionInfo );
600 MagickCore::Image* newImage =
601 ColorizeImage ( image(), opacity,
602 penColor_, &exceptionInfo );
603 replaceImage( newImage );
604 throwException( exceptionInfo );
605 (void) DestroyExceptionInfo( &exceptionInfo );
607 void Magick::Image::colorize ( const unsigned int opacity_,
608 const Color &penColor_ )
610 colorize( opacity_, opacity_, opacity_, penColor_ );
613 // Apply a color matrix to the image channels. The user supplied
614 // matrix may be of order 1 to 6 (1x1 through 6x6).
615 void Magick::Image::colorMatrix (const size_t order_,
616 const double *color_matrix_)
621 ExceptionInfo exceptionInfo;
622 GetExceptionInfo( &exceptionInfo );
623 kernel_info=AcquireKernelInfo("1");
624 kernel_info->width=order_;
625 kernel_info->height=order_;
626 kernel_info->values=(double *) color_matrix_;
627 MagickCore::Image* newImage =
628 ColorMatrixImage( image(), kernel_info, &exceptionInfo );
629 kernel_info->values=(double *) NULL;
630 kernel_info=DestroyKernelInfo(kernel_info);
631 replaceImage( newImage );
632 throwException( exceptionInfo );
633 (void) DestroyExceptionInfo( &exceptionInfo );
636 // Compare current image with another image
637 // Sets meanErrorPerPixel, normalizedMaxError, and normalizedMeanError
638 // in the current image. False is returned if the images are identical.
639 bool Magick::Image::compare ( const Image &reference_ )
642 Image ref = reference_;
644 return static_cast<bool>(IsImagesEqual(image(), ref.image()));
647 // Composite two images
648 void Magick::Image::composite ( const Image &compositeImage_,
649 const ssize_t xOffset_,
650 const ssize_t yOffset_,
651 const CompositeOperator compose_ )
653 // Image supplied as compositeImage is composited with current image and
654 // results in updating current image.
657 CompositeImage( image(),
659 compositeImage_.constImage(),
662 throwImageException();
664 void Magick::Image::composite ( const Image &compositeImage_,
665 const Geometry &offset_,
666 const CompositeOperator compose_ )
670 ssize_t x = offset_.xOff();
671 ssize_t y = offset_.yOff();
672 size_t width = columns();
673 size_t height = rows();
675 ParseMetaGeometry (static_cast<std::string>(offset_).c_str(),
679 CompositeImage( image(),
681 compositeImage_.constImage(),
683 throwImageException();
685 void Magick::Image::composite ( const Image &compositeImage_,
686 const GravityType gravity_,
687 const CompositeOperator compose_ )
691 RectangleInfo geometry;
693 SetGeometry(compositeImage_.constImage(), &geometry);
694 GravityAdjustGeometry(columns(), rows(), gravity_, &geometry);
696 CompositeImage( image(),
698 compositeImage_.constImage(),
699 geometry.x, geometry.y );
700 throwImageException();
704 void Magick::Image::contrast ( const size_t sharpen_ )
707 ContrastImage ( image(), (MagickBooleanType) sharpen_ );
708 throwImageException();
711 // Convolve image. Applies a general image convolution kernel to the image.
712 // order_ represents the number of columns and rows in the filter kernel.
713 // kernel_ is an array of doubles representing the convolution kernel.
714 void Magick::Image::convolve ( const size_t order_,
715 const double *kernel_ )
717 ExceptionInfo exceptionInfo;
718 GetExceptionInfo( &exceptionInfo );
719 MagickCore::Image* newImage =
720 ConvolveImage ( image(), order_,
721 kernel_, &exceptionInfo );
722 replaceImage( newImage );
723 throwException( exceptionInfo );
724 (void) DestroyExceptionInfo( &exceptionInfo );
728 void Magick::Image::crop ( const Geometry &geometry_ )
730 RectangleInfo cropInfo = geometry_;
731 ExceptionInfo exceptionInfo;
732 GetExceptionInfo( &exceptionInfo );
733 MagickCore::Image* newImage =
737 replaceImage( newImage );
738 throwException( exceptionInfo );
739 (void) DestroyExceptionInfo( &exceptionInfo );
743 void Magick::Image::cycleColormap ( const ssize_t amount_ )
746 CycleColormapImage( image(), amount_ );
747 throwImageException();
751 void Magick::Image::despeckle ( void )
753 ExceptionInfo exceptionInfo;
754 GetExceptionInfo( &exceptionInfo );
755 MagickCore::Image* newImage =
756 DespeckleImage( image(), &exceptionInfo );
757 replaceImage( newImage );
758 throwException( exceptionInfo );
759 (void) DestroyExceptionInfo( &exceptionInfo );
763 void Magick::Image::display( void )
765 DisplayImages( imageInfo(), image() );
768 // Distort image. distorts an image using various distortion methods, by
769 // mapping color lookups of the source image to a new destination image
770 // usally of the same size as the source image, unless 'bestfit' is set to
772 void Magick::Image::distort ( const DistortImageMethod method_,
773 const size_t number_arguments_,
774 const double *arguments_,
775 const bool bestfit_ )
777 ExceptionInfo exceptionInfo;
778 GetExceptionInfo( &exceptionInfo );
779 MagickCore::Image* newImage = DistortImage ( image(), method_,
780 number_arguments_, arguments_, bestfit_ == true ? MagickTrue : MagickFalse,
782 replaceImage( newImage );
783 throwException( exceptionInfo );
784 (void) DestroyExceptionInfo( &exceptionInfo );
787 // Draw on image using single drawable
788 void Magick::Image::draw ( const Magick::Drawable &drawable_ )
792 DrawingWand *wand = DrawAllocateWand( options()->drawInfo(), image());
796 drawable_.operator()(wand);
798 if( constImage()->exception.severity == UndefinedException)
801 wand=DestroyDrawingWand(wand);
804 throwImageException();
807 // Draw on image using a drawable list
808 void Magick::Image::draw ( const std::list<Magick::Drawable> &drawable_ )
812 DrawingWand *wand = DrawAllocateWand( options()->drawInfo(), image());
816 for( std::list<Magick::Drawable>::const_iterator p = drawable_.begin();
817 p != drawable_.end(); p++ )
820 if( constImage()->exception.severity != UndefinedException)
824 if( constImage()->exception.severity == UndefinedException)
827 wand=DestroyDrawingWand(wand);
830 throwImageException();
833 // Hilight edges in image
834 void Magick::Image::edge ( const double radius_ )
836 ExceptionInfo exceptionInfo;
837 GetExceptionInfo( &exceptionInfo );
838 MagickCore::Image* newImage =
839 EdgeImage( image(), radius_, &exceptionInfo );
840 replaceImage( newImage );
841 throwException( exceptionInfo );
842 (void) DestroyExceptionInfo( &exceptionInfo );
845 // Emboss image (hilight edges)
846 void Magick::Image::emboss ( const double radius_, const double sigma_ )
848 ExceptionInfo exceptionInfo;
849 GetExceptionInfo( &exceptionInfo );
850 MagickCore::Image* newImage =
851 EmbossImage( image(), radius_, sigma_, &exceptionInfo );
852 replaceImage( newImage );
853 throwException( exceptionInfo );
854 (void) DestroyExceptionInfo( &exceptionInfo );
857 // Enhance image (minimize noise)
858 void Magick::Image::enhance ( void )
860 ExceptionInfo exceptionInfo;
861 GetExceptionInfo( &exceptionInfo );
862 MagickCore::Image* newImage =
863 EnhanceImage( image(), &exceptionInfo );
864 replaceImage( newImage );
865 throwException( exceptionInfo );
866 (void) DestroyExceptionInfo( &exceptionInfo );
869 // Equalize image (histogram equalization)
870 void Magick::Image::equalize ( void )
873 EqualizeImage( image() );
874 throwImageException();
877 // Erase image to current "background color"
878 void Magick::Image::erase ( void )
881 SetImageBackgroundColor( image() );
882 throwImageException();
885 // Extends image as defined by the geometry.
887 void Magick::Image::extent ( const Geometry &geometry_ )
889 RectangleInfo extentInfo = geometry_;
891 ExceptionInfo exceptionInfo;
892 GetExceptionInfo( &exceptionInfo );
893 MagickCore::Image* newImage =
894 ExtentImage ( image(), &extentInfo, &exceptionInfo );
895 replaceImage( newImage );
896 throwException( exceptionInfo );
897 (void) DestroyExceptionInfo( &exceptionInfo );
899 void Magick::Image::extent ( const Geometry &geometry_, const Color &backgroundColor_ )
901 backgroundColor ( backgroundColor_ );
902 extent ( geometry_ );
904 void Magick::Image::extent ( const Geometry &geometry_, const GravityType gravity_ )
906 image()->gravity = gravity_;
907 extent ( geometry_ );
909 void Magick::Image::extent ( const Geometry &geometry_, const Color &backgroundColor_, const GravityType gravity_ )
911 image()->gravity = gravity_;
912 backgroundColor ( backgroundColor_ );
913 extent ( geometry_ );
916 // Flip image (reflect each scanline in the vertical direction)
917 void Magick::Image::flip ( void )
919 ExceptionInfo exceptionInfo;
920 GetExceptionInfo( &exceptionInfo );
921 MagickCore::Image* newImage =
922 FlipImage( image(), &exceptionInfo );
923 replaceImage( newImage );
924 throwException( exceptionInfo );
925 (void) DestroyExceptionInfo( &exceptionInfo );
928 // Flood-fill color across pixels that match the color of the
929 // target pixel and are neighbors of the target pixel.
930 // Uses current fuzz setting when determining color match.
931 void Magick::Image::floodFillColor( const ssize_t x_,
933 const Magick::Color &fillColor_ )
935 floodFillTexture( x_, y_, Image( Geometry( 1, 1), fillColor_ ) );
937 void Magick::Image::floodFillColor( const Geometry &point_,
938 const Magick::Color &fillColor_ )
940 floodFillTexture( point_, Image( Geometry( 1, 1), fillColor_) );
943 // Flood-fill color across pixels starting at target-pixel and
944 // stopping at pixels matching specified border color.
945 // Uses current fuzz setting when determining color match.
946 void Magick::Image::floodFillColor( const ssize_t x_,
948 const Magick::Color &fillColor_,
949 const Magick::Color &borderColor_ )
951 floodFillTexture( x_, y_, Image( Geometry( 1, 1), fillColor_),
954 void Magick::Image::floodFillColor( const Geometry &point_,
955 const Magick::Color &fillColor_,
956 const Magick::Color &borderColor_ )
958 floodFillTexture( point_, Image( Geometry( 1, 1), fillColor_),
962 // Floodfill pixels matching color (within fuzz factor) of target
963 // pixel(x,y) with replacement opacity value using method.
964 void Magick::Image::floodFillOpacity( const ssize_t x_,
966 const unsigned int opacity_,
967 const PaintMethod method_ )
970 MagickPixelPacket target;
971 GetMagickPixelPacket(image(),&target);
972 PixelPacket pixel=static_cast<PixelPacket>(pixelColor(x_,y_));
973 target.red=pixel.red;
974 target.green=pixel.green;
975 target.blue=pixel.blue;
976 target.opacity=opacity_;
977 FloodfillPaintImage ( image(),
979 options()->drawInfo(), // const DrawInfo *draw_info
981 static_cast<ssize_t>(x_), static_cast<ssize_t>(y_),
982 method_ == FloodfillMethod ? MagickFalse : MagickTrue);
983 throwImageException();
986 // Flood-fill texture 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::floodFillTexture( const ssize_t x_,
991 const Magick::Image &texture_ )
995 // Set drawing pattern
996 options()->fillPattern(texture_.constImage());
999 Pixels pixels(*this);
1001 PixelPacket *p = pixels.get(x_, y_, 1, 1 );
1002 MagickPixelPacket target;
1003 GetMagickPixelPacket(constImage(),&target);
1005 target.green=p->green;
1006 target.blue=p->blue;
1008 FloodfillPaintImage ( image(), // Image *image
1010 options()->drawInfo(), // const DrawInfo *draw_info
1011 &target, // const MagickPacket target
1012 static_cast<ssize_t>(x_), // const ssize_t x_offset
1013 static_cast<ssize_t>(y_), // const ssize_t y_offset
1014 MagickFalse // const PaintMethod method
1017 throwImageException();
1019 void Magick::Image::floodFillTexture( const Magick::Geometry &point_,
1020 const Magick::Image &texture_ )
1022 floodFillTexture( point_.xOff(), point_.yOff(), texture_ );
1025 // Flood-fill texture across pixels starting at target-pixel and
1026 // stopping at pixels matching specified border color.
1027 // Uses current fuzz setting when determining color match.
1028 void Magick::Image::floodFillTexture( const ssize_t x_,
1030 const Magick::Image &texture_,
1031 const Magick::Color &borderColor_ )
1035 // Set drawing fill pattern
1036 options()->fillPattern(texture_.constImage());
1038 MagickPixelPacket target;
1039 GetMagickPixelPacket(constImage(),&target);
1040 target.red=static_cast<PixelPacket>(borderColor_).red;
1041 target.green=static_cast<PixelPacket>(borderColor_).green;
1042 target.blue=static_cast<PixelPacket>(borderColor_).blue;
1043 FloodfillPaintImage ( image(),
1045 options()->drawInfo(),
1047 static_cast<ssize_t>(x_),
1048 static_cast<ssize_t>(y_),
1051 throwImageException();
1053 void Magick::Image::floodFillTexture( const Magick::Geometry &point_,
1054 const Magick::Image &texture_,
1055 const Magick::Color &borderColor_ )
1057 floodFillTexture( point_.xOff(), point_.yOff(), texture_, borderColor_ );
1060 // Flop image (reflect each scanline in the horizontal direction)
1061 void Magick::Image::flop ( void )
1063 ExceptionInfo exceptionInfo;
1064 GetExceptionInfo( &exceptionInfo );
1065 MagickCore::Image* newImage =
1066 FlopImage( image(), &exceptionInfo );
1067 replaceImage( newImage );
1068 throwException( exceptionInfo );
1069 (void) DestroyExceptionInfo( &exceptionInfo );
1073 void Magick::Image::frame ( const Geometry &geometry_ )
1077 info.x = static_cast<ssize_t>(geometry_.width());
1078 info.y = static_cast<ssize_t>(geometry_.height());
1079 info.width = columns() + ( static_cast<size_t>(info.x) << 1 );
1080 info.height = rows() + ( static_cast<size_t>(info.y) << 1 );
1081 info.outer_bevel = geometry_.xOff();
1082 info.inner_bevel = geometry_.yOff();
1084 ExceptionInfo exceptionInfo;
1085 GetExceptionInfo( &exceptionInfo );
1086 MagickCore::Image* newImage =
1087 FrameImage( image(), &info, &exceptionInfo );
1088 replaceImage( newImage );
1089 throwException( exceptionInfo );
1090 (void) DestroyExceptionInfo( &exceptionInfo );
1092 void Magick::Image::frame ( const size_t width_,
1093 const size_t height_,
1094 const ssize_t outerBevel_, const ssize_t innerBevel_ )
1097 info.x = static_cast<ssize_t>(width_);
1098 info.y = static_cast<ssize_t>(height_);
1099 info.width = columns() + ( static_cast<size_t>(info.x) << 1 );
1100 info.height = rows() + ( static_cast<size_t>(info.y) << 1 );
1101 info.outer_bevel = static_cast<ssize_t>(outerBevel_);
1102 info.inner_bevel = static_cast<ssize_t>(innerBevel_);
1104 ExceptionInfo exceptionInfo;
1105 GetExceptionInfo( &exceptionInfo );
1106 MagickCore::Image* newImage =
1107 FrameImage( image(), &info, &exceptionInfo );
1108 replaceImage( newImage );
1109 throwException( exceptionInfo );
1110 (void) DestroyExceptionInfo( &exceptionInfo );
1113 // Fx image. Applies a mathematical expression to the image.
1114 void Magick::Image::fx ( const std::string expression )
1116 ExceptionInfo exceptionInfo;
1117 GetExceptionInfo( &exceptionInfo );
1118 MagickCore::Image* newImage =
1119 FxImageChannel ( image(), DefaultChannels, expression.c_str(), &exceptionInfo );
1120 replaceImage( newImage );
1121 throwException( exceptionInfo );
1122 (void) DestroyExceptionInfo( &exceptionInfo );
1124 void Magick::Image::fx ( const std::string expression,
1125 const Magick::ChannelType channel )
1127 ExceptionInfo exceptionInfo;
1128 GetExceptionInfo( &exceptionInfo );
1129 MagickCore::Image* newImage =
1130 FxImageChannel ( image(), channel, expression.c_str(), &exceptionInfo );
1131 replaceImage( newImage );
1132 throwException( exceptionInfo );
1133 (void) DestroyExceptionInfo( &exceptionInfo );
1136 // Gamma correct image
1137 void Magick::Image::gamma ( const double gamma_ )
1139 char gamma[MaxTextExtent + 1];
1140 FormatMagickString( gamma, MaxTextExtent, "%3.6f", gamma_);
1143 GammaImage ( image(), gamma );
1146 void Magick::Image::gamma ( const double gammaRed_,
1147 const double gammaGreen_,
1148 const double gammaBlue_ )
1150 char gamma[MaxTextExtent + 1];
1151 FormatMagickString( gamma, MaxTextExtent, "%3.6f/%3.6f/%3.6f/",
1152 gammaRed_, gammaGreen_, gammaBlue_);
1155 GammaImage ( image(), gamma );
1156 throwImageException();
1159 // Gaussian blur image
1160 // The number of neighbor pixels to be included in the convolution
1161 // mask is specified by 'width_'. The standard deviation of the
1162 // gaussian bell curve is specified by 'sigma_'.
1163 void Magick::Image::gaussianBlur ( const double width_, const double sigma_ )
1165 ExceptionInfo exceptionInfo;
1166 GetExceptionInfo( &exceptionInfo );
1167 MagickCore::Image* newImage =
1168 GaussianBlurImage( image(), width_, sigma_, &exceptionInfo );
1169 replaceImage( newImage );
1170 throwException( exceptionInfo );
1171 (void) DestroyExceptionInfo( &exceptionInfo );
1174 void Magick::Image::gaussianBlurChannel ( const ChannelType channel_,
1175 const double width_,
1176 const double sigma_ )
1178 ExceptionInfo exceptionInfo;
1179 GetExceptionInfo( &exceptionInfo );
1180 MagickCore::Image* newImage =
1181 GaussianBlurImageChannel( image(), channel_, width_, sigma_, &exceptionInfo );
1182 replaceImage( newImage );
1183 throwException( exceptionInfo );
1184 (void) DestroyExceptionInfo( &exceptionInfo );
1187 // Apply a color lookup table (Hald CLUT) to the image.
1188 void Magick::Image::haldClut ( const Image &clutImage_ )
1191 (void) HaldClutImage( image(), clutImage_.constImage() );
1192 throwImageException();
1196 void Magick::Image::implode ( const double factor_ )
1198 ExceptionInfo exceptionInfo;
1199 GetExceptionInfo( &exceptionInfo );
1200 MagickCore::Image* newImage =
1201 ImplodeImage( image(), factor_, &exceptionInfo );
1202 replaceImage( newImage );
1203 throwException( exceptionInfo );
1204 (void) DestroyExceptionInfo( &exceptionInfo );
1207 // implements the inverse discrete Fourier transform (IFT) of the image either
1208 // as a magnitude / phase or real / imaginary image pair.
1209 void Magick::Image::inverseFourierTransform ( const Image &phase_ )
1211 ExceptionInfo exceptionInfo;
1212 GetExceptionInfo( &exceptionInfo );
1213 MagickCore::Image* newImage = InverseFourierTransformImage( image(),
1214 phase_.constImage(), MagickTrue, &exceptionInfo);
1215 replaceImage( newImage );
1216 throwException( exceptionInfo );
1217 (void) DestroyExceptionInfo( &exceptionInfo );
1219 void Magick::Image::inverseFourierTransform ( const Image &phase_,
1220 const bool magnitude_ )
1222 ExceptionInfo exceptionInfo;
1223 GetExceptionInfo( &exceptionInfo );
1224 MagickCore::Image* newImage = InverseFourierTransformImage( image(),
1225 phase_.constImage(), magnitude_ == true ? MagickTrue : MagickFalse,
1227 replaceImage( newImage );
1228 throwException( exceptionInfo );
1229 (void) DestroyExceptionInfo( &exceptionInfo );
1232 // Level image. Adjust the levels of the image by scaling the colors
1233 // falling between specified white and black points to the full
1234 // available quantum range. The parameters provided represent the
1235 // black, mid (gamma), and white points. The black point specifies
1236 // the darkest color in the image. Colors darker than the black point
1237 // are set to zero. Mid point (gamma) specifies a gamma correction to
1238 // apply to the image. White point specifies the lightest color in the
1239 // image. Colors brighter than the white point are set to the maximum
1240 // quantum value. The black and white point have the valid range 0 to
1241 // QuantumRange while gamma has a useful range of 0 to ten.
1242 void Magick::Image::level ( const double black_point,
1243 const double white_point,
1244 const double gamma )
1247 char levels[MaxTextExtent];
1248 FormatMagickString( levels, MaxTextExtent, "%g,%g,%g",black_point,white_point,gamma);
1249 (void) LevelImage( image(), levels );
1250 throwImageException();
1253 // Level image channel. Adjust the levels of the image channel by
1254 // scaling the values falling between specified white and black points
1255 // to the full available quantum range. The parameters provided
1256 // represent the black, mid (gamma), and white points. The black
1257 // point specifies the darkest color in the image. Colors darker than
1258 // the black point are set to zero. Mid point (gamma) specifies a
1259 // gamma correction to apply to the image. White point specifies the
1260 // lightest color in the image. Colors brighter than the white point
1261 // are set to the maximum quantum value. The black and white point
1262 // have the valid range 0 to QuantumRange while gamma has a useful range of
1264 void Magick::Image::levelChannel ( const Magick::ChannelType channel,
1265 const double black_point,
1266 const double white_point,
1267 const double gamma )
1270 (void) LevelImageChannel( image(), channel, black_point, white_point,
1272 throwImageException();
1275 // Magnify image by integral size
1276 void Magick::Image::magnify ( void )
1278 ExceptionInfo exceptionInfo;
1279 GetExceptionInfo( &exceptionInfo );
1280 MagickCore::Image* newImage =
1281 MagnifyImage( image(), &exceptionInfo );
1282 replaceImage( newImage );
1283 throwException( exceptionInfo );
1284 (void) DestroyExceptionInfo( &exceptionInfo );
1287 // Remap image colors with closest color from reference image
1288 void Magick::Image::map ( const Image &mapImage_ , const bool dither_ )
1291 options()->quantizeDither( dither_ );
1292 RemapImage ( options()->quantizeInfo(), image(),
1293 mapImage_.constImage());
1294 throwImageException();
1296 // Floodfill designated area with replacement opacity value
1297 void Magick::Image::matteFloodfill ( const Color &target_ ,
1298 const unsigned int opacity_,
1299 const ssize_t x_, const ssize_t y_,
1300 const Magick::PaintMethod method_ )
1303 MagickPixelPacket target;
1304 GetMagickPixelPacket(constImage(),&target);
1305 target.red=static_cast<PixelPacket>(target_).red;
1306 target.green=static_cast<PixelPacket>(target_).green;
1307 target.blue=static_cast<PixelPacket>(target_).blue;
1308 target.opacity=opacity_;
1309 FloodfillPaintImage ( image(), OpacityChannel, options()->drawInfo(), &target,
1310 x_, y_, method_ == FloodfillMethod ? MagickFalse : MagickTrue);
1311 throwImageException();
1314 // Filter image by replacing each pixel component with the median
1315 // color in a circular neighborhood
1316 void Magick::Image::medianFilter ( const double radius_ )
1318 ExceptionInfo exceptionInfo;
1319 GetExceptionInfo( &exceptionInfo );
1320 MagickCore::Image* newImage =
1321 StatisticImage ( image(), MedianStatistic, (size_t) radius_, (size_t)
1322 radius_,&exceptionInfo );
1323 replaceImage( newImage );
1324 throwException( exceptionInfo );
1325 (void) DestroyExceptionInfo( &exceptionInfo );
1328 // Reduce image by integral size
1329 void Magick::Image::minify ( void )
1331 ExceptionInfo exceptionInfo;
1332 GetExceptionInfo( &exceptionInfo );
1333 MagickCore::Image* newImage =
1334 MinifyImage( image(), &exceptionInfo );
1335 replaceImage( newImage );
1336 throwException( exceptionInfo );
1337 (void) DestroyExceptionInfo( &exceptionInfo );
1340 // Modulate percent hue, saturation, and brightness of an image
1341 void Magick::Image::modulate ( const double brightness_,
1342 const double saturation_,
1345 char modulate[MaxTextExtent + 1];
1346 FormatMagickString( modulate, MaxTextExtent, "%3.6f,%3.6f,%3.6f",
1347 brightness_, saturation_, hue_);
1350 ModulateImage( image(), modulate );
1351 throwImageException();
1354 // Motion blur image with specified blur factor
1355 // The radius_ parameter specifies the radius of the Gaussian, in
1356 // pixels, not counting the center pixel. The sigma_ parameter
1357 // specifies the standard deviation of the Laplacian, in pixels.
1358 // The angle_ parameter specifies the angle the object appears
1359 // to be comming from (zero degrees is from the right).
1360 void Magick::Image::motionBlur ( const double radius_,
1361 const double sigma_,
1362 const double angle_ )
1364 ExceptionInfo exceptionInfo;
1365 GetExceptionInfo( &exceptionInfo );
1366 MagickCore::Image* newImage =
1367 MotionBlurImage( image(), radius_, sigma_, angle_, &exceptionInfo);
1368 replaceImage( newImage );
1369 throwException( exceptionInfo );
1370 (void) DestroyExceptionInfo( &exceptionInfo );
1373 // Negate image. Set grayscale_ to true to effect grayscale values
1375 void Magick::Image::negate ( const bool grayscale_ )
1378 NegateImage ( image(), grayscale_ == true ? MagickTrue : MagickFalse );
1379 throwImageException();
1383 void Magick::Image::normalize ( void )
1386 NormalizeImage ( image() );
1387 throwImageException();
1391 void Magick::Image::oilPaint ( const double radius_ )
1393 ExceptionInfo exceptionInfo;
1394 GetExceptionInfo( &exceptionInfo );
1395 MagickCore::Image* newImage =
1396 OilPaintImage( image(), radius_, &exceptionInfo );
1397 replaceImage( newImage );
1398 throwException( exceptionInfo );
1399 (void) DestroyExceptionInfo( &exceptionInfo );
1402 // Set or attenuate the opacity channel. If the image pixels are
1403 // opaque then they are set to the specified opacity value, otherwise
1404 // they are blended with the supplied opacity value. The value of
1405 // opacity_ ranges from 0 (completely opaque) to QuantumRange. The defines
1406 // OpaqueOpacity and TransparentOpacity are available to specify
1407 // completely opaque or completely transparent, respectively.
1408 void Magick::Image::opacity ( const unsigned int opacity_ )
1411 SetImageOpacity( image(), opacity_ );
1414 // Change the color of an opaque pixel to the pen color.
1415 void Magick::Image::opaque ( const Color &opaqueColor_,
1416 const Color &penColor_ )
1418 if ( !opaqueColor_.isValid() )
1420 throwExceptionExplicit( OptionError,
1421 "Opaque color argument is invalid" );
1423 if ( !penColor_.isValid() )
1425 throwExceptionExplicit( OptionError,
1426 "Pen color argument is invalid" );
1430 std::string opaqueColor = opaqueColor_;
1431 std::string penColor = penColor_;
1433 MagickPixelPacket opaque;
1434 MagickPixelPacket pen;
1435 (void) QueryMagickColor(std::string(opaqueColor_).c_str(),&opaque,&image()->exception);
1436 (void) QueryMagickColor(std::string(penColor_).c_str(),&pen,&image()->exception);
1437 OpaquePaintImage ( image(), &opaque, &pen, MagickFalse );
1438 throwImageException();
1441 // Ping is similar to read except only enough of the image is read to
1442 // determine the image columns, rows, and filesize. Access the
1443 // columns(), rows(), and fileSize() attributes after invoking ping.
1444 // The image data is not valid after calling ping.
1445 void Magick::Image::ping ( const std::string &imageSpec_ )
1447 options()->fileName( imageSpec_ );
1448 ExceptionInfo exceptionInfo;
1449 GetExceptionInfo( &exceptionInfo );
1450 MagickCore::Image* image =
1451 PingImage( imageInfo(), &exceptionInfo );
1452 replaceImage( image );
1453 throwException( exceptionInfo );
1454 (void) DestroyExceptionInfo( &exceptionInfo );
1457 // Ping is similar to read except only enough of the image is read
1458 // to determine the image columns, rows, and filesize. Access the
1459 // columns(), rows(), and fileSize() attributes after invoking
1460 // ping. The image data is not valid after calling ping.
1461 void Magick::Image::ping ( const Blob& blob_ )
1463 ExceptionInfo exceptionInfo;
1464 GetExceptionInfo( &exceptionInfo );
1465 MagickCore::Image* image =
1466 PingBlob( imageInfo(), blob_.data(), blob_.length(), &exceptionInfo );
1467 replaceImage( image );
1468 throwException( exceptionInfo );
1469 (void) DestroyExceptionInfo( &exceptionInfo );
1472 // Execute a named process module using an argc/argv syntax similar to
1473 // that accepted by a C 'main' routine. An exception is thrown if the
1474 // requested process module doesn't exist, fails to load, or fails during
1476 void Magick::Image::process( std::string name_, const ssize_t argc, const char **argv )
1481 InvokeDynamicImageFilter( name_.c_str(), &image(), argc, argv,
1482 &image()->exception );
1484 if (status == false)
1485 throwException( image()->exception );
1488 // Quantize colors in image using current quantization settings
1489 // Set measureError_ to true in order to measure quantization error
1490 void Magick::Image::quantize ( const bool measureError_ )
1495 options()->quantizeInfo()->measure_error=MagickTrue;
1497 options()->quantizeInfo()->measure_error=MagickFalse;
1499 QuantizeImage( options()->quantizeInfo(), image() );
1501 throwImageException();
1504 // Apply an arithmetic or bitwise operator to the image pixel quantums.
1505 void Magick::Image::quantumOperator ( const ChannelType channel_,
1506 const MagickEvaluateOperator operator_,
1509 ExceptionInfo exceptionInfo;
1510 GetExceptionInfo( &exceptionInfo );
1511 EvaluateImageChannel( image(), channel_, operator_, rvalue_, &exceptionInfo);
1512 throwException( exceptionInfo );
1513 (void) DestroyExceptionInfo( &exceptionInfo );
1516 void Magick::Image::quantumOperator ( const ssize_t x_,const ssize_t y_,
1517 const size_t columns_,
1519 const ChannelType channel_,
1520 const MagickEvaluateOperator operator_,
1521 const double rvalue_)
1523 ExceptionInfo exceptionInfo;
1524 GetExceptionInfo( &exceptionInfo );
1525 RectangleInfo geometry;
1526 geometry.width = columns_;
1527 geometry.height = rows_;
1530 MagickCore::Image *crop_image = CropImage( image(), &geometry,
1532 EvaluateImageChannel( crop_image, channel_, operator_, rvalue_,
1534 (void) CompositeImage( image(), image()->matte != MagickFalse ?
1535 OverCompositeOp : CopyCompositeOp, crop_image, geometry.x, geometry.y );
1536 crop_image = DestroyImageList(crop_image);
1537 throwException( exceptionInfo );
1538 (void) DestroyExceptionInfo( &exceptionInfo );
1541 // Raise image (lighten or darken the edges of an image to give a 3-D
1542 // raised or lowered effect)
1543 void Magick::Image::raise ( const Geometry &geometry_ ,
1544 const bool raisedFlag_ )
1546 RectangleInfo raiseInfo = geometry_;
1548 RaiseImage ( image(), &raiseInfo, raisedFlag_ == true ? MagickTrue : MagickFalse );
1549 throwImageException();
1553 // Random threshold image.
1555 // Changes the value of individual pixels based on the intensity
1556 // of each pixel compared to a random threshold. The result is a
1557 // low-contrast, two color image. The thresholds_ argument is a
1558 // geometry containing LOWxHIGH thresholds. If the string
1559 // contains 2x2, 3x3, or 4x4, then an ordered dither of order 2,
1560 // 3, or 4 will be performed instead. If a channel_ argument is
1561 // specified then only the specified channel is altered. This is
1562 // a very fast alternative to 'quantize' based dithering.
1563 void Magick::Image::randomThreshold( const Geometry &thresholds_ )
1565 randomThresholdChannel(thresholds_,DefaultChannels);
1567 void Magick::Image::randomThresholdChannel( const Geometry &thresholds_,
1568 const ChannelType channel_ )
1570 ExceptionInfo exceptionInfo;
1571 GetExceptionInfo( &exceptionInfo );
1573 (void) RandomThresholdImageChannel( image(),
1575 static_cast<std::string>(thresholds_).c_str(),
1577 throwImageException();
1578 (void) DestroyExceptionInfo( &exceptionInfo );
1581 // Read image into current object
1582 void Magick::Image::read ( const std::string &imageSpec_ )
1584 options()->fileName( imageSpec_ );
1586 ExceptionInfo exceptionInfo;
1587 GetExceptionInfo( &exceptionInfo );
1588 MagickCore::Image* image =
1589 ReadImage( imageInfo(), &exceptionInfo );
1591 // Ensure that multiple image frames were not read.
1592 if ( image && image->next )
1594 // Destroy any extra image frames
1595 MagickCore::Image* next = image->next;
1598 DestroyImageList( next );
1601 replaceImage( image );
1602 throwException( exceptionInfo );
1604 throwException( image->exception );
1605 (void) DestroyExceptionInfo( &exceptionInfo );
1608 // Read image of specified size into current object
1609 void Magick::Image::read ( const Geometry &size_,
1610 const std::string &imageSpec_ )
1616 // Read image from in-memory BLOB
1617 void Magick::Image::read ( const Blob &blob_ )
1619 ExceptionInfo exceptionInfo;
1620 GetExceptionInfo( &exceptionInfo );
1621 MagickCore::Image* image =
1622 BlobToImage( imageInfo(),
1623 static_cast<const void *>(blob_.data()),
1624 blob_.length(), &exceptionInfo );
1625 replaceImage( image );
1626 throwException( exceptionInfo );
1628 throwException( image->exception );
1629 (void) DestroyExceptionInfo( &exceptionInfo );
1632 // Read image of specified size from in-memory BLOB
1633 void Magick::Image::read ( const Blob &blob_,
1634 const Geometry &size_ )
1642 // Read image of specified size and depth from in-memory BLOB
1643 void Magick::Image::read ( const Blob &blob_,
1644 const Geometry &size_,
1645 const size_t depth_ )
1655 // Read image of specified size, depth, and format from in-memory BLOB
1656 void Magick::Image::read ( const Blob &blob_,
1657 const Geometry &size_,
1658 const size_t depth_,
1659 const std::string &magick_ )
1667 // Set explicit image format
1668 fileName( magick_ + ':');
1673 // Read image of specified size, and format from in-memory BLOB
1674 void Magick::Image::read ( const Blob &blob_,
1675 const Geometry &size_,
1676 const std::string &magick_ )
1682 // Set explicit image format
1683 fileName( magick_ + ':');
1688 // Read image based on raw pixels in memory (ConstituteImage)
1689 void Magick::Image::read ( const size_t width_,
1690 const size_t height_,
1691 const std::string &map_,
1692 const StorageType type_,
1693 const void *pixels_ )
1695 ExceptionInfo exceptionInfo;
1696 GetExceptionInfo( &exceptionInfo );
1697 MagickCore::Image* image =
1698 ConstituteImage( width_, height_, map_.c_str(), type_, pixels_,
1700 replaceImage( image );
1701 throwException( exceptionInfo );
1703 throwException( image->exception );
1704 (void) DestroyExceptionInfo( &exceptionInfo );
1707 // Reduce noise in image
1708 void Magick::Image::reduceNoise ( const double order_ )
1710 ExceptionInfo exceptionInfo;
1711 GetExceptionInfo( &exceptionInfo );
1712 MagickCore::Image* newImage =
1713 StatisticImage( image(), NonpeakStatistic, (size_t) order_, (size_t) order_,
1715 replaceImage( newImage );
1716 throwException( exceptionInfo );
1717 (void) DestroyExceptionInfo( &exceptionInfo );
1721 void Magick::Image::resize( const Geometry &geometry_ )
1723 // Calculate new size. This code should be supported using binary arguments
1724 // in the ImageMagick library.
1727 size_t width = columns();
1728 size_t height = rows();
1730 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1734 ExceptionInfo exceptionInfo;
1735 GetExceptionInfo( &exceptionInfo );
1736 MagickCore::Image* newImage =
1737 ResizeImage( image(),
1743 replaceImage( newImage );
1744 throwException( exceptionInfo );
1745 (void) DestroyExceptionInfo( &exceptionInfo );
1749 void Magick::Image::roll ( const Geometry &roll_ )
1751 ssize_t xOff = roll_.xOff();
1752 if ( roll_.xNegative() )
1754 ssize_t yOff = roll_.yOff();
1755 if ( roll_.yNegative() )
1758 ExceptionInfo exceptionInfo;
1759 GetExceptionInfo( &exceptionInfo );
1760 MagickCore::Image* newImage =
1761 RollImage( image(), xOff, yOff, &exceptionInfo );
1762 replaceImage( newImage );
1763 throwException( exceptionInfo );
1764 (void) DestroyExceptionInfo( &exceptionInfo );
1766 void Magick::Image::roll ( const size_t columns_,
1767 const size_t rows_ )
1769 ExceptionInfo exceptionInfo;
1770 GetExceptionInfo( &exceptionInfo );
1771 MagickCore::Image* newImage =
1773 static_cast<ssize_t>(columns_),
1774 static_cast<ssize_t>(rows_), &exceptionInfo );
1775 replaceImage( newImage );
1776 throwException( exceptionInfo );
1777 (void) DestroyExceptionInfo( &exceptionInfo );
1781 void Magick::Image::rotate ( const double degrees_ )
1783 ExceptionInfo exceptionInfo;
1784 GetExceptionInfo( &exceptionInfo );
1785 MagickCore::Image* newImage =
1786 RotateImage( image(), degrees_, &exceptionInfo);
1787 replaceImage( newImage );
1788 throwException( exceptionInfo );
1789 (void) DestroyExceptionInfo( &exceptionInfo );
1793 void Magick::Image::sample ( const Geometry &geometry_ )
1797 size_t width = columns();
1798 size_t height = rows();
1800 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1804 ExceptionInfo exceptionInfo;
1805 GetExceptionInfo( &exceptionInfo );
1806 MagickCore::Image* newImage =
1807 SampleImage( image(), width, height, &exceptionInfo );
1808 replaceImage( newImage );
1809 throwException( exceptionInfo );
1810 (void) DestroyExceptionInfo( &exceptionInfo );
1814 void Magick::Image::scale ( const Geometry &geometry_ )
1818 size_t width = columns();
1819 size_t height = rows();
1821 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1825 ExceptionInfo exceptionInfo;
1826 GetExceptionInfo( &exceptionInfo );
1827 MagickCore::Image* newImage =
1828 ScaleImage( image(), width, height, &exceptionInfo );
1829 replaceImage( newImage );
1830 throwException( exceptionInfo );
1831 (void) DestroyExceptionInfo( &exceptionInfo );
1834 // Segment (coalesce similar image components) by analyzing the
1835 // histograms of the color components and identifying units that are
1836 // homogeneous with the fuzzy c-means technique.
1837 void Magick::Image::segment ( const double clusterThreshold_,
1838 const double smoothingThreshold_ )
1841 SegmentImage ( image(),
1842 options()->quantizeColorSpace(),
1843 (MagickBooleanType) options()->verbose(),
1845 smoothingThreshold_ );
1846 throwImageException();
1847 SyncImage( image() );
1848 throwImageException();
1851 // Shade image using distant light source
1852 void Magick::Image::shade ( const double azimuth_,
1853 const double elevation_,
1854 const bool colorShading_ )
1856 ExceptionInfo exceptionInfo;
1857 GetExceptionInfo( &exceptionInfo );
1858 MagickCore::Image* newImage =
1859 ShadeImage( image(),
1860 colorShading_ == true ? MagickTrue : MagickFalse,
1864 replaceImage( newImage );
1865 throwException( exceptionInfo );
1866 (void) DestroyExceptionInfo( &exceptionInfo );
1869 // Sharpen pixels in image
1870 void Magick::Image::sharpen ( const double radius_, const double sigma_ )
1872 ExceptionInfo exceptionInfo;
1873 GetExceptionInfo( &exceptionInfo );
1874 MagickCore::Image* newImage =
1875 SharpenImage( image(),
1879 replaceImage( newImage );
1880 throwException( exceptionInfo );
1881 (void) DestroyExceptionInfo( &exceptionInfo );
1884 void Magick::Image::sharpenChannel ( const ChannelType channel_,
1885 const double radius_, const double sigma_ )
1887 ExceptionInfo exceptionInfo;
1888 GetExceptionInfo( &exceptionInfo );
1889 MagickCore::Image* newImage =
1890 SharpenImageChannel( image(),
1895 replaceImage( newImage );
1896 throwException( exceptionInfo );
1897 (void) DestroyExceptionInfo( &exceptionInfo );
1900 // Shave pixels from image edges.
1901 void Magick::Image::shave ( const Geometry &geometry_ )
1903 RectangleInfo shaveInfo = geometry_;
1904 ExceptionInfo exceptionInfo;
1905 GetExceptionInfo( &exceptionInfo );
1906 MagickCore::Image* newImage =
1907 ShaveImage( image(),
1910 replaceImage( newImage );
1911 throwException( exceptionInfo );
1912 (void) DestroyExceptionInfo( &exceptionInfo );
1916 void Magick::Image::shear ( const double xShearAngle_,
1917 const double yShearAngle_ )
1919 ExceptionInfo exceptionInfo;
1920 GetExceptionInfo( &exceptionInfo );
1921 MagickCore::Image* newImage =
1922 ShearImage( image(),
1926 replaceImage( newImage );
1927 throwException( exceptionInfo );
1928 (void) DestroyExceptionInfo( &exceptionInfo );
1932 void Magick::Image::sigmoidalContrast ( const size_t sharpen_, const double contrast, const double midpoint )
1935 (void) SigmoidalContrastImageChannel( image(), DefaultChannels, (MagickBooleanType) sharpen_, contrast, midpoint );
1936 throwImageException();
1939 // Solarize image (similar to effect seen when exposing a photographic
1940 // film to light during the development process)
1941 void Magick::Image::solarize ( const double factor_ )
1944 SolarizeImage ( image(), factor_ );
1945 throwImageException();
1948 // Sparse color image, given a set of coordinates, interpolates the colors
1949 // found at those coordinates, across the whole image, using various methods.
1951 void Magick::Image::sparseColor ( const ChannelType channel,
1952 const SparseColorMethod method,
1953 const size_t number_arguments,
1954 const double *arguments )
1956 ExceptionInfo exceptionInfo;
1957 GetExceptionInfo( &exceptionInfo );
1958 MagickCore::Image* newImage = SparseColorImage ( image(), channel, method,
1959 number_arguments, arguments, &exceptionInfo );
1960 replaceImage( newImage );
1961 throwException( exceptionInfo );
1962 (void) DestroyExceptionInfo( &exceptionInfo );
1965 // Spread pixels randomly within image by specified ammount
1966 void Magick::Image::spread ( const size_t amount_ )
1968 ExceptionInfo exceptionInfo;
1969 GetExceptionInfo( &exceptionInfo );
1970 MagickCore::Image* newImage =
1971 SpreadImage( image(),
1974 replaceImage( newImage );
1975 throwException( exceptionInfo );
1976 (void) DestroyExceptionInfo( &exceptionInfo );
1979 // Add a digital watermark to the image (based on second image)
1980 void Magick::Image::stegano ( const Image &watermark_ )
1982 ExceptionInfo exceptionInfo;
1983 GetExceptionInfo( &exceptionInfo );
1984 MagickCore::Image* newImage =
1985 SteganoImage( image(),
1986 watermark_.constImage(),
1988 replaceImage( newImage );
1989 throwException( exceptionInfo );
1990 (void) DestroyExceptionInfo( &exceptionInfo );
1993 // Stereo image (left image is current image)
1994 void Magick::Image::stereo ( const Image &rightImage_ )
1996 ExceptionInfo exceptionInfo;
1997 GetExceptionInfo( &exceptionInfo );
1998 MagickCore::Image* newImage =
1999 StereoImage( image(),
2000 rightImage_.constImage(),
2002 replaceImage( newImage );
2003 throwException( exceptionInfo );
2004 (void) DestroyExceptionInfo( &exceptionInfo );
2008 void Magick::Image::swirl ( const double degrees_ )
2010 ExceptionInfo exceptionInfo;
2011 GetExceptionInfo( &exceptionInfo );
2012 MagickCore::Image* newImage =
2013 SwirlImage( image(), degrees_,
2015 replaceImage( newImage );
2016 throwException( exceptionInfo );
2017 (void) DestroyExceptionInfo( &exceptionInfo );
2021 void Magick::Image::texture ( const Image &texture_ )
2024 TextureImage( image(), texture_.constImage() );
2025 throwImageException();
2029 void Magick::Image::threshold ( const double threshold_ )
2032 BilevelImage( image(), threshold_ );
2033 throwImageException();
2036 // Transform image based on image geometry only
2037 void Magick::Image::transform ( const Geometry &imageGeometry_ )
2040 TransformImage ( &(image()), 0,
2041 std::string(imageGeometry_).c_str() );
2042 throwImageException();
2044 // Transform image based on image and crop geometries
2045 void Magick::Image::transform ( const Geometry &imageGeometry_,
2046 const Geometry &cropGeometry_ )
2049 TransformImage ( &(image()), std::string(cropGeometry_).c_str(),
2050 std::string(imageGeometry_).c_str() );
2051 throwImageException();
2054 // Add matte image to image, setting pixels matching color to transparent
2055 void Magick::Image::transparent ( const Color &color_ )
2057 if ( !color_.isValid() )
2059 throwExceptionExplicit( OptionError,
2060 "Color argument is invalid" );
2063 std::string color = color_;
2065 MagickPixelPacket target;
2066 (void) QueryMagickColor(std::string(color_).c_str(),&target,&image()->exception);
2068 TransparentPaintImage ( image(), &target, TransparentOpacity, MagickFalse );
2069 throwImageException();
2072 // Add matte image to image, setting pixels matching color to transparent
2073 void Magick::Image::transparentChroma(const Color &colorLow_,
2074 const Color &colorHigh_)
2076 if ( !colorLow_.isValid() || !colorHigh_.isValid() )
2078 throwExceptionExplicit( OptionError,
2079 "Color argument is invalid" );
2082 std::string colorLow = colorLow_;
2083 std::string colorHigh = colorHigh_;
2085 MagickPixelPacket targetLow;
2086 MagickPixelPacket targetHigh;
2087 (void) QueryMagickColor(std::string(colorLow_).c_str(),&targetLow,
2088 &image()->exception);
2089 (void) QueryMagickColor(std::string(colorHigh_).c_str(),&targetHigh,
2090 &image()->exception);
2092 TransparentPaintImageChroma ( image(), &targetLow, &targetHigh,
2093 TransparentOpacity, MagickFalse );
2094 throwImageException();
2098 // Trim edges that are the background color from the image
2099 void Magick::Image::trim ( void )
2101 ExceptionInfo exceptionInfo;
2102 GetExceptionInfo( &exceptionInfo );
2103 MagickCore::Image* newImage =
2104 TrimImage( image(), &exceptionInfo);
2105 replaceImage( newImage );
2106 throwException( exceptionInfo );
2107 (void) DestroyExceptionInfo( &exceptionInfo );
2110 // Replace image with a sharpened version of the original image
2111 // using the unsharp mask algorithm.
2113 // the radius of the Gaussian, in pixels, not counting the
2116 // the standard deviation of the Gaussian, in pixels.
2118 // the percentage of the difference between the original and
2119 // the blur image that is added back into the original.
2121 // the threshold in pixels needed to apply the diffence amount.
2122 void Magick::Image::unsharpmask ( const double radius_,
2123 const double sigma_,
2124 const double amount_,
2125 const double threshold_ )
2127 ExceptionInfo exceptionInfo;
2128 GetExceptionInfo( &exceptionInfo );
2129 MagickCore::Image* newImage =
2130 UnsharpMaskImage( image(),
2136 replaceImage( newImage );
2137 throwException( exceptionInfo );
2138 (void) DestroyExceptionInfo( &exceptionInfo );
2141 void Magick::Image::unsharpmaskChannel ( const ChannelType channel_,
2142 const double radius_,
2143 const double sigma_,
2144 const double amount_,
2145 const double threshold_ )
2147 ExceptionInfo exceptionInfo;
2148 GetExceptionInfo( &exceptionInfo );
2149 MagickCore::Image* newImage =
2150 UnsharpMaskImageChannel( image(),
2157 replaceImage( newImage );
2158 throwException( exceptionInfo );
2159 (void) DestroyExceptionInfo( &exceptionInfo );
2162 // Map image pixels to a sine wave
2163 void Magick::Image::wave ( const double amplitude_, const double wavelength_ )
2165 ExceptionInfo exceptionInfo;
2166 GetExceptionInfo( &exceptionInfo );
2167 MagickCore::Image* newImage =
2172 replaceImage( newImage );
2173 throwException( exceptionInfo );
2174 (void) DestroyExceptionInfo( &exceptionInfo );
2177 // Write image to file
2178 void Magick::Image::write( const std::string &imageSpec_ )
2181 fileName( imageSpec_ );
2182 WriteImage( imageInfo(), image() );
2183 throwImageException();
2186 // Write image to in-memory BLOB
2187 void Magick::Image::write ( Blob *blob_ )
2190 size_t length = 2048; // Efficient size for small images
2191 ExceptionInfo exceptionInfo;
2192 GetExceptionInfo( &exceptionInfo );
2193 void* data = ImageToBlob( imageInfo(),
2197 throwException( exceptionInfo );
2198 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2199 throwImageException();
2200 (void) DestroyExceptionInfo( &exceptionInfo );
2202 void Magick::Image::write ( Blob *blob_,
2203 const std::string &magick_ )
2207 size_t length = 2048; // Efficient size for small images
2208 ExceptionInfo exceptionInfo;
2209 GetExceptionInfo( &exceptionInfo );
2210 void* data = ImageToBlob( imageInfo(),
2214 throwException( exceptionInfo );
2215 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2216 throwImageException();
2217 (void) DestroyExceptionInfo( &exceptionInfo );
2219 void Magick::Image::write ( Blob *blob_,
2220 const std::string &magick_,
2221 const size_t depth_ )
2226 size_t length = 2048; // Efficient size for small images
2227 ExceptionInfo exceptionInfo;
2228 GetExceptionInfo( &exceptionInfo );
2229 void* data = ImageToBlob( imageInfo(),
2233 throwException( exceptionInfo );
2234 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2235 throwImageException();
2236 (void) DestroyExceptionInfo( &exceptionInfo );
2239 // Write image to an array of pixels with storage type specified
2240 // by user (ExportImagePixels), e.g.
2241 // image.write( 0, 0, 640, 1, "RGB", 0, pixels );
2242 void Magick::Image::write ( const ssize_t x_,
2244 const size_t columns_,
2246 const std::string &map_,
2247 const StorageType type_,
2250 ExceptionInfo exceptionInfo;
2251 GetExceptionInfo( &exceptionInfo );
2252 ExportImagePixels( image(), x_, y_, columns_, rows_, map_.c_str(), type_,
2255 throwException( exceptionInfo );
2256 (void) DestroyExceptionInfo( &exceptionInfo );
2260 void Magick::Image::zoom( const Geometry &geometry_ )
2262 // Calculate new size. This code should be supported using binary arguments
2263 // in the ImageMagick library.
2266 size_t width = columns();
2267 size_t height = rows();
2269 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
2273 ExceptionInfo exceptionInfo;
2274 GetExceptionInfo( &exceptionInfo );
2275 MagickCore::Image* newImage =
2276 ResizeImage( image(),
2282 replaceImage( newImage );
2283 throwException( exceptionInfo );
2284 (void) DestroyExceptionInfo( &exceptionInfo );
2288 * Methods for setting image attributes
2292 // Join images into a single multi-image file
2293 void Magick::Image::adjoin ( const bool flag_ )
2296 options()->adjoin( flag_ );
2298 bool Magick::Image::adjoin ( void ) const
2300 return constOptions()->adjoin();
2303 // Remove pixel aliasing
2304 void Magick::Image::antiAlias( const bool flag_ )
2307 options()->antiAlias( static_cast<size_t>(flag_) );
2309 bool Magick::Image::antiAlias( void )
2311 return static_cast<bool>( options()->antiAlias( ) );
2314 // Animation inter-frame delay
2315 void Magick::Image::animationDelay ( const size_t delay_ )
2318 image()->delay = delay_;
2320 size_t Magick::Image::animationDelay ( void ) const
2322 return constImage()->delay;
2325 // Number of iterations to play animation
2326 void Magick::Image::animationIterations ( const size_t iterations_ )
2329 image()->iterations = iterations_;
2331 size_t Magick::Image::animationIterations ( void ) const
2333 return constImage()->iterations;
2336 // Access/Update a named image attribute
2337 void Magick::Image::attribute ( const std::string name_,
2338 const std::string value_ )
2341 SetImageProperty( image(), name_.c_str(), value_.c_str() );
2343 std::string Magick::Image::attribute ( const std::string name_ )
2345 const char *value = GetImageProperty( constImage(), name_.c_str() );
2348 return std::string( value );
2350 return std::string(); // Intentionally no exception
2354 void Magick::Image::backgroundColor ( const Color &backgroundColor_ )
2358 if ( backgroundColor_.isValid() )
2360 image()->background_color = backgroundColor_;
2364 image()->background_color = Color();
2367 options()->backgroundColor( backgroundColor_ );
2369 Magick::Color Magick::Image::backgroundColor ( void ) const
2371 return constOptions()->backgroundColor( );
2374 // Background fill texture
2375 void Magick::Image::backgroundTexture ( const std::string &backgroundTexture_ )
2378 options()->backgroundTexture( backgroundTexture_ );
2380 std::string Magick::Image::backgroundTexture ( void ) const
2382 return constOptions()->backgroundTexture( );
2385 // Original image columns
2386 size_t Magick::Image::baseColumns ( void ) const
2388 return constImage()->magick_columns;
2391 // Original image name
2392 std::string Magick::Image::baseFilename ( void ) const
2394 return std::string(constImage()->magick_filename);
2397 // Original image rows
2398 size_t Magick::Image::baseRows ( void ) const
2400 return constImage()->magick_rows;
2404 void Magick::Image::borderColor ( const Color &borderColor_ )
2408 if ( borderColor_.isValid() )
2410 image()->border_color = borderColor_;
2414 image()->border_color = Color();
2417 options()->borderColor( borderColor_ );
2419 Magick::Color Magick::Image::borderColor ( void ) const
2421 return constOptions()->borderColor( );
2424 // Return smallest bounding box enclosing non-border pixels. The
2425 // current fuzz value is used when discriminating between pixels.
2426 // This is the crop bounding box used by crop(Geometry(0,0));
2427 Magick::Geometry Magick::Image::boundingBox ( void ) const
2429 ExceptionInfo exceptionInfo;
2430 GetExceptionInfo( &exceptionInfo );
2431 RectangleInfo bbox = GetImageBoundingBox( constImage(), &exceptionInfo);
2432 throwException( exceptionInfo );
2433 (void) DestroyExceptionInfo( &exceptionInfo );
2434 return Geometry( bbox );
2437 // Text bounding-box base color
2438 void Magick::Image::boxColor ( const Color &boxColor_ )
2441 options()->boxColor( boxColor_ );
2443 Magick::Color Magick::Image::boxColor ( void ) const
2445 return constOptions()->boxColor( );
2448 // Pixel cache threshold. Once this threshold is exceeded, all
2449 // subsequent pixels cache operations are to/from disk.
2450 // This setting is shared by all Image objects.
2452 void Magick::Image::cacheThreshold ( const size_t threshold_ )
2454 SetMagickResourceLimit( MemoryResource, threshold_ );
2457 void Magick::Image::chromaBluePrimary ( const double x_, const double y_ )
2460 image()->chromaticity.blue_primary.x = x_;
2461 image()->chromaticity.blue_primary.y = y_;
2463 void Magick::Image::chromaBluePrimary ( double *x_, double *y_ ) const
2465 *x_ = constImage()->chromaticity.blue_primary.x;
2466 *y_ = constImage()->chromaticity.blue_primary.y;
2469 void Magick::Image::chromaGreenPrimary ( const double x_, const double y_ )
2472 image()->chromaticity.green_primary.x = x_;
2473 image()->chromaticity.green_primary.y = y_;
2475 void Magick::Image::chromaGreenPrimary ( double *x_, double *y_ ) const
2477 *x_ = constImage()->chromaticity.green_primary.x;
2478 *y_ = constImage()->chromaticity.green_primary.y;
2481 void Magick::Image::chromaRedPrimary ( const double x_, const double y_ )
2484 image()->chromaticity.red_primary.x = x_;
2485 image()->chromaticity.red_primary.y = y_;
2487 void Magick::Image::chromaRedPrimary ( double *x_, double *y_ ) const
2489 *x_ = constImage()->chromaticity.red_primary.x;
2490 *y_ = constImage()->chromaticity.red_primary.y;
2493 void Magick::Image::chromaWhitePoint ( const double x_, const double y_ )
2496 image()->chromaticity.white_point.x = x_;
2497 image()->chromaticity.white_point.y = y_;
2499 void Magick::Image::chromaWhitePoint ( double *x_, double *y_ ) const
2501 *x_ = constImage()->chromaticity.white_point.x;
2502 *y_ = constImage()->chromaticity.white_point.y;
2505 // Set image storage class
2506 void Magick::Image::classType ( const ClassType class_ )
2508 if ( classType() == PseudoClass && class_ == DirectClass )
2510 // Use SyncImage to synchronize the DirectClass pixels with the
2511 // color map and then set to DirectClass type.
2513 SyncImage( image() );
2514 image()->colormap = (PixelPacket *)
2515 RelinquishMagickMemory( image()->colormap );
2516 image()->storage_class = static_cast<MagickCore::ClassType>(DirectClass);
2520 if ( classType() == DirectClass && class_ == PseudoClass )
2522 // Quantize to create PseudoClass color map
2524 quantizeColors(MaxColormapSize);
2526 image()->storage_class = static_cast<MagickCore::ClassType>(PseudoClass);
2530 // Associate a clip mask with the image. The clip mask must be the
2531 // same dimensions as the image. Pass an invalid image to unset an
2532 // existing clip mask.
2533 void Magick::Image::clipMask ( const Magick::Image & clipMask_ )
2537 if( clipMask_.isValid() )
2540 SetImageClipMask( image(), clipMask_.constImage() );
2544 // Unset existing clip mask
2545 SetImageClipMask( image(), 0 );
2548 Magick::Image Magick::Image::clipMask ( void ) const
2550 ExceptionInfo exceptionInfo;
2551 GetExceptionInfo( &exceptionInfo );
2552 MagickCore::Image* image =
2553 GetImageClipMask( constImage(), &exceptionInfo );
2554 throwException( exceptionInfo );
2555 (void) DestroyExceptionInfo( &exceptionInfo );
2556 return Magick::Image( image );
2559 void Magick::Image::colorFuzz ( const double fuzz_ )
2562 image()->fuzz = fuzz_;
2563 options()->colorFuzz( fuzz_ );
2565 double Magick::Image::colorFuzz ( void ) const
2567 return constOptions()->colorFuzz( );
2570 // Set color in colormap at index
2571 void Magick::Image::colorMap ( const size_t index_,
2572 const Color &color_ )
2574 MagickCore::Image* imageptr = image();
2576 if (index_ > (MaxColormapSize-1) )
2577 throwExceptionExplicit( OptionError,
2578 "Colormap index must be less than MaxColormapSize" );
2580 if ( !color_.isValid() )
2581 throwExceptionExplicit( OptionError,
2582 "Color argument is invalid");
2585 // Ensure that colormap size is large enough
2586 if ( colorMapSize() < (index_+1) )
2587 colorMapSize( index_ + 1 );
2589 // Set color at index in colormap
2590 (imageptr->colormap)[index_] = color_;
2592 // Return color in colormap at index
2593 Magick::Color Magick::Image::colorMap ( const size_t index_ ) const
2595 const MagickCore::Image* imageptr = constImage();
2597 if ( !imageptr->colormap )
2598 throwExceptionExplicit( OptionError,
2599 "Image does not contain a colormap");
2601 if ( index_ > imageptr->colors-1 )
2602 throwExceptionExplicit( OptionError,
2603 "Index out of range");
2605 return Magick::Color( (imageptr->colormap)[index_] );
2608 // Colormap size (number of colormap entries)
2609 void Magick::Image::colorMapSize ( const size_t entries_ )
2611 if (entries_ >MaxColormapSize )
2612 throwExceptionExplicit( OptionError,
2613 "Colormap entries must not exceed MaxColormapSize" );
2617 MagickCore::Image* imageptr = image();
2619 if( !imageptr->colormap )
2621 // Allocate colormap
2622 imageptr->colormap =
2623 static_cast<PixelPacket*>(AcquireMagickMemory(entries_*sizeof(PixelPacket)));
2624 imageptr->colors = 0;
2626 else if ( entries_ > imageptr->colors )
2628 // Re-allocate colormap
2629 imageptr->colormap=(PixelPacket *)
2630 ResizeMagickMemory(imageptr->colormap,(entries_)*sizeof(PixelPacket));
2633 // Initialize any new colormap entries as all black
2635 for( size_t i=imageptr->colors; i<(entries_-1); i++ )
2636 (imageptr->colormap)[i] = black;
2638 imageptr->colors = entries_;
2640 size_t Magick::Image::colorMapSize ( void )
2642 const MagickCore::Image* imageptr = constImage();
2644 if ( !imageptr->colormap )
2645 throwExceptionExplicit( OptionError,
2646 "Image does not contain a colormap");
2648 return imageptr->colors;
2652 void Magick::Image::colorSpace( const ColorspaceType colorSpace_ )
2655 if ( image()->colorspace == colorSpace_ )
2660 if ( colorSpace_ != RGBColorspace &&
2661 colorSpace_ != TransparentColorspace &&
2662 colorSpace_ != GRAYColorspace )
2664 if (image()->colorspace != RGBColorspace &&
2665 image()->colorspace != TransparentColorspace &&
2666 image()->colorspace != GRAYColorspace)
2668 /* Transform to RGB colorspace as intermediate step */
2669 TransformRGBImage( image(), image()->colorspace );
2670 throwImageException();
2672 /* Transform to final non-RGB colorspace */
2673 RGBTransformImage( image(), colorSpace_ );
2674 throwImageException();
2678 if ( colorSpace_ == RGBColorspace ||
2679 colorSpace_ == TransparentColorspace ||
2680 colorSpace_ == GRAYColorspace )
2682 /* Transform to a RGB-type colorspace */
2683 TransformRGBImage( image(), image()->colorspace );
2684 throwImageException();
2688 Magick::ColorspaceType Magick::Image::colorSpace ( void ) const
2690 return constImage()->colorspace;
2693 // Set image colorspace type.
2694 void Magick::Image::colorspaceType( const ColorspaceType colorSpace_ )
2697 options()->colorspaceType( colorSpace_ );
2699 Magick::ColorspaceType Magick::Image::colorspaceType ( void ) const
2701 return constOptions()->colorspaceType();
2706 void Magick::Image::comment ( const std::string &comment_ )
2709 SetImageProperty( image(), "Comment", NULL );
2710 if ( comment_.length() > 0 )
2711 SetImageProperty( image(), "Comment", comment_.c_str() );
2712 throwImageException();
2714 std::string Magick::Image::comment ( void ) const
2716 const char *value = GetImageProperty( constImage(), "Comment" );
2719 return std::string( value );
2721 return std::string(); // Intentionally no exception
2724 // Composition operator to be used when composition is implicitly used
2725 // (such as for image flattening).
2726 void Magick::Image::compose (const CompositeOperator compose_)
2728 image()->compose=compose_;
2731 Magick::CompositeOperator Magick::Image::compose ( void ) const
2733 return constImage()->compose;
2736 // Compression algorithm
2737 void Magick::Image::compressType ( const CompressionType compressType_ )
2740 image()->compression = compressType_;
2741 options()->compressType( compressType_ );
2743 Magick::CompressionType Magick::Image::compressType ( void ) const
2745 return constImage()->compression;
2748 // Enable printing of debug messages from ImageMagick
2749 void Magick::Image::debug ( const bool flag_ )
2752 options()->debug( flag_ );
2754 bool Magick::Image::debug ( void ) const
2756 return constOptions()->debug();
2759 // Tagged image format define (set/access coder-specific option) The
2760 // magick_ option specifies the coder the define applies to. The key_
2761 // option provides the key specific to that coder. The value_ option
2762 // provides the value to set (if any). See the defineSet() method if the
2763 // key must be removed entirely.
2764 void Magick::Image::defineValue ( const std::string &magick_,
2765 const std::string &key_,
2766 const std::string &value_ )
2769 std::string format = magick_ + ":" + key_;
2770 std::string option = value_;
2771 (void) SetImageOption ( imageInfo(), format.c_str(), option.c_str() );
2773 std::string Magick::Image::defineValue ( const std::string &magick_,
2774 const std::string &key_ ) const
2776 std::string definition = magick_ + ":" + key_;
2777 const char *option =
2778 GetImageOption ( constImageInfo(), definition.c_str() );
2780 return std::string( option );
2781 return std::string( );
2784 // Tagged image format define. Similar to the defineValue() method
2785 // except that passing the flag_ value 'true' creates a value-less
2786 // define with that format and key. Passing the flag_ value 'false'
2787 // removes any existing matching definition. The method returns 'true'
2788 // if a matching key exists, and 'false' if no matching key exists.
2789 void Magick::Image::defineSet ( const std::string &magick_,
2790 const std::string &key_,
2794 std::string definition = magick_ + ":" + key_;
2797 (void) SetImageOption ( imageInfo(), definition.c_str(), "" );
2801 DeleteImageOption( imageInfo(), definition.c_str() );
2804 bool Magick::Image::defineSet ( const std::string &magick_,
2805 const std::string &key_ ) const
2807 std::string key = magick_ + ":" + key_;
2808 const char *option =
2809 GetImageOption ( constImageInfo(), key.c_str() );
2816 void Magick::Image::density ( const Geometry &density_ )
2819 options()->density( density_ );
2820 if ( density_.isValid() )
2822 image()->x_resolution = density_.width();
2823 if ( density_.height() != 0 )
2825 image()->y_resolution = density_.height();
2829 image()->y_resolution = density_.width();
2835 image()->x_resolution = 0;
2836 image()->y_resolution = 0;
2839 Magick::Geometry Magick::Image::density ( void ) const
2843 ssize_t x_resolution=72;
2844 ssize_t y_resolution=72;
2846 if (constImage()->x_resolution > 0.0)
2847 x_resolution=static_cast<ssize_t>(constImage()->x_resolution + 0.5);
2849 if (constImage()->y_resolution > 0.0)
2850 y_resolution=static_cast<ssize_t>(constImage()->y_resolution + 0.5);
2852 return Geometry(x_resolution,y_resolution);
2855 return constOptions()->density( );
2858 // Image depth (bits allocated to red/green/blue components)
2859 void Magick::Image::depth ( const size_t depth_ )
2861 size_t depth = depth_;
2863 if (depth > MAGICKCORE_QUANTUM_DEPTH)
2864 depth=MAGICKCORE_QUANTUM_DEPTH;
2867 image()->depth=depth;
2868 options()->depth( depth );
2870 size_t Magick::Image::depth ( void ) const
2872 return constImage()->depth;
2875 std::string Magick::Image::directory ( void ) const
2877 if ( constImage()->directory )
2878 return std::string( constImage()->directory );
2880 throwExceptionExplicit( CorruptImageWarning,
2881 "Image does not contain a directory");
2883 return std::string();
2886 // Endianness (little like Intel or big like SPARC) for image
2887 // formats which support endian-specific options.
2888 void Magick::Image::endian ( const Magick::EndianType endian_ )
2891 options()->endian( endian_ );
2892 image()->endian = endian_;
2894 Magick::EndianType Magick::Image::endian ( void ) const
2896 return constImage()->endian;
2899 // EXIF profile (BLOB)
2900 void Magick::Image::exifProfile( const Magick::Blob &exifProfile_ )
2903 if ( exifProfile_.data() != 0 )
2905 StringInfo * exif_profile = AcquireStringInfo( exifProfile_.length() );
2906 SetStringInfoDatum(exif_profile ,(unsigned char *) exifProfile_.data());
2907 (void) SetImageProfile( image(), "exif", exif_profile);
2908 exif_profile =DestroyStringInfo( exif_profile );
2911 Magick::Blob Magick::Image::exifProfile( void ) const
2913 const StringInfo * exif_profile = GetImageProfile( constImage(), "exif" );
2914 if ( exif_profile == (StringInfo *) NULL)
2915 return Blob( 0, 0 );
2916 return Blob(GetStringInfoDatum(exif_profile),GetStringInfoLength(exif_profile));
2920 void Magick::Image::fileName ( const std::string &fileName_ )
2924 fileName_.copy( image()->filename,
2925 sizeof(image()->filename) - 1 );
2926 image()->filename[ fileName_.length() ] = 0; // Null terminate
2928 options()->fileName( fileName_ );
2931 std::string Magick::Image::fileName ( void ) const
2933 return constOptions()->fileName( );
2937 off_t Magick::Image::fileSize ( void ) const
2939 return (off_t) GetBlobSize( constImage() );
2942 // Color to use when drawing inside an object
2943 void Magick::Image::fillColor ( const Magick::Color &fillColor_ )
2946 options()->fillColor(fillColor_);
2948 Magick::Color Magick::Image::fillColor ( void ) const
2950 return constOptions()->fillColor();
2953 // Rule to use when filling drawn objects
2954 void Magick::Image::fillRule ( const Magick::FillRule &fillRule_ )
2957 options()->fillRule(fillRule_);
2959 Magick::FillRule Magick::Image::fillRule ( void ) const
2961 return constOptions()->fillRule();
2964 // Pattern to use while filling drawn objects.
2965 void Magick::Image::fillPattern ( const Image &fillPattern_ )
2968 if(fillPattern_.isValid())
2969 options()->fillPattern( fillPattern_.constImage() );
2971 options()->fillPattern( static_cast<MagickCore::Image*>(NULL) );
2973 Magick::Image Magick::Image::fillPattern ( void ) const
2975 // FIXME: This is inordinately innefficient
2978 const MagickCore::Image* tmpTexture = constOptions()->fillPattern( );
2982 ExceptionInfo exceptionInfo;
2983 GetExceptionInfo( &exceptionInfo );
2984 MagickCore::Image* image =
2985 CloneImage( tmpTexture,
2988 MagickTrue, // orphan
2990 texture.replaceImage( image );
2991 throwException( exceptionInfo );
2992 (void) DestroyExceptionInfo( &exceptionInfo );
2997 // Filter used by zoom
2998 void Magick::Image::filterType ( const Magick::FilterTypes filterType_ )
3001 image()->filter = filterType_;
3003 Magick::FilterTypes Magick::Image::filterType ( void ) const
3005 return constImage()->filter;
3009 void Magick::Image::font ( const std::string &font_ )
3012 options()->font( font_ );
3014 std::string Magick::Image::font ( void ) const
3016 return constOptions()->font( );
3020 void Magick::Image::fontPointsize ( const double pointSize_ )
3023 options()->fontPointsize( pointSize_ );
3025 double Magick::Image::fontPointsize ( void ) const
3027 return constOptions()->fontPointsize( );
3030 // Font type metrics
3031 void Magick::Image::fontTypeMetrics( const std::string &text_,
3032 TypeMetric *metrics )
3034 DrawInfo *drawInfo = options()->drawInfo();
3035 drawInfo->text = const_cast<char *>(text_.c_str());
3036 GetTypeMetrics( image(), drawInfo, &(metrics->_typeMetric) );
3040 // Image format string
3041 std::string Magick::Image::format ( void ) const
3043 ExceptionInfo exceptionInfo;
3044 GetExceptionInfo( &exceptionInfo );
3045 const MagickInfo * magick_info
3046 = GetMagickInfo( constImage()->magick, &exceptionInfo);
3047 throwException( exceptionInfo );
3048 (void) DestroyExceptionInfo( &exceptionInfo );
3050 if (( magick_info != 0 ) &&
3051 ( *magick_info->description != '\0' ))
3052 return std::string(magick_info->description);
3054 throwExceptionExplicit( CorruptImageWarning,
3055 "Unrecognized image magick type" );
3056 return std::string();
3060 double Magick::Image::gamma ( void ) const
3062 return constImage()->gamma;
3065 Magick::Geometry Magick::Image::geometry ( void ) const
3067 if ( constImage()->geometry )
3069 return Geometry(constImage()->geometry);
3072 throwExceptionExplicit( OptionWarning,
3073 "Image does not contain a geometry");
3078 void Magick::Image::gifDisposeMethod ( const size_t disposeMethod_ )
3081 image()->dispose = (DisposeType) disposeMethod_;
3083 size_t Magick::Image::gifDisposeMethod ( void ) const
3085 // FIXME: It would be better to return an enumeration
3086 return constImage()->dispose;
3089 // ICC ICM color profile (BLOB)
3090 void Magick::Image::iccColorProfile( const Magick::Blob &colorProfile_ )
3092 profile("icm",colorProfile_);
3094 Magick::Blob Magick::Image::iccColorProfile( void ) const
3096 const StringInfo * color_profile = GetImageProfile( constImage(), "icc" );
3097 if ( color_profile == (StringInfo *) NULL)
3098 return Blob( 0, 0 );
3099 return Blob( GetStringInfoDatum(color_profile), GetStringInfoLength(color_profile) );
3102 void Magick::Image::interlaceType ( const Magick::InterlaceType interlace_ )
3105 image()->interlace = interlace_;
3106 options()->interlaceType ( interlace_ );
3108 Magick::InterlaceType Magick::Image::interlaceType ( void ) const
3110 return constImage()->interlace;
3113 // IPTC profile (BLOB)
3114 void Magick::Image::iptcProfile( const Magick::Blob &iptcProfile_ )
3117 if ( iptcProfile_.data() != 0 )
3119 StringInfo * iptc_profile = AcquireStringInfo( iptcProfile_.length() );
3120 SetStringInfoDatum(iptc_profile ,(unsigned char *) iptcProfile_.data());
3121 (void) SetImageProfile( image(), "iptc", iptc_profile);
3122 iptc_profile =DestroyStringInfo( iptc_profile );
3125 Magick::Blob Magick::Image::iptcProfile( void ) const
3127 const StringInfo * iptc_profile = GetImageProfile( constImage(), "iptc" );
3128 if ( iptc_profile == (StringInfo *) NULL)
3129 return Blob( 0, 0 );
3130 return Blob( GetStringInfoDatum(iptc_profile), GetStringInfoLength(iptc_profile));
3133 // Does object contain valid image?
3134 void Magick::Image::isValid ( const bool isValid_ )
3139 _imgRef = new ImageRef;
3141 else if ( !isValid() )
3143 // Construct with single-pixel black image to make
3144 // image valid. This is an obvious hack.
3145 size( Geometry(1,1) );
3146 read( "xc:#000000" );
3150 bool Magick::Image::isValid ( void ) const
3152 if ( rows() && columns() )
3159 void Magick::Image::label ( const std::string &label_ )
3162 SetImageProperty ( image(), "Label", NULL );
3163 if ( label_.length() > 0 )
3164 SetImageProperty ( image(), "Label", label_.c_str() );
3165 throwImageException();
3167 std::string Magick::Image::label ( void ) const
3169 const char *value = GetImageProperty( constImage(), "Label" );
3172 return std::string( value );
3174 return std::string();
3177 void Magick::Image::magick ( const std::string &magick_ )
3181 magick_.copy( image()->magick,
3182 sizeof(image()->magick) - 1 );
3183 image()->magick[ magick_.length() ] = 0;
3185 options()->magick( magick_ );
3187 std::string Magick::Image::magick ( void ) const
3189 if ( *(constImage()->magick) != '\0' )
3190 return std::string(constImage()->magick);
3192 return constOptions()->magick( );
3195 void Magick::Image::matte ( const bool matteFlag_ )
3199 // If matte channel is requested, but image doesn't already have a
3200 // matte channel, then create an opaque matte channel. Likewise, if
3201 // the image already has a matte channel but a matte channel is not
3202 // desired, then set the matte channel to opaque.
3203 if ((matteFlag_ && !constImage()->matte) ||
3204 (constImage()->matte && !matteFlag_))
3205 SetImageOpacity(image(),OpaqueOpacity);
3207 image()->matte = (MagickBooleanType) matteFlag_;
3209 bool Magick::Image::matte ( void ) const
3211 if ( constImage()->matte )
3217 void Magick::Image::matteColor ( const Color &matteColor_ )
3221 if ( matteColor_.isValid() )
3223 image()->matte_color = matteColor_;
3224 options()->matteColor( matteColor_ );
3228 // Set to default matte color
3229 Color tmpColor( "#BDBDBD" );
3230 image()->matte_color = tmpColor;
3231 options()->matteColor( tmpColor );
3234 Magick::Color Magick::Image::matteColor ( void ) const
3236 return Color( constImage()->matte_color.red,
3237 constImage()->matte_color.green,
3238 constImage()->matte_color.blue );
3241 double Magick::Image::meanErrorPerPixel ( void ) const
3243 return(constImage()->error.mean_error_per_pixel);
3246 // Image modulus depth (minimum number of bits required to support
3247 // red/green/blue components without loss of accuracy)
3248 void Magick::Image::modulusDepth ( const size_t depth_ )
3251 SetImageDepth( image(), depth_ );
3252 options()->depth( depth_ );
3254 size_t Magick::Image::modulusDepth ( void ) const
3256 ExceptionInfo exceptionInfo;
3257 GetExceptionInfo( &exceptionInfo );
3258 size_t depth=GetImageDepth( constImage(), &exceptionInfo );
3259 throwException( exceptionInfo );
3260 (void) DestroyExceptionInfo( &exceptionInfo );
3264 void Magick::Image::monochrome ( const bool monochromeFlag_ )
3267 options()->monochrome( monochromeFlag_ );
3269 bool Magick::Image::monochrome ( void ) const
3271 return constOptions()->monochrome( );
3274 Magick::Geometry Magick::Image::montageGeometry ( void ) const
3276 if ( constImage()->montage )
3277 return Magick::Geometry(constImage()->montage);
3279 throwExceptionExplicit( CorruptImageWarning,
3280 "Image does not contain a montage" );
3282 return Magick::Geometry();
3285 double Magick::Image::normalizedMaxError ( void ) const
3287 return(constImage()->error.normalized_maximum_error);
3290 double Magick::Image::normalizedMeanError ( void ) const
3292 return constImage()->error.normalized_mean_error;
3295 // Image orientation
3296 void Magick::Image::orientation ( const Magick::OrientationType orientation_ )
3299 image()->orientation = orientation_;
3301 Magick::OrientationType Magick::Image::orientation ( void ) const
3303 return constImage()->orientation;
3306 void Magick::Image::penColor ( const Color &penColor_ )
3309 options()->fillColor(penColor_);
3310 options()->strokeColor(penColor_);
3312 Magick::Color Magick::Image::penColor ( void ) const
3314 return constOptions()->fillColor();
3317 void Magick::Image::penTexture ( const Image &penTexture_ )
3320 if(penTexture_.isValid())
3321 options()->fillPattern( penTexture_.constImage() );
3323 options()->fillPattern( static_cast<MagickCore::Image*>(NULL) );
3326 Magick::Image Magick::Image::penTexture ( void ) const
3328 // FIXME: This is inordinately innefficient
3331 const MagickCore::Image* tmpTexture = constOptions()->fillPattern( );
3335 ExceptionInfo exceptionInfo;
3336 GetExceptionInfo( &exceptionInfo );
3337 MagickCore::Image* image =
3338 CloneImage( tmpTexture,
3341 MagickTrue, // orphan
3343 texture.replaceImage( image );
3344 throwException( exceptionInfo );
3345 (void) DestroyExceptionInfo( &exceptionInfo );
3350 // Set the color of a pixel.
3351 void Magick::Image::pixelColor ( const ssize_t x_, const ssize_t y_,
3352 const Color &color_ )
3354 // Test arguments to ensure they are within the image.
3355 if ( y_ > (ssize_t) rows() || x_ > (ssize_t) columns() )
3356 throwExceptionExplicit( OptionError,
3357 "Access outside of image boundary" );
3361 // Set image to DirectClass
3362 classType( DirectClass );
3365 Pixels pixels(*this);
3367 *(pixels.get(x_, y_, 1, 1 )) = color_;
3368 // Tell ImageMagick that pixels have been updated
3374 // Get the color of a pixel
3375 Magick::Color Magick::Image::pixelColor ( const ssize_t x_,
3376 const ssize_t y_ ) const
3378 ClassType storage_class;
3379 storage_class = classType();
3381 const PixelPacket* pixel = getConstPixels( x_, y_, 1, 1 );
3382 if ( storage_class == DirectClass )
3385 return Color( *pixel );
3389 if ( storage_class == PseudoClass )
3391 const IndexPacket* indexes = getConstIndexes();
3393 return colorMap( (size_t) *indexes );
3396 return Color(); // invalid
3399 // Preferred size and location of an image canvas.
3400 void Magick::Image::page ( const Magick::Geometry &pageSize_ )
3403 options()->page( pageSize_ );
3404 image()->page = pageSize_;
3406 Magick::Geometry Magick::Image::page ( void ) const
3408 return Geometry( constImage()->page.width,
3409 constImage()->page.height,
3410 AbsoluteValue(constImage()->page.x),
3411 AbsoluteValue(constImage()->page.y),
3412 constImage()->page.x < 0 ? true : false,
3413 constImage()->page.y < 0 ? true : false);
3416 // Add a named profile to an image or remove a named profile by
3417 // passing an empty Blob (use default Blob constructor).
3419 // "*", "8BIM", "ICM", "IPTC", or a generic profile name.
3420 void Magick::Image::profile( const std::string name_,
3421 const Magick::Blob &profile_ )
3424 ssize_t result = ProfileImage( image(), name_.c_str(),
3425 (unsigned char *)profile_.data(),
3426 profile_.length(), MagickTrue);
3429 throwImageException();
3432 // Retrieve a named profile from the image.
3434 // "8BIM", "8BIMTEXT", "APP1", "APP1JPEG", "ICC", "ICM", & "IPTC" or
3435 // an existing generic profile name.
3436 Magick::Blob Magick::Image::profile( const std::string name_ ) const
3438 const MagickCore::Image* image = constImage();
3440 const StringInfo * profile = GetImageProfile( image, name_.c_str() );
3442 if ( profile != (StringInfo *) NULL)
3443 return Blob( (void*) GetStringInfoDatum(profile), GetStringInfoLength(profile));
3446 Image temp_image = *this;
3447 temp_image.write( &blob, name_ );
3451 void Magick::Image::quality ( const size_t quality_ )
3454 image()->quality = quality_;
3455 options()->quality( quality_ );
3457 size_t Magick::Image::quality ( void ) const
3459 return constImage()->quality;
3462 void Magick::Image::quantizeColors ( const size_t colors_ )
3465 options()->quantizeColors( colors_ );
3467 size_t Magick::Image::quantizeColors ( void ) const
3469 return constOptions()->quantizeColors( );
3472 void Magick::Image::quantizeColorSpace
3473 ( const Magick::ColorspaceType colorSpace_ )
3476 options()->quantizeColorSpace( colorSpace_ );
3478 Magick::ColorspaceType Magick::Image::quantizeColorSpace ( void ) const
3480 return constOptions()->quantizeColorSpace( );
3483 void Magick::Image::quantizeDither ( const bool ditherFlag_ )
3486 options()->quantizeDither( ditherFlag_ );
3488 bool Magick::Image::quantizeDither ( void ) const
3490 return constOptions()->quantizeDither( );
3493 void Magick::Image::quantizeTreeDepth ( const size_t treeDepth_ )
3496 options()->quantizeTreeDepth( treeDepth_ );
3498 size_t Magick::Image::quantizeTreeDepth ( void ) const
3500 return constOptions()->quantizeTreeDepth( );
3503 void Magick::Image::renderingIntent
3504 ( const Magick::RenderingIntent renderingIntent_ )
3507 image()->rendering_intent = renderingIntent_;
3509 Magick::RenderingIntent Magick::Image::renderingIntent ( void ) const
3511 return static_cast<Magick::RenderingIntent>(constImage()->rendering_intent);
3514 void Magick::Image::resolutionUnits
3515 ( const Magick::ResolutionType resolutionUnits_ )
3518 image()->units = resolutionUnits_;
3519 options()->resolutionUnits( resolutionUnits_ );
3521 Magick::ResolutionType Magick::Image::resolutionUnits ( void ) const
3523 return constOptions()->resolutionUnits( );
3526 void Magick::Image::scene ( const size_t scene_ )
3529 image()->scene = scene_;
3531 size_t Magick::Image::scene ( void ) const
3533 return constImage()->scene;
3536 std::string Magick::Image::signature ( const bool force_ ) const
3538 Lock( &_imgRef->_mutexLock );
3540 // Re-calculate image signature if necessary
3542 !GetImageProperty(constImage(), "Signature") ||
3543 constImage()->taint )
3545 SignatureImage( const_cast<MagickCore::Image *>(constImage()) );
3548 const char *property = GetImageProperty(constImage(), "Signature");
3550 return std::string( property );
3553 void Magick::Image::size ( const Geometry &geometry_ )
3556 options()->size( geometry_ );
3557 image()->rows = geometry_.height();
3558 image()->columns = geometry_.width();
3560 Magick::Geometry Magick::Image::size ( void ) const
3562 return Magick::Geometry( constImage()->columns, constImage()->rows );
3566 void Magick::Image::splice( const Geometry &geometry_ )
3568 RectangleInfo spliceInfo = geometry_;
3569 ExceptionInfo exceptionInfo;
3570 GetExceptionInfo( &exceptionInfo );
3571 MagickCore::Image* newImage =
3572 SpliceImage( image(), &spliceInfo, &exceptionInfo);
3573 replaceImage( newImage );
3574 throwException( exceptionInfo );
3575 (void) DestroyExceptionInfo( &exceptionInfo );
3578 // Obtain image statistics. Statistics are normalized to the range of
3579 // 0.0 to 1.0 and are output to the specified ImageStatistics
3581 void Magick::Image::statistics ( ImageStatistics *statistics ) const
3587 ExceptionInfo exceptionInfo;
3588 GetExceptionInfo( &exceptionInfo );
3589 (void) GetImageChannelRange(constImage(),RedChannel,&minimum,&maximum,
3591 statistics->red.minimum=minimum;
3592 statistics->red.maximum=maximum;
3593 (void) GetImageChannelMean(constImage(),RedChannel,
3594 &statistics->red.mean,&statistics->red.standard_deviation,&exceptionInfo);
3595 (void) GetImageChannelKurtosis(constImage(),RedChannel,
3596 &statistics->red.kurtosis,&statistics->red.skewness,&exceptionInfo);
3597 (void) GetImageChannelRange(constImage(),GreenChannel,&minimum,&maximum,
3599 statistics->green.minimum=minimum;
3600 statistics->green.maximum=maximum;
3601 (void) GetImageChannelMean(constImage(),GreenChannel,
3602 &statistics->green.mean,&statistics->green.standard_deviation,
3604 (void) GetImageChannelKurtosis(constImage(),GreenChannel,
3605 &statistics->green.kurtosis,&statistics->green.skewness,&exceptionInfo);
3606 (void) GetImageChannelRange(constImage(),BlueChannel,&minimum,&maximum,
3608 statistics->blue.minimum=minimum;
3609 statistics->blue.maximum=maximum;
3610 (void) GetImageChannelMean(constImage(),BlueChannel,
3611 &statistics->blue.mean,&statistics->blue.standard_deviation,&exceptionInfo);
3612 (void) GetImageChannelKurtosis(constImage(),BlueChannel,
3613 &statistics->blue.kurtosis,&statistics->blue.skewness,&exceptionInfo);
3614 (void) GetImageChannelRange(constImage(),OpacityChannel,&minimum,&maximum,
3616 statistics->opacity.minimum=minimum;
3617 statistics->opacity.maximum=maximum;
3618 (void) GetImageChannelMean(constImage(),OpacityChannel,
3619 &statistics->opacity.mean,&statistics->opacity.standard_deviation,
3621 (void) GetImageChannelKurtosis(constImage(),OpacityChannel,
3622 &statistics->opacity.kurtosis,&statistics->opacity.skewness,&exceptionInfo);
3623 throwException( exceptionInfo );
3624 (void) DestroyExceptionInfo( &exceptionInfo );
3627 // Strip strips an image of all profiles and comments.
3628 void Magick::Image::strip ( void )
3631 StripImage( image() );
3632 throwImageException();
3635 // enabled/disable stroke anti-aliasing
3636 void Magick::Image::strokeAntiAlias ( const bool flag_ )
3639 options()->strokeAntiAlias(flag_);
3641 bool Magick::Image::strokeAntiAlias ( void ) const
3643 return constOptions()->strokeAntiAlias();
3646 // Color to use when drawing object outlines
3647 void Magick::Image::strokeColor ( const Magick::Color &strokeColor_ )
3650 options()->strokeColor(strokeColor_);
3652 Magick::Color Magick::Image::strokeColor ( void ) const
3654 return constOptions()->strokeColor();
3657 // dash pattern for drawing vector objects (default one)
3658 void Magick::Image::strokeDashArray ( const double* strokeDashArray_ )
3661 options()->strokeDashArray( strokeDashArray_ );
3664 const double* Magick::Image::strokeDashArray ( void ) const
3666 return constOptions()->strokeDashArray( );
3669 // dash offset for drawing vector objects (default one)
3670 void Magick::Image::strokeDashOffset ( const double strokeDashOffset_ )
3673 options()->strokeDashOffset( strokeDashOffset_ );
3676 double Magick::Image::strokeDashOffset ( void ) const
3678 return constOptions()->strokeDashOffset( );
3681 // Specify the shape to be used at the end of open subpaths when they
3682 // are stroked. Values of LineCap are UndefinedCap, ButtCap, RoundCap,
3684 void Magick::Image::strokeLineCap ( const Magick::LineCap lineCap_ )
3687 options()->strokeLineCap( lineCap_ );
3689 Magick::LineCap Magick::Image::strokeLineCap ( void ) const
3691 return constOptions()->strokeLineCap( );
3694 // Specify the shape to be used at the corners of paths (or other
3695 // vector shapes) when they are stroked. Values of LineJoin are
3696 // UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.
3697 void Magick::Image::strokeLineJoin ( const Magick::LineJoin lineJoin_ )
3700 options()->strokeLineJoin( lineJoin_ );
3702 Magick::LineJoin Magick::Image::strokeLineJoin ( void ) const
3704 return constOptions()->strokeLineJoin( );
3707 // Specify miter limit. When two line segments meet at a sharp angle
3708 // and miter joins have been specified for 'lineJoin', it is possible
3709 // for the miter to extend far beyond the thickness of the line
3710 // stroking the path. The miterLimit' imposes a limit on the ratio of
3711 // the miter length to the 'lineWidth'. The default value of this
3713 void Magick::Image::strokeMiterLimit ( const size_t strokeMiterLimit_ )
3716 options()->strokeMiterLimit( strokeMiterLimit_ );
3718 size_t Magick::Image::strokeMiterLimit ( void ) const
3720 return constOptions()->strokeMiterLimit( );
3723 // Pattern to use while stroking drawn objects.
3724 void Magick::Image::strokePattern ( const Image &strokePattern_ )
3727 if(strokePattern_.isValid())
3728 options()->strokePattern( strokePattern_.constImage() );
3730 options()->strokePattern( static_cast<MagickCore::Image*>(NULL) );
3732 Magick::Image Magick::Image::strokePattern ( void ) const
3734 // FIXME: This is inordinately innefficient
3737 const MagickCore::Image* tmpTexture = constOptions()->strokePattern( );
3741 ExceptionInfo exceptionInfo;
3742 GetExceptionInfo( &exceptionInfo );
3743 MagickCore::Image* image =
3744 CloneImage( tmpTexture,
3747 MagickTrue, // orphan
3749 throwException( exceptionInfo );
3750 (void) DestroyExceptionInfo( &exceptionInfo );
3751 texture.replaceImage( image );
3756 // Stroke width for drawing lines, circles, ellipses, etc.
3757 void Magick::Image::strokeWidth ( const double strokeWidth_ )
3760 options()->strokeWidth( strokeWidth_ );
3762 double Magick::Image::strokeWidth ( void ) const
3764 return constOptions()->strokeWidth( );
3767 void Magick::Image::subImage ( const size_t subImage_ )
3770 options()->subImage( subImage_ );
3772 size_t Magick::Image::subImage ( void ) const
3774 return constOptions()->subImage( );
3777 void Magick::Image::subRange ( const size_t subRange_ )
3780 options()->subRange( subRange_ );
3782 size_t Magick::Image::subRange ( void ) const
3784 return constOptions()->subRange( );
3787 // Annotation text encoding (e.g. "UTF-16")
3788 void Magick::Image::textEncoding ( const std::string &encoding_ )
3791 options()->textEncoding( encoding_ );
3793 std::string Magick::Image::textEncoding ( void ) const
3795 return constOptions()->textEncoding( );
3798 void Magick::Image::tileName ( const std::string &tileName_ )
3801 options()->tileName( tileName_ );
3803 std::string Magick::Image::tileName ( void ) const
3805 return constOptions()->tileName( );
3808 size_t Magick::Image::totalColors ( void )
3810 ExceptionInfo exceptionInfo;
3811 GetExceptionInfo( &exceptionInfo );
3812 size_t colors = GetNumberColors( image(), 0, &exceptionInfo);
3813 throwException( exceptionInfo );
3814 (void) DestroyExceptionInfo( &exceptionInfo );
3818 // Origin of coordinate system to use when annotating with text or drawing
3819 void Magick::Image::transformOrigin ( const double x_, const double y_ )
3822 options()->transformOrigin( x_, y_ );
3825 // Rotation to use when annotating with text or drawing
3826 void Magick::Image::transformRotation ( const double angle_ )
3829 options()->transformRotation( angle_ );
3832 // Reset transformation parameters to default
3833 void Magick::Image::transformReset ( void )
3836 options()->transformReset();
3839 // Scale to use when annotating with text or drawing
3840 void Magick::Image::transformScale ( const double sx_, const double sy_ )
3843 options()->transformScale( sx_, sy_ );
3846 // Skew to use in X axis when annotating with text or drawing
3847 void Magick::Image::transformSkewX ( const double skewx_ )
3850 options()->transformSkewX( skewx_ );
3853 // Skew to use in Y axis when annotating with text or drawing
3854 void Magick::Image::transformSkewY ( const double skewy_ )
3857 options()->transformSkewY( skewy_ );
3860 // Image representation type
3861 Magick::ImageType Magick::Image::type ( void ) const
3864 ExceptionInfo exceptionInfo;
3865 GetExceptionInfo( &exceptionInfo );
3866 ImageType image_type = constOptions()->type();
3867 if ( image_type == UndefinedType )
3868 image_type= GetImageType( constImage(), &exceptionInfo);
3869 throwException( exceptionInfo );
3870 (void) DestroyExceptionInfo( &exceptionInfo );
3873 void Magick::Image::type ( const Magick::ImageType type_)
3876 options()->type( type_ );
3877 SetImageType( image(), type_ );
3880 void Magick::Image::verbose ( const bool verboseFlag_ )
3883 options()->verbose( verboseFlag_ );
3885 bool Magick::Image::verbose ( void ) const
3887 return constOptions()->verbose( );
3890 void Magick::Image::view ( const std::string &view_ )
3893 options()->view( view_ );
3895 std::string Magick::Image::view ( void ) const
3897 return constOptions()->view( );
3900 // Virtual pixel method
3901 void Magick::Image::virtualPixelMethod ( const VirtualPixelMethod virtual_pixel_method_ )
3904 SetImageVirtualPixelMethod( image(), virtual_pixel_method_ );
3905 options()->virtualPixelMethod( virtual_pixel_method_ );
3907 Magick::VirtualPixelMethod Magick::Image::virtualPixelMethod ( void ) const
3909 return GetImageVirtualPixelMethod( constImage() );
3912 void Magick::Image::x11Display ( const std::string &display_ )
3915 options()->x11Display( display_ );
3917 std::string Magick::Image::x11Display ( void ) const
3919 return constOptions()->x11Display( );
3922 double Magick::Image::xResolution ( void ) const
3924 return constImage()->x_resolution;
3926 double Magick::Image::yResolution ( void ) const
3928 return constImage()->y_resolution;
3932 Magick::Image::Image( const Image & image_ )
3933 : _imgRef(image_._imgRef)
3935 Lock( &_imgRef->_mutexLock );
3937 // Increase reference count
3938 ++_imgRef->_refCount;
3941 // Assignment operator
3942 Magick::Image& Magick::Image::operator=( const Magick::Image &image_ )
3944 if( this != &image_ )
3947 Lock( &image_._imgRef->_mutexLock );
3948 ++image_._imgRef->_refCount;
3951 bool doDelete = false;
3953 Lock( &_imgRef->_mutexLock );
3954 if ( --_imgRef->_refCount == 0 )
3960 // Delete old image reference with associated image and options.
3964 // Use new image reference
3965 _imgRef = image_._imgRef;
3971 //////////////////////////////////////////////////////////////////////
3973 // Low-level Pixel Access Routines
3975 // Also see the Pixels class, which provides support for multiple
3976 // cache views. The low-level pixel access routines in the Image
3977 // class are provided in order to support backward compatability.
3979 //////////////////////////////////////////////////////////////////////
3981 // Transfers read-only pixels from the image to the pixel cache as
3982 // defined by the specified region
3983 const Magick::PixelPacket* Magick::Image::getConstPixels
3984 ( const ssize_t x_, const ssize_t y_,
3985 const size_t columns_,
3986 const size_t rows_ ) const
3988 ExceptionInfo exceptionInfo;
3989 GetExceptionInfo( &exceptionInfo );
3990 const PixelPacket* p = (*GetVirtualPixels)( constImage(),
3994 throwException( exceptionInfo );
3995 (void) DestroyExceptionInfo( &exceptionInfo );
3999 // Obtain read-only pixel indexes (valid for PseudoClass images)
4000 const Magick::IndexPacket* Magick::Image::getConstIndexes ( void ) const
4002 const Magick::IndexPacket* result = GetVirtualIndexQueue( constImage() );
4005 throwImageException();
4010 // Obtain image pixel indexes (valid for PseudoClass images)
4011 Magick::IndexPacket* Magick::Image::getIndexes ( void )
4013 Magick::IndexPacket* result = GetAuthenticIndexQueue( image() );
4016 throwImageException();
4021 // Transfers pixels from the image to the pixel cache as defined
4022 // by the specified region. Modified pixels may be subsequently
4023 // transferred back to the image via syncPixels.
4024 Magick::PixelPacket* Magick::Image::getPixels ( const ssize_t x_, const ssize_t y_,
4025 const size_t columns_,
4026 const size_t rows_ )
4029 ExceptionInfo exceptionInfo;
4030 GetExceptionInfo( &exceptionInfo );
4031 PixelPacket* result = (*GetAuthenticPixels)( image(),
4033 columns_, rows_, &exceptionInfo );
4034 throwException( exceptionInfo );
4035 (void) DestroyExceptionInfo( &exceptionInfo );
4040 // Allocates a pixel cache region to store image pixels as defined
4041 // by the region rectangle. This area is subsequently transferred
4042 // from the pixel cache to the image via syncPixels.
4043 Magick::PixelPacket* Magick::Image::setPixels ( const ssize_t x_, const ssize_t y_,
4044 const size_t columns_,
4045 const size_t rows_ )
4048 ExceptionInfo exceptionInfo;
4049 GetExceptionInfo( &exceptionInfo );
4050 PixelPacket* result = (*QueueAuthenticPixels)( image(),
4052 columns_, rows_, &exceptionInfo );
4053 throwException( exceptionInfo );
4054 (void) DestroyExceptionInfo( &exceptionInfo );
4059 // Transfers the image cache pixels to the image.
4060 void Magick::Image::syncPixels ( void )
4062 ExceptionInfo exceptionInfo;
4063 GetExceptionInfo( &exceptionInfo );
4064 (*SyncAuthenticPixels)( image(), &exceptionInfo );
4065 throwException( exceptionInfo );
4066 (void) DestroyExceptionInfo( &exceptionInfo );
4069 // Transfers one or more pixel components from a buffer or file
4070 // into the image pixel cache of an image.
4071 // Used to support image decoders.
4072 void Magick::Image::readPixels ( const Magick::QuantumType quantum_,
4073 const unsigned char *source_ )
4078 quantum_info=AcquireQuantumInfo(imageInfo(),image());
4079 ExceptionInfo exceptionInfo;
4080 GetExceptionInfo( &exceptionInfo );
4081 ImportQuantumPixels(image(),(MagickCore::CacheView *) NULL,quantum_info,
4082 quantum_,source_, &exceptionInfo);
4083 throwException( exceptionInfo );
4084 (void) DestroyExceptionInfo( &exceptionInfo );
4085 quantum_info=DestroyQuantumInfo(quantum_info);
4088 // Transfers one or more pixel components from the image pixel
4089 // cache to a buffer or file.
4090 // Used to support image encoders.
4091 void Magick::Image::writePixels ( const Magick::QuantumType quantum_,
4092 unsigned char *destination_ )
4097 quantum_info=AcquireQuantumInfo(imageInfo(),image());
4098 ExceptionInfo exceptionInfo;
4099 GetExceptionInfo( &exceptionInfo );
4100 ExportQuantumPixels(image(),(MagickCore::CacheView *) NULL,quantum_info,
4101 quantum_,destination_, &exceptionInfo);
4102 quantum_info=DestroyQuantumInfo(quantum_info);
4103 throwException( exceptionInfo );
4104 (void) DestroyExceptionInfo( &exceptionInfo );
4107 /////////////////////////////////////////////////////////////////////
4109 // No end-user methods beyond this point
4111 /////////////////////////////////////////////////////////////////////
4115 // Construct using existing image and default options
4117 Magick::Image::Image ( MagickCore::Image* image_ )
4118 : _imgRef(new ImageRef( image_))
4122 // Get Magick::Options*
4123 Magick::Options* Magick::Image::options( void )
4125 return _imgRef->options();
4127 const Magick::Options* Magick::Image::constOptions( void ) const
4129 return _imgRef->options();
4132 // Get MagickCore::Image*
4133 MagickCore::Image*& Magick::Image::image( void )
4135 return _imgRef->image();
4137 const MagickCore::Image* Magick::Image::constImage( void ) const
4139 return _imgRef->image();
4143 MagickCore::ImageInfo* Magick::Image::imageInfo( void )
4145 return _imgRef->options()->imageInfo();
4147 const MagickCore::ImageInfo * Magick::Image::constImageInfo( void ) const
4149 return _imgRef->options()->imageInfo();
4152 // Get QuantizeInfo *
4153 MagickCore::QuantizeInfo* Magick::Image::quantizeInfo( void )
4155 return _imgRef->options()->quantizeInfo();
4157 const MagickCore::QuantizeInfo * Magick::Image::constQuantizeInfo( void ) const
4159 return _imgRef->options()->quantizeInfo();
4163 // Replace current image
4165 MagickCore::Image * Magick::Image::replaceImage
4166 ( MagickCore::Image* replacement_ )
4168 MagickCore::Image* image;
4171 image = replacement_;
4173 image = AcquireImage(constImageInfo());
4176 Lock( &_imgRef->_mutexLock );
4178 if ( _imgRef->_refCount == 1 )
4180 // We own the image, just replace it, and de-register
4182 _imgRef->image(image);
4186 // We don't own the image, dereference and replace with copy
4187 --_imgRef->_refCount;
4188 _imgRef = new ImageRef( image, constOptions() );
4192 return _imgRef->_image;
4196 // Prepare to modify image or image options
4197 // Replace current image and options with copy if reference count > 1
4199 void Magick::Image::modifyImage( void )
4202 Lock( &_imgRef->_mutexLock );
4203 if ( _imgRef->_refCount == 1 )
4205 // De-register image and return
4211 ExceptionInfo exceptionInfo;
4212 GetExceptionInfo( &exceptionInfo );
4213 replaceImage( CloneImage( image(),
4216 MagickTrue, // orphan
4218 throwException( exceptionInfo );
4219 (void) DestroyExceptionInfo( &exceptionInfo );
4224 // Test for an ImageMagick reported error and throw exception if one
4225 // has been reported. Secretly resets image->exception back to default
4226 // state even though this method is const.
4228 void Magick::Image::throwImageException( void ) const
4230 // Throw C++ exception while resetting Image exception to default state
4231 throwException( const_cast<MagickCore::Image*>(constImage())->exception );
4234 // Register image with image registry or obtain registration id
4235 ssize_t Magick::Image::registerId( void )
4237 Lock( &_imgRef->_mutexLock );
4238 if( _imgRef->id() < 0 )
4240 char id[MaxTextExtent];
4241 ExceptionInfo exceptionInfo;
4242 GetExceptionInfo( &exceptionInfo );
4243 _imgRef->id(_imgRef->id()+1);
4244 sprintf(id,"%.20g\n",(double) _imgRef->id());
4245 SetImageRegistry(ImageRegistryType, id, image(), &exceptionInfo);
4246 throwException( exceptionInfo );
4247 (void) DestroyExceptionInfo( &exceptionInfo );
4249 return _imgRef->id();
4252 // Unregister image from image registry
4253 void Magick::Image::unregisterId( void )
4260 // Create a local wrapper around MagickCoreTerminus
4265 void MagickPlusPlusDestroyMagick(void);
4269 void Magick::MagickPlusPlusDestroyMagick(void)
4271 if (magick_initialized)
4273 magick_initialized=false;
4274 MagickCore::MagickCoreTerminus();
4278 // C library initialization routine
4279 void MagickDLLDecl Magick::InitializeMagick(const char *path_)
4281 MagickCore::MagickCoreGenesis(path_,MagickFalse);
4282 if (!magick_initialized)
4283 magick_initialized=true;
4287 // Cleanup class to ensure that ImageMagick singletons are destroyed
4288 // so as to avoid any resemblence to a memory leak (which seems to
4297 MagickCleanUp( void );
4298 ~MagickCleanUp( void );
4301 // The destructor for this object is invoked when the destructors for
4302 // static objects in this translation unit are invoked.
4303 static MagickCleanUp magickCleanUpGuard;
4306 Magick::MagickCleanUp::MagickCleanUp ( void )
4308 // Don't even think about invoking InitializeMagick here!
4311 Magick::MagickCleanUp::~MagickCleanUp ( void )
4313 MagickPlusPlusDestroyMagick();