1 // This may look like C code, but it is really -*- C++ -*-
3 // Copyright Bob Friesenhahn, 1999, 2000, 2001, 2002, 2003
5 // Implementation of Image
8 #define MAGICKCORE_IMPLEMENTATION 1
9 #define MAGICK_PLUSPLUS_IMPLEMENTATION 1
16 #include "Magick++/Include.h"
20 #include "Magick++/Image.h"
21 #include "Magick++/Functions.h"
22 #include "Magick++/Pixels.h"
23 #include "Magick++/Options.h"
24 #include "Magick++/ImageRef.h"
26 #define AbsoluteValue(x) ((x) < 0 ? -(x) : (x))
27 #define DegreesToRadians(x) (MagickPI*(x)/180.0)
29 MagickPPExport const char *Magick::borderGeometryDefault = "6x6+0+0";
30 MagickPPExport const char *Magick::frameGeometryDefault = "25x25+6+6";
31 MagickPPExport const char *Magick::raiseGeometryDefault = "6x6+0+0";
33 static bool magick_initialized=false;
36 // Explicit template instantiations
40 // Friend functions to compare Image objects
43 MagickPPExport int Magick::operator == ( const Magick::Image& left_,
44 const Magick::Image& right_ )
46 // If image pixels and signature are the same, then the image is identical
47 return ( ( left_.rows() == right_.rows() ) &&
48 ( left_.columns() == right_.columns() ) &&
49 ( left_.signature() == right_.signature() )
52 MagickPPExport int Magick::operator != ( const Magick::Image& left_,
53 const Magick::Image& right_ )
55 return ( ! (left_ == right_) );
57 MagickPPExport int Magick::operator > ( const Magick::Image& left_,
58 const Magick::Image& right_ )
60 return ( !( left_ < right_ ) && ( left_ != right_ ) );
62 MagickPPExport int Magick::operator < ( const Magick::Image& left_,
63 const Magick::Image& right_ )
65 // If image pixels are less, then image is smaller
66 return ( ( left_.rows() * left_.columns() ) <
67 ( right_.rows() * right_.columns() )
70 MagickPPExport int Magick::operator >= ( const Magick::Image& left_,
71 const Magick::Image& right_ )
73 return ( ( left_ > right_ ) || ( left_ == right_ ) );
75 MagickPPExport int Magick::operator <= ( const Magick::Image& left_,
76 const Magick::Image& right_ )
78 return ( ( left_ < right_ ) || ( left_ == right_ ) );
82 // Image object implementation
85 // Construct from image file or image specification
86 Magick::Image::Image( const std::string &imageSpec_ )
87 : _imgRef(new ImageRef)
91 // Initialize, Allocate and Read images
94 catch ( const Warning & /*warning_*/ )
96 // FIXME: need a way to report warnings in constructor
98 catch ( const Error & /*error_*/ )
106 // Construct a blank image canvas of specified size and color
107 Magick::Image::Image( const Geometry &size_,
108 const Color &color_ )
109 : _imgRef(new ImageRef)
111 // xc: prefix specifies an X11 color string
112 std::string imageSpec("xc:");
120 // Initialize, Allocate and Read images
123 catch ( const Warning & /*warning_*/ )
125 // FIXME: need a way to report warnings in constructor
127 catch ( const Error & /*error_*/ )
135 // Construct Image from in-memory BLOB
136 Magick::Image::Image ( const Blob &blob_ )
137 : _imgRef(new ImageRef)
141 // Initialize, Allocate and Read images
144 catch ( const Warning & /*warning_*/ )
146 // FIXME: need a way to report warnings in constructor
148 catch ( const Error & /*error_*/ )
156 // Construct Image of specified size from in-memory BLOB
157 Magick::Image::Image ( const Blob &blob_,
158 const Geometry &size_ )
159 : _imgRef(new ImageRef)
164 read( blob_, size_ );
166 catch ( const Warning & /*warning_*/ )
168 // FIXME: need a way to report warnings in constructor
170 catch ( const Error & /*error_*/ )
178 // Construct Image of specified size and depth from in-memory BLOB
179 Magick::Image::Image ( const Blob &blob_,
180 const Geometry &size_,
181 const size_t depth_ )
182 : _imgRef(new ImageRef)
187 read( blob_, size_, depth_ );
189 catch ( const Warning & /*warning_*/ )
191 // FIXME: need a way to report warnings in constructor
193 catch ( const Error & /*error_*/ )
201 // Construct Image of specified size, depth, and format from in-memory BLOB
202 Magick::Image::Image ( const Blob &blob_,
203 const Geometry &size_,
205 const std::string &magick_ )
206 : _imgRef(new ImageRef)
211 read( blob_, size_, depth_, magick_ );
213 catch ( const Warning & /*warning_*/ )
215 // FIXME: need a way to report warnings in constructor
217 catch ( const Error & /*error_*/ )
225 // Construct Image of specified size, and format from in-memory BLOB
226 Magick::Image::Image ( const Blob &blob_,
227 const Geometry &size_,
228 const std::string &magick_ )
229 : _imgRef(new ImageRef)
234 read( blob_, size_, magick_ );
236 catch ( const Warning & /*warning_*/ )
238 // FIXME: need a way to report warnings in constructor
240 catch ( const Error & /*error_*/ )
248 // Construct an image based on an array of raw pixels, of specified
249 // type and mapping, in memory
250 Magick::Image::Image ( const size_t width_,
251 const size_t height_,
252 const std::string &map_,
253 const StorageType type_,
254 const void *pixels_ )
255 : _imgRef(new ImageRef)
259 read( width_, height_, map_.c_str(), type_, pixels_ );
261 catch ( const Warning & /*warning_*/ )
263 // FIXME: need a way to report warnings in constructor
265 catch ( const Error & /*error_*/ )
273 // Default constructor
274 Magick::Image::Image( void )
275 : _imgRef(new ImageRef)
281 Magick::Image::~Image()
283 bool doDelete = false;
285 Lock( &_imgRef->_mutexLock );
286 if ( --_imgRef->_refCount == 0 )
297 // Adaptive-blur image
298 void Magick::Image::adaptiveBlur( const double radius_, const double sigma_ )
300 ExceptionInfo exceptionInfo;
301 GetExceptionInfo( &exceptionInfo );
302 MagickCore::Image* newImage =
303 AdaptiveBlurImage( image(), radius_, sigma_, image()->bias, &exceptionInfo);
304 replaceImage( newImage );
305 throwException( exceptionInfo );
306 (void) DestroyExceptionInfo( &exceptionInfo );
309 // Local adaptive threshold image
310 // http://www.dai.ed.ac.uk/HIPR2/adpthrsh.htm
311 // Width x height define the size of the pixel neighborhood
312 // offset = constant to subtract from pixel neighborhood mean
313 void Magick::Image::adaptiveThreshold ( const size_t width_,
314 const size_t height_,
315 const ssize_t offset_ )
317 ExceptionInfo exceptionInfo;
318 GetExceptionInfo( &exceptionInfo );
319 MagickCore::Image* newImage =
320 AdaptiveThresholdImage( constImage(), width_, height_, offset_, &exceptionInfo );
321 replaceImage( newImage );
322 throwException( exceptionInfo );
323 (void) DestroyExceptionInfo( &exceptionInfo );
326 // Add noise to image
327 void Magick::Image::addNoise( const NoiseType noiseType_ )
329 ExceptionInfo exceptionInfo;
330 GetExceptionInfo( &exceptionInfo );
331 MagickCore::Image* newImage =
332 AddNoiseImage ( image(),
335 replaceImage( newImage );
336 throwException( exceptionInfo );
337 (void) DestroyExceptionInfo( &exceptionInfo );
340 void Magick::Image::addNoiseChannel( const ChannelType channel_,
341 const NoiseType noiseType_ )
343 ExceptionInfo exceptionInfo;
344 GetExceptionInfo( &exceptionInfo );
345 ChannelType channel_mask = SetPixelChannelMask( image(), channel_);
346 MagickCore::Image* newImage =
347 AddNoiseImage ( image(),
350 (void) SetPixelChannelMapMask( image(), channel_mask );
351 replaceImage( newImage );
352 throwException( exceptionInfo );
353 (void) DestroyExceptionInfo( &exceptionInfo );
356 // Affine Transform image
357 void Magick::Image::affineTransform ( const DrawableAffine &affine_ )
359 ExceptionInfo exceptionInfo;
360 GetExceptionInfo( &exceptionInfo );
362 AffineMatrix _affine;
363 _affine.sx = affine_.sx();
364 _affine.sy = affine_.sy();
365 _affine.rx = affine_.rx();
366 _affine.ry = affine_.ry();
367 _affine.tx = affine_.tx();
368 _affine.ty = affine_.ty();
370 MagickCore::Image* newImage =
371 AffineTransformImage( image(), &_affine, &exceptionInfo);
372 replaceImage( newImage );
373 throwException( exceptionInfo );
374 (void) DestroyExceptionInfo( &exceptionInfo );
377 // Annotate using specified text, and placement location
378 void Magick::Image::annotate ( const std::string &text_,
379 const Geometry &location_ )
381 annotate ( text_, location_, NorthWestGravity, 0.0 );
383 // Annotate using specified text, bounding area, and placement gravity
384 void Magick::Image::annotate ( const std::string &text_,
385 const Geometry &boundingArea_,
386 const GravityType gravity_ )
388 annotate ( text_, boundingArea_, gravity_, 0.0 );
390 // Annotate with text using specified text, bounding area, placement
391 // gravity, and rotation.
392 void Magick::Image::annotate ( const std::string &text_,
393 const Geometry &boundingArea_,
394 const GravityType gravity_,
395 const double degrees_ )
400 = options()->drawInfo();
402 drawInfo->text = const_cast<char *>(text_.c_str());
404 char boundingArea[MaxTextExtent];
406 drawInfo->geometry = 0;
407 if ( boundingArea_.isValid() ){
408 if ( boundingArea_.width() == 0 || boundingArea_.height() == 0 )
410 FormatLocaleString( boundingArea, MaxTextExtent, "%+.20g%+.20g",
411 (double) boundingArea_.xOff(), (double) boundingArea_.yOff() );
415 (void) CopyMagickString( boundingArea, string(boundingArea_).c_str(),
418 drawInfo->geometry = boundingArea;
421 drawInfo->gravity = gravity_;
423 AffineMatrix oaffine = drawInfo->affine;
424 if ( degrees_ != 0.0)
434 AffineMatrix current = drawInfo->affine;
435 affine.sx=cos(DegreesToRadians(fmod(degrees_,360.0)));
436 affine.rx=sin(DegreesToRadians(fmod(degrees_,360.0)));
437 affine.ry=(-sin(DegreesToRadians(fmod(degrees_,360.0))));
438 affine.sy=cos(DegreesToRadians(fmod(degrees_,360.0)));
440 drawInfo->affine.sx=current.sx*affine.sx+current.ry*affine.rx;
441 drawInfo->affine.rx=current.rx*affine.sx+current.sy*affine.rx;
442 drawInfo->affine.ry=current.sx*affine.ry+current.ry*affine.sy;
443 drawInfo->affine.sy=current.rx*affine.ry+current.sy*affine.sy;
444 drawInfo->affine.tx=current.sx*affine.tx+current.ry*affine.ty
448 ExceptionInfo exceptionInfo;
449 GetExceptionInfo( &exceptionInfo );
450 AnnotateImage( image(), drawInfo, &exceptionInfo );
452 // Restore original values
453 drawInfo->affine = oaffine;
455 drawInfo->geometry = 0;
457 throwException( exceptionInfo );
458 (void) DestroyExceptionInfo( &exceptionInfo );
460 // Annotate with text (bounding area is entire image) and placement gravity.
461 void Magick::Image::annotate ( const std::string &text_,
462 const GravityType gravity_ )
467 = options()->drawInfo();
469 drawInfo->text = const_cast<char *>(text_.c_str());
471 drawInfo->gravity = gravity_;
473 ExceptionInfo exceptionInfo;
474 GetExceptionInfo( &exceptionInfo );
475 AnnotateImage( image(), drawInfo, &exceptionInfo );
477 drawInfo->gravity = NorthWestGravity;
480 throwException( exceptionInfo );
481 (void) DestroyExceptionInfo( &exceptionInfo );
485 void Magick::Image::blur( const double radius_, const double sigma_ )
487 ExceptionInfo exceptionInfo;
488 GetExceptionInfo( &exceptionInfo );
489 MagickCore::Image* newImage =
490 BlurImage( image(), radius_, sigma_, image()->bias, &exceptionInfo);
491 replaceImage( newImage );
492 throwException( exceptionInfo );
493 (void) DestroyExceptionInfo( &exceptionInfo );
496 void Magick::Image::blurChannel( const ChannelType channel_,
497 const double radius_, const double sigma_ )
499 ExceptionInfo exceptionInfo;
500 GetExceptionInfo( &exceptionInfo );
501 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
502 MagickCore::Image* newImage =
503 BlurImage( image(), radius_, sigma_, image()->bias, &exceptionInfo);
504 (void) SetPixelChannelMapMask( image(), channel_mask );
505 replaceImage( newImage );
506 throwException( exceptionInfo );
507 (void) DestroyExceptionInfo( &exceptionInfo );
510 // Add border to image
511 // Only uses width & height
512 void Magick::Image::border( const Geometry &geometry_ )
514 RectangleInfo borderInfo = geometry_;
515 ExceptionInfo exceptionInfo;
516 GetExceptionInfo( &exceptionInfo );
517 MagickCore::Image* newImage =
518 BorderImage( image(), &borderInfo, image()->compose, &exceptionInfo);
519 replaceImage( newImage );
520 throwException( exceptionInfo );
521 (void) DestroyExceptionInfo( &exceptionInfo );
524 // Extract channel from image
525 void Magick::Image::channel ( const ChannelType channel_ )
528 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
529 ExceptionInfo exceptionInfo;
530 GetExceptionInfo( &exceptionInfo );
531 SeparateImage ( image(), &exceptionInfo );
532 throwException( exceptionInfo );
533 (void) DestroyExceptionInfo( &exceptionInfo );
534 (void) SetPixelChannelMapMask( image(), channel_mask );
537 // Set or obtain modulus channel depth
538 void Magick::Image::channelDepth ( const size_t depth_ )
541 ExceptionInfo exceptionInfo;
542 GetExceptionInfo( &exceptionInfo );
543 SetImageDepth( image(), depth_, &exceptionInfo);
544 throwException( exceptionInfo );
545 (void) DestroyExceptionInfo( &exceptionInfo );
547 size_t Magick::Image::channelDepth ( )
549 size_t channel_depth;
551 ExceptionInfo exceptionInfo;
552 GetExceptionInfo( &exceptionInfo );
553 channel_depth=GetImageDepth( constImage(), &exceptionInfo );
554 throwException( exceptionInfo );
555 (void) DestroyExceptionInfo( &exceptionInfo );
556 return channel_depth;
560 // Charcoal-effect image
561 void Magick::Image::charcoal( const double radius_, const double sigma_ )
563 ExceptionInfo exceptionInfo;
564 GetExceptionInfo( &exceptionInfo );
565 MagickCore::Image* newImage =
566 CharcoalImage( image(), radius_, sigma_, image()->bias, &exceptionInfo );
567 replaceImage( newImage );
568 throwException( exceptionInfo );
569 (void) DestroyExceptionInfo( &exceptionInfo );
573 void Magick::Image::chop( const Geometry &geometry_ )
575 RectangleInfo chopInfo = geometry_;
576 ExceptionInfo exceptionInfo;
577 GetExceptionInfo( &exceptionInfo );
578 MagickCore::Image* newImage =
579 ChopImage( image(), &chopInfo, &exceptionInfo);
580 replaceImage( newImage );
581 throwException( exceptionInfo );
582 (void) DestroyExceptionInfo( &exceptionInfo );
585 // contains one or more color corrections and applies the correction to the
587 void Magick::Image::cdl ( const std::string &cdl_ )
590 ExceptionInfo exceptionInfo;
591 GetExceptionInfo( &exceptionInfo );
592 (void) ColorDecisionListImage( image(), cdl_.c_str(), &exceptionInfo );
593 throwException( exceptionInfo );
594 (void) DestroyExceptionInfo( &exceptionInfo );
598 void Magick::Image::colorize ( const unsigned int alphaRed_,
599 const unsigned int alphaGreen_,
600 const unsigned int alphaBlue_,
601 const Color &penColor_ )
603 if ( !penColor_.isValid() )
605 throwExceptionExplicit( OptionError,
606 "Pen color argument is invalid");
609 char blend[MaxTextExtent];
610 FormatLocaleString(blend,MaxTextExtent,"%u/%u/%u",alphaRed_,alphaGreen_,alphaBlue_);
612 ExceptionInfo exceptionInfo;
613 GetExceptionInfo( &exceptionInfo );
615 GetPixelInfo(image(),&target);
616 PixelInfo pixel=static_cast<PixelInfo>(penColor_);
617 target.red=pixel.red;
618 target.green=pixel.green;
619 target.blue=pixel.blue;
620 target.alpha=pixel.alpha;
621 MagickCore::Image* newImage =
622 ColorizeImage ( image(), blend, &target, &exceptionInfo );
623 replaceImage( newImage );
624 throwException( exceptionInfo );
625 (void) DestroyExceptionInfo( &exceptionInfo );
627 void Magick::Image::colorize ( const unsigned int alpha_,
628 const Color &penColor_ )
630 colorize( alpha_, alpha_, alpha_, penColor_ );
633 // Apply a color matrix to the image channels. The user supplied
634 // matrix may be of order 1 to 6 (1x1 through 6x6).
635 void Magick::Image::colorMatrix (const size_t order_,
636 const double *color_matrix_)
641 ExceptionInfo exceptionInfo;
642 GetExceptionInfo( &exceptionInfo );
643 kernel_info=AcquireKernelInfo((const char *) NULL);
644 kernel_info->width=order_;
645 kernel_info->height=order_;
646 kernel_info->values=(double *) color_matrix_;
647 MagickCore::Image* newImage =
648 ColorMatrixImage( image(), kernel_info, &exceptionInfo );
649 kernel_info->values=(double *) NULL;
650 kernel_info=DestroyKernelInfo(kernel_info);
651 replaceImage( newImage );
652 throwException( exceptionInfo );
653 (void) DestroyExceptionInfo( &exceptionInfo );
656 // Compare current image with another image
657 // Sets meanErrorPerPixel, normalizedMaxError, and normalizedMeanError
658 // in the current image. False is returned if the images are identical.
659 bool Magick::Image::compare ( const Image &reference_ )
661 ExceptionInfo exceptionInfo;
662 GetExceptionInfo( &exceptionInfo );
664 Image ref = reference_;
667 static_cast<bool>(IsImagesEqual(image(), ref.image(), &exceptionInfo));
668 throwException( exceptionInfo );
669 (void) DestroyExceptionInfo( &exceptionInfo );
673 // Composite two images
674 void Magick::Image::composite ( const Image &compositeImage_,
675 const ssize_t xOffset_,
676 const ssize_t yOffset_,
677 const CompositeOperator compose_ )
679 // Image supplied as compositeImage is composited with current image and
680 // results in updating current image.
683 ExceptionInfo exceptionInfo;
684 GetExceptionInfo( &exceptionInfo );
685 CompositeImage( image(),
687 compositeImage_.constImage(),
689 yOffset_, &exceptionInfo );
690 throwException( exceptionInfo );
691 (void) DestroyExceptionInfo( &exceptionInfo );
693 void Magick::Image::composite ( const Image &compositeImage_,
694 const Geometry &offset_,
695 const CompositeOperator compose_ )
699 ssize_t x = offset_.xOff();
700 ssize_t y = offset_.yOff();
701 size_t width = columns();
702 size_t height = rows();
704 ParseMetaGeometry (static_cast<std::string>(offset_).c_str(),
708 ExceptionInfo exceptionInfo;
709 GetExceptionInfo( &exceptionInfo );
710 CompositeImage( image(),
712 compositeImage_.constImage(),
713 x, y, &exceptionInfo );
714 throwException( exceptionInfo );
715 (void) DestroyExceptionInfo( &exceptionInfo );
717 void Magick::Image::composite ( const Image &compositeImage_,
718 const GravityType gravity_,
719 const CompositeOperator compose_ )
723 RectangleInfo geometry;
725 SetGeometry(compositeImage_.constImage(), &geometry);
726 GravityAdjustGeometry(columns(), rows(), gravity_, &geometry);
728 ExceptionInfo exceptionInfo;
729 GetExceptionInfo( &exceptionInfo );
730 CompositeImage( image(),
732 compositeImage_.constImage(),
733 geometry.x, geometry.y, &exceptionInfo );
734 throwException( exceptionInfo );
735 (void) DestroyExceptionInfo( &exceptionInfo );
739 void Magick::Image::contrast ( const size_t sharpen_ )
742 ExceptionInfo exceptionInfo;
743 GetExceptionInfo( &exceptionInfo );
744 ContrastImage ( image(), (MagickBooleanType) sharpen_, &exceptionInfo );
745 throwException( exceptionInfo );
746 (void) DestroyExceptionInfo( &exceptionInfo );
749 // Convolve image. Applies a general image convolution kernel to the image.
750 // order_ represents the number of columns and rows in the filter kernel.
751 // kernel_ is an array of doubles representing the convolution kernel.
752 void Magick::Image::convolve ( const size_t order_,
753 const double *kernel_ )
758 ExceptionInfo exceptionInfo;
759 GetExceptionInfo( &exceptionInfo );
760 kernel_info=AcquireKernelInfo((const char *) NULL);
761 kernel_info->width=order_;
762 kernel_info->height=order_;
763 kernel_info->values=(double *) kernel_;
764 kernel_info->bias=image()->bias;
765 MagickCore::Image* newImage =
766 ConvolveImage ( image(), kernel_info, &exceptionInfo );
767 kernel_info->values=(double *) NULL;
768 kernel_info=DestroyKernelInfo(kernel_info);
769 replaceImage( newImage );
770 throwException( exceptionInfo );
771 (void) DestroyExceptionInfo( &exceptionInfo );
775 void Magick::Image::crop ( const Geometry &geometry_ )
777 RectangleInfo cropInfo = geometry_;
778 ExceptionInfo exceptionInfo;
779 GetExceptionInfo( &exceptionInfo );
780 MagickCore::Image* newImage =
784 replaceImage( newImage );
785 throwException( exceptionInfo );
786 (void) DestroyExceptionInfo( &exceptionInfo );
790 void Magick::Image::cycleColormap ( const ssize_t amount_ )
792 ExceptionInfo exceptionInfo;
793 GetExceptionInfo( &exceptionInfo );
795 CycleColormapImage( image(), amount_, &exceptionInfo );
796 throwException( exceptionInfo );
797 (void) DestroyExceptionInfo( &exceptionInfo );
801 void Magick::Image::despeckle ( void )
803 ExceptionInfo exceptionInfo;
804 GetExceptionInfo( &exceptionInfo );
805 MagickCore::Image* newImage =
806 DespeckleImage( image(), &exceptionInfo );
807 replaceImage( newImage );
808 throwException( exceptionInfo );
809 (void) DestroyExceptionInfo( &exceptionInfo );
813 void Magick::Image::display( void )
815 ExceptionInfo exceptionInfo;
816 GetExceptionInfo( &exceptionInfo );
817 DisplayImages( imageInfo(), image(), &exceptionInfo );
818 throwException( exceptionInfo );
819 (void) DestroyExceptionInfo( &exceptionInfo );
822 // Distort image. distorts an image using various distortion methods, by
823 // mapping color lookups of the source image to a new destination image
824 // usally of the same size as the source image, unless 'bestfit' is set to
826 void Magick::Image::distort ( const DistortImageMethod method_,
827 const size_t number_arguments_,
828 const double *arguments_,
829 const bool bestfit_ )
831 ExceptionInfo exceptionInfo;
832 GetExceptionInfo( &exceptionInfo );
833 MagickCore::Image* newImage = DistortImage ( image(), method_,
834 number_arguments_, arguments_, bestfit_ == true ? MagickTrue : MagickFalse,
836 replaceImage( newImage );
837 throwException( exceptionInfo );
838 (void) DestroyExceptionInfo( &exceptionInfo );
841 // Draw on image using single drawable
842 void Magick::Image::draw ( const Magick::Drawable &drawable_ )
846 DrawingWand *wand = DrawAllocateWand( options()->drawInfo(), image());
850 drawable_.operator()(wand);
854 wand=DestroyDrawingWand(wand);
857 throwImageException();
860 // Draw on image using a drawable list
861 void Magick::Image::draw ( const std::list<Magick::Drawable> &drawable_ )
865 DrawingWand *wand = DrawAllocateWand( options()->drawInfo(), image());
869 for( std::list<Magick::Drawable>::const_iterator p = drawable_.begin();
870 p != drawable_.end(); p++ )
877 wand=DestroyDrawingWand(wand);
880 throwImageException();
883 // Hilight edges in image
884 void Magick::Image::edge ( const double radius_, const double sigma_ )
886 ExceptionInfo exceptionInfo;
887 GetExceptionInfo( &exceptionInfo );
888 MagickCore::Image* newImage =
889 EdgeImage( image(), radius_, sigma_, &exceptionInfo );
890 replaceImage( newImage );
891 throwException( exceptionInfo );
892 (void) DestroyExceptionInfo( &exceptionInfo );
895 // Emboss image (hilight edges)
896 void Magick::Image::emboss ( const double radius_, const double sigma_ )
898 ExceptionInfo exceptionInfo;
899 GetExceptionInfo( &exceptionInfo );
900 MagickCore::Image* newImage =
901 EmbossImage( image(), radius_, sigma_, &exceptionInfo );
902 replaceImage( newImage );
903 throwException( exceptionInfo );
904 (void) DestroyExceptionInfo( &exceptionInfo );
907 // Enhance image (minimize noise)
908 void Magick::Image::enhance ( void )
910 ExceptionInfo exceptionInfo;
911 GetExceptionInfo( &exceptionInfo );
912 MagickCore::Image* newImage =
913 EnhanceImage( image(), &exceptionInfo );
914 replaceImage( newImage );
915 throwException( exceptionInfo );
916 (void) DestroyExceptionInfo( &exceptionInfo );
919 // Equalize image (histogram equalization)
920 void Magick::Image::equalize ( void )
922 ExceptionInfo exceptionInfo;
923 GetExceptionInfo( &exceptionInfo );
925 EqualizeImage( image(), &exceptionInfo );
926 throwException( exceptionInfo );
927 (void) DestroyExceptionInfo( &exceptionInfo );
930 // Erase image to current "background color"
931 void Magick::Image::erase ( void )
934 ExceptionInfo exceptionInfo;
935 GetExceptionInfo( &exceptionInfo );
936 SetImageBackgroundColor( image(), &exceptionInfo );
937 throwException( exceptionInfo );
938 (void) DestroyExceptionInfo( &exceptionInfo );
941 // Extends image as defined by the geometry.
943 void Magick::Image::extent ( const Geometry &geometry_ )
945 RectangleInfo extentInfo = geometry_;
947 ExceptionInfo exceptionInfo;
948 GetExceptionInfo( &exceptionInfo );
949 MagickCore::Image* newImage =
950 ExtentImage ( image(), &extentInfo, &exceptionInfo );
951 replaceImage( newImage );
952 throwException( exceptionInfo );
953 (void) DestroyExceptionInfo( &exceptionInfo );
955 void Magick::Image::extent ( const Geometry &geometry_, const Color &backgroundColor_ )
957 backgroundColor ( backgroundColor_ );
958 extent ( geometry_ );
960 void Magick::Image::extent ( const Geometry &geometry_, const GravityType gravity_ )
962 image()->gravity = gravity_;
963 extent ( geometry_ );
965 void Magick::Image::extent ( const Geometry &geometry_, const Color &backgroundColor_, const GravityType gravity_ )
967 image()->gravity = gravity_;
968 backgroundColor ( backgroundColor_ );
969 extent ( geometry_ );
972 // Flip image (reflect each scanline in the vertical direction)
973 void Magick::Image::flip ( void )
975 ExceptionInfo exceptionInfo;
976 GetExceptionInfo( &exceptionInfo );
977 MagickCore::Image* newImage =
978 FlipImage( image(), &exceptionInfo );
979 replaceImage( newImage );
980 throwException( exceptionInfo );
981 (void) DestroyExceptionInfo( &exceptionInfo );
984 // Flood-fill color across pixels that match the color of the
985 // target pixel and are neighbors of the target pixel.
986 // Uses current fuzz setting when determining color match.
987 void Magick::Image::floodFillColor( const ssize_t x_,
989 const Magick::Color &fillColor_ )
991 floodFillTexture( x_, y_, Image( Geometry( 1, 1), fillColor_ ) );
993 void Magick::Image::floodFillColor( const Geometry &point_,
994 const Magick::Color &fillColor_ )
996 floodFillTexture( point_, Image( Geometry( 1, 1), fillColor_) );
999 // Flood-fill color across pixels starting at target-pixel and
1000 // stopping at pixels matching specified border color.
1001 // Uses current fuzz setting when determining color match.
1002 void Magick::Image::floodFillColor( const ssize_t x_,
1004 const Magick::Color &fillColor_,
1005 const Magick::Color &borderColor_ )
1007 floodFillTexture( x_, y_, Image( Geometry( 1, 1), fillColor_),
1010 void Magick::Image::floodFillColor( const Geometry &point_,
1011 const Magick::Color &fillColor_,
1012 const Magick::Color &borderColor_ )
1014 floodFillTexture( point_, Image( Geometry( 1, 1), fillColor_),
1018 // Floodfill pixels matching color (within fuzz factor) of target
1019 // pixel(x,y) with replacement alpha value using method.
1020 void Magick::Image::floodFillAlpha( const ssize_t x_,
1022 const unsigned int alpha_,
1023 const PaintMethod method_ )
1027 GetPixelInfo(image(),&target);
1028 PixelInfo pixel=static_cast<PixelInfo>(pixelColor(x_,y_));
1029 target.red=pixel.red;
1030 target.green=pixel.green;
1031 target.blue=pixel.blue;
1032 target.alpha=alpha_;
1033 ExceptionInfo exceptionInfo;
1034 GetExceptionInfo( &exceptionInfo );
1035 FloodfillPaintImage ( image(),
1036 options()->drawInfo(), // const DrawInfo *draw_info
1038 static_cast<ssize_t>(x_), static_cast<ssize_t>(y_),
1039 method_ == FloodfillMethod ? MagickFalse : MagickTrue,
1041 throwException( exceptionInfo );
1042 (void) DestroyExceptionInfo( &exceptionInfo );
1045 // Flood-fill texture across pixels that match the color of the
1046 // target pixel and are neighbors of the target pixel.
1047 // Uses current fuzz setting when determining color match.
1048 void Magick::Image::floodFillTexture( const ssize_t x_,
1050 const Magick::Image &texture_ )
1054 // Set drawing pattern
1055 options()->fillPattern(texture_.constImage());
1058 Pixels pixels(*this);
1060 Quantum *p = pixels.get(x_, y_, 1, 1 );
1062 GetPixelInfo(constImage(),&target);
1063 target.red=GetPixelRed(constImage(),p);
1064 target.green=GetPixelGreen(constImage(),p);
1065 target.blue=GetPixelBlue(constImage(),p);
1066 ExceptionInfo exceptionInfo;
1067 GetExceptionInfo( &exceptionInfo );
1069 FloodfillPaintImage ( image(), // Image *image
1070 options()->drawInfo(), // const DrawInfo *draw_info
1071 &target, // const MagickPacket target
1072 static_cast<ssize_t>(x_), // const ssize_t x_offset
1073 static_cast<ssize_t>(y_), // const ssize_t y_offset
1074 MagickFalse, // const PaintMethod method
1076 throwException( exceptionInfo );
1077 (void) DestroyExceptionInfo( &exceptionInfo );
1080 void Magick::Image::floodFillTexture( const Magick::Geometry &point_,
1081 const Magick::Image &texture_ )
1083 floodFillTexture( point_.xOff(), point_.yOff(), texture_ );
1086 // Flood-fill texture across pixels starting at target-pixel and
1087 // stopping at pixels matching specified border color.
1088 // Uses current fuzz setting when determining color match.
1089 void Magick::Image::floodFillTexture( const ssize_t x_,
1091 const Magick::Image &texture_,
1092 const Magick::Color &borderColor_ )
1096 // Set drawing fill pattern
1097 options()->fillPattern(texture_.constImage());
1100 GetPixelInfo(constImage(),&target);
1101 target.red=static_cast<PixelInfo>(borderColor_).red;
1102 target.green=static_cast<PixelInfo>(borderColor_).green;
1103 target.blue=static_cast<PixelInfo>(borderColor_).blue;
1104 ExceptionInfo exceptionInfo;
1105 GetExceptionInfo( &exceptionInfo );
1106 FloodfillPaintImage ( image(),
1107 options()->drawInfo(),
1109 static_cast<ssize_t>(x_),
1110 static_cast<ssize_t>(y_),
1111 MagickTrue, &exceptionInfo);
1113 throwException( exceptionInfo );
1114 (void) DestroyExceptionInfo( &exceptionInfo );
1116 void Magick::Image::floodFillTexture( const Magick::Geometry &point_,
1117 const Magick::Image &texture_,
1118 const Magick::Color &borderColor_ )
1120 floodFillTexture( point_.xOff(), point_.yOff(), texture_, borderColor_ );
1123 // Flop image (reflect each scanline in the horizontal direction)
1124 void Magick::Image::flop ( void )
1126 ExceptionInfo exceptionInfo;
1127 GetExceptionInfo( &exceptionInfo );
1128 MagickCore::Image* newImage =
1129 FlopImage( image(), &exceptionInfo );
1130 replaceImage( newImage );
1131 throwException( exceptionInfo );
1132 (void) DestroyExceptionInfo( &exceptionInfo );
1136 void Magick::Image::frame ( const Geometry &geometry_ )
1140 info.x = static_cast<ssize_t>(geometry_.width());
1141 info.y = static_cast<ssize_t>(geometry_.height());
1142 info.width = columns() + ( static_cast<size_t>(info.x) << 1 );
1143 info.height = rows() + ( static_cast<size_t>(info.y) << 1 );
1144 info.outer_bevel = geometry_.xOff();
1145 info.inner_bevel = geometry_.yOff();
1147 ExceptionInfo exceptionInfo;
1148 GetExceptionInfo( &exceptionInfo );
1149 MagickCore::Image* newImage =
1150 FrameImage( image(), &info, image()->compose, &exceptionInfo );
1151 replaceImage( newImage );
1152 throwException( exceptionInfo );
1153 (void) DestroyExceptionInfo( &exceptionInfo );
1155 void Magick::Image::frame ( const size_t width_,
1156 const size_t height_,
1157 const ssize_t outerBevel_, const ssize_t innerBevel_ )
1160 info.x = static_cast<ssize_t>(width_);
1161 info.y = static_cast<ssize_t>(height_);
1162 info.width = columns() + ( static_cast<size_t>(info.x) << 1 );
1163 info.height = rows() + ( static_cast<size_t>(info.y) << 1 );
1164 info.outer_bevel = static_cast<ssize_t>(outerBevel_);
1165 info.inner_bevel = static_cast<ssize_t>(innerBevel_);
1167 ExceptionInfo exceptionInfo;
1168 GetExceptionInfo( &exceptionInfo );
1169 MagickCore::Image* newImage =
1170 FrameImage( image(), &info, image()->compose, &exceptionInfo );
1171 replaceImage( newImage );
1172 throwException( exceptionInfo );
1173 (void) DestroyExceptionInfo( &exceptionInfo );
1176 // Fx image. Applies a mathematical expression to the image.
1177 void Magick::Image::fx ( const std::string expression )
1179 ExceptionInfo exceptionInfo;
1180 GetExceptionInfo( &exceptionInfo );
1181 MagickCore::Image* newImage =
1182 FxImage ( image(), expression.c_str(), &exceptionInfo );
1183 replaceImage( newImage );
1184 throwException( exceptionInfo );
1185 (void) DestroyExceptionInfo( &exceptionInfo );
1187 void Magick::Image::fx ( const std::string expression,
1188 const Magick::ChannelType channel )
1190 ExceptionInfo exceptionInfo;
1191 GetExceptionInfo( &exceptionInfo );
1192 ChannelType channel_mask = SetPixelChannelMask( image(), channel );
1193 MagickCore::Image* newImage =
1194 FxImage ( image(), expression.c_str(), &exceptionInfo );
1195 (void) SetPixelChannelMapMask( image(), channel_mask );
1196 replaceImage( newImage );
1197 throwException( exceptionInfo );
1198 (void) DestroyExceptionInfo( &exceptionInfo );
1201 // Gamma correct image
1202 void Magick::Image::gamma ( const double gamma_ )
1204 ExceptionInfo exceptionInfo;
1205 GetExceptionInfo( &exceptionInfo );
1207 GammaImage ( image(), gamma_, &exceptionInfo );
1208 throwException( exceptionInfo );
1209 (void) DestroyExceptionInfo( &exceptionInfo );
1212 void Magick::Image::gamma ( const double gammaRed_,
1213 const double gammaGreen_,
1214 const double gammaBlue_ )
1216 char gamma[MaxTextExtent + 1];
1217 FormatLocaleString( gamma, MaxTextExtent, "%3.6f/%3.6f/%3.6f/",
1218 gammaRed_, gammaGreen_, gammaBlue_);
1220 ExceptionInfo exceptionInfo;
1221 GetExceptionInfo( &exceptionInfo );
1223 GammaImage ( image(), atof(gamma), &exceptionInfo );
1224 throwException( exceptionInfo );
1225 (void) DestroyExceptionInfo( &exceptionInfo );
1228 // Gaussian blur image
1229 // The number of neighbor pixels to be included in the convolution
1230 // mask is specified by 'width_'. The standard deviation of the
1231 // gaussian bell curve is specified by 'sigma_'.
1232 void Magick::Image::gaussianBlur ( const double width_, const double sigma_ )
1234 ExceptionInfo exceptionInfo;
1235 GetExceptionInfo( &exceptionInfo );
1236 MagickCore::Image* newImage =
1237 GaussianBlurImage( image(), width_, sigma_, image()->bias, &exceptionInfo );
1238 replaceImage( newImage );
1239 throwException( exceptionInfo );
1240 (void) DestroyExceptionInfo( &exceptionInfo );
1243 void Magick::Image::gaussianBlurChannel ( const ChannelType channel_,
1244 const double width_,
1245 const double sigma_ )
1247 ExceptionInfo exceptionInfo;
1248 GetExceptionInfo( &exceptionInfo );
1249 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1250 MagickCore::Image* newImage =
1251 GaussianBlurImage( image(), width_, sigma_, image()->bias, &exceptionInfo );
1252 (void) SetPixelChannelMapMask( image(), channel_mask );
1253 replaceImage( newImage );
1254 throwException( exceptionInfo );
1255 (void) DestroyExceptionInfo( &exceptionInfo );
1258 // Apply a color lookup table (Hald CLUT) to the image.
1259 void Magick::Image::haldClut ( const Image &clutImage_ )
1261 ExceptionInfo exceptionInfo;
1262 GetExceptionInfo( &exceptionInfo );
1264 (void) HaldClutImage( image(), clutImage_.constImage(), &exceptionInfo );
1265 throwException( exceptionInfo );
1266 (void) DestroyExceptionInfo( &exceptionInfo );
1270 void Magick::Image::implode ( const double factor_ )
1272 ExceptionInfo exceptionInfo;
1273 GetExceptionInfo( &exceptionInfo );
1274 MagickCore::Image* newImage =
1275 ImplodeImage( image(), factor_, image()->interpolate, &exceptionInfo );
1276 replaceImage( newImage );
1277 throwException( exceptionInfo );
1278 (void) DestroyExceptionInfo( &exceptionInfo );
1281 // implements the inverse discrete Fourier transform (IFT) of the image either
1282 // as a magnitude / phase or real / imaginary image pair.
1283 void Magick::Image::inverseFourierTransform ( const Image &phase_ )
1285 ExceptionInfo exceptionInfo;
1286 GetExceptionInfo( &exceptionInfo );
1287 MagickCore::Image* newImage = InverseFourierTransformImage( image(),
1288 phase_.constImage(), MagickTrue, &exceptionInfo);
1289 replaceImage( newImage );
1290 throwException( exceptionInfo );
1291 (void) DestroyExceptionInfo( &exceptionInfo );
1293 void Magick::Image::inverseFourierTransform ( const Image &phase_,
1294 const bool magnitude_ )
1296 ExceptionInfo exceptionInfo;
1297 GetExceptionInfo( &exceptionInfo );
1298 MagickCore::Image* newImage = InverseFourierTransformImage( image(),
1299 phase_.constImage(), magnitude_ == true ? MagickTrue : MagickFalse,
1301 replaceImage( newImage );
1302 throwException( exceptionInfo );
1303 (void) DestroyExceptionInfo( &exceptionInfo );
1306 // Level image. Adjust the levels of the image by scaling the colors
1307 // falling between specified white and black points to the full
1308 // available quantum range. The parameters provided represent the
1309 // black, mid (gamma), and white points. The black point specifies
1310 // the darkest color in the image. Colors darker than the black point
1311 // are set to zero. Mid point (gamma) specifies a gamma correction to
1312 // apply to the image. White point specifies the lightest color in the
1313 // image. Colors brighter than the white point are set to the maximum
1314 // quantum value. The black and white point have the valid range 0 to
1315 // QuantumRange while gamma has a useful range of 0 to ten.
1316 void Magick::Image::level ( const double black_point,
1317 const double white_point,
1318 const double gamma )
1320 ExceptionInfo exceptionInfo;
1321 GetExceptionInfo( &exceptionInfo );
1323 (void) LevelImage( image(), black_point, white_point, gamma, &exceptionInfo );
1324 throwException( exceptionInfo );
1325 (void) DestroyExceptionInfo( &exceptionInfo );
1328 // Magnify image by integral size
1329 void Magick::Image::magnify ( void )
1331 ExceptionInfo exceptionInfo;
1332 GetExceptionInfo( &exceptionInfo );
1333 MagickCore::Image* newImage =
1334 MagnifyImage( image(), &exceptionInfo );
1335 replaceImage( newImage );
1336 throwException( exceptionInfo );
1337 (void) DestroyExceptionInfo( &exceptionInfo );
1340 // Remap image colors with closest color from reference image
1341 void Magick::Image::map ( const Image &mapImage_ , const bool dither_ )
1343 ExceptionInfo exceptionInfo;
1344 GetExceptionInfo( &exceptionInfo );
1346 options()->quantizeDither( dither_ );
1347 RemapImage ( options()->quantizeInfo(), image(),
1348 mapImage_.constImage(), &exceptionInfo);
1349 throwException( exceptionInfo );
1350 (void) DestroyExceptionInfo( &exceptionInfo );
1352 // Floodfill designated area with replacement alpha value
1353 void Magick::Image::matteFloodfill ( const Color &target_ ,
1354 const unsigned int alpha_,
1355 const ssize_t x_, const ssize_t y_,
1356 const Magick::PaintMethod method_ )
1360 GetPixelInfo(constImage(),&target);
1361 target.red=static_cast<PixelInfo>(target_).red;
1362 target.green=static_cast<PixelInfo>(target_).green;
1363 target.blue=static_cast<PixelInfo>(target_).blue;
1364 target.alpha=alpha_;
1365 ChannelType channel_mask = SetPixelChannelMask( image(), AlphaChannel );
1366 ExceptionInfo exceptionInfo;
1367 GetExceptionInfo( &exceptionInfo );
1368 FloodfillPaintImage ( image(), options()->drawInfo(), &target, x_, y_,
1369 method_ == FloodfillMethod ? MagickFalse : MagickTrue, &exceptionInfo);
1370 (void) SetPixelChannelMapMask( image(), channel_mask );
1371 throwException( exceptionInfo );
1372 (void) DestroyExceptionInfo( &exceptionInfo );
1375 // Filter image by replacing each pixel component with the median
1376 // color in a circular neighborhood
1377 void Magick::Image::medianFilter ( const double radius_ )
1379 ExceptionInfo exceptionInfo;
1380 GetExceptionInfo( &exceptionInfo );
1381 MagickCore::Image* newImage =
1382 StatisticImage ( image(), MedianStatistic, (size_t) radius_, (size_t)
1383 radius_,&exceptionInfo );
1384 replaceImage( newImage );
1385 throwException( exceptionInfo );
1386 (void) DestroyExceptionInfo( &exceptionInfo );
1389 // Reduce image by integral size
1390 void Magick::Image::minify ( void )
1392 ExceptionInfo exceptionInfo;
1393 GetExceptionInfo( &exceptionInfo );
1394 MagickCore::Image* newImage =
1395 MinifyImage( image(), &exceptionInfo );
1396 replaceImage( newImage );
1397 throwException( exceptionInfo );
1398 (void) DestroyExceptionInfo( &exceptionInfo );
1401 // Modulate percent hue, saturation, and brightness of an image
1402 void Magick::Image::modulate ( const double brightness_,
1403 const double saturation_,
1406 char modulate[MaxTextExtent + 1];
1407 FormatLocaleString( modulate, MaxTextExtent, "%3.6f,%3.6f,%3.6f",
1408 brightness_, saturation_, hue_);
1410 ExceptionInfo exceptionInfo;
1411 GetExceptionInfo( &exceptionInfo );
1413 ModulateImage( image(), modulate, &exceptionInfo );
1414 throwException( exceptionInfo );
1415 (void) DestroyExceptionInfo( &exceptionInfo );
1418 // Motion blur image with specified blur factor
1419 // The radius_ parameter specifies the radius of the Gaussian, in
1420 // pixels, not counting the center pixel. The sigma_ parameter
1421 // specifies the standard deviation of the Laplacian, in pixels.
1422 // The angle_ parameter specifies the angle the object appears
1423 // to be comming from (zero degrees is from the right).
1424 void Magick::Image::motionBlur ( const double radius_,
1425 const double sigma_,
1426 const double angle_ )
1428 ExceptionInfo exceptionInfo;
1429 GetExceptionInfo( &exceptionInfo );
1430 MagickCore::Image* newImage =
1431 MotionBlurImage( image(), radius_, sigma_, angle_, 0.0, &exceptionInfo);
1432 replaceImage( newImage );
1433 throwException( exceptionInfo );
1434 (void) DestroyExceptionInfo( &exceptionInfo );
1437 // Negate image. Set grayscale_ to true to effect grayscale values
1439 void Magick::Image::negate ( const bool grayscale_ )
1441 ExceptionInfo exceptionInfo;
1442 GetExceptionInfo( &exceptionInfo );
1444 NegateImage ( image(), grayscale_ == true ? MagickTrue : MagickFalse,
1446 throwException( exceptionInfo );
1447 (void) DestroyExceptionInfo( &exceptionInfo );
1451 void Magick::Image::normalize ( void )
1454 ExceptionInfo exceptionInfo;
1455 GetExceptionInfo( &exceptionInfo );
1456 NormalizeImage ( image(), &exceptionInfo );
1457 throwException( exceptionInfo );
1458 (void) DestroyExceptionInfo( &exceptionInfo );
1462 void Magick::Image::oilPaint ( const double radius_, const double sigma_ )
1464 ExceptionInfo exceptionInfo;
1465 GetExceptionInfo( &exceptionInfo );
1466 MagickCore::Image* newImage =
1467 OilPaintImage( image(), radius_, sigma_, &exceptionInfo );
1468 replaceImage( newImage );
1469 throwException( exceptionInfo );
1470 (void) DestroyExceptionInfo( &exceptionInfo );
1473 // Set or attenuate the alpha channel. If the image pixels are
1474 // opaque then they are set to the specified alpha value, otherwise
1475 // they are blended with the supplied alpha value. The value of
1476 // alpha_ ranges from 0 (completely opaque) to QuantumRange. The defines
1477 // OpaqueAlpha and TransparentAlpha are available to specify
1478 // completely opaque or completely transparent, respectively.
1479 void Magick::Image::alpha ( const unsigned int alpha_ )
1482 ExceptionInfo exceptionInfo;
1483 GetExceptionInfo( &exceptionInfo );
1484 SetImageAlpha( image(), alpha_, &exceptionInfo );
1485 throwException( exceptionInfo );
1486 (void) DestroyExceptionInfo( &exceptionInfo );
1489 // Change the color of an opaque pixel to the pen color.
1490 void Magick::Image::opaque ( const Color &opaqueColor_,
1491 const Color &penColor_ )
1493 if ( !opaqueColor_.isValid() )
1495 throwExceptionExplicit( OptionError,
1496 "Opaque color argument is invalid" );
1498 if ( !penColor_.isValid() )
1500 throwExceptionExplicit( OptionError,
1501 "Pen color argument is invalid" );
1505 std::string opaqueColor = opaqueColor_;
1506 std::string penColor = penColor_;
1510 ExceptionInfo exceptionInfo;
1511 GetExceptionInfo( &exceptionInfo );
1512 (void) QueryColorCompliance(std::string(opaqueColor_).c_str(),
1513 AllCompliance, &opaque, &exceptionInfo);
1514 (void) QueryColorCompliance(std::string(penColor_).c_str(),
1515 AllCompliance, &pen, &exceptionInfo);
1516 OpaquePaintImage ( image(), &opaque, &pen, MagickFalse, &exceptionInfo );
1517 throwException( exceptionInfo );
1518 (void) DestroyExceptionInfo( &exceptionInfo );
1521 // Ping is similar to read except only enough of the image is read to
1522 // determine the image columns, rows, and filesize. Access the
1523 // columns(), rows(), and fileSize() attributes after invoking ping.
1524 // The image data is not valid after calling ping.
1525 void Magick::Image::ping ( const std::string &imageSpec_ )
1527 options()->fileName( imageSpec_ );
1528 ExceptionInfo exceptionInfo;
1529 GetExceptionInfo( &exceptionInfo );
1530 MagickCore::Image* image =
1531 PingImage( imageInfo(), &exceptionInfo );
1532 replaceImage( image );
1533 throwException( exceptionInfo );
1534 (void) DestroyExceptionInfo( &exceptionInfo );
1537 // Ping is similar to read except only enough of the image is read
1538 // to determine the image columns, rows, and filesize. Access the
1539 // columns(), rows(), and fileSize() attributes after invoking
1540 // ping. The image data is not valid after calling ping.
1541 void Magick::Image::ping ( const Blob& blob_ )
1543 ExceptionInfo exceptionInfo;
1544 GetExceptionInfo( &exceptionInfo );
1545 MagickCore::Image* image =
1546 PingBlob( imageInfo(), blob_.data(), blob_.length(), &exceptionInfo );
1547 replaceImage( image );
1548 throwException( exceptionInfo );
1549 (void) DestroyExceptionInfo( &exceptionInfo );
1552 // Execute a named process module using an argc/argv syntax similar to
1553 // that accepted by a C 'main' routine. An exception is thrown if the
1554 // requested process module doesn't exist, fails to load, or fails during
1556 void Magick::Image::process( std::string name_, const ssize_t argc, const char **argv )
1560 ExceptionInfo exceptionInfo;
1561 GetExceptionInfo( &exceptionInfo );
1563 InvokeDynamicImageFilter( name_.c_str(), &image(), argc, argv,
1565 throwException( exceptionInfo );
1566 (void) DestroyExceptionInfo( &exceptionInfo );
1569 // Quantize colors in image using current quantization settings
1570 // Set measureError_ to true in order to measure quantization error
1571 void Magick::Image::quantize ( const bool measureError_ )
1576 options()->quantizeInfo()->measure_error=MagickTrue;
1578 options()->quantizeInfo()->measure_error=MagickFalse;
1580 ExceptionInfo exceptionInfo;
1581 GetExceptionInfo( &exceptionInfo );
1582 QuantizeImage( options()->quantizeInfo(), image(), &exceptionInfo );
1584 throwException( exceptionInfo );
1585 (void) DestroyExceptionInfo( &exceptionInfo );
1588 // Apply an arithmetic or bitwise operator to the image pixel quantums.
1589 void Magick::Image::quantumOperator ( const ChannelType channel_,
1590 const MagickEvaluateOperator operator_,
1593 ExceptionInfo exceptionInfo;
1594 GetExceptionInfo( &exceptionInfo );
1595 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1596 EvaluateImage( image(), operator_, rvalue_, &exceptionInfo);
1597 (void) SetPixelChannelMapMask( image(), channel_mask );
1598 throwException( exceptionInfo );
1599 (void) DestroyExceptionInfo( &exceptionInfo );
1602 void Magick::Image::quantumOperator ( const ssize_t x_,const ssize_t y_,
1603 const size_t columns_,
1605 const ChannelType channel_,
1606 const MagickEvaluateOperator operator_,
1607 const double rvalue_)
1609 ExceptionInfo exceptionInfo;
1610 GetExceptionInfo( &exceptionInfo );
1611 RectangleInfo geometry;
1612 geometry.width = columns_;
1613 geometry.height = rows_;
1616 MagickCore::Image *crop_image = CropImage( image(), &geometry,
1618 ChannelType channel_mask = SetPixelChannelMask( image(), channel_);
1619 EvaluateImage( crop_image, operator_, rvalue_, &exceptionInfo );
1620 (void) SetPixelChannelMapMask( image(), channel_mask );
1621 (void) CompositeImage( image(), image()->matte != MagickFalse ?
1622 OverCompositeOp : CopyCompositeOp, crop_image, geometry.x, geometry.y,
1624 crop_image = DestroyImageList(crop_image);
1625 throwException( exceptionInfo );
1626 (void) DestroyExceptionInfo( &exceptionInfo );
1629 // Raise image (lighten or darken the edges of an image to give a 3-D
1630 // raised or lowered effect)
1631 void Magick::Image::raise ( const Geometry &geometry_ ,
1632 const bool raisedFlag_ )
1634 ExceptionInfo exceptionInfo;
1635 GetExceptionInfo( &exceptionInfo );
1636 RectangleInfo raiseInfo = geometry_;
1638 RaiseImage ( image(), &raiseInfo, raisedFlag_ == true ? MagickTrue : MagickFalse, &exceptionInfo );
1639 throwException( exceptionInfo );
1640 (void) DestroyExceptionInfo( &exceptionInfo );
1644 // Random threshold image.
1646 // Changes the value of individual pixels based on the intensity
1647 // of each pixel compared to a random threshold. The result is a
1648 // low-contrast, two color image. The thresholds_ argument is a
1649 // geometry containing LOWxHIGH thresholds. If the string
1650 // contains 2x2, 3x3, or 4x4, then an ordered dither of order 2,
1651 // 3, or 4 will be performed instead. If a channel_ argument is
1652 // specified then only the specified channel is altered. This is
1653 // a very fast alternative to 'quantize' based dithering.
1654 void Magick::Image::randomThreshold( const Geometry &thresholds_ )
1656 randomThresholdChannel(thresholds_,DefaultChannels);
1658 void Magick::Image::randomThresholdChannel( const Geometry &thresholds_,
1659 const ChannelType channel_ )
1661 ExceptionInfo exceptionInfo;
1662 GetExceptionInfo( &exceptionInfo );
1664 ChannelType channel_mask = SetPixelChannelMask( image(), channel_);
1665 (void) RandomThresholdImage( image(),
1666 static_cast<std::string>(thresholds_).c_str(),
1668 (void) SetPixelChannelMapMask( image(), channel_mask );
1669 throwImageException();
1670 (void) DestroyExceptionInfo( &exceptionInfo );
1673 // Read image into current object
1674 void Magick::Image::read ( const std::string &imageSpec_ )
1676 options()->fileName( imageSpec_ );
1678 ExceptionInfo exceptionInfo;
1679 GetExceptionInfo( &exceptionInfo );
1680 MagickCore::Image* image =
1681 ReadImage( imageInfo(), &exceptionInfo );
1683 // Ensure that multiple image frames were not read.
1684 if ( image && image->next )
1686 // Destroy any extra image frames
1687 MagickCore::Image* next = image->next;
1690 DestroyImageList( next );
1693 replaceImage( image );
1694 throwException( exceptionInfo );
1695 (void) DestroyExceptionInfo( &exceptionInfo );
1698 // Read image of specified size into current object
1699 void Magick::Image::read ( const Geometry &size_,
1700 const std::string &imageSpec_ )
1706 // Read image from in-memory BLOB
1707 void Magick::Image::read ( const Blob &blob_ )
1709 ExceptionInfo exceptionInfo;
1710 GetExceptionInfo( &exceptionInfo );
1711 MagickCore::Image* image =
1712 BlobToImage( imageInfo(),
1713 static_cast<const void *>(blob_.data()),
1714 blob_.length(), &exceptionInfo );
1715 replaceImage( image );
1716 throwException( exceptionInfo );
1717 (void) DestroyExceptionInfo( &exceptionInfo );
1720 // Read image of specified size from in-memory BLOB
1721 void Magick::Image::read ( const Blob &blob_,
1722 const Geometry &size_ )
1730 // Read image of specified size and depth from in-memory BLOB
1731 void Magick::Image::read ( const Blob &blob_,
1732 const Geometry &size_,
1733 const size_t depth_ )
1743 // Read image of specified size, depth, and format from in-memory BLOB
1744 void Magick::Image::read ( const Blob &blob_,
1745 const Geometry &size_,
1746 const size_t depth_,
1747 const std::string &magick_ )
1755 // Set explicit image format
1756 fileName( magick_ + ':');
1761 // Read image of specified size, and format from in-memory BLOB
1762 void Magick::Image::read ( const Blob &blob_,
1763 const Geometry &size_,
1764 const std::string &magick_ )
1770 // Set explicit image format
1771 fileName( magick_ + ':');
1776 // Read image based on raw pixels in memory (ConstituteImage)
1777 void Magick::Image::read ( const size_t width_,
1778 const size_t height_,
1779 const std::string &map_,
1780 const StorageType type_,
1781 const void *pixels_ )
1783 ExceptionInfo exceptionInfo;
1784 GetExceptionInfo( &exceptionInfo );
1785 MagickCore::Image* image =
1786 ConstituteImage( width_, height_, map_.c_str(), type_, pixels_,
1788 replaceImage( image );
1789 throwException( exceptionInfo );
1790 (void) DestroyExceptionInfo( &exceptionInfo );
1793 // Reduce noise in image
1794 void Magick::Image::reduceNoise ( const double order_ )
1796 ExceptionInfo exceptionInfo;
1797 GetExceptionInfo( &exceptionInfo );
1798 MagickCore::Image* newImage =
1799 StatisticImage( image(), NonpeakStatistic, (size_t) order_, (size_t) order_,
1801 replaceImage( newImage );
1802 throwException( exceptionInfo );
1803 (void) DestroyExceptionInfo( &exceptionInfo );
1807 void Magick::Image::resize( const Geometry &geometry_ )
1809 // Calculate new size. This code should be supported using binary arguments
1810 // in the ImageMagick library.
1813 size_t width = columns();
1814 size_t height = rows();
1816 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1820 ExceptionInfo exceptionInfo;
1821 GetExceptionInfo( &exceptionInfo );
1822 MagickCore::Image* newImage =
1823 ResizeImage( image(),
1829 replaceImage( newImage );
1830 throwException( exceptionInfo );
1831 (void) DestroyExceptionInfo( &exceptionInfo );
1835 void Magick::Image::roll ( const Geometry &roll_ )
1837 ssize_t xOff = roll_.xOff();
1838 if ( roll_.xNegative() )
1840 ssize_t yOff = roll_.yOff();
1841 if ( roll_.yNegative() )
1844 ExceptionInfo exceptionInfo;
1845 GetExceptionInfo( &exceptionInfo );
1846 MagickCore::Image* newImage =
1847 RollImage( image(), xOff, yOff, &exceptionInfo );
1848 replaceImage( newImage );
1849 throwException( exceptionInfo );
1850 (void) DestroyExceptionInfo( &exceptionInfo );
1852 void Magick::Image::roll ( const size_t columns_,
1853 const size_t rows_ )
1855 ExceptionInfo exceptionInfo;
1856 GetExceptionInfo( &exceptionInfo );
1857 MagickCore::Image* newImage =
1859 static_cast<ssize_t>(columns_),
1860 static_cast<ssize_t>(rows_), &exceptionInfo );
1861 replaceImage( newImage );
1862 throwException( exceptionInfo );
1863 (void) DestroyExceptionInfo( &exceptionInfo );
1867 void Magick::Image::rotate ( const double degrees_ )
1869 ExceptionInfo exceptionInfo;
1870 GetExceptionInfo( &exceptionInfo );
1871 MagickCore::Image* newImage =
1872 RotateImage( image(), degrees_, &exceptionInfo);
1873 replaceImage( newImage );
1874 throwException( exceptionInfo );
1875 (void) DestroyExceptionInfo( &exceptionInfo );
1879 void Magick::Image::sample ( const Geometry &geometry_ )
1883 size_t width = columns();
1884 size_t height = rows();
1886 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1890 ExceptionInfo exceptionInfo;
1891 GetExceptionInfo( &exceptionInfo );
1892 MagickCore::Image* newImage =
1893 SampleImage( image(), width, height, &exceptionInfo );
1894 replaceImage( newImage );
1895 throwException( exceptionInfo );
1896 (void) DestroyExceptionInfo( &exceptionInfo );
1900 void Magick::Image::scale ( const Geometry &geometry_ )
1904 size_t width = columns();
1905 size_t height = rows();
1907 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
1911 ExceptionInfo exceptionInfo;
1912 GetExceptionInfo( &exceptionInfo );
1913 MagickCore::Image* newImage =
1914 ScaleImage( image(), width, height, &exceptionInfo );
1915 replaceImage( newImage );
1916 throwException( exceptionInfo );
1917 (void) DestroyExceptionInfo( &exceptionInfo );
1920 // Segment (coalesce similar image components) by analyzing the
1921 // histograms of the color components and identifying units that are
1922 // homogeneous with the fuzzy c-means technique.
1923 void Magick::Image::segment ( const double clusterThreshold_,
1924 const double smoothingThreshold_ )
1926 ExceptionInfo exceptionInfo;
1927 GetExceptionInfo( &exceptionInfo );
1929 SegmentImage ( image(),
1930 options()->quantizeColorSpace(),
1931 (MagickBooleanType) options()->verbose(),
1933 smoothingThreshold_, &exceptionInfo );
1934 SyncImage( image(), &exceptionInfo );
1935 throwException( exceptionInfo );
1936 (void) DestroyExceptionInfo( &exceptionInfo );
1939 // Shade image using distant light source
1940 void Magick::Image::shade ( const double azimuth_,
1941 const double elevation_,
1942 const bool colorShading_ )
1944 ExceptionInfo exceptionInfo;
1945 GetExceptionInfo( &exceptionInfo );
1946 MagickCore::Image* newImage =
1947 ShadeImage( image(),
1948 colorShading_ == true ? MagickTrue : MagickFalse,
1952 replaceImage( newImage );
1953 throwException( exceptionInfo );
1954 (void) DestroyExceptionInfo( &exceptionInfo );
1957 // Sharpen pixels in image
1958 void Magick::Image::sharpen ( const double radius_, const double sigma_ )
1960 ExceptionInfo exceptionInfo;
1961 GetExceptionInfo( &exceptionInfo );
1962 MagickCore::Image* newImage =
1963 SharpenImage( image(),
1968 replaceImage( newImage );
1969 throwException( exceptionInfo );
1970 (void) DestroyExceptionInfo( &exceptionInfo );
1973 void Magick::Image::sharpenChannel ( const ChannelType channel_,
1974 const double radius_, const double sigma_ )
1976 ExceptionInfo exceptionInfo;
1977 GetExceptionInfo( &exceptionInfo );
1978 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
1979 MagickCore::Image* newImage =
1980 SharpenImage( image(),
1985 (void) SetPixelChannelMapMask( image(), channel_mask );
1986 replaceImage( newImage );
1987 throwException( exceptionInfo );
1988 (void) DestroyExceptionInfo( &exceptionInfo );
1991 // Shave pixels from image edges.
1992 void Magick::Image::shave ( const Geometry &geometry_ )
1994 RectangleInfo shaveInfo = geometry_;
1995 ExceptionInfo exceptionInfo;
1996 GetExceptionInfo( &exceptionInfo );
1997 MagickCore::Image* newImage =
1998 ShaveImage( image(),
2001 replaceImage( newImage );
2002 throwException( exceptionInfo );
2003 (void) DestroyExceptionInfo( &exceptionInfo );
2007 void Magick::Image::shear ( const double xShearAngle_,
2008 const double yShearAngle_ )
2010 ExceptionInfo exceptionInfo;
2011 GetExceptionInfo( &exceptionInfo );
2012 MagickCore::Image* newImage =
2013 ShearImage( image(),
2017 replaceImage( newImage );
2018 throwException( exceptionInfo );
2019 (void) DestroyExceptionInfo( &exceptionInfo );
2023 void Magick::Image::sigmoidalContrast ( const size_t sharpen_, const double contrast, const double midpoint )
2025 ExceptionInfo exceptionInfo;
2026 GetExceptionInfo( &exceptionInfo );
2028 (void) SigmoidalContrastImage( image(), (MagickBooleanType) sharpen_, contrast, midpoint, &exceptionInfo );
2029 throwException( exceptionInfo );
2030 (void) DestroyExceptionInfo( &exceptionInfo );
2033 // Solarize image (similar to effect seen when exposing a photographic
2034 // film to light during the development process)
2035 void Magick::Image::solarize ( const double factor_ )
2037 ExceptionInfo exceptionInfo;
2038 GetExceptionInfo( &exceptionInfo );
2040 SolarizeImage ( image(), factor_, &exceptionInfo );
2041 throwException( exceptionInfo );
2042 (void) DestroyExceptionInfo( &exceptionInfo );
2045 // Sparse color image, given a set of coordinates, interpolates the colors
2046 // found at those coordinates, across the whole image, using various methods.
2048 void Magick::Image::sparseColor ( const ChannelType channel,
2049 const SparseColorMethod method,
2050 const size_t number_arguments,
2051 const double *arguments )
2053 ExceptionInfo exceptionInfo;
2054 GetExceptionInfo( &exceptionInfo );
2056 ChannelType channel_mask = SetPixelChannelMask( image(), channel );
2057 MagickCore::Image* newImage = SparseColorImage ( image(), method,
2058 number_arguments, arguments, &exceptionInfo );
2059 (void) SetPixelChannelMapMask( image(), channel_mask );
2060 replaceImage( newImage );
2061 throwException( exceptionInfo );
2062 (void) DestroyExceptionInfo( &exceptionInfo );
2065 // Spread pixels randomly within image by specified ammount
2066 void Magick::Image::spread ( const size_t amount_ )
2068 ExceptionInfo exceptionInfo;
2069 GetExceptionInfo( &exceptionInfo );
2070 MagickCore::Image* newImage =
2071 SpreadImage( image(),
2073 image()->interpolate,
2075 replaceImage( newImage );
2076 throwException( exceptionInfo );
2077 (void) DestroyExceptionInfo( &exceptionInfo );
2080 // Add a digital watermark to the image (based on second image)
2081 void Magick::Image::stegano ( const Image &watermark_ )
2083 ExceptionInfo exceptionInfo;
2084 GetExceptionInfo( &exceptionInfo );
2085 MagickCore::Image* newImage =
2086 SteganoImage( image(),
2087 watermark_.constImage(),
2089 replaceImage( newImage );
2090 throwException( exceptionInfo );
2091 (void) DestroyExceptionInfo( &exceptionInfo );
2094 // Stereo image (left image is current image)
2095 void Magick::Image::stereo ( const Image &rightImage_ )
2097 ExceptionInfo exceptionInfo;
2098 GetExceptionInfo( &exceptionInfo );
2099 MagickCore::Image* newImage =
2100 StereoImage( image(),
2101 rightImage_.constImage(),
2103 replaceImage( newImage );
2104 throwException( exceptionInfo );
2105 (void) DestroyExceptionInfo( &exceptionInfo );
2109 void Magick::Image::swirl ( const double degrees_ )
2111 ExceptionInfo exceptionInfo;
2112 GetExceptionInfo( &exceptionInfo );
2113 MagickCore::Image* newImage =
2114 SwirlImage( image(), degrees_, image()->interpolate,
2116 replaceImage( newImage );
2117 throwException( exceptionInfo );
2118 (void) DestroyExceptionInfo( &exceptionInfo );
2122 void Magick::Image::texture ( const Image &texture_ )
2125 ExceptionInfo exceptionInfo;
2126 GetExceptionInfo( &exceptionInfo );
2127 TextureImage( image(), texture_.constImage(), &exceptionInfo );
2128 throwException( exceptionInfo );
2129 (void) DestroyExceptionInfo( &exceptionInfo );
2133 void Magick::Image::threshold ( const double threshold_ )
2136 ExceptionInfo exceptionInfo;
2137 GetExceptionInfo( &exceptionInfo );
2138 BilevelImage( image(), threshold_, &exceptionInfo );
2139 throwException( exceptionInfo );
2140 (void) DestroyExceptionInfo( &exceptionInfo );
2143 // Transform image based on image geometry only
2144 void Magick::Image::transform ( const Geometry &imageGeometry_ )
2147 ExceptionInfo exceptionInfo;
2148 GetExceptionInfo( &exceptionInfo );
2149 TransformImage ( &(image()), 0,
2150 std::string(imageGeometry_).c_str(), &exceptionInfo );
2151 throwException( exceptionInfo );
2152 (void) DestroyExceptionInfo( &exceptionInfo );
2154 // Transform image based on image and crop geometries
2155 void Magick::Image::transform ( const Geometry &imageGeometry_,
2156 const Geometry &cropGeometry_ )
2159 ExceptionInfo exceptionInfo;
2160 GetExceptionInfo( &exceptionInfo );
2161 TransformImage ( &(image()), std::string(cropGeometry_).c_str(),
2162 std::string(imageGeometry_).c_str(), &exceptionInfo );
2163 throwException( exceptionInfo );
2164 (void) DestroyExceptionInfo( &exceptionInfo );
2167 // Add matte image to image, setting pixels matching color to transparent
2168 void Magick::Image::transparent ( const Color &color_ )
2170 if ( !color_.isValid() )
2172 throwExceptionExplicit( OptionError,
2173 "Color argument is invalid" );
2176 std::string color = color_;
2179 ExceptionInfo exceptionInfo;
2180 GetExceptionInfo( &exceptionInfo );
2181 (void) QueryColorCompliance(std::string(color_).c_str(),AllCompliance,
2182 &target,&exceptionInfo);
2184 TransparentPaintImage ( image(), &target, TransparentAlpha, MagickFalse,
2186 throwException( exceptionInfo );
2187 (void) DestroyExceptionInfo( &exceptionInfo );
2190 // Add matte image to image, setting pixels matching color to transparent
2191 void Magick::Image::transparentChroma(const Color &colorLow_,
2192 const Color &colorHigh_)
2194 if ( !colorLow_.isValid() || !colorHigh_.isValid() )
2196 throwExceptionExplicit( OptionError,
2197 "Color argument is invalid" );
2200 std::string colorLow = colorLow_;
2201 std::string colorHigh = colorHigh_;
2203 PixelInfo targetLow;
2204 PixelInfo targetHigh;
2205 ExceptionInfo exceptionInfo;
2206 GetExceptionInfo( &exceptionInfo );
2207 (void) QueryColorCompliance(std::string(colorLow_).c_str(),
2208 AllCompliance,&targetLow,&exceptionInfo);
2209 (void) QueryColorCompliance(std::string(colorHigh_).c_str(),
2210 AllCompliance,&targetHigh,&exceptionInfo);
2212 TransparentPaintImageChroma ( image(), &targetLow, &targetHigh,
2213 TransparentAlpha, MagickFalse, &exceptionInfo );
2214 throwException( exceptionInfo );
2215 (void) DestroyExceptionInfo( &exceptionInfo );
2219 // Trim edges that are the background color from the image
2220 void Magick::Image::trim ( void )
2222 ExceptionInfo exceptionInfo;
2223 GetExceptionInfo( &exceptionInfo );
2224 MagickCore::Image* newImage =
2225 TrimImage( image(), &exceptionInfo);
2226 replaceImage( newImage );
2227 throwException( exceptionInfo );
2228 (void) DestroyExceptionInfo( &exceptionInfo );
2231 // Replace image with a sharpened version of the original image
2232 // using the unsharp mask algorithm.
2234 // the radius of the Gaussian, in pixels, not counting the
2237 // the standard deviation of the Gaussian, in pixels.
2239 // the percentage of the difference between the original and
2240 // the blur image that is added back into the original.
2242 // the threshold in pixels needed to apply the diffence amount.
2243 void Magick::Image::unsharpmask ( const double radius_,
2244 const double sigma_,
2245 const double amount_,
2246 const double threshold_ )
2248 ExceptionInfo exceptionInfo;
2249 GetExceptionInfo( &exceptionInfo );
2250 MagickCore::Image* newImage =
2251 UnsharpMaskImage( image(),
2257 replaceImage( newImage );
2258 throwException( exceptionInfo );
2259 (void) DestroyExceptionInfo( &exceptionInfo );
2262 void Magick::Image::unsharpmaskChannel ( const ChannelType channel_,
2263 const double radius_,
2264 const double sigma_,
2265 const double amount_,
2266 const double threshold_ )
2268 ExceptionInfo exceptionInfo;
2269 GetExceptionInfo( &exceptionInfo );
2270 ChannelType channel_mask = SetPixelChannelMask( image(), channel_ );
2271 MagickCore::Image* newImage =
2272 UnsharpMaskImage( image(),
2278 (void) SetPixelChannelMapMask( image(), channel_mask );
2279 replaceImage( newImage );
2280 throwException( exceptionInfo );
2281 (void) DestroyExceptionInfo( &exceptionInfo );
2284 // Map image pixels to a sine wave
2285 void Magick::Image::wave ( const double amplitude_, const double wavelength_ )
2287 ExceptionInfo exceptionInfo;
2288 GetExceptionInfo( &exceptionInfo );
2289 MagickCore::Image* newImage =
2293 image()->interpolate,
2295 replaceImage( newImage );
2296 throwException( exceptionInfo );
2297 (void) DestroyExceptionInfo( &exceptionInfo );
2300 // Write image to file
2301 void Magick::Image::write( const std::string &imageSpec_ )
2303 ExceptionInfo exceptionInfo;
2304 GetExceptionInfo( &exceptionInfo );
2306 fileName( imageSpec_ );
2307 WriteImage( imageInfo(), image(), &exceptionInfo );
2308 throwException( exceptionInfo );
2309 (void) DestroyExceptionInfo( &exceptionInfo );
2312 // Write image to in-memory BLOB
2313 void Magick::Image::write ( Blob *blob_ )
2316 size_t length = 2048; // Efficient size for small images
2317 ExceptionInfo exceptionInfo;
2318 GetExceptionInfo( &exceptionInfo );
2319 void* data = ImageToBlob( imageInfo(),
2323 throwException( exceptionInfo );
2324 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2325 throwImageException();
2326 (void) DestroyExceptionInfo( &exceptionInfo );
2328 void Magick::Image::write ( Blob *blob_,
2329 const std::string &magick_ )
2333 size_t length = 2048; // Efficient size for small images
2334 ExceptionInfo exceptionInfo;
2335 GetExceptionInfo( &exceptionInfo );
2336 void* data = ImageToBlob( imageInfo(),
2340 throwException( exceptionInfo );
2341 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2342 throwImageException();
2343 (void) DestroyExceptionInfo( &exceptionInfo );
2345 void Magick::Image::write ( Blob *blob_,
2346 const std::string &magick_,
2347 const size_t depth_ )
2352 size_t length = 2048; // Efficient size for small images
2353 ExceptionInfo exceptionInfo;
2354 GetExceptionInfo( &exceptionInfo );
2355 void* data = ImageToBlob( imageInfo(),
2359 throwException( exceptionInfo );
2360 blob_->updateNoCopy( data, length, Blob::MallocAllocator );
2361 throwImageException();
2362 (void) DestroyExceptionInfo( &exceptionInfo );
2365 // Write image to an array of pixels with storage type specified
2366 // by user (ExportImagePixels), e.g.
2367 // image.write( 0, 0, 640, 1, "RGB", 0, pixels );
2368 void Magick::Image::write ( const ssize_t x_,
2370 const size_t columns_,
2372 const std::string &map_,
2373 const StorageType type_,
2376 ExceptionInfo exceptionInfo;
2377 GetExceptionInfo( &exceptionInfo );
2378 ExportImagePixels( image(), x_, y_, columns_, rows_, map_.c_str(), type_,
2381 throwException( exceptionInfo );
2382 (void) DestroyExceptionInfo( &exceptionInfo );
2386 void Magick::Image::zoom( const Geometry &geometry_ )
2388 // Calculate new size. This code should be supported using binary arguments
2389 // in the ImageMagick library.
2392 size_t width = columns();
2393 size_t height = rows();
2395 ParseMetaGeometry (static_cast<std::string>(geometry_).c_str(),
2399 ExceptionInfo exceptionInfo;
2400 GetExceptionInfo( &exceptionInfo );
2401 MagickCore::Image* newImage =
2402 ResizeImage( image(),
2408 replaceImage( newImage );
2409 throwException( exceptionInfo );
2410 (void) DestroyExceptionInfo( &exceptionInfo );
2414 * Methods for setting image attributes
2418 // Join images into a single multi-image file
2419 void Magick::Image::adjoin ( const bool flag_ )
2422 options()->adjoin( flag_ );
2424 bool Magick::Image::adjoin ( void ) const
2426 return constOptions()->adjoin();
2429 // Remove pixel aliasing
2430 void Magick::Image::antiAlias( const bool flag_ )
2433 options()->antiAlias( static_cast<size_t>(flag_) );
2435 bool Magick::Image::antiAlias( void )
2437 return static_cast<bool>( options()->antiAlias( ) );
2440 // Animation inter-frame delay
2441 void Magick::Image::animationDelay ( const size_t delay_ )
2444 image()->delay = delay_;
2446 size_t Magick::Image::animationDelay ( void ) const
2448 return constImage()->delay;
2451 // Number of iterations to play animation
2452 void Magick::Image::animationIterations ( const size_t iterations_ )
2455 image()->iterations = iterations_;
2457 size_t Magick::Image::animationIterations ( void ) const
2459 return constImage()->iterations;
2462 // Access/Update a named image attribute
2463 void Magick::Image::attribute ( const std::string name_,
2464 const std::string value_ )
2467 ExceptionInfo exceptionInfo;
2468 GetExceptionInfo( &exceptionInfo );
2469 SetImageProperty( image(), name_.c_str(), value_.c_str(), &exceptionInfo );
2470 throwException( exceptionInfo );
2471 (void) DestroyExceptionInfo( &exceptionInfo );
2473 std::string Magick::Image::attribute ( const std::string name_ )
2475 ExceptionInfo exceptionInfo;
2476 GetExceptionInfo( &exceptionInfo );
2477 const char *value = GetImageProperty( constImage(), name_.c_str(),
2479 throwException( exceptionInfo );
2480 (void) DestroyExceptionInfo( &exceptionInfo );
2483 return std::string( value );
2485 return std::string(); // Intentionally no exception
2489 void Magick::Image::backgroundColor ( const Color &backgroundColor_ )
2493 if ( backgroundColor_.isValid() )
2495 image()->background_color = backgroundColor_;
2499 image()->background_color = Color();
2502 options()->backgroundColor( backgroundColor_ );
2504 Magick::Color Magick::Image::backgroundColor ( void ) const
2506 return constOptions()->backgroundColor( );
2509 // Background fill texture
2510 void Magick::Image::backgroundTexture ( const std::string &backgroundTexture_ )
2513 options()->backgroundTexture( backgroundTexture_ );
2515 std::string Magick::Image::backgroundTexture ( void ) const
2517 return constOptions()->backgroundTexture( );
2520 // Original image columns
2521 size_t Magick::Image::baseColumns ( void ) const
2523 return constImage()->magick_columns;
2526 // Original image name
2527 std::string Magick::Image::baseFilename ( void ) const
2529 return std::string(constImage()->magick_filename);
2532 // Original image rows
2533 size_t Magick::Image::baseRows ( void ) const
2535 return constImage()->magick_rows;
2539 void Magick::Image::borderColor ( const Color &borderColor_ )
2543 if ( borderColor_.isValid() )
2545 image()->border_color = borderColor_;
2549 image()->border_color = Color();
2552 options()->borderColor( borderColor_ );
2554 Magick::Color Magick::Image::borderColor ( void ) const
2556 return constOptions()->borderColor( );
2559 // Return smallest bounding box enclosing non-border pixels. The
2560 // current fuzz value is used when discriminating between pixels.
2561 // This is the crop bounding box used by crop(Geometry(0,0));
2562 Magick::Geometry Magick::Image::boundingBox ( void ) const
2564 ExceptionInfo exceptionInfo;
2565 GetExceptionInfo( &exceptionInfo );
2566 RectangleInfo bbox = GetImageBoundingBox( constImage(), &exceptionInfo);
2567 throwException( exceptionInfo );
2568 (void) DestroyExceptionInfo( &exceptionInfo );
2569 return Geometry( bbox );
2572 // Text bounding-box base color
2573 void Magick::Image::boxColor ( const Color &boxColor_ )
2576 options()->boxColor( boxColor_ );
2578 Magick::Color Magick::Image::boxColor ( void ) const
2580 return constOptions()->boxColor( );
2583 // Pixel cache threshold. Once this threshold is exceeded, all
2584 // subsequent pixels cache operations are to/from disk.
2585 // This setting is shared by all Image objects.
2587 void Magick::Image::cacheThreshold ( const size_t threshold_ )
2589 SetMagickResourceLimit( MemoryResource, threshold_ );
2592 void Magick::Image::chromaBluePrimary ( const double x_, const double y_ )
2595 image()->chromaticity.blue_primary.x = x_;
2596 image()->chromaticity.blue_primary.y = y_;
2598 void Magick::Image::chromaBluePrimary ( double *x_, double *y_ ) const
2600 *x_ = constImage()->chromaticity.blue_primary.x;
2601 *y_ = constImage()->chromaticity.blue_primary.y;
2604 void Magick::Image::chromaGreenPrimary ( const double x_, const double y_ )
2607 image()->chromaticity.green_primary.x = x_;
2608 image()->chromaticity.green_primary.y = y_;
2610 void Magick::Image::chromaGreenPrimary ( double *x_, double *y_ ) const
2612 *x_ = constImage()->chromaticity.green_primary.x;
2613 *y_ = constImage()->chromaticity.green_primary.y;
2616 void Magick::Image::chromaRedPrimary ( const double x_, const double y_ )
2619 image()->chromaticity.red_primary.x = x_;
2620 image()->chromaticity.red_primary.y = y_;
2622 void Magick::Image::chromaRedPrimary ( double *x_, double *y_ ) const
2624 *x_ = constImage()->chromaticity.red_primary.x;
2625 *y_ = constImage()->chromaticity.red_primary.y;
2628 void Magick::Image::chromaWhitePoint ( const double x_, const double y_ )
2631 image()->chromaticity.white_point.x = x_;
2632 image()->chromaticity.white_point.y = y_;
2634 void Magick::Image::chromaWhitePoint ( double *x_, double *y_ ) const
2636 *x_ = constImage()->chromaticity.white_point.x;
2637 *y_ = constImage()->chromaticity.white_point.y;
2640 // Set image storage class
2641 void Magick::Image::classType ( const ClassType class_ )
2643 if ( classType() == PseudoClass && class_ == DirectClass )
2645 // Use SyncImage to synchronize the DirectClass pixels with the
2646 // color map and then set to DirectClass type.
2648 ExceptionInfo exceptionInfo;
2649 GetExceptionInfo( &exceptionInfo );
2650 SyncImage( image(), &exceptionInfo );
2651 throwException( exceptionInfo );
2652 (void) DestroyExceptionInfo( &exceptionInfo );
2653 image()->colormap = (PixelInfo *)
2654 RelinquishMagickMemory( image()->colormap );
2655 image()->storage_class = static_cast<MagickCore::ClassType>(DirectClass);
2659 if ( classType() == DirectClass && class_ == PseudoClass )
2661 // Quantize to create PseudoClass color map
2663 quantizeColors(MaxColormapSize);
2665 image()->storage_class = static_cast<MagickCore::ClassType>(PseudoClass);
2669 // Associate a clip mask with the image. The clip mask must be the
2670 // same dimensions as the image. Pass an invalid image to unset an
2671 // existing clip mask.
2672 void Magick::Image::clipMask ( const Magick::Image & clipMask_ )
2676 ExceptionInfo exceptionInfo;
2677 GetExceptionInfo( &exceptionInfo );
2678 if( clipMask_.isValid() )
2681 SetImageClipMask( image(), clipMask_.constImage(), &exceptionInfo );
2685 // Unset existing clip mask
2686 SetImageClipMask( image(), 0, &exceptionInfo );
2688 throwException( exceptionInfo );
2689 (void) DestroyExceptionInfo( &exceptionInfo );
2691 Magick::Image Magick::Image::clipMask ( void ) const
2693 ExceptionInfo exceptionInfo;
2694 GetExceptionInfo( &exceptionInfo );
2695 MagickCore::Image* image =
2696 GetImageClipMask( constImage(), &exceptionInfo );
2697 throwException( exceptionInfo );
2698 (void) DestroyExceptionInfo( &exceptionInfo );
2699 return Magick::Image( image );
2702 void Magick::Image::colorFuzz ( const double fuzz_ )
2705 image()->fuzz = fuzz_;
2706 options()->colorFuzz( fuzz_ );
2708 double Magick::Image::colorFuzz ( void ) const
2710 return constOptions()->colorFuzz( );
2713 // Set color in colormap at index
2714 void Magick::Image::colorMap ( const size_t index_,
2715 const Color &color_ )
2717 MagickCore::Image* imageptr = image();
2719 if (index_ > (MaxColormapSize-1) )
2720 throwExceptionExplicit( OptionError,
2721 "Colormap index must be less than MaxColormapSize" );
2723 if ( !color_.isValid() )
2724 throwExceptionExplicit( OptionError,
2725 "Color argument is invalid");
2728 // Ensure that colormap size is large enough
2729 if ( colorMapSize() < (index_+1) )
2730 colorMapSize( index_ + 1 );
2732 // Set color at index in colormap
2733 (imageptr->colormap)[index_] = color_;
2735 // Return color in colormap at index
2736 Magick::Color Magick::Image::colorMap ( const size_t index_ ) const
2738 const MagickCore::Image* imageptr = constImage();
2740 if ( !imageptr->colormap )
2741 throwExceptionExplicit( OptionError,
2742 "Image does not contain a colormap");
2744 if ( index_ > imageptr->colors-1 )
2745 throwExceptionExplicit( OptionError,
2746 "Index out of range");
2748 return Magick::Color( (imageptr->colormap)[index_] );
2751 // Colormap size (number of colormap entries)
2752 void Magick::Image::colorMapSize ( const size_t entries_ )
2754 if (entries_ >MaxColormapSize )
2755 throwExceptionExplicit( OptionError,
2756 "Colormap entries must not exceed MaxColormapSize" );
2760 MagickCore::Image* imageptr = image();
2762 if( !imageptr->colormap )
2764 // Allocate colormap
2765 imageptr->colormap =
2766 static_cast<PixelInfo*>(AcquireMagickMemory(entries_*sizeof(PixelInfo)));
2767 imageptr->colors = 0;
2769 else if ( entries_ > imageptr->colors )
2771 // Re-allocate colormap
2772 imageptr->colormap=(PixelInfo *)
2773 ResizeMagickMemory(imageptr->colormap,(entries_)*sizeof(PixelInfo));
2776 // Initialize any new colormap entries as all black
2778 for( size_t i=imageptr->colors; i<(entries_-1); i++ )
2779 (imageptr->colormap)[i] = black;
2781 imageptr->colors = entries_;
2783 size_t Magick::Image::colorMapSize ( void )
2785 const MagickCore::Image* imageptr = constImage();
2787 if ( !imageptr->colormap )
2788 throwExceptionExplicit( OptionError,
2789 "Image does not contain a colormap");
2791 return imageptr->colors;
2795 void Magick::Image::colorSpace( const ColorspaceType colorSpace_ )
2798 if ( image()->colorspace == colorSpace_ )
2803 ExceptionInfo exceptionInfo;
2804 GetExceptionInfo( &exceptionInfo );
2805 if ( colorSpace_ != RGBColorspace &&
2806 colorSpace_ != sRGBColorspace &&
2807 colorSpace_ != TransparentColorspace &&
2808 colorSpace_ != GRAYColorspace )
2810 if (image()->colorspace != RGBColorspace &&
2811 image()->colorspace != sRGBColorspace &&
2812 image()->colorspace != TransparentColorspace &&
2813 image()->colorspace != GRAYColorspace)
2815 /* Transform to RGB colorspace as intermediate step */
2816 TransformRGBImage( image(), image()->colorspace, &exceptionInfo );
2817 throwImageException();
2819 /* Transform to final non-RGB colorspace */
2820 RGBTransformImage( image(), colorSpace_, &exceptionInfo );
2821 throwException( exceptionInfo );
2822 (void) DestroyExceptionInfo( &exceptionInfo );
2826 if ( colorSpace_ == RGBColorspace ||
2827 colorSpace_ == sRGBColorspace ||
2828 colorSpace_ == TransparentColorspace ||
2829 colorSpace_ == GRAYColorspace )
2831 /* Transform to a RGB-type colorspace */
2832 TransformRGBImage( image(), image()->colorspace, &exceptionInfo );
2833 throwException( exceptionInfo );
2834 (void) DestroyExceptionInfo( &exceptionInfo );
2837 throwException( exceptionInfo );
2838 (void) DestroyExceptionInfo( &exceptionInfo );
2840 Magick::ColorspaceType Magick::Image::colorSpace ( void ) const
2842 return constImage()->colorspace;
2845 // Set image colorspace type.
2846 void Magick::Image::colorspaceType( const ColorspaceType colorSpace_ )
2849 options()->colorspaceType( colorSpace_ );
2851 Magick::ColorspaceType Magick::Image::colorspaceType ( void ) const
2853 return constOptions()->colorspaceType();
2858 void Magick::Image::comment ( const std::string &comment_ )
2861 ExceptionInfo exceptionInfo;
2862 GetExceptionInfo( &exceptionInfo );
2863 SetImageProperty( image(), "Comment", NULL, &exceptionInfo );
2864 if ( comment_.length() > 0 )
2865 SetImageProperty( image(), "Comment", comment_.c_str(), &exceptionInfo );
2866 throwException( exceptionInfo );
2867 (void) DestroyExceptionInfo( &exceptionInfo );
2869 std::string Magick::Image::comment ( void ) const
2871 ExceptionInfo exceptionInfo;
2872 GetExceptionInfo( &exceptionInfo );
2873 const char *value = GetImageProperty( constImage(), "Comment",
2875 throwException( exceptionInfo );
2876 (void) DestroyExceptionInfo( &exceptionInfo );
2879 return std::string( value );
2881 return std::string(); // Intentionally no exception
2884 // Composition operator to be used when composition is implicitly used
2885 // (such as for image flattening).
2886 void Magick::Image::compose (const CompositeOperator compose_)
2888 image()->compose=compose_;
2891 Magick::CompositeOperator Magick::Image::compose ( void ) const
2893 return constImage()->compose;
2896 // Compression algorithm
2897 void Magick::Image::compressType ( const CompressionType compressType_ )
2900 image()->compression = compressType_;
2901 options()->compressType( compressType_ );
2903 Magick::CompressionType Magick::Image::compressType ( void ) const
2905 return constImage()->compression;
2908 // Enable printing of debug messages from ImageMagick
2909 void Magick::Image::debug ( const bool flag_ )
2912 options()->debug( flag_ );
2914 bool Magick::Image::debug ( void ) const
2916 return constOptions()->debug();
2919 // Tagged image format define (set/access coder-specific option) The
2920 // magick_ option specifies the coder the define applies to. The key_
2921 // option provides the key specific to that coder. The value_ option
2922 // provides the value to set (if any). See the defineSet() method if the
2923 // key must be removed entirely.
2924 void Magick::Image::defineValue ( const std::string &magick_,
2925 const std::string &key_,
2926 const std::string &value_ )
2929 std::string format = magick_ + ":" + key_;
2930 std::string option = value_;
2931 (void) SetImageOption ( imageInfo(), format.c_str(), option.c_str() );
2933 std::string Magick::Image::defineValue ( const std::string &magick_,
2934 const std::string &key_ ) const
2936 std::string definition = magick_ + ":" + key_;
2937 const char *option =
2938 GetImageOption ( constImageInfo(), definition.c_str() );
2940 return std::string( option );
2941 return std::string( );
2944 // Tagged image format define. Similar to the defineValue() method
2945 // except that passing the flag_ value 'true' creates a value-less
2946 // define with that format and key. Passing the flag_ value 'false'
2947 // removes any existing matching definition. The method returns 'true'
2948 // if a matching key exists, and 'false' if no matching key exists.
2949 void Magick::Image::defineSet ( const std::string &magick_,
2950 const std::string &key_,
2954 std::string definition = magick_ + ":" + key_;
2957 (void) SetImageOption ( imageInfo(), definition.c_str(), "" );
2961 DeleteImageOption( imageInfo(), definition.c_str() );
2964 bool Magick::Image::defineSet ( const std::string &magick_,
2965 const std::string &key_ ) const
2967 std::string key = magick_ + ":" + key_;
2968 const char *option =
2969 GetImageOption ( constImageInfo(), key.c_str() );
2976 void Magick::Image::density ( const Geometry &density_ )
2979 options()->density( density_ );
2980 if ( density_.isValid() )
2982 image()->resolution.x = density_.width();
2983 if ( density_.height() != 0 )
2985 image()->resolution.y = density_.height();
2989 image()->resolution.y = density_.width();
2995 image()->resolution.x = 0;
2996 image()->resolution.y = 0;
2999 Magick::Geometry Magick::Image::density ( void ) const
3003 ssize_t x_resolution=72;
3004 ssize_t y_resolution=72;
3006 if (constImage()->resolution.x > 0.0)
3007 x_resolution=static_cast<ssize_t>(constImage()->resolution.x + 0.5);
3009 if (constImage()->resolution.y > 0.0)
3010 y_resolution=static_cast<ssize_t>(constImage()->resolution.y + 0.5);
3012 return Geometry(x_resolution,y_resolution);
3015 return constOptions()->density( );
3018 // Image depth (bits allocated to red/green/blue components)
3019 void Magick::Image::depth ( const size_t depth_ )
3021 size_t depth = depth_;
3023 if (depth > MAGICKCORE_QUANTUM_DEPTH)
3024 depth=MAGICKCORE_QUANTUM_DEPTH;
3027 image()->depth=depth;
3028 options()->depth( depth );
3030 size_t Magick::Image::depth ( void ) const
3032 return constImage()->depth;
3035 std::string Magick::Image::directory ( void ) const
3037 if ( constImage()->directory )
3038 return std::string( constImage()->directory );
3040 throwExceptionExplicit( CorruptImageWarning,
3041 "Image does not contain a directory");
3043 return std::string();
3046 // Endianness (little like Intel or big like SPARC) for image
3047 // formats which support endian-specific options.
3048 void Magick::Image::endian ( const Magick::EndianType endian_ )
3051 options()->endian( endian_ );
3052 image()->endian = endian_;
3054 Magick::EndianType Magick::Image::endian ( void ) const
3056 return constImage()->endian;
3059 // EXIF profile (BLOB)
3060 void Magick::Image::exifProfile( const Magick::Blob &exifProfile_ )
3063 if ( exifProfile_.data() != 0 )
3065 StringInfo * exif_profile = AcquireStringInfo( exifProfile_.length() );
3066 SetStringInfoDatum(exif_profile ,(unsigned char *) exifProfile_.data());
3067 ExceptionInfo exceptionInfo;
3068 GetExceptionInfo( &exceptionInfo );
3069 (void) SetImageProfile( image(), "exif", exif_profile, &exceptionInfo);
3070 exif_profile =DestroyStringInfo( exif_profile );
3071 throwException( exceptionInfo );
3072 (void) DestroyExceptionInfo( &exceptionInfo );
3075 Magick::Blob Magick::Image::exifProfile( void ) const
3077 const StringInfo * exif_profile = GetImageProfile( constImage(), "exif" );
3078 if ( exif_profile == (StringInfo *) NULL)
3079 return Blob( 0, 0 );
3080 return Blob(GetStringInfoDatum(exif_profile),GetStringInfoLength(exif_profile));
3084 void Magick::Image::fileName ( const std::string &fileName_ )
3088 fileName_.copy( image()->filename,
3089 sizeof(image()->filename) - 1 );
3090 image()->filename[ fileName_.length() ] = 0; // Null terminate
3092 options()->fileName( fileName_ );
3095 std::string Magick::Image::fileName ( void ) const
3097 return constOptions()->fileName( );
3101 off_t Magick::Image::fileSize ( void ) const
3103 return (off_t) GetBlobSize( constImage() );
3106 // Color to use when drawing inside an object
3107 void Magick::Image::fillColor ( const Magick::Color &fillColor_ )
3110 options()->fillColor(fillColor_);
3112 Magick::Color Magick::Image::fillColor ( void ) const
3114 return constOptions()->fillColor();
3117 // Rule to use when filling drawn objects
3118 void Magick::Image::fillRule ( const Magick::FillRule &fillRule_ )
3121 options()->fillRule(fillRule_);
3123 Magick::FillRule Magick::Image::fillRule ( void ) const
3125 return constOptions()->fillRule();
3128 // Pattern to use while filling drawn objects.
3129 void Magick::Image::fillPattern ( const Image &fillPattern_ )
3132 if(fillPattern_.isValid())
3133 options()->fillPattern( fillPattern_.constImage() );
3135 options()->fillPattern( static_cast<MagickCore::Image*>(NULL) );
3137 Magick::Image Magick::Image::fillPattern ( void ) const
3139 // FIXME: This is inordinately innefficient
3142 const MagickCore::Image* tmpTexture = constOptions()->fillPattern( );
3146 ExceptionInfo exceptionInfo;
3147 GetExceptionInfo( &exceptionInfo );
3148 MagickCore::Image* image =
3149 CloneImage( tmpTexture,
3152 MagickTrue, // orphan
3154 texture.replaceImage( image );
3155 throwException( exceptionInfo );
3156 (void) DestroyExceptionInfo( &exceptionInfo );
3161 // Filter used by zoom
3162 void Magick::Image::filterType ( const Magick::FilterTypes filterType_ )
3165 image()->filter = filterType_;
3167 Magick::FilterTypes Magick::Image::filterType ( void ) const
3169 return constImage()->filter;
3173 void Magick::Image::font ( const std::string &font_ )
3176 options()->font( font_ );
3178 std::string Magick::Image::font ( void ) const
3180 return constOptions()->font( );
3184 void Magick::Image::fontPointsize ( const double pointSize_ )
3187 options()->fontPointsize( pointSize_ );
3189 double Magick::Image::fontPointsize ( void ) const
3191 return constOptions()->fontPointsize( );
3194 // Font type metrics
3195 void Magick::Image::fontTypeMetrics( const std::string &text_,
3196 TypeMetric *metrics )
3198 DrawInfo *drawInfo = options()->drawInfo();
3199 drawInfo->text = const_cast<char *>(text_.c_str());
3200 ExceptionInfo exceptionInfo;
3201 GetExceptionInfo( &exceptionInfo );
3202 GetTypeMetrics( image(), drawInfo, &(metrics->_typeMetric), &exceptionInfo );
3204 throwException( exceptionInfo );
3205 (void) DestroyExceptionInfo( &exceptionInfo );
3208 // Image format string
3209 std::string Magick::Image::format ( void ) const
3211 ExceptionInfo exceptionInfo;
3212 GetExceptionInfo( &exceptionInfo );
3213 const MagickInfo * magick_info
3214 = GetMagickInfo( constImage()->magick, &exceptionInfo);
3215 throwException( exceptionInfo );
3216 (void) DestroyExceptionInfo( &exceptionInfo );
3218 if (( magick_info != 0 ) &&
3219 ( *magick_info->description != '\0' ))
3220 return std::string(magick_info->description);
3222 throwExceptionExplicit( CorruptImageWarning,
3223 "Unrecognized image magick type" );
3224 return std::string();
3228 double Magick::Image::gamma ( void ) const
3230 return constImage()->gamma;
3233 Magick::Geometry Magick::Image::geometry ( void ) const
3235 if ( constImage()->geometry )
3237 return Geometry(constImage()->geometry);
3240 throwExceptionExplicit( OptionWarning,
3241 "Image does not contain a geometry");
3246 void Magick::Image::gifDisposeMethod ( const size_t disposeMethod_ )
3249 image()->dispose = (DisposeType) disposeMethod_;
3251 size_t Magick::Image::gifDisposeMethod ( void ) const
3253 // FIXME: It would be better to return an enumeration
3254 return constImage()->dispose;
3257 // ICC ICM color profile (BLOB)
3258 void Magick::Image::iccColorProfile( const Magick::Blob &colorProfile_ )
3260 profile("icm",colorProfile_);
3262 Magick::Blob Magick::Image::iccColorProfile( void ) const
3264 const StringInfo * color_profile = GetImageProfile( constImage(), "icc" );
3265 if ( color_profile == (StringInfo *) NULL)
3266 return Blob( 0, 0 );
3267 return Blob( GetStringInfoDatum(color_profile), GetStringInfoLength(color_profile) );
3270 void Magick::Image::interlaceType ( const Magick::InterlaceType interlace_ )
3273 image()->interlace = interlace_;
3274 options()->interlaceType ( interlace_ );
3276 Magick::InterlaceType Magick::Image::interlaceType ( void ) const
3278 return constImage()->interlace;
3281 // IPTC profile (BLOB)
3282 void Magick::Image::iptcProfile( const Magick::Blob &iptcProfile_ )
3285 if ( iptcProfile_.data() != 0 )
3287 StringInfo * iptc_profile = AcquireStringInfo( iptcProfile_.length() );
3288 SetStringInfoDatum(iptc_profile ,(unsigned char *) iptcProfile_.data());
3289 ExceptionInfo exceptionInfo;
3290 GetExceptionInfo( &exceptionInfo );
3291 (void) SetImageProfile( image(), "iptc", iptc_profile, &exceptionInfo);
3292 iptc_profile =DestroyStringInfo( iptc_profile );
3293 throwException( exceptionInfo );
3294 (void) DestroyExceptionInfo( &exceptionInfo );
3297 Magick::Blob Magick::Image::iptcProfile( void ) const
3299 const StringInfo * iptc_profile = GetImageProfile( constImage(), "iptc" );
3300 if ( iptc_profile == (StringInfo *) NULL)
3301 return Blob( 0, 0 );
3302 return Blob( GetStringInfoDatum(iptc_profile), GetStringInfoLength(iptc_profile));
3305 // Does object contain valid image?
3306 void Magick::Image::isValid ( const bool isValid_ )
3311 _imgRef = new ImageRef;
3313 else if ( !isValid() )
3315 // Construct with single-pixel black image to make
3316 // image valid. This is an obvious hack.
3317 size( Geometry(1,1) );
3318 read( "xc:#000000" );
3322 bool Magick::Image::isValid ( void ) const
3324 if ( rows() && columns() )
3331 void Magick::Image::label ( const std::string &label_ )
3334 ExceptionInfo exceptionInfo;
3335 GetExceptionInfo( &exceptionInfo );
3336 SetImageProperty ( image(), "Label", NULL, &exceptionInfo );
3337 if ( label_.length() > 0 )
3338 SetImageProperty ( image(), "Label", label_.c_str(), &exceptionInfo );
3339 throwException( exceptionInfo );
3340 (void) DestroyExceptionInfo( &exceptionInfo );
3342 std::string Magick::Image::label ( void ) const
3344 ExceptionInfo exceptionInfo;
3345 GetExceptionInfo( &exceptionInfo );
3346 const char *value = GetImageProperty( constImage(), "Label", &exceptionInfo );
3347 throwException( exceptionInfo );
3348 (void) DestroyExceptionInfo( &exceptionInfo );
3351 return std::string( value );
3353 return std::string();
3356 void Magick::Image::magick ( const std::string &magick_ )
3360 magick_.copy( image()->magick,
3361 sizeof(image()->magick) - 1 );
3362 image()->magick[ magick_.length() ] = 0;
3364 options()->magick( magick_ );
3366 std::string Magick::Image::magick ( void ) const
3368 if ( *(constImage()->magick) != '\0' )
3369 return std::string(constImage()->magick);
3371 return constOptions()->magick( );
3374 void Magick::Image::matte ( const bool matteFlag_ )
3378 // If matte channel is requested, but image doesn't already have a
3379 // matte channel, then create an opaque matte channel. Likewise, if
3380 // the image already has a matte channel but a matte channel is not
3381 // desired, then set the matte channel to opaque.
3382 ExceptionInfo exceptionInfo;
3383 GetExceptionInfo( &exceptionInfo );
3384 if ((matteFlag_ && !constImage()->matte) ||
3385 (constImage()->matte && !matteFlag_))
3386 SetImageAlpha(image(),OpaqueAlpha,&exceptionInfo);
3387 throwException( exceptionInfo );
3388 (void) DestroyExceptionInfo( &exceptionInfo );
3390 image()->matte = (MagickBooleanType) matteFlag_;
3392 bool Magick::Image::matte ( void ) const
3394 if ( constImage()->matte )
3400 void Magick::Image::matteColor ( const Color &matteColor_ )
3404 if ( matteColor_.isValid() )
3406 image()->matte_color = matteColor_;
3407 options()->matteColor( matteColor_ );
3411 // Set to default matte color
3412 Color tmpColor( "#BDBDBD" );
3413 image()->matte_color = tmpColor;
3414 options()->matteColor( tmpColor );
3417 Magick::Color Magick::Image::matteColor ( void ) const
3419 return Color( constImage()->matte_color.red,
3420 constImage()->matte_color.green,
3421 constImage()->matte_color.blue );
3424 double Magick::Image::meanErrorPerPixel ( void ) const
3426 return(constImage()->error.mean_error_per_pixel);
3429 // Image modulus depth (minimum number of bits required to support
3430 // red/green/blue components without loss of accuracy)
3431 void Magick::Image::modulusDepth ( const size_t depth_ )
3434 ExceptionInfo exceptionInfo;
3435 GetExceptionInfo( &exceptionInfo );
3436 SetImageDepth( image(), depth_, &exceptionInfo );
3437 throwException( exceptionInfo );
3438 (void) DestroyExceptionInfo( &exceptionInfo );
3439 options()->depth( depth_ );
3441 size_t Magick::Image::modulusDepth ( void ) const
3443 ExceptionInfo exceptionInfo;
3444 GetExceptionInfo( &exceptionInfo );
3445 size_t depth=GetImageDepth( constImage(), &exceptionInfo );
3446 throwException( exceptionInfo );
3447 (void) DestroyExceptionInfo( &exceptionInfo );
3451 void Magick::Image::monochrome ( const bool monochromeFlag_ )
3454 options()->monochrome( monochromeFlag_ );
3456 bool Magick::Image::monochrome ( void ) const
3458 return constOptions()->monochrome( );
3461 Magick::Geometry Magick::Image::montageGeometry ( void ) const
3463 if ( constImage()->montage )
3464 return Magick::Geometry(constImage()->montage);
3466 throwExceptionExplicit( CorruptImageWarning,
3467 "Image does not contain a montage" );
3469 return Magick::Geometry();
3472 double Magick::Image::normalizedMaxError ( void ) const
3474 return(constImage()->error.normalized_maximum_error);
3477 double Magick::Image::normalizedMeanError ( void ) const
3479 return constImage()->error.normalized_mean_error;
3482 // Image orientation
3483 void Magick::Image::orientation ( const Magick::OrientationType orientation_ )
3486 image()->orientation = orientation_;
3488 Magick::OrientationType Magick::Image::orientation ( void ) const
3490 return constImage()->orientation;
3493 void Magick::Image::penColor ( const Color &penColor_ )
3496 options()->fillColor(penColor_);
3497 options()->strokeColor(penColor_);
3499 Magick::Color Magick::Image::penColor ( void ) const
3501 return constOptions()->fillColor();
3504 void Magick::Image::penTexture ( const Image &penTexture_ )
3507 if(penTexture_.isValid())
3508 options()->fillPattern( penTexture_.constImage() );
3510 options()->fillPattern( static_cast<MagickCore::Image*>(NULL) );
3513 Magick::Image Magick::Image::penTexture ( void ) const
3515 // FIXME: This is inordinately innefficient
3518 const MagickCore::Image* tmpTexture = constOptions()->fillPattern( );
3522 ExceptionInfo exceptionInfo;
3523 GetExceptionInfo( &exceptionInfo );
3524 MagickCore::Image* image =
3525 CloneImage( tmpTexture,
3528 MagickTrue, // orphan
3530 texture.replaceImage( image );
3531 throwException( exceptionInfo );
3532 (void) DestroyExceptionInfo( &exceptionInfo );
3537 // Set the color of a pixel.
3538 void Magick::Image::pixelColor ( const ssize_t x_, const ssize_t y_,
3539 const Color &color_ )
3541 // Test arguments to ensure they are within the image.
3542 if ( y_ > (ssize_t) rows() || x_ > (ssize_t) columns() )
3543 throwExceptionExplicit( OptionError,
3544 "Access outside of image boundary" );
3548 // Set image to DirectClass
3549 classType( DirectClass );
3552 Pixels pixels(*this);
3554 Quantum *pixel = pixels.get(x_, y_, 1, 1 );
3555 PixelInfo packet = color_;
3556 MagickCore::SetPixelInfoPixel(constImage(),&packet,pixel);
3557 // Tell ImageMagick that pixels have been updated
3563 // Get the color of a pixel
3564 Magick::Color Magick::Image::pixelColor ( const ssize_t x_,
3565 const ssize_t y_ ) const
3567 ClassType storage_class;
3568 storage_class = classType();
3570 const Quantum* pixel = getConstPixels( x_, y_, 1, 1 );
3574 MagickCore::GetPixelInfoPixel(constImage(),pixel,&packet);
3575 return Color( packet );
3578 return Color(); // invalid
3581 // Preferred size and location of an image canvas.
3582 void Magick::Image::page ( const Magick::Geometry &pageSize_ )
3585 options()->page( pageSize_ );
3586 image()->page = pageSize_;
3588 Magick::Geometry Magick::Image::page ( void ) const
3590 return Geometry( constImage()->page.width,
3591 constImage()->page.height,
3592 AbsoluteValue(constImage()->page.x),
3593 AbsoluteValue(constImage()->page.y),
3594 constImage()->page.x < 0 ? true : false,
3595 constImage()->page.y < 0 ? true : false);
3598 // Add a named profile to an image or remove a named profile by
3599 // passing an empty Blob (use default Blob constructor).
3601 // "*", "8BIM", "ICM", "IPTC", or a generic profile name.
3602 void Magick::Image::profile( const std::string name_,
3603 const Magick::Blob &profile_ )
3606 ExceptionInfo exceptionInfo;
3607 GetExceptionInfo( &exceptionInfo );
3608 ssize_t result = ProfileImage( image(), name_.c_str(),
3609 (unsigned char *)profile_.data(),
3610 profile_.length(), &exceptionInfo);
3611 throwException( exceptionInfo );
3612 (void) DestroyExceptionInfo( &exceptionInfo );
3616 // Retrieve a named profile from the image.
3618 // "8BIM", "8BIMTEXT", "APP1", "APP1JPEG", "ICC", "ICM", & "IPTC" or
3619 // an existing generic profile name.
3620 Magick::Blob Magick::Image::profile( const std::string name_ ) const
3622 const MagickCore::Image* image = constImage();
3624 const StringInfo * profile = GetImageProfile( image, name_.c_str() );
3626 if ( profile != (StringInfo *) NULL)
3627 return Blob( (void*) GetStringInfoDatum(profile), GetStringInfoLength(profile));
3630 Image temp_image = *this;
3631 temp_image.write( &blob, name_ );
3635 void Magick::Image::quality ( const size_t quality_ )
3638 image()->quality = quality_;
3639 options()->quality( quality_ );
3641 size_t Magick::Image::quality ( void ) const
3643 return constImage()->quality;
3646 void Magick::Image::quantizeColors ( const size_t colors_ )
3649 options()->quantizeColors( colors_ );
3651 size_t Magick::Image::quantizeColors ( void ) const
3653 return constOptions()->quantizeColors( );
3656 void Magick::Image::quantizeColorSpace
3657 ( const Magick::ColorspaceType colorSpace_ )
3660 options()->quantizeColorSpace( colorSpace_ );
3662 Magick::ColorspaceType Magick::Image::quantizeColorSpace ( void ) const
3664 return constOptions()->quantizeColorSpace( );
3667 void Magick::Image::quantizeDither ( const bool ditherFlag_ )
3670 options()->quantizeDither( ditherFlag_ );
3672 bool Magick::Image::quantizeDither ( void ) const
3674 return constOptions()->quantizeDither( );
3677 void Magick::Image::quantizeTreeDepth ( const size_t treeDepth_ )
3680 options()->quantizeTreeDepth( treeDepth_ );
3682 size_t Magick::Image::quantizeTreeDepth ( void ) const
3684 return constOptions()->quantizeTreeDepth( );
3687 void Magick::Image::renderingIntent
3688 ( const Magick::RenderingIntent renderingIntent_ )
3691 image()->rendering_intent = renderingIntent_;
3693 Magick::RenderingIntent Magick::Image::renderingIntent ( void ) const
3695 return static_cast<Magick::RenderingIntent>(constImage()->rendering_intent);
3698 void Magick::Image::resolutionUnits
3699 ( const Magick::ResolutionType resolutionUnits_ )
3702 image()->units = resolutionUnits_;
3703 options()->resolutionUnits( resolutionUnits_ );
3705 Magick::ResolutionType Magick::Image::resolutionUnits ( void ) const
3707 return constOptions()->resolutionUnits( );
3710 void Magick::Image::scene ( const size_t scene_ )
3713 image()->scene = scene_;
3715 size_t Magick::Image::scene ( void ) const
3717 return constImage()->scene;
3720 std::string Magick::Image::signature ( const bool force_ ) const
3722 Lock( &_imgRef->_mutexLock );
3724 // Re-calculate image signature if necessary
3725 ExceptionInfo exceptionInfo;
3726 GetExceptionInfo( &exceptionInfo );
3728 !GetImageProperty(constImage(), "Signature", &exceptionInfo) ||
3729 constImage()->taint )
3731 SignatureImage( const_cast<MagickCore::Image *>(constImage()), &exceptionInfo );
3734 const char *property = GetImageProperty(constImage(), "Signature",
3736 throwException( exceptionInfo );
3737 (void) DestroyExceptionInfo( &exceptionInfo );
3739 return std::string( property );
3742 void Magick::Image::size ( const Geometry &geometry_ )
3745 options()->size( geometry_ );
3746 image()->rows = geometry_.height();
3747 image()->columns = geometry_.width();
3749 Magick::Geometry Magick::Image::size ( void ) const
3751 return Magick::Geometry( constImage()->columns, constImage()->rows );
3755 void Magick::Image::splice( const Geometry &geometry_ )
3757 RectangleInfo spliceInfo = geometry_;
3758 ExceptionInfo exceptionInfo;
3759 GetExceptionInfo( &exceptionInfo );
3760 MagickCore::Image* newImage =
3761 SpliceImage( image(), &spliceInfo, &exceptionInfo);
3762 replaceImage( newImage );
3763 throwException( exceptionInfo );
3764 (void) DestroyExceptionInfo( &exceptionInfo );
3767 // Obtain image statistics. Statistics are normalized to the range of
3768 // 0.0 to 1.0 and are output to the specified ImageStatistics
3770 void Magick::Image::statistics ( ImageStatistics *statistics )
3776 ExceptionInfo exceptionInfo;
3777 GetExceptionInfo( &exceptionInfo );
3779 ChannelType channel_mask = SetPixelChannelMask( image(), RedChannel);
3780 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3781 statistics->red.minimum=minimum;
3782 statistics->red.maximum=maximum;
3783 (void) GetImageMean( image(),&statistics->red.mean,
3784 &statistics->red.standard_deviation,&exceptionInfo);
3785 (void) GetImageKurtosis( image(),&statistics->red.kurtosis,
3786 &statistics->red.skewness,&exceptionInfo);
3787 (void) SetPixelChannelMapMask( image(), channel_mask );
3789 channel_mask = SetPixelChannelMask( image(), GreenChannel);
3790 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3791 statistics->green.minimum=minimum;
3792 statistics->green.maximum=maximum;
3793 (void) GetImageMean( image(),&statistics->green.mean,
3794 &statistics->green.standard_deviation,&exceptionInfo);
3795 (void) GetImageKurtosis( image(),&statistics->green.kurtosis,
3796 &statistics->green.skewness,&exceptionInfo);
3797 (void) SetPixelChannelMapMask( image(), channel_mask );
3799 channel_mask = SetPixelChannelMask( image(), GreenChannel);
3800 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3801 statistics->blue.minimum=minimum;
3802 statistics->blue.maximum=maximum;
3803 (void) GetImageMean( image(),&statistics->blue.mean,
3804 &statistics->blue.standard_deviation,&exceptionInfo);
3805 (void) GetImageKurtosis( image(),&statistics->blue.kurtosis,
3806 &statistics->blue.skewness,&exceptionInfo);
3807 (void) SetPixelChannelMapMask( image(), channel_mask );
3809 channel_mask = SetPixelChannelMask( image(), AlphaChannel);
3810 (void) GetImageRange( image(),&minimum,&maximum,&exceptionInfo);
3811 statistics->alpha.minimum=minimum;
3812 statistics->alpha.maximum=maximum;
3813 (void) GetImageMean( image(),&statistics->alpha.mean,
3814 &statistics->alpha.standard_deviation,&exceptionInfo);
3815 (void) GetImageKurtosis( image(),&statistics->alpha.kurtosis,
3816 &statistics->alpha.skewness,&exceptionInfo);
3817 (void) SetPixelChannelMapMask( image(), channel_mask );
3819 throwException( exceptionInfo );
3820 (void) DestroyExceptionInfo( &exceptionInfo );
3823 // Strip strips an image of all profiles and comments.
3824 void Magick::Image::strip ( void )
3827 ExceptionInfo exceptionInfo;
3828 GetExceptionInfo( &exceptionInfo );
3829 StripImage( image(), &exceptionInfo );
3830 throwException( exceptionInfo );
3831 (void) DestroyExceptionInfo( &exceptionInfo );
3834 // enabled/disable stroke anti-aliasing
3835 void Magick::Image::strokeAntiAlias ( const bool flag_ )
3838 options()->strokeAntiAlias(flag_);
3840 bool Magick::Image::strokeAntiAlias ( void ) const
3842 return constOptions()->strokeAntiAlias();
3845 // Color to use when drawing object outlines
3846 void Magick::Image::strokeColor ( const Magick::Color &strokeColor_ )
3849 options()->strokeColor(strokeColor_);
3851 Magick::Color Magick::Image::strokeColor ( void ) const
3853 return constOptions()->strokeColor();
3856 // dash pattern for drawing vector objects (default one)
3857 void Magick::Image::strokeDashArray ( const double* strokeDashArray_ )
3860 options()->strokeDashArray( strokeDashArray_ );
3863 const double* Magick::Image::strokeDashArray ( void ) const
3865 return constOptions()->strokeDashArray( );
3868 // dash offset for drawing vector objects (default one)
3869 void Magick::Image::strokeDashOffset ( const double strokeDashOffset_ )
3872 options()->strokeDashOffset( strokeDashOffset_ );
3875 double Magick::Image::strokeDashOffset ( void ) const
3877 return constOptions()->strokeDashOffset( );
3880 // Specify the shape to be used at the end of open subpaths when they
3881 // are stroked. Values of LineCap are UndefinedCap, ButtCap, RoundCap,
3883 void Magick::Image::strokeLineCap ( const Magick::LineCap lineCap_ )
3886 options()->strokeLineCap( lineCap_ );
3888 Magick::LineCap Magick::Image::strokeLineCap ( void ) const
3890 return constOptions()->strokeLineCap( );
3893 // Specify the shape to be used at the corners of paths (or other
3894 // vector shapes) when they are stroked. Values of LineJoin are
3895 // UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.
3896 void Magick::Image::strokeLineJoin ( const Magick::LineJoin lineJoin_ )
3899 options()->strokeLineJoin( lineJoin_ );
3901 Magick::LineJoin Magick::Image::strokeLineJoin ( void ) const
3903 return constOptions()->strokeLineJoin( );
3906 // Specify miter limit. When two line segments meet at a sharp angle
3907 // and miter joins have been specified for 'lineJoin', it is possible
3908 // for the miter to extend far beyond the thickness of the line
3909 // stroking the path. The miterLimit' imposes a limit on the ratio of
3910 // the miter length to the 'lineWidth'. The default value of this
3912 void Magick::Image::strokeMiterLimit ( const size_t strokeMiterLimit_ )
3915 options()->strokeMiterLimit( strokeMiterLimit_ );
3917 size_t Magick::Image::strokeMiterLimit ( void ) const
3919 return constOptions()->strokeMiterLimit( );
3922 // Pattern to use while stroking drawn objects.
3923 void Magick::Image::strokePattern ( const Image &strokePattern_ )
3926 if(strokePattern_.isValid())
3927 options()->strokePattern( strokePattern_.constImage() );
3929 options()->strokePattern( static_cast<MagickCore::Image*>(NULL) );
3931 Magick::Image Magick::Image::strokePattern ( void ) const
3933 // FIXME: This is inordinately innefficient
3936 const MagickCore::Image* tmpTexture = constOptions()->strokePattern( );
3940 ExceptionInfo exceptionInfo;
3941 GetExceptionInfo( &exceptionInfo );
3942 MagickCore::Image* image =
3943 CloneImage( tmpTexture,
3946 MagickTrue, // orphan
3948 throwException( exceptionInfo );
3949 (void) DestroyExceptionInfo( &exceptionInfo );
3950 texture.replaceImage( image );
3955 // Stroke width for drawing lines, circles, ellipses, etc.
3956 void Magick::Image::strokeWidth ( const double strokeWidth_ )
3959 options()->strokeWidth( strokeWidth_ );
3961 double Magick::Image::strokeWidth ( void ) const
3963 return constOptions()->strokeWidth( );
3966 void Magick::Image::subImage ( const size_t subImage_ )
3969 options()->subImage( subImage_ );
3971 size_t Magick::Image::subImage ( void ) const
3973 return constOptions()->subImage( );
3976 void Magick::Image::subRange ( const size_t subRange_ )
3979 options()->subRange( subRange_ );
3981 size_t Magick::Image::subRange ( void ) const
3983 return constOptions()->subRange( );
3986 // Annotation text encoding (e.g. "UTF-16")
3987 void Magick::Image::textEncoding ( const std::string &encoding_ )
3990 options()->textEncoding( encoding_ );
3992 std::string Magick::Image::textEncoding ( void ) const
3994 return constOptions()->textEncoding( );
3997 size_t Magick::Image::totalColors ( void )
3999 ExceptionInfo exceptionInfo;
4000 GetExceptionInfo( &exceptionInfo );
4001 size_t colors = GetNumberColors( image(), 0, &exceptionInfo);
4002 throwException( exceptionInfo );
4003 (void) DestroyExceptionInfo( &exceptionInfo );
4007 // Origin of coordinate system to use when annotating with text or drawing
4008 void Magick::Image::transformOrigin ( const double x_, const double y_ )
4011 options()->transformOrigin( x_, y_ );
4014 // Rotation to use when annotating with text or drawing
4015 void Magick::Image::transformRotation ( const double angle_ )
4018 options()->transformRotation( angle_ );
4021 // Reset transformation parameters to default
4022 void Magick::Image::transformReset ( void )
4025 options()->transformReset();
4028 // Scale to use when annotating with text or drawing
4029 void Magick::Image::transformScale ( const double sx_, const double sy_ )
4032 options()->transformScale( sx_, sy_ );
4035 // Skew to use in X axis when annotating with text or drawing
4036 void Magick::Image::transformSkewX ( const double skewx_ )
4039 options()->transformSkewX( skewx_ );
4042 // Skew to use in Y axis when annotating with text or drawing
4043 void Magick::Image::transformSkewY ( const double skewy_ )
4046 options()->transformSkewY( skewy_ );
4049 // Image representation type
4050 Magick::ImageType Magick::Image::type ( void ) const
4053 ExceptionInfo exceptionInfo;
4054 GetExceptionInfo( &exceptionInfo );
4055 ImageType image_type = constOptions()->type();
4056 if ( image_type == UndefinedType )
4057 image_type= GetImageType( constImage(), &exceptionInfo);
4058 throwException( exceptionInfo );
4059 (void) DestroyExceptionInfo( &exceptionInfo );
4062 void Magick::Image::type ( const Magick::ImageType type_)
4064 ExceptionInfo exceptionInfo;
4065 GetExceptionInfo( &exceptionInfo );
4067 options()->type( type_ );
4068 SetImageType( image(), type_, &exceptionInfo );
4069 throwException( exceptionInfo );
4070 (void) DestroyExceptionInfo( &exceptionInfo );
4073 void Magick::Image::verbose ( const bool verboseFlag_ )
4076 options()->verbose( verboseFlag_ );
4078 bool Magick::Image::verbose ( void ) const
4080 return constOptions()->verbose( );
4083 void Magick::Image::view ( const std::string &view_ )
4086 options()->view( view_ );
4088 std::string Magick::Image::view ( void ) const
4090 return constOptions()->view( );
4093 // Virtual pixel method
4094 void Magick::Image::virtualPixelMethod ( const VirtualPixelMethod virtual_pixel_method_ )
4097 SetImageVirtualPixelMethod( image(), virtual_pixel_method_ );
4098 options()->virtualPixelMethod( virtual_pixel_method_ );
4100 Magick::VirtualPixelMethod Magick::Image::virtualPixelMethod ( void ) const
4102 return GetImageVirtualPixelMethod( constImage() );
4105 void Magick::Image::x11Display ( const std::string &display_ )
4108 options()->x11Display( display_ );
4110 std::string Magick::Image::x11Display ( void ) const
4112 return constOptions()->x11Display( );
4115 double Magick::Image::xResolution ( void ) const
4117 return constImage()->resolution.x;
4119 double Magick::Image::yResolution ( void ) const
4121 return constImage()->resolution.y;
4125 Magick::Image::Image( const Image & image_ )
4126 : _imgRef(image_._imgRef)
4128 Lock( &_imgRef->_mutexLock );
4130 // Increase reference count
4131 ++_imgRef->_refCount;
4134 // Assignment operator
4135 Magick::Image& Magick::Image::operator=( const Magick::Image &image_ )
4137 if( this != &image_ )
4140 Lock( &image_._imgRef->_mutexLock );
4141 ++image_._imgRef->_refCount;
4144 bool doDelete = false;
4146 Lock( &_imgRef->_mutexLock );
4147 if ( --_imgRef->_refCount == 0 )
4153 // Delete old image reference with associated image and options.
4157 // Use new image reference
4158 _imgRef = image_._imgRef;
4164 //////////////////////////////////////////////////////////////////////
4166 // Low-level Pixel Access Routines
4168 // Also see the Pixels class, which provides support for multiple
4169 // cache views. The low-level pixel access routines in the Image
4170 // class are provided in order to support backward compatability.
4172 //////////////////////////////////////////////////////////////////////
4174 // Transfers read-only pixels from the image to the pixel cache as
4175 // defined by the specified region
4176 const Magick::Quantum* Magick::Image::getConstPixels
4177 ( const ssize_t x_, const ssize_t y_,
4178 const size_t columns_,
4179 const size_t rows_ ) const
4181 ExceptionInfo exceptionInfo;
4182 GetExceptionInfo( &exceptionInfo );
4183 const Quantum* p = (*GetVirtualPixels)( constImage(),
4187 throwException( exceptionInfo );
4188 (void) DestroyExceptionInfo( &exceptionInfo );
4192 // Obtain read-only pixel associated pixels channels
4193 const void* Magick::Image::getConstMetacontent ( void ) const
4195 const void* result = GetVirtualMetacontent( constImage() );
4198 throwImageException();
4203 // Obtain image pixel associated pixels channels
4204 void* Magick::Image::getMetacontent ( void )
4206 void* result = GetAuthenticMetacontent( image() );
4209 throwImageException();
4214 // Transfers pixels from the image to the pixel cache as defined
4215 // by the specified region. Modified pixels may be subsequently
4216 // transferred back to the image via syncPixels.
4217 Magick::Quantum* Magick::Image::getPixels ( const ssize_t x_, const ssize_t y_,
4218 const size_t columns_,
4219 const size_t rows_ )
4222 ExceptionInfo exceptionInfo;
4223 GetExceptionInfo( &exceptionInfo );
4224 Quantum* result = (*GetAuthenticPixels)( image(),
4226 columns_, rows_, &exceptionInfo );
4227 throwException( exceptionInfo );
4228 (void) DestroyExceptionInfo( &exceptionInfo );
4233 // Allocates a pixel cache region to store image pixels as defined
4234 // by the region rectangle. This area is subsequently transferred
4235 // from the pixel cache to the image via syncPixels.
4236 Magick::Quantum* Magick::Image::setPixels ( const ssize_t x_, const ssize_t y_,
4237 const size_t columns_,
4238 const size_t rows_ )
4241 ExceptionInfo exceptionInfo;
4242 GetExceptionInfo( &exceptionInfo );
4243 Quantum* result = (*QueueAuthenticPixels)( image(),
4245 columns_, rows_, &exceptionInfo );
4246 throwException( exceptionInfo );
4247 (void) DestroyExceptionInfo( &exceptionInfo );
4252 // Transfers the image cache pixels to the image.
4253 void Magick::Image::syncPixels ( void )
4255 ExceptionInfo exceptionInfo;
4256 GetExceptionInfo( &exceptionInfo );
4257 (*SyncAuthenticPixels)( image(), &exceptionInfo );
4258 throwException( exceptionInfo );
4259 (void) DestroyExceptionInfo( &exceptionInfo );
4262 // Transfers one or more pixel components from a buffer or file
4263 // into the image pixel cache of an image.
4264 // Used to support image decoders.
4265 void Magick::Image::readPixels ( const Magick::QuantumType quantum_,
4266 const unsigned char *source_ )
4271 quantum_info=AcquireQuantumInfo(imageInfo(),image());
4272 ExceptionInfo exceptionInfo;
4273 GetExceptionInfo( &exceptionInfo );
4274 ImportQuantumPixels(image(),(MagickCore::CacheView *) NULL,quantum_info,
4275 quantum_,source_, &exceptionInfo);
4276 throwException( exceptionInfo );
4277 (void) DestroyExceptionInfo( &exceptionInfo );
4278 quantum_info=DestroyQuantumInfo(quantum_info);
4281 // Transfers one or more pixel components from the image pixel
4282 // cache to a buffer or file.
4283 // Used to support image encoders.
4284 void Magick::Image::writePixels ( const Magick::QuantumType quantum_,
4285 unsigned char *destination_ )
4290 quantum_info=AcquireQuantumInfo(imageInfo(),image());
4291 ExceptionInfo exceptionInfo;
4292 GetExceptionInfo( &exceptionInfo );
4293 ExportQuantumPixels(image(),(MagickCore::CacheView *) NULL,quantum_info,
4294 quantum_,destination_, &exceptionInfo);
4295 quantum_info=DestroyQuantumInfo(quantum_info);
4296 throwException( exceptionInfo );
4297 (void) DestroyExceptionInfo( &exceptionInfo );
4300 /////////////////////////////////////////////////////////////////////
4302 // No end-user methods beyond this point
4304 /////////////////////////////////////////////////////////////////////
4308 // Construct using existing image and default options
4310 Magick::Image::Image ( MagickCore::Image* image_ )
4311 : _imgRef(new ImageRef( image_))
4315 // Get Magick::Options*
4316 Magick::Options* Magick::Image::options( void )
4318 return _imgRef->options();
4320 const Magick::Options* Magick::Image::constOptions( void ) const
4322 return _imgRef->options();
4325 // Get MagickCore::Image*
4326 MagickCore::Image*& Magick::Image::image( void )
4328 return _imgRef->image();
4330 const MagickCore::Image* Magick::Image::constImage( void ) const
4332 return _imgRef->image();
4336 MagickCore::ImageInfo* Magick::Image::imageInfo( void )
4338 return _imgRef->options()->imageInfo();
4340 const MagickCore::ImageInfo * Magick::Image::constImageInfo( void ) const
4342 return _imgRef->options()->imageInfo();
4345 // Get QuantizeInfo *
4346 MagickCore::QuantizeInfo* Magick::Image::quantizeInfo( void )
4348 return _imgRef->options()->quantizeInfo();
4350 const MagickCore::QuantizeInfo * Magick::Image::constQuantizeInfo( void ) const
4352 return _imgRef->options()->quantizeInfo();
4356 // Replace current image
4358 MagickCore::Image * Magick::Image::replaceImage
4359 ( MagickCore::Image* replacement_ )
4361 MagickCore::Image* image;
4364 image = replacement_;
4367 ExceptionInfo exceptionInfo;
4368 GetExceptionInfo( &exceptionInfo );
4369 image = AcquireImage(constImageInfo(), &exceptionInfo);
4370 throwException( exceptionInfo );
4371 (void) DestroyExceptionInfo( &exceptionInfo );
4375 Lock( &_imgRef->_mutexLock );
4377 if ( _imgRef->_refCount == 1 )
4379 // We own the image, just replace it, and de-register
4381 _imgRef->image(image);
4385 // We don't own the image, dereference and replace with copy
4386 --_imgRef->_refCount;
4387 _imgRef = new ImageRef( image, constOptions() );
4391 return _imgRef->_image;
4395 // Prepare to modify image or image options
4396 // Replace current image and options with copy if reference count > 1
4398 void Magick::Image::modifyImage( void )
4401 Lock( &_imgRef->_mutexLock );
4402 if ( _imgRef->_refCount == 1 )
4404 // De-register image and return
4410 ExceptionInfo exceptionInfo;
4411 GetExceptionInfo( &exceptionInfo );
4412 replaceImage( CloneImage( image(),
4415 MagickTrue, // orphan
4417 throwException( exceptionInfo );
4418 (void) DestroyExceptionInfo( &exceptionInfo );
4423 // Test for an ImageMagick reported error and throw exception if one
4424 // has been reported. Secretly resets image->exception back to default
4425 // state even though this method is const.
4427 void Magick::Image::throwImageException( void ) const
4429 // Throw C++ exception while resetting Image exception to default state
4432 // Register image with image registry or obtain registration id
4433 ssize_t Magick::Image::registerId( void )
4435 Lock( &_imgRef->_mutexLock );
4436 if( _imgRef->id() < 0 )
4438 char id[MaxTextExtent];
4439 ExceptionInfo exceptionInfo;
4440 GetExceptionInfo( &exceptionInfo );
4441 _imgRef->id(_imgRef->id()+1);
4442 sprintf(id,"%.20g\n",(double) _imgRef->id());
4443 SetImageRegistry(ImageRegistryType, id, image(), &exceptionInfo);
4444 throwException( exceptionInfo );
4445 (void) DestroyExceptionInfo( &exceptionInfo );
4447 return _imgRef->id();
4450 // Unregister image from image registry
4451 void Magick::Image::unregisterId( void )
4458 // Create a local wrapper around MagickCoreTerminus
4463 void MagickPlusPlusDestroyMagick(void);
4467 void Magick::MagickPlusPlusDestroyMagick(void)
4469 if (magick_initialized)
4471 magick_initialized=false;
4472 MagickCore::MagickCoreTerminus();
4476 // C library initialization routine
4477 void MagickPPExport Magick::InitializeMagick(const char *path_)
4479 MagickCore::MagickCoreGenesis(path_,MagickFalse);
4480 if (!magick_initialized)
4481 magick_initialized=true;
4485 // Cleanup class to ensure that ImageMagick singletons are destroyed
4486 // so as to avoid any resemblence to a memory leak (which seems to
4495 MagickCleanUp( void );
4496 ~MagickCleanUp( void );
4499 // The destructor for this object is invoked when the destructors for
4500 // static objects in this translation unit are invoked.
4501 static MagickCleanUp magickCleanUpGuard;
4504 Magick::MagickCleanUp::MagickCleanUp ( void )
4506 // Don't even think about invoking InitializeMagick here!
4509 Magick::MagickCleanUp::~MagickCleanUp ( void )
4511 MagickPlusPlusDestroyMagick();