Image.h revision 1f5fd5aeaee99fd19bacf7a1350ce73cd5ab1825
1// This may look like C code, but it is really -*- C++ -*- 2// 3// Copyright Bob Friesenhahn, 1999, 2000, 2001, 2002, 2003 4// Copyright Dirk Lemstra 2013-2015 5// 6// Definition of Image, the representation of a single image in Magick++ 7// 8 9#if !defined(Magick_Image_header) 10#define Magick_Image_header 11 12#include "Magick++/Include.h" 13#include <string> 14#include <list> 15#include "Magick++/Blob.h" 16#include "Magick++/Color.h" 17#include "Magick++/Drawable.h" 18#include "Magick++/Exception.h" 19#include "Magick++/Geometry.h" 20#include "Magick++/Statistic.h" 21#include "Magick++/TypeMetric.h" 22 23namespace Magick 24{ 25 // Forward declarations 26 class Options; 27 class ImageRef; 28 29 extern MagickPPExport const char *borderGeometryDefault; 30 extern MagickPPExport const char *frameGeometryDefault; 31 extern MagickPPExport const char *raiseGeometryDefault; 32 33 // Compare two Image objects regardless of LHS/RHS 34 // Image sizes and signatures are used as basis of comparison 35 MagickPPExport int operator == 36 (const Magick::Image &left_,const Magick::Image &right_); 37 MagickPPExport int operator != 38 (const Magick::Image &left_,const Magick::Image &right_); 39 MagickPPExport int operator > 40 (const Magick::Image &left_,const Magick::Image &right_); 41 MagickPPExport int operator < 42 (const Magick::Image &left_,const Magick::Image &right_); 43 MagickPPExport int operator >= 44 (const Magick::Image &left_,const Magick::Image &right_); 45 MagickPPExport int operator <= 46 (const Magick::Image &left_,const Magick::Image &right_); 47 48 // 49 // Image is the representation of an image. In reality, it actually 50 // a handle object which contains a pointer to a shared reference 51 // object (ImageRef). As such, this object is extremely space efficient. 52 // 53 class MagickPPExport Image 54 { 55 public: 56 57 // Default constructor 58 Image(void); 59 60 // Construct Image from in-memory BLOB 61 Image(const Blob &blob_); 62 63 // Construct Image of specified size from in-memory BLOB 64 Image(const Blob &blob_,const Geometry &size_); 65 66 // Construct Image of specified size and depth from in-memory BLOB 67 Image(const Blob &blob_,const Geometry &size,const size_t depth); 68 69 // Construct Image of specified size, depth, and format from 70 // in-memory BLOB 71 Image(const Blob &blob_,const Geometry &size,const size_t depth_, 72 const std::string &magick_); 73 74 // Construct Image of specified size, and format from in-memory BLOB 75 Image(const Blob &blob_,const Geometry &size,const std::string &magick_); 76 77 // Construct a blank image canvas of specified size and color 78 Image(const Geometry &size_,const Color &color_); 79 80 // Copy constructor 81 Image(const Image &image_); 82 83 // Construct an image based on an array of raw pixels, of 84 // specified type and mapping, in memory 85 Image(const size_t width_,const size_t height_,const std::string &map_, 86 const StorageType type_,const void *pixels_); 87 88 // Construct from image file or image specification 89 Image(const std::string &imageSpec_); 90 91 // Destructor 92 virtual ~Image(); 93 94 // Assignment operator 95 Image& operator=(const Image &image_); 96 97 // Join images into a single multi-image file 98 void adjoin(const bool flag_); 99 bool adjoin(void) const; 100 101 // Image supports transparency (alpha channel) 102 void alpha(const bool alphaFlag_); 103 bool alpha(void) const; 104 105 // Transparent color 106 void alphaColor(const Color &alphaColor_); 107 Color alphaColor(void) const; 108 109 // Anti-alias Postscript and TrueType fonts (default true) 110 void antiAlias(const bool flag_); 111 bool antiAlias(void) const; 112 113 // Time in 1/100ths of a second which must expire before 114 // displaying the next image in an animated sequence. 115 void animationDelay(const size_t delay_); 116 size_t animationDelay(void) const; 117 118 // Lessen (or intensify) when adding noise to an image. 119 void attenuate(const double attenuate_); 120 121 // Number of iterations to loop an animation (e.g. Netscape loop 122 // extension) for. 123 void animationIterations(const size_t iterations_); 124 size_t animationIterations(void) const; 125 126 // Image background color 127 void backgroundColor(const Color &color_); 128 Color backgroundColor(void) const; 129 130 // Name of texture image to tile onto the image background 131 void backgroundTexture(const std::string &backgroundTexture_); 132 std::string backgroundTexture(void) const; 133 134 // Base image width (before transformations) 135 size_t baseColumns(void) const; 136 137 // Base image filename (before transformations) 138 std::string baseFilename(void) const; 139 140 // Base image height (before transformations) 141 size_t baseRows(void) const; 142 143 // Use black point compensation. 144 void blackPointCompensation(const bool flag_); 145 bool blackPointCompensation(void) const; 146 147 // Image border color 148 void borderColor(const Color &color_); 149 Color borderColor(void) const; 150 151 // Return smallest bounding box enclosing non-border pixels. The 152 // current fuzz value is used when discriminating between pixels. 153 // This is the crop bounding box used by crop(Geometry(0,0)); 154 Geometry boundingBox(void) const; 155 156 // Text bounding-box base color (default none) 157 void boxColor(const Color &boxColor_); 158 Color boxColor(void) const; 159 160 // Set or obtain modulus channel depth 161 void channelDepth(const ChannelType channel_,const size_t depth_); 162 size_t channelDepth(const ChannelType channel_); 163 164 // Returns the number of channels in this image. 165 size_t channels() const; 166 167 // Image class (DirectClass or PseudoClass) 168 // NOTE: setting a DirectClass image to PseudoClass will result in 169 // the loss of color information if the number of colors in the 170 // image is greater than the maximum palette size (either 256 or 171 // 65536 entries depending on the value of MAGICKCORE_QUANTUM_DEPTH when 172 // ImageMagick was built). 173 void classType(const ClassType class_); 174 ClassType classType(void) const; 175 176 // Colors within this distance are considered equal 177 void colorFuzz(const double fuzz_); 178 double colorFuzz(void) const; 179 180 // Colormap size (number of colormap entries) 181 void colorMapSize(const size_t entries_); 182 size_t colorMapSize(void) const; 183 184 // Image Color Space 185 void colorSpace(const ColorspaceType colorSpace_); 186 ColorspaceType colorSpace(void) const; 187 188 void colorSpaceType(const ColorspaceType colorSpace_); 189 ColorspaceType colorSpaceType(void) const; 190 191 // Image width 192 size_t columns(void) const; 193 194 // Comment image (add comment string to image) 195 void comment(const std::string &comment_); 196 std::string comment(void) const; 197 198 // Composition operator to be used when composition is implicitly 199 // used (such as for image flattening). 200 void compose(const CompositeOperator compose_); 201 CompositeOperator compose(void) const; 202 203 // Compression type 204 void compressType(const CompressionType compressType_); 205 CompressionType compressType(void) const; 206 207 // Enable printing of debug messages from ImageMagick 208 void debug(const bool flag_); 209 bool debug(void) const; 210 211 // Vertical and horizontal resolution in pixels of the image 212 void density(const Point &density_); 213 Point density(void) const; 214 215 // Image depth (bits allocated to red/green/blue components) 216 void depth(const size_t depth_); 217 size_t depth(void) const; 218 219 // Tile names from within an image montage 220 std::string directory(void) const; 221 222 // Endianness (little like Intel or big like SPARC) for image 223 // formats which support endian-specific options. 224 void endian(const EndianType endian_); 225 EndianType endian(void) const; 226 227 // Exif profile (BLOB) 228 void exifProfile(const Blob &exifProfile_); 229 Blob exifProfile(void) const; 230 231 // Image file name 232 void fileName(const std::string &fileName_); 233 std::string fileName(void) const; 234 235 // Number of bytes of the image on disk 236 MagickSizeType fileSize(void) const; 237 238 // Color to use when filling drawn objects 239 void fillColor(const Color &fillColor_); 240 Color fillColor(void) const; 241 242 // Rule to use when filling drawn objects 243 void fillRule(const FillRule &fillRule_); 244 FillRule fillRule(void) const; 245 246 // Pattern to use while filling drawn objects. 247 void fillPattern(const Image &fillPattern_); 248 Image fillPattern(void) const; 249 250 // Filter to use when resizing image 251 void filterType(const FilterTypes filterType_); 252 FilterTypes filterType(void) const; 253 254 // Text rendering font 255 void font(const std::string &font_); 256 std::string font(void) const; 257 258 // Font point size 259 void fontPointsize(const double pointSize_); 260 double fontPointsize(void) const; 261 262 // Long image format description 263 std::string format(void) const; 264 265 // Formats the specified expression 266 // More info here: http://www.imagemagick.org/script/escape.php 267 std::string formatExpression(const std::string expression); 268 269 // Gamma level of the image 270 double gamma(void) const; 271 272 // Preferred size of the image when encoding 273 Geometry geometry(void) const; 274 275 // GIF disposal method 276 void gifDisposeMethod(const DisposeType disposeMethod_); 277 DisposeType gifDisposeMethod(void) const; 278 279 bool hasChannel(const PixelChannel channel) const; 280 281 // When comparing images, emphasize pixel differences with this color. 282 void highlightColor(const Color color_); 283 284 // ICC color profile (BLOB) 285 void iccColorProfile(const Blob &colorProfile_); 286 Blob iccColorProfile(void) const; 287 288 // Type of interlacing to use 289 void interlaceType(const InterlaceType interlace_); 290 InterlaceType interlaceType(void) const; 291 292 // Pixel color interpolation method to use 293 void interpolate(const PixelInterpolateMethod interpolate_); 294 PixelInterpolateMethod interpolate(void) const; 295 296 // IPTC profile (BLOB) 297 void iptcProfile(const Blob &iptcProfile_); 298 Blob iptcProfile(void) const; 299 300 // Returns true if none of the pixels in the image have an alpha value 301 // other than OpaqueAlpha (QuantumRange). 302 bool isOpaque(void) const; 303 304 // Does object contain valid image? 305 void isValid(const bool isValid_); 306 bool isValid(void) const; 307 308 // Image label 309 void label(const std::string &label_); 310 std::string label(void) const; 311 312 // When comparing images, de-emphasize pixel differences with this color. 313 void lowlightColor(const Color color_); 314 315 // File type magick identifier (.e.g "GIF") 316 void magick(const std::string &magick_); 317 std::string magick(void) const; 318 319 // Associate a mask with the image. The mask must be the same dimensions 320 // as the image. Pass an invalid image to unset an existing mask. 321 void mask(const Image &mask_); 322 Image mask(void) const; 323 324 // The mean error per pixel computed when an image is color reduced 325 double meanErrorPerPixel(void) const; 326 327 // Image modulus depth (minimum number of bits required to support 328 // red/green/blue components without loss of accuracy) 329 void modulusDepth(const size_t modulusDepth_); 330 size_t modulusDepth(void) const; 331 332 // Transform image to black and white 333 void monochrome(const bool monochromeFlag_); 334 bool monochrome(void) const; 335 336 // Tile size and offset within an image montage 337 Geometry montageGeometry(void) const; 338 339 // The normalized max error per pixel computed when an image is 340 // color reduced. 341 double normalizedMaxError(void) const; 342 343 // The normalized mean error per pixel computed when an image is 344 // color reduced. 345 double normalizedMeanError(void) const; 346 347 // Image orientation 348 void orientation(const OrientationType orientation_); 349 OrientationType orientation(void) const; 350 351 // Preferred size and location of an image canvas. 352 void page(const Geometry &pageSize_); 353 Geometry page(void) const; 354 355 // JPEG/MIFF/PNG compression level (default 75). 356 void quality(const size_t quality_); 357 size_t quality(void) const; 358 359 // Maximum number of colors to quantize to 360 void quantizeColors(const size_t colors_); 361 size_t quantizeColors(void) const; 362 363 // Colorspace to quantize in. 364 void quantizeColorSpace(const ColorspaceType colorSpace_); 365 ColorspaceType quantizeColorSpace(void) const; 366 367 // Dither image during quantization (default true). 368 void quantizeDither(const bool ditherFlag_); 369 bool quantizeDither(void) const; 370 371 // Dither method 372 void quantizeDitherMethod(const DitherMethod ditherMethod_); 373 DitherMethod quantizeDitherMethod(void) const; 374 375 // Quantization tree-depth 376 void quantizeTreeDepth(const size_t treeDepth_); 377 size_t quantizeTreeDepth(void) const; 378 379 // Suppress all warning messages. Error messages are still reported. 380 void quiet(const bool quiet_); 381 bool quiet(void) const; 382 383 // The type of rendering intent 384 void renderingIntent(const RenderingIntent renderingIntent_); 385 RenderingIntent renderingIntent(void) const; 386 387 // Units of image resolution 388 void resolutionUnits(const ResolutionType resolutionUnits_); 389 ResolutionType resolutionUnits(void) const; 390 391 // The number of pixel rows in the image 392 size_t rows(void) const; 393 394 // Image scene number 395 void scene(const size_t scene_); 396 size_t scene(void) const; 397 398 // Width and height of a raw image 399 void size(const Geometry &geometry_); 400 Geometry size(void) const; 401 402 // enabled/disable stroke anti-aliasing 403 void strokeAntiAlias(const bool flag_); 404 bool strokeAntiAlias(void) const; 405 406 // Color to use when drawing object outlines 407 void strokeColor(const Color &strokeColor_); 408 Color strokeColor(void) const; 409 410 // Specify the pattern of dashes and gaps used to stroke 411 // paths. The strokeDashArray represents a zero-terminated array 412 // of numbers that specify the lengths of alternating dashes and 413 // gaps in pixels. If an odd number of values is provided, then 414 // the list of values is repeated to yield an even number of 415 // values. A typical strokeDashArray_ array might contain the 416 // members 5 3 2 0, where the zero value indicates the end of the 417 // pattern array. 418 void strokeDashArray(const double *strokeDashArray_); 419 const double *strokeDashArray(void) const; 420 421 // While drawing using a dash pattern, specify distance into the 422 // dash pattern to start the dash (default 0). 423 void strokeDashOffset(const double strokeDashOffset_); 424 double strokeDashOffset(void) const; 425 426 // Specify the shape to be used at the end of open subpaths when 427 // they are stroked. Values of LineCap are UndefinedCap, ButtCap, 428 // RoundCap, and SquareCap. 429 void strokeLineCap(const LineCap lineCap_); 430 LineCap strokeLineCap(void) const; 431 432 // Specify the shape to be used at the corners of paths (or other 433 // vector shapes) when they are stroked. Values of LineJoin are 434 // UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin. 435 void strokeLineJoin(const LineJoin lineJoin_); 436 LineJoin strokeLineJoin(void) const; 437 438 // Specify miter limit. When two line segments meet at a sharp 439 // angle and miter joins have been specified for 'lineJoin', it is 440 // possible for the miter to extend far beyond the thickness of 441 // the line stroking the path. The miterLimit' imposes a limit on 442 // the ratio of the miter length to the 'lineWidth'. The default 443 // value of this parameter is 4. 444 void strokeMiterLimit(const size_t miterLimit_); 445 size_t strokeMiterLimit(void) const; 446 447 // Pattern image to use while stroking object outlines. 448 void strokePattern(const Image &strokePattern_); 449 Image strokePattern(void) const; 450 451 // Stroke width for drawing vector objects (default one) 452 void strokeWidth(const double strokeWidth_); 453 double strokeWidth(void) const; 454 455 // Subimage of an image sequence 456 void subImage(const size_t subImage_); 457 size_t subImage(void) const; 458 459 // Number of images relative to the base image 460 void subRange(const size_t subRange_); 461 size_t subRange(void) const; 462 463 // Render text right-to-left or left-to-right. 464 void textDirection(DirectionType direction_); 465 DirectionType textDirection() const; 466 467 // Annotation text encoding (e.g. "UTF-16") 468 void textEncoding(const std::string &encoding_); 469 std::string textEncoding(void) const; 470 471 // Text gravity. 472 void textGravity(GravityType gravity_); 473 GravityType textGravity() const; 474 475 // Text inter-line spacing 476 void textInterlineSpacing(double spacing_); 477 double textInterlineSpacing(void) const; 478 479 // Text inter-word spacing 480 void textInterwordSpacing(double spacing_); 481 double textInterwordSpacing(void) const; 482 483 // Text inter-character kerning 484 void textKerning(double kerning_); 485 double textKerning(void) const; 486 487 // Number of colors in the image 488 size_t totalColors(void) const; 489 490 // Rotation to use when annotating with text or drawing 491 void transformRotation(const double angle_); 492 493 // Skew to use in X axis when annotating with text or drawing 494 void transformSkewX(const double skewx_); 495 496 // Skew to use in Y axis when annotating with text or drawing 497 void transformSkewY(const double skewy_); 498 499 // Image representation type (also see type operation) 500 // Available types: 501 // Bilevel Grayscale GrayscaleMatte 502 // Palette PaletteMatte TrueColor 503 // TrueColorMatte ColorSeparation ColorSeparationMatte 504 void type(const ImageType type_); 505 ImageType type(void) const; 506 507 // Print detailed information about the image 508 void verbose(const bool verboseFlag_); 509 bool verbose(void) const; 510 511 // FlashPix viewing parameters 512 void view(const std::string &view_); 513 std::string view(void) const; 514 515 // Virtual pixel method 516 void virtualPixelMethod(const VirtualPixelMethod virtualPixelMethod_); 517 VirtualPixelMethod virtualPixelMethod(void) const; 518 519 // X11 display to display to, obtain fonts from, or to capture 520 // image from 521 void x11Display(const std::string &display_); 522 std::string x11Display(void) const; 523 524 // x resolution of the image 525 double xResolution(void) const; 526 527 // y resolution of the image 528 double yResolution(void) const; 529 530 // Adaptive-blur image with specified blur factor 531 // The radius_ parameter specifies the radius of the Gaussian, in 532 // pixels, not counting the center pixel. The sigma_ parameter 533 // specifies the standard deviation of the Laplacian, in pixels. 534 void adaptiveBlur(const double radius_=0.0,const double sigma_=1.0); 535 536 // This is shortcut function for a fast interpolative resize using mesh 537 // interpolation. It works well for small resizes of less than +/- 50% 538 // of the original image size. For larger resizing on images a full 539 // filtered and slower resize function should be used instead. 540 void adaptiveResize(const Geometry &geometry_); 541 542 // Adaptively sharpens the image by sharpening more intensely near image 543 // edges and less intensely far from edges. We sharpen the image with a 544 // Gaussian operator of the given radius and standard deviation (sigma). 545 // For reasonable results, radius should be larger than sigma. 546 void adaptiveSharpen(const double radius_=0.0,const double sigma_=1.0); 547 void adaptiveSharpenChannel(const ChannelType channel_, 548 const double radius_=0.0,const double sigma_=1.0); 549 550 // Local adaptive threshold image 551 // http://www.dai.ed.ac.uk/HIPR2/adpthrsh.htm 552 // Width x height define the size of the pixel neighborhood 553 // bias = constant to subtract from pixel neighborhood mean 554 void adaptiveThreshold(const size_t width_,const size_t height_, 555 const double bias_=0.0); 556 557 // Add noise to image with specified noise type 558 void addNoise(const NoiseType noiseType_); 559 void addNoiseChannel(const ChannelType channel_, 560 const NoiseType noiseType_); 561 562 // Transform image by specified affine (or free transform) matrix. 563 void affineTransform(const DrawableAffine &affine); 564 565 // Set or attenuate the alpha channel in the image. If the image 566 // pixels are opaque then they are set to the specified alpha 567 // value, otherwise they are blended with the supplied alpha 568 // value. The value of alpha_ ranges from 0 (completely opaque) 569 // to QuantumRange. The defines OpaqueAlpha and TransparentAlpha are 570 // available to specify completely opaque or completely 571 // transparent, respectively. 572 void alpha(const unsigned int alpha_); 573 574 // AlphaChannel() activates, deactivates, resets, or sets the alpha 575 // channel. 576 void alphaChannel(AlphaChannelOption alphaOption_); 577 578 // 579 // Annotate image (draw text on image) 580 // 581 // Gravity effects text placement in bounding area according to rules: 582 // NorthWestGravity text bottom-left corner placed at top-left 583 // NorthGravity text bottom-center placed at top-center 584 // NorthEastGravity text bottom-right corner placed at top-right 585 // WestGravity text left-center placed at left-center 586 // CenterGravity text center placed at center 587 // EastGravity text right-center placed at right-center 588 // SouthWestGravity text top-left placed at bottom-left 589 // SouthGravity text top-center placed at bottom-center 590 // SouthEastGravity text top-right placed at bottom-right 591 592 // Annotate using specified text, and placement location 593 void annotate(const std::string &text_,const Geometry &location_); 594 595 // Annotate using specified text, bounding area, and placement 596 // gravity 597 void annotate(const std::string &text_,const Geometry &boundingArea_, 598 const GravityType gravity_); 599 600 // Annotate with text using specified text, bounding area, 601 // placement gravity, and rotation. 602 void annotate(const std::string &text_,const Geometry &boundingArea_, 603 const GravityType gravity_,const double degrees_); 604 605 // Annotate with text (bounding area is entire image) and placement 606 // gravity. 607 void annotate(const std::string &text_,const GravityType gravity_); 608 609 // Inserts the artifact with the specified name and value into 610 // the artifact tree of the image. 611 void artifact(const std::string &name_,const std::string &value_); 612 613 // Returns the value of the artifact with the specified name. 614 std::string artifact(const std::string &name_) const; 615 616 // Access/Update a named image attribute 617 void attribute(const std::string name_,const std::string value_); 618 std::string attribute(const std::string name_) const; 619 620 // Extracts the 'mean' from the image and adjust the image to try 621 // make set its gamma appropriatally. 622 void autoGamma(void); 623 void autoGammaChannel(const ChannelType channel_); 624 625 // Adjusts the levels of a particular image channel by scaling the 626 // minimum and maximum values to the full quantum range. 627 void autoLevel(void); 628 void autoLevelChannel(const ChannelType channel_); 629 630 // Adjusts an image so that its orientation is suitable for viewing. 631 void autoOrient(void); 632 633 // Forces all pixels below the threshold into black while leaving all 634 // pixels at or above the threshold unchanged. 635 void blackThreshold(const std::string &threshold_); 636 void blackThresholdChannel(const ChannelType channel_, 637 const std::string &threshold_); 638 639 // Simulate a scene at nighttime in the moonlight. 640 void blueShift(const double factor_=1.5); 641 642 // Blur image with specified blur factor 643 // The radius_ parameter specifies the radius of the Gaussian, in 644 // pixels, not counting the center pixel. The sigma_ parameter 645 // specifies the standard deviation of the Laplacian, in pixels. 646 void blur(const double radius_=0.0,const double sigma_=1.0); 647 void blurChannel(const ChannelType channel_,const double radius_=0.0, 648 const double sigma_=1.0); 649 650 // Border image (add border to image) 651 void border(const Geometry &geometry_=borderGeometryDefault); 652 653 // Changes the brightness and/or contrast of an image. It converts the 654 // brightness and contrast parameters into slope and intercept and calls 655 // a polynomical function to apply to the image. 656 void brightnessContrast(const double brightness_=0.0, 657 const double contrast_=0.0); 658 void brightnessContrastChannel(const ChannelType channel_, 659 const double brightness_=0.0,const double contrast_=0.0); 660 661 // Uses a multi-stage algorithm to detect a wide range of edges in images. 662 void cannyEdge(const double radius_=0.0,const double sigma_=1.0, 663 const double lowerPercent_=0.1,const double upperPercent_=0.3); 664 665 // Accepts a lightweight Color Correction Collection 666 // (CCC) file which solely contains one or more color corrections and 667 // applies the correction to the image. 668 void cdl(const std::string &cdl_); 669 670 // Extract channel from image 671 void channel(const ChannelType channel_); 672 673 // Charcoal effect image (looks like charcoal sketch) 674 // The radius_ parameter specifies the radius of the Gaussian, in 675 // pixels, not counting the center pixel. The sigma_ parameter 676 // specifies the standard deviation of the Laplacian, in pixels. 677 void charcoal(const double radius_=0.0,const double sigma_=1.0); 678 679 // Chop image (remove vertical or horizontal subregion of image) 680 // FIXME: describe how geometry argument is used to select either 681 // horizontal or vertical subregion of image. 682 void chop(const Geometry &geometry_); 683 684 // Chromaticity blue primary point (e.g. x=0.15, y=0.06) 685 void chromaBluePrimary(const double x_,const double y_); 686 void chromaBluePrimary(double *x_,double *y_) const; 687 688 // Chromaticity green primary point (e.g. x=0.3, y=0.6) 689 void chromaGreenPrimary(const double x_,const double y_); 690 void chromaGreenPrimary(double *x_,double *y_) const; 691 692 // Chromaticity red primary point (e.g. x=0.64, y=0.33) 693 void chromaRedPrimary(const double x_,const double y_); 694 void chromaRedPrimary(double *x_,double *y_) const; 695 696 // Chromaticity white point (e.g. x=0.3127, y=0.329) 697 void chromaWhitePoint(const double x_,const double y_); 698 void chromaWhitePoint(double *x_,double *y_) const; 699 700 // Set each pixel whose value is below zero to zero and any the 701 // pixel whose value is above the quantum range to the quantum range (e.g. 702 // 65535) otherwise the pixel value remains unchanged. 703 void clamp(void); 704 void clampChannel(const ChannelType channel_); 705 706 // Sets the image clip mask based on any clipping path information 707 // if it exists. 708 void clip(void); 709 void clipPath(const std::string pathname_,const bool inside_); 710 711 // Apply a color lookup table (CLUT) to the image. 712 void clut(const Image &clutImage_,const PixelInterpolateMethod method); 713 void clutChannel(const ChannelType channel_,const Image &clutImage_, 714 const PixelInterpolateMethod method); 715 716 // Colorize image with pen color, using specified percent alpha. 717 void colorize(const unsigned int alpha_,const Color &penColor_); 718 719 // Colorize image with pen color, using specified percent alpha 720 // for red, green, and blue quantums 721 void colorize(const unsigned int alphaRed_,const unsigned int alphaGreen_, 722 const unsigned int alphaBlue_,const Color &penColor_); 723 724 // Color at colormap position index_ 725 void colorMap(const size_t index_,const Color &color_); 726 Color colorMap(const size_t index_) const; 727 728 // Apply a color matrix to the image channels. The user supplied 729 // matrix may be of order 1 to 5 (1x1 through 5x5). 730 void colorMatrix(const size_t order_,const double *color_matrix_); 731 732 // Compare current image with another image 733 // Sets meanErrorPerPixel, normalizedMaxError, and normalizedMeanError 734 // in the current image. False is returned if the images are identical. 735 bool compare(const Image &reference_); 736 737 // Compare current image with another image 738 // Returns the distortion based on the specified metric. 739 double compare(const Image &reference_,const MetricType metric_); 740 double compareChannel(const ChannelType channel_, 741 const Image &reference_, 742 const MetricType metric_ ); 743 744 // Compare current image with another image 745 // Sets the distortion and returns the difference image. 746 Image compare(const Image &reference_,const MetricType metric_, 747 double *distortion); 748 Image compareChannel(const ChannelType channel_,const Image &reference_, 749 const MetricType metric_,double *distortion); 750 751 // Compose an image onto another at specified offset and using 752 // specified algorithm 753 void composite(const Image &compositeImage_,const Geometry &offset_, 754 const CompositeOperator compose_=InCompositeOp); 755 void composite(const Image &compositeImage_,const GravityType gravity_, 756 const CompositeOperator compose_=InCompositeOp); 757 void composite(const Image &compositeImage_,const ::ssize_t xOffset_, 758 const ::ssize_t yOffset_,const CompositeOperator compose_=InCompositeOp); 759 760 // Determines the connected-components of the image 761 void connectedComponents(const size_t connectivity_); 762 763 // Contrast image (enhance intensity differences in image) 764 void contrast(const bool sharpen_); 765 766 // A simple image enhancement technique that attempts to improve the 767 // contrast in an image by 'stretching' the range of intensity values 768 // it contains to span a desired range of values. It differs from the 769 // more sophisticated histogram equalization in that it can only apply a 770 // linear scaling function to the image pixel values. As a result the 771 // 'enhancement' is less harsh. 772 void contrastStretch(const double blackPoint_,const double whitePoint_); 773 void contrastStretchChannel(const ChannelType channel_, 774 const double blackPoint_,const double whitePoint_); 775 776 // Convolve image. Applies a user-specified convolution to the image. 777 // order_ represents the number of columns and rows in the filter kernel. 778 // kernel_ is an array of doubles representing the convolution kernel. 779 void convolve(const size_t order_,const double *kernel_); 780 781 // Copies pixels from the source image as defined by the geometry the 782 // destination image at the specified offset. 783 void copyPixels(const Image &source_,const Geometry &geometry_, 784 const Offset &offset_); 785 786 // Crop image (subregion of original image) 787 void crop(const Geometry &geometry_); 788 789 // Cycle image colormap 790 void cycleColormap(const ::ssize_t amount_); 791 792 // Converts cipher pixels to plain pixels. 793 void decipher(const std::string &passphrase_); 794 795 // Tagged image format define. Similar to the defineValue() method 796 // except that passing the flag_ value 'true' creates a value-less 797 // define with that format and key. Passing the flag_ value 'false' 798 // removes any existing matching definition. The method returns 'true' 799 // if a matching key exists, and 'false' if no matching key exists. 800 void defineSet(const std::string &magick_,const std::string &key_, 801 bool flag_); 802 bool defineSet(const std::string &magick_,const std::string &key_) const; 803 804 // Tagged image format define (set/access coder-specific option) The 805 // magick_ option specifies the coder the define applies to. The key_ 806 // option provides the key specific to that coder. The value_ option 807 // provides the value to set (if any). See the defineSet() method if the 808 // key must be removed entirely. 809 void defineValue(const std::string &magick_,const std::string &key_, 810 const std::string &value_); 811 std::string defineValue(const std::string &magick_, 812 const std::string &key_) const; 813 814 // Removes skew from the image. Skew is an artifact that occurs in scanned 815 // images because of the camera being misaligned, imperfections in the 816 // scanning or surface, or simply because the paper was not placed 817 // completely flat when scanned. The value of threshold_ ranges from 0 818 // to QuantumRange. 819 void deskew(const double threshold_); 820 821 // Despeckle image (reduce speckle noise) 822 void despeckle(void); 823 824 // Determines the color type of the image. This method can be used to 825 // automaticly make the type GrayScale. 826 ImageType determineType(void) const; 827 828 // Display image on screen 829 void display(void); 830 831 // Distort image. distorts an image using various distortion methods, by 832 // mapping color lookups of the source image to a new destination image 833 // usally of the same size as the source image, unless 'bestfit' is set to 834 // true. 835 void distort(const DistortImageMethod method_, 836 const size_t numberArguments_,const double *arguments_, 837 const bool bestfit_=false); 838 839 // Draw on image using a single drawable 840 void draw(const Drawable &drawable_); 841 842 // Draw on image using a drawable list 843 void draw(const std::vector<Magick::Drawable> &drawable_); 844 845 // Edge image (hilight edges in image) 846 void edge(const double radius_=0.0); 847 848 // Emboss image (hilight edges with 3D effect) 849 // The radius_ parameter specifies the radius of the Gaussian, in 850 // pixels, not counting the center pixel. The sigma_ parameter 851 // specifies the standard deviation of the Laplacian, in pixels. 852 void emboss(const double radius_=0.0,const double sigma_=1.0); 853 854 // Converts pixels to cipher-pixels. 855 void encipher(const std::string &passphrase_); 856 857 // Enhance image (minimize noise) 858 void enhance(void); 859 860 // Equalize image (histogram equalization) 861 void equalize(void); 862 863 // Erase image to current "background color" 864 void erase(void); 865 866 // Extend the image as defined by the geometry. 867 void extent(const Geometry &geometry_); 868 void extent(const Geometry &geometry_,const Color &backgroundColor); 869 void extent(const Geometry &geometry_,const Color &backgroundColor, 870 const GravityType gravity_); 871 void extent(const Geometry &geometry_,const GravityType gravity_); 872 873 // Flip image (reflect each scanline in the vertical direction) 874 void flip(void); 875 876 // Floodfill pixels matching color (within fuzz factor) of target 877 // pixel(x,y) with replacement alpha value. 878 void floodFillAlpha(const ::ssize_t x_,const ::ssize_t y_, 879 const unsigned int alpha_,const bool invert_=false); 880 881 // Floodfill designated area with replacement alpha value 882 void floodFillAlpha(const ssize_t x_,const ssize_t y_, 883 const unsigned int alpha_,const Color &target_,const bool invert_=false); 884 885 // Flood-fill color across pixels that match the color of the 886 // target pixel and are neighbors of the target pixel. 887 // Uses current fuzz setting when determining color match. 888 void floodFillColor(const Geometry &point_,const Color &fillColor_, 889 const bool invert_=false); 890 void floodFillColor(const ::ssize_t x_,const ::ssize_t y_, 891 const Color &fillColor_,const bool invert_=false); 892 893 // Flood-fill color across pixels starting at target-pixel and 894 // stopping at pixels matching specified border color. 895 // Uses current fuzz setting when determining color match. 896 void floodFillColor(const Geometry &point_,const Color &fillColor_, 897 const Color &borderColor_,const bool invert_=false); 898 void floodFillColor(const ::ssize_t x_,const ::ssize_t y_, 899 const Color &fillColor_,const Color &borderColor_, 900 const bool invert_=false); 901 902 // Flood-fill texture across pixels that match the color of the 903 // target pixel and are neighbors of the target pixel. 904 // Uses current fuzz setting when determining color match. 905 void floodFillTexture(const Geometry &point_,const Image &texture_, 906 const bool invert_=false); 907 void floodFillTexture(const ::ssize_t x_,const ::ssize_t y_, 908 const Image &texture_,const bool invert_=false); 909 910 // Flood-fill texture across pixels starting at target-pixel and 911 // stopping at pixels matching specified border color. 912 // Uses current fuzz setting when determining color match. 913 void floodFillTexture(const Geometry &point_,const Image &texture_, 914 const Color &borderColor_,const bool invert_=false); 915 void floodFillTexture(const ::ssize_t x_,const ::ssize_t y_, 916 const Image &texture_,const Color &borderColor_, 917 const bool invert_=false); 918 919 // Flop image (reflect each scanline in the horizontal direction) 920 void flop(void); 921 922 // Obtain font metrics for text string given current font, 923 // pointsize, and density settings. 924 void fontTypeMetrics(const std::string &text_,TypeMetric *metrics); 925 926 // Obtain multi line font metrics for text string given current font, 927 // pointsize, and density settings. 928 void fontTypeMetricsMultiline(const std::string &text_, 929 TypeMetric *metrics); 930 931 // Frame image 932 void frame(const Geometry &geometry_=frameGeometryDefault); 933 void frame(const size_t width_,const size_t height_, 934 const ::ssize_t innerBevel_=6,const ::ssize_t outerBevel_=6); 935 936 // Applies a mathematical expression to the image. 937 void fx(const std::string expression_); 938 void fx(const std::string expression_,const Magick::ChannelType channel_); 939 940 // Gamma correct image 941 void gamma(const double gamma_); 942 void gamma(const double gammaRed_,const double gammaGreen_, 943 const double gammaBlue_); 944 945 // Gaussian blur image 946 // The number of neighbor pixels to be included in the convolution 947 // mask is specified by 'width_'. The standard deviation of the 948 // gaussian bell curve is specified by 'sigma_'. 949 void gaussianBlur(const double width_,const double sigma_); 950 void gaussianBlurChannel(const ChannelType channel_,const double width_, 951 const double sigma_); 952 953 // Transfers read-only pixels from the image to the pixel cache as 954 // defined by the specified region 955 const Quantum *getConstPixels(const ::ssize_t x_, const ::ssize_t y_, 956 const size_t columns_,const size_t rows_) const; 957 958 // Obtain immutable image pixel metacontent (valid for PseudoClass images) 959 const void *getConstMetacontent(void) const; 960 961 // Obtain mutable image pixel metacontent (valid for PseudoClass images) 962 void *getMetacontent(void); 963 964 // Transfers pixels from the image to the pixel cache as defined 965 // by the specified region. Modified pixels may be subsequently 966 // transferred back to the image via syncPixels. This method is 967 // valid for DirectClass images. 968 Quantum *getPixels(const ::ssize_t x_,const ::ssize_t y_, 969 const size_t columns_,const size_t rows_); 970 971 // Converts the colors in the image to gray. 972 void grayscale(const PixelIntensityMethod method_); 973 974 // Apply a color lookup table (Hald CLUT) to the image. 975 void haldClut(const Image &clutImage_); 976 977 // Identifies lines in the image. 978 void houghLine(const size_t width_,const size_t height_, 979 const size_t threshold_=40); 980 981 // Implode image (special effect) 982 void implode(const double factor_); 983 984 // Implements the inverse discrete Fourier transform (DFT) of the image 985 // either as a magnitude / phase or real / imaginary image pair. 986 void inverseFourierTransform(const Image &phase_); 987 void inverseFourierTransform(const Image &phase_,const bool magnitude_); 988 989 // An edge preserving noise reduction filter. 990 void kuwahara(const double radius_=0.0,const double sigma_=1.0); 991 void kuwaharaChannel(const ChannelType channel_,const double radius_=0.0, 992 const double sigma_=1.0); 993 994 // Level image. Adjust the levels of the image by scaling the 995 // colors falling between specified white and black points to the 996 // full available quantum range. The parameters provided represent 997 // the black, mid (gamma), and white points. The black point 998 // specifies the darkest color in the image. Colors darker than 999 // the black point are set to zero. Mid point (gamma) specifies a 1000 // gamma correction to apply to the image. White point specifies 1001 // the lightest color in the image. Colors brighter than the 1002 // white point are set to the maximum quantum value. The black and 1003 // white point have the valid range 0 to QuantumRange while mid (gamma) 1004 // has a useful range of 0 to ten. 1005 void level(const double blackPoint_,const double whitePoint_, 1006 const double gamma_=1.0); 1007 void levelChannel(const ChannelType channel_,const double blackPoint_, 1008 const double whitePoint_,const double gamma_=1.0); 1009 1010 // Maps the given color to "black" and "white" values, linearly spreading 1011 // out the colors, and level values on a channel by channel bases, as 1012 // per level(). The given colors allows you to specify different level 1013 // ranges for each of the color channels separately. 1014 void levelColors(const Color &blackColor_,const Color &whiteColor_, 1015 const bool invert_=true); 1016 void levelColorsChannel(const ChannelType channel_, 1017 const Color &blackColor_,const Color &whiteColor_, 1018 const bool invert_=true); 1019 1020 // Discards any pixels below the black point and above the white point and 1021 // levels the remaining pixels. 1022 void linearStretch(const double blackPoint_,const double whitePoint_); 1023 1024 // Rescales image with seam carving. 1025 void liquidRescale(const Geometry &geometry_); 1026 1027 // Magnify image by integral size 1028 void magnify(void); 1029 1030 // Remap image colors with closest color from reference image 1031 void map(const Image &mapImage_,const bool dither_=false); 1032 1033 // Filter image by replacing each pixel component with the median 1034 // color in a circular neighborhood 1035 void medianFilter(const double radius_=0.0); 1036 1037 // Reduce image by integral size 1038 void minify(void); 1039 1040 // Modulate percent hue, saturation, and brightness of an image 1041 void modulate(const double brightness_,const double saturation_, 1042 const double hue_); 1043 1044 // Returns the normalized moments of one or more image channels. 1045 ImageMoments moments(void) const; 1046 1047 // Applies a kernel to the image according to the given mophology method. 1048 void morphology(const MorphologyMethod method_,const std::string kernel_, 1049 const ssize_t iterations_=1); 1050 void morphology(const MorphologyMethod method_, 1051 const KernelInfoType kernel_,const std::string arguments_, 1052 const ssize_t iterations_=1); 1053 void morphologyChannel(const ChannelType channel_, 1054 const MorphologyMethod method_,const std::string kernel_, 1055 const ssize_t iterations_=1); 1056 void morphologyChannel(const ChannelType channel_, 1057 const MorphologyMethod method_,const KernelInfoType kernel_, 1058 const std::string arguments_,const ssize_t iterations_=1); 1059 1060 // Motion blur image with specified blur factor 1061 // The radius_ parameter specifies the radius of the Gaussian, in 1062 // pixels, not counting the center pixel. The sigma_ parameter 1063 // specifies the standard deviation of the Laplacian, in pixels. 1064 // The angle_ parameter specifies the angle the object appears 1065 // to be comming from (zero degrees is from the right). 1066 void motionBlur(const double radius_,const double sigma_, 1067 const double angle_); 1068 1069 // Negate colors in image. Set grayscale to only negate grayscale 1070 // values in image. 1071 void negate(const bool grayscale_=false); 1072 void negateChannel(const ChannelType channel_,const bool grayscale_=false); 1073 1074 // Normalize image (increase contrast by normalizing the pixel 1075 // values to span the full range of color values) 1076 void normalize(void); 1077 1078 // Oilpaint image (image looks like oil painting) 1079 void oilPaint(const double radius_=0.0,const double sigma=1.0); 1080 1081 // Change color of opaque pixel to specified pen color. 1082 void opaque(const Color &opaqueColor_,const Color &penColor_, 1083 const bool invert_=false); 1084 1085 // Perform a ordered dither based on a number of pre-defined dithering 1086 // threshold maps, but over multiple intensity levels. 1087 void orderedDither(std::string thresholdMap_); 1088 void orderedDitherChannel(const ChannelType channel_, 1089 std::string thresholdMap_); 1090 1091 // Set each pixel whose value is less than epsilon to epsilon or 1092 // -epsilon (whichever is closer) otherwise the pixel value remains 1093 // unchanged. 1094 void perceptible(const double epsilon_); 1095 void perceptibleChannel(const ChannelType channel_,const double epsilon_); 1096 1097 // Returns the perceptual hash for this image. 1098 Magick::ImagePerceptualHash perceptualHash() const; 1099 1100 // Ping is similar to read except only enough of the image is read 1101 // to determine the image columns, rows, and filesize. Access the 1102 // columns(), rows(), and fileSize() attributes after invoking 1103 // ping. The image data is not valid after calling ping. 1104 void ping(const std::string &imageSpec_); 1105 1106 // Ping is similar to read except only enough of the image is read 1107 // to determine the image columns, rows, and filesize. Access the 1108 // columns(), rows(), and fileSize() attributes after invoking 1109 // ping. The image data is not valid after calling ping. 1110 void ping(const Blob &blob_); 1111 1112 // Get/set pixel color at location x & y. 1113 void pixelColor(const ::ssize_t x_,const ::ssize_t y_,const Color &color_); 1114 Color pixelColor(const ::ssize_t x_,const ::ssize_t y_ ) const; 1115 1116 // Simulates a Polaroid picture. 1117 void polaroid(const std::string &caption_,const double angle_, 1118 const PixelInterpolateMethod method_); 1119 1120 // Reduces the image to a limited number of colors for a "poster" effect. 1121 void posterize(const size_t levels_,const DitherMethod method_); 1122 void posterizeChannel(const ChannelType channel_,const size_t levels_, 1123 const DitherMethod method_); 1124 1125 // Execute a named process module using an argc/argv syntax similar to 1126 // that accepted by a C 'main' routine. An exception is thrown if the 1127 // requested process module doesn't exist, fails to load, or fails during 1128 // execution. 1129 void process(std::string name_,const ::ssize_t argc_,const char **argv_); 1130 1131 // Add or remove a named profile to/from the image. Remove the 1132 // profile by passing an empty Blob (e.g. Blob()). Valid names are 1133 // "*", "8BIM", "ICM", "IPTC", or a user/format-defined profile name. 1134 void profile(const std::string name_,const Blob &colorProfile_); 1135 1136 // Retrieve a named profile from the image. Valid names are: 1137 // "8BIM", "8BIMTEXT", "APP1", "APP1JPEG", "ICC", "ICM", & "IPTC" 1138 // or an existing user/format-defined profile name. 1139 Blob profile(const std::string name_) const; 1140 1141 // Quantize image (reduce number of colors) 1142 void quantize(const bool measureError_=false); 1143 1144 void quantumOperator(const ChannelType channel_, 1145 const MagickEvaluateOperator operator_,double rvalue_); 1146 1147 void quantumOperator(const ::ssize_t x_,const ::ssize_t y_, 1148 const size_t columns_,const size_t rows_,const ChannelType channel_, 1149 const MagickEvaluateOperator operator_,const double rvalue_); 1150 1151 // Raise image (lighten or darken the edges of an image to give a 1152 // 3-D raised or lowered effect) 1153 void raise(const Geometry &geometry_=raiseGeometryDefault, 1154 const bool raisedFlag_=false); 1155 1156 // Random threshold image. 1157 // 1158 // Changes the value of individual pixels based on the intensity 1159 // of each pixel compared to a random threshold. The result is a 1160 // low-contrast, two color image. The thresholds_ argument is a 1161 // geometry containing LOWxHIGH thresholds. If the string 1162 // contains 2x2, 3x3, or 4x4, then an ordered dither of order 2, 1163 // 3, or 4 will be performed instead. If a channel_ argument is 1164 // specified then only the specified channel is altered. This is 1165 // a very fast alternative to 'quantize' based dithering. 1166 void randomThreshold(const Geometry &thresholds_); 1167 void randomThresholdChannel(const ChannelType channel_, 1168 const Geometry &thresholds_); 1169 1170 // Read single image frame from in-memory BLOB 1171 void read(const Blob &blob_); 1172 1173 // Read single image frame of specified size from in-memory BLOB 1174 void read(const Blob &blob_,const Geometry &size_); 1175 1176 // Read single image frame of specified size and depth from 1177 // in-memory BLOB 1178 void read(const Blob &blob_,const Geometry &size_,const size_t depth_); 1179 1180 // Read single image frame of specified size, depth, and format 1181 // from in-memory BLOB 1182 void read(const Blob &blob_,const Geometry &size_,const size_t depth_, 1183 const std::string &magick_); 1184 1185 // Read single image frame of specified size, and format from 1186 // in-memory BLOB 1187 void read(const Blob &blob_,const Geometry &size_, 1188 const std::string &magick_); 1189 1190 // Read single image frame of specified size into current object 1191 void read(const Geometry &size_,const std::string &imageSpec_); 1192 1193 // Read single image frame from an array of raw pixels, with 1194 // specified storage type (ConstituteImage), e.g. 1195 // image.read( 640, 480, "RGB", 0, pixels ); 1196 void read(const size_t width_,const size_t height_,const std::string &map_, 1197 const StorageType type_,const void *pixels_); 1198 1199 // Read single image frame into current object 1200 void read(const std::string &imageSpec_); 1201 1202 // Transfers one or more pixel components from a buffer or file 1203 // into the image pixel cache of an image. 1204 // Used to support image decoders. 1205 void readPixels(const QuantumType quantum_,const unsigned char *source_); 1206 1207 // Reduce noise in image using a noise peak elimination filter 1208 void reduceNoise(void); 1209 void reduceNoise(const size_t order_); 1210 1211 // Resets the image page canvas and position. 1212 void repage(); 1213 1214 // Resize image in terms of its pixel size. 1215 void resample(const Point &density_); 1216 1217 // Resize image to specified size. 1218 void resize(const Geometry &geometry_); 1219 1220 // Roll image (rolls image vertically and horizontally) by specified 1221 // number of columnms and rows) 1222 void roll(const Geometry &roll_); 1223 void roll(const size_t columns_,const size_t rows_); 1224 1225 // Rotate image counter-clockwise by specified number of degrees. 1226 void rotate(const double degrees_); 1227 1228 // Rotational blur image. 1229 void rotationalBlur(const double angle_); 1230 void rotationalBlurChannel(const ChannelType channel_,const double angle_); 1231 1232 // Resize image by using pixel sampling algorithm 1233 void sample(const Geometry &geometry_); 1234 1235 // Resize image by using simple ratio algorithm 1236 void scale(const Geometry &geometry_); 1237 1238 // Segment (coalesce similar image components) by analyzing the 1239 // histograms of the color components and identifying units that 1240 // are homogeneous with the fuzzy c-means technique. Also uses 1241 // QuantizeColorSpace and Verbose image attributes 1242 void segment(const double clusterThreshold_=1.0, 1243 const double smoothingThreshold_=1.5); 1244 1245 // Selectively blur pixels within a contrast threshold. It is similar to 1246 // the unsharpen mask that sharpens everything with contrast above a 1247 // certain threshold. 1248 void selectiveBlur(const double radius_,const double sigma_, 1249 const double threshold_); 1250 void selectiveBlurChannel(const ChannelType channel_,const double radius_, 1251 const double sigma_,const double threshold_); 1252 1253 // Separates a channel from the image and returns it as a grayscale image. 1254 Image separate(const ChannelType channel_) const; 1255 1256 // Applies a special effect to the image, similar to the effect achieved in 1257 // a photo darkroom by sepia toning. Threshold ranges from 0 to 1258 // QuantumRange and is a measure of the extent of the sepia toning. 1259 // A threshold of 80% is a good starting point for a reasonable tone. 1260 void sepiaTone(const double threshold_); 1261 1262 // Allocates a pixel cache region to store image pixels as defined 1263 // by the region rectangle. This area is subsequently transferred 1264 // from the pixel cache to the image via syncPixels. 1265 Quantum *setPixels(const ::ssize_t x_, const ::ssize_t y_, 1266 const size_t columns_,const size_t rows_); 1267 1268 // Shade image using distant light source 1269 void shade(const double azimuth_=30,const double elevation_=30, 1270 const bool colorShading_=false); 1271 1272 // Simulate an image shadow 1273 void shadow(const double percentAlpha_=80.0,const double sigma_=0.5, 1274 const ssize_t x_=5,const ssize_t y_=5); 1275 1276 // Sharpen pixels in image 1277 // The radius_ parameter specifies the radius of the Gaussian, in 1278 // pixels, not counting the center pixel. The sigma_ parameter 1279 // specifies the standard deviation of the Laplacian, in pixels. 1280 void sharpen(const double radius_=0.0,const double sigma_=1.0); 1281 void sharpenChannel(const ChannelType channel_,const double radius_=0.0, 1282 const double sigma_=1.0); 1283 1284 // Shave pixels from image edges. 1285 void shave(const Geometry &geometry_); 1286 1287 // Shear image (create parallelogram by sliding image by X or Y axis) 1288 void shear(const double xShearAngle_,const double yShearAngle_); 1289 1290 // adjust the image contrast with a non-linear sigmoidal contrast algorithm 1291 void sigmoidalContrast(const bool sharpen_,const double contrast, 1292 const double midpoint=QuantumRange/2.0); 1293 1294 // Image signature. Set force_ to true in order to re-calculate 1295 // the signature regardless of whether the image data has been 1296 // modified. 1297 std::string signature(const bool force_=false) const; 1298 1299 // Simulates a pencil sketch. We convolve the image with a Gaussian 1300 // operator of the given radius and standard deviation (sigma). For 1301 // reasonable results, radius should be larger than sigma. Use a 1302 // radius of 0 and SketchImage() selects a suitable radius for you. 1303 void sketch(const double radius_=0.0,const double sigma_=1.0, 1304 const double angle_=0.0); 1305 1306 // Solarize image (similar to effect seen when exposing a 1307 // photographic film to light during the development process) 1308 void solarize(const double factor_=50.0); 1309 1310 // Sparse color image, given a set of coordinates, interpolates the colors 1311 // found at those coordinates, across the whole image, using various 1312 // methods. 1313 void sparseColor(const ChannelType channel_, 1314 const SparseColorMethod method_,const size_t numberArguments_, 1315 const double *arguments_); 1316 1317 // Splice the background color into the image. 1318 void splice(const Geometry &geometry_); 1319 void splice(const Geometry &geometry_,const Color &backgroundColor_); 1320 void splice(const Geometry &geometry_,const Color &backgroundColor_, 1321 const GravityType gravity_); 1322 1323 // Spread pixels randomly within image by specified ammount 1324 void spread(const size_t amount_=3); 1325 1326 // Returns the statistics for this image. 1327 Magick::ImageStatistics statistics() const; 1328 1329 // Add a digital watermark to the image (based on second image) 1330 void stegano(const Image &watermark_); 1331 1332 // Create an image which appears in stereo when viewed with 1333 // red-blue glasses (Red image on left, blue on right) 1334 void stereo(const Image &rightImage_); 1335 1336 // Strip strips an image of all profiles and comments. 1337 void strip(void); 1338 1339 // Search for the specified image at EVERY possible location in this image. 1340 // This is slow! very very slow.. It returns a similarity image such that 1341 // an exact match location is completely white and if none of the pixels 1342 // match, black, otherwise some gray level in-between. 1343 Image subImageSearch(const Image &reference_,const MetricType metric_, 1344 Geometry *offset_,double *similarityMetric_, 1345 const double similarityThreshold=(-1.0)); 1346 1347 // Swirl image (image pixels are rotated by degrees) 1348 void swirl(const double degrees_); 1349 1350 // Transfers the image cache pixels to the image. 1351 void syncPixels(void); 1352 1353 // Channel a texture on image background 1354 void texture(const Image &texture_); 1355 1356 // Threshold image 1357 void threshold(const double threshold_); 1358 1359 // Resize image to thumbnail size 1360 void thumbnail(const Geometry &geometry_); 1361 1362 // Applies a color vector to each pixel in the image. The length of the 1363 // vector is 0 for black and white and at its maximum for the midtones. 1364 // The vector weighting function is f(x)=(1-(4.0*((x-0.5)*(x-0.5)))) 1365 void tint(const std::string opacity_); 1366 1367 // Transform image based on image and crop geometries 1368 // Crop geometry is optional 1369 void transform(const Geometry &imageGeometry_); 1370 void transform(const Geometry &imageGeometry_, 1371 const Geometry &cropGeometry_); 1372 1373 // Origin of coordinate system to use when annotating with text or drawing 1374 void transformOrigin(const double x_,const double y_); 1375 1376 // Reset transformation parameters to default 1377 void transformReset(void); 1378 1379 // Scale to use when annotating with text or drawing 1380 void transformScale(const double sx_,const double sy_); 1381 1382 // Add matte image to image, setting pixels matching color to 1383 // transparent 1384 void transparent(const Color &color_); 1385 1386 // Add matte image to image, for all the pixels that lies in between 1387 // the given two color 1388 void transparentChroma(const Color &colorLow_,const Color &colorHigh_); 1389 1390 // Creates a horizontal mirror image by reflecting the pixels around the 1391 // central y-axis while rotating them by 90 degrees. 1392 void transpose(void); 1393 1394 // Creates a vertical mirror image by reflecting the pixels around the 1395 // central x-axis while rotating them by 270 degrees. 1396 void transverse(void); 1397 1398 // Trim edges that are the background color from the image 1399 void trim(void); 1400 1401 // Returns the unique colors of an image. 1402 Image uniqueColors(void) const; 1403 1404 // Replace image with a sharpened version of the original image 1405 // using the unsharp mask algorithm. 1406 // radius_ 1407 // the radius of the Gaussian, in pixels, not counting the 1408 // center pixel. 1409 // sigma_ 1410 // the standard deviation of the Gaussian, in pixels. 1411 // amount_ 1412 // the percentage of the difference between the original and 1413 // the blur image that is added back into the original. 1414 // threshold_ 1415 // the threshold in pixels needed to apply the diffence amount. 1416 void unsharpmask(const double radius_,const double sigma_, 1417 const double amount_,const double threshold_); 1418 void unsharpmaskChannel(const ChannelType channel_,const double radius_, 1419 const double sigma_,const double amount_,const double threshold_); 1420 1421 // Softens the edges of the image in vignette style. 1422 void vignette(const double radius_=0.0,const double sigma_=1.0, 1423 const ssize_t x_=0,const ssize_t y_=0); 1424 1425 // Map image pixels to a sine wave 1426 void wave(const double amplitude_=25.0,const double wavelength_=150.0); 1427 1428 // Forces all pixels above the threshold into white while leaving all 1429 // pixels at or below the threshold unchanged. 1430 void whiteThreshold(const std::string &threshold_); 1431 void whiteThresholdChannel(const ChannelType channel_, 1432 const std::string &threshold_); 1433 1434 // Write single image frame to in-memory BLOB, with optional 1435 // format and adjoin parameters. 1436 void write(Blob *blob_); 1437 void write(Blob *blob_,const std::string &magick_); 1438 void write(Blob *blob_,const std::string &magick_,const size_t depth_); 1439 1440 // Write single image frame to an array of pixels with storage 1441 // type specified by user (DispatchImage), e.g. 1442 // image.write( 0, 0, 640, 1, "RGB", 0, pixels ); 1443 void write(const ::ssize_t x_,const ::ssize_t y_,const size_t columns_, 1444 const size_t rows_,const std::string &map_,const StorageType type_, 1445 void *pixels_); 1446 1447 // Write single image frame to a file 1448 void write(const std::string &imageSpec_); 1449 1450 // Transfers one or more pixel components from the image pixel 1451 // cache to a buffer or file. 1452 // Used to support image encoders. 1453 void writePixels(const QuantumType quantum_,unsigned char *destination_); 1454 1455 // Zoom image to specified size. 1456 void zoom(const Geometry &geometry_); 1457 1458 ////////////////////////////////////////////////////////////////////// 1459 // 1460 // No user-serviceable parts beyond this point 1461 // 1462 ////////////////////////////////////////////////////////////////////// 1463 1464 // Construct with MagickCore::Image and default options 1465 Image(MagickCore::Image *image_); 1466 1467 // Retrieve Image* 1468 MagickCore::Image *&image(void); 1469 const MagickCore::Image *constImage(void) const; 1470 1471 // Retrieve ImageInfo* 1472 MagickCore::ImageInfo *imageInfo(void); 1473 const MagickCore::ImageInfo *constImageInfo(void) const; 1474 1475 // Retrieve Options* 1476 Options *options(void); 1477 const Options *constOptions(void) const; 1478 1479 // Retrieve QuantizeInfo* 1480 MagickCore::QuantizeInfo *quantizeInfo(void); 1481 const MagickCore::QuantizeInfo *constQuantizeInfo(void) const; 1482 1483 // Prepare to update image (copy if reference > 1) 1484 void modifyImage(void); 1485 1486 // Replace current image (reference counted) 1487 MagickCore::Image *replaceImage(MagickCore::Image *replacement_); 1488 1489 private: 1490 1491 void read(MagickCore::Image *image, 1492 MagickCore::ExceptionInfo *exceptionInfo); 1493 1494 void floodFill(const ssize_t x_,const ssize_t y_, 1495 const Magick::Image *fillPattern_,const Color &fill_, 1496 const PixelInfo *target,const bool invert_); 1497 1498 ImageRef *_imgRef; 1499 }; 1500 1501} // end of namespace Magick 1502 1503#endif // Magick_Image_header 1504