granicus.if.org Git - imagemagick/blob - www/api/profile.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Profiles</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Application-name" content="ImageMagick"/>
  16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, image, profiles, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <a href="../../index.html">\r
  53   <img src="../../images/script.png" alt="[ImageMagick]"\r
  54   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  55 <a href="http://www.networkredux.com">\r
  56   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  57   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
  58 <a href="http://www.imagemagick.org/discourse-server/">\r
  59   <img src="../../images/logo.jpg"\r
  60   alt="ImageMagick Logo"\r
  61   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  62 <a href="../../index.html">\r
  63   <img src="../../images/sprite.jpg"\r
  64   alt="ImageMagick Sprite"\r
  65   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  66 </div>\r
  67 \r
  68 <div class="westbar">\r
  69 \r
  70 <div class="menu">
  71   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  72 </div>
  73 <div class="sep"></div>\r
  74 <div class="menu">
  75   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  76 </div>
  77 <div class="sub">
  78     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  79 </div>
  80 <div class="sub">
  81     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  88 </div>
  89 <div class="sep"></div>\r
  90 <div class="menu">
  91   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  95 </div>
  96 <div class="sub">
  97     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 101 </div>
 102 <div class="menu">
 103   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 104 </div>
 105 <div class="sub">
 106     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 107 </div>
 108 <div class="sub">
 109     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div  class="menu">
 119    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 123 </div>
 124 <div class="sub">
 125     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 126  </div>
 127 <div class="menu">
 128   <a title="Resources" href="../../www/resources.html">Resources</a>
 129 </div>
 130 <div class="menu">
 131   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 132 </div>
 133 <div class="menu">
 134   <a title="Download" href="../../www/download.html">Download</a>
 135 </div>
 136 <div class="sep"></div>\r
 137 <div class="menu">
 138   <a title="Search" href="../../www/search.html">Search</a>
 139 </div>
 140 <div class="sep"></div>\r
 141 <div class="menu">
 142   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 143 </div>
 144 <div  class="sub">
 145   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div  class="menu">
 149   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 150
 151 <div class="sponsbox">
 152 <div  class="sponsor">
 153   <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 154 </div>
 155 <div  class="sponsor">
 156   <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
 157 </div>
 158 <div  class="sponsor">
 159   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
 160 </div>
 161 <div  class="sponsor">
 162   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 163 </div>
 164 <div  class="sponsor">
 165   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 166 </div>
 167 <div  class="sponsor">
 168   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 169 </div>
 170 <div class="sponsor">
 171   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
 172 </div>
 173 <div  class="sponsor">
 174   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 175 </div>
 176 <div  class="sponsor">
 177    <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011060100025 atlas.multimedia-->
 178 </div>
 179 </div>
 180 </div>
 181 </div>\r
 182 \r
 183 <div class="eastbar">\r
 184   <script type="text/javascript">\r
 185   <!--\r
 186     google_ad_client = "pub-3129977114552745";\r
 187     google_ad_slot = "0574824969";\r
 188     google_ad_width = 160;\r
 189     google_ad_height = 600;\r
 190   //-->\r
 191   </script>\r
 192   <script type="text/javascript"\r
 193     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 194   </script>\r
 195 </div>\r
 196 \r
 197 <div class="main">\r
 198 \r
 199 <h1>Module profile Methods</h1>
 200 <p class="navigation-index">[<a href="#CloneImageProfiles">CloneImageProfiles</a> &bull; <a href="#DeleteImageProfile">DeleteImageProfile</a> &bull; <a href="#DestroyImageProfiles">DestroyImageProfiles</a> &bull; <a href="#GetImageProfile">GetImageProfile</a> &bull; <a href="#GetNextImageProfile">GetNextImageProfile</a> &bull; <a href="#ProfileImage">ProfileImage</a> &bull; <a href="#RemoveImageProfile">RemoveImageProfile</a> &bull; <a href="#ResetImageProfileIterator">ResetImageProfileIterator</a> &bull; <a href="#SetImageProfile">SetImageProfile</a> &bull; <a href="#SyncImageProfiles">SyncImageProfiles</a>]</p>
 201
 202 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="CloneImageProfiles">CloneImageProfiles</a></h2>
 203 <div class="doc-section">
 204
 205 <p>CloneImageProfiles() clones one or more image profiles.</p>
 206
 207 <p>The format of the CloneImageProfiles method is:</p>
 208
 209 <pre class="code">
 210   MagickBooleanType CloneImageProfiles(Image *image,
 211     const Image *clone_image)
 212 </pre>
 213
 214 <p>A description of each parameter follows:</p>
 215
 216 <h5>image</h5>
 217 <p>the image.</p>
 218
 219 <h5>clone_image</h5>
 220 <p>the clone image.</p>
 221
 222  </div>
 223 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="DeleteImageProfile">DeleteImageProfile</a></h2>
 224 <div class="doc-section">
 225
 226 <p>DeleteImageProfile() deletes a profile from the image by its name.</p>
 227
 228 <p>The format of the DeleteImageProfile method is:</p>
 229
 230 <pre class="code">
 231   MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
 232 </pre>
 233
 234 <p>A description of each parameter follows:</p>
 235
 236 <h5>image</h5>
 237 <p>the image.</p>
 238
 239 <h5>name</h5>
 240 <p>the profile name.</p>
 241
 242  </div>
 243 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="DestroyImageProfiles">DestroyImageProfiles</a></h2>
 244 <div class="doc-section">
 245
 246 <p>DestroyImageProfiles() releases memory associated with an image profile map.</p>
 247
 248 <p>The format of the DestroyProfiles method is:</p>
 249
 250 <pre class="code">
 251   void DestroyImageProfiles(Image *image)
 252 </pre>
 253
 254 <p>A description of each parameter follows:</p>
 255
 256 <h5>image</h5>
 257 <p>the image.</p>
 258
 259  </div>
 260 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="GetImageProfile">GetImageProfile</a></h2>
 261 <div class="doc-section">
 262
 263 <p>GetImageProfile() gets a profile associated with an image by name.</p>
 264
 265 <p>The format of the GetImageProfile method is:</p>
 266
 267 <pre class="code">
 268   const StringInfo *GetImageProfile(const Image *image,const char *name)
 269 </pre>
 270
 271 <p>A description of each parameter follows:</p>
 272
 273 <h5>image</h5>
 274 <p>the image.</p>
 275
 276 <h5>name</h5>
 277 <p>the profile name.</p>
 278
 279  </div>
 280 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="GetNextImageProfile">GetNextImageProfile</a></h2>
 281 <div class="doc-section">
 282
 283 <p>GetNextImageProfile() gets the next profile name for an image.</p>
 284
 285 <p>The format of the GetNextImageProfile method is:</p>
 286
 287 <pre class="code">
 288   char *GetNextImageProfile(const Image *image)
 289 </pre>
 290
 291 <p>A description of each parameter follows:</p>
 292
 293 <h5>hash_info</h5>
 294 <p>the hash info.</p>
 295
 296  </div>
 297 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="ProfileImage">ProfileImage</a></h2>
 298 <div class="doc-section">
 299
 300 <p>ProfileImage() associates, applies, or removes an ICM, IPTC, or generic profile with / to / from an image.  If the profile is NULL, it is removed from the image otherwise added or applied.  Use a name of '*' and a profile of NULL to remove all profiles from the image.</p>
 301
 302 <p>ICC and ICM profiles are handled as follows: If the image does not have an associated color profile, the one you provide is associated with the image and the image pixels are not transformed.  Otherwise, the colorspace transform defined by the existing and new profile are applied to the image pixels and the new profile is associated with the image.</p>
 303
 304 <p>The format of the ProfileImage method is:</p>
 305
 306 <pre class="code">
 307   MagickBooleanType ProfileImage(Image *image,const char *name,
 308     const void *datum,const size_t length,const MagickBooleanType clone)
 309 </pre>
 310
 311 <p>A description of each parameter follows:</p>
 312
 313 <h5>image</h5>
 314 <p>the image.</p>
 315
 316 <h5>name</h5>
 317 <p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p>
 318
 319 <h5>datum</h5>
 320 <p>the profile data.</p>
 321
 322 <h5>length</h5>
 323 <p>the length of the profile.</p>
 324
 325 <h5>clone</h5>
 326 <p>should be MagickFalse.</p>
 327
 328  </div>
 329 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="RemoveImageProfile">RemoveImageProfile</a></h2>
 330 <div class="doc-section">
 331
 332 <p>RemoveImageProfile() removes a named profile from the image and returns its value.</p>
 333
 334 <p>The format of the RemoveImageProfile method is:</p>
 335
 336 <pre class="code">
 337   void *RemoveImageProfile(Image *image,const char *name)
 338 </pre>
 339
 340 <p>A description of each parameter follows:</p>
 341
 342 <h5>image</h5>
 343 <p>the image.</p>
 344
 345 <h5>name</h5>
 346 <p>the profile name.</p>
 347
 348  </div>
 349 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
 350 <div class="doc-section">
 351
 352 <p>ResetImageProfileIterator() resets the image profile iterator.  Use it in conjunction with GetNextImageProfile() to iterate over all the profiles associated with an image.</p>
 353
 354 <p>The format of the ResetImageProfileIterator method is:</p>
 355
 356 <pre class="code">
 357   ResetImageProfileIterator(Image *image)
 358 </pre>
 359
 360 <p>A description of each parameter follows:</p>
 361
 362 <h5>image</h5>
 363 <p>the image.</p>
 364
 365  </div>
 366 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="SetImageProfile">SetImageProfile</a></h2>
 367 <div class="doc-section">
 368
 369 <p>SetImageProfile() adds a named profile to the image.  If a profile with the same name already exists, it is replaced.  This method differs from the ProfileImage() method in that it does not apply CMS color profiles.</p>
 370
 371 <p>The format of the SetImageProfile method is:</p>
 372
 373 <pre class="code">
 374   MagickBooleanType SetImageProfile(Image *image,const char *name,
 375     const StringInfo *profile)
 376 </pre>
 377
 378 <p>A description of each parameter follows:</p>
 379
 380 <h5>image</h5>
 381 <p>the image.</p>
 382
 383 <h5>name</h5>
 384 <p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p>
 385
 386 <h5>profile</h5>
 387 <p>A StringInfo structure that contains the named profile.</p>
 388
 389  </div>
 390 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="SyncImageProfiles">SyncImageProfiles</a></h2>
 391 <div class="doc-section">
 392
 393 <p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p>
 394
 395 <p>The format of the SyncImageProfiles method is:</p>
 396
 397 <pre class="code">
 398   MagickBooleanType SyncImageProfiles(Image *image)
 399 </pre>
 400
 401 <p>A description of each parameter follows:</p>
 402
 403 <h5>image</h5>
 404 <p>the image.</p>
 405
 406  </div>
 407 \r
 408 </div>\r
 409 \r
 410 <div id="linkbar">\r
 411     <span id="linkbar-west">&nbsp;</span>\r
 412     <span id="linkbar-center">\r
 413       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 414       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 415     </span>\r
 416     <span id="linkbar-east">&nbsp;</span>\r
 417   </div>\r
 418   <div class="footer">\r
 419     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 420     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 421   </div>\r
 422   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 423   <script type="text/javascript">\r
 424     var _gaq = _gaq || [];\r
 425     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 426     _gaq.push(['_trackPageview']);\r
 427 \r
 428     (function() {\r
 429       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 430       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 431       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 432     })();\r
 433   </script>\r
 434 </body>\r
 435 </html>\r