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