Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 751980dac8acbf24b155ae0d3b45fdf4c452f55c / . / www / api / histogram.html
blob: 5153926e0efe26b2ee27ebcbaf2e9644eac5dc7f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html version="-//W3C//DTD XHTML 1.1//EN"
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/1999/xhtml
http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
<title>ImageMagick: MagickCore, C API for ImageMagick: Image Histograms</title>
<meta http-equiv="content-language" content="en-US"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
<meta name="application-name" content="ImageMagick"/>
<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 automagically."/>
<meta name="application-url" content="http://www.imagemagick.org"/>
<meta name="generator" content="PHP"/>
<meta name="keywords" content="magickcore, c, api, for, imagemagick:, image, histograms, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
<meta name="rating" content="GENERAL"/>
<meta name="robots" content="INDEX, FOLLOW"/>
<meta name="generator" content="ImageMagick Studio LLC"/>
<meta name="author" content="ImageMagick Studio LLC"/>
<meta name="revisit-after" content="2 DAYS"/>
<meta name="resource-type" content="document"/>
<meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
<meta name="distribution" content="Global"/>
<link rel="icon" href="../../../../../../../../../../../../../../../../images/wand.png"/>
<link rel="shortcut icon" href="../../../../../../../../../../../../../../../../images/wand.ico" type="images/x-icon"/>
<link rel="canonical" href="http://www.imagemagick.org" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
<!-- Add jQuery library -->
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
<!-- Optionaly include easing and/or mousewheel plugins -->
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
<!-- Add fancyBox -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
<!-- Optionaly include button and/or thumbnail helpers -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
<script type="text/javascript">
$(document).ready(function() {
$(".fancybox").fancybox();
});
</script>
<!-- ImageMagick style -->
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
<style type="text/css" media="all">
@import url("../../../../../../../../../../../../../../../../www/magick.css");
</style>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<div style="margin: 17px auto; float: left;">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "5439289906";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</div>
<a href="../../../../../../../../../../../../../../../../discourse-server">
<img src="../../../../../../../../../../../../../../../../images/logo.jpg"
alt="ImageMagick Logo"
style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../../../../../../../../../../../../../../../index.html">
<img src="../../../../../../../../../../../../../../../../images/sprite.jpg"
alt="ImageMagick Sprite"
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="westbar">
<div class="menu">
<a title="About ImageMagick" href="../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
</div>
<div class="menu">
<a title="Binary Releases" href="../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="../../../../../../../../../../../../../../../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="../../../../../../../../../../../../../../../../www/search.html">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map" href="../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links" href="../../../../../../../../../../../../../../../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
<a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
<a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
<div class="sponsbox">
<div class="sponsor">
<a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
</div>
<div class="sponsor">
<a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
</div>
<div class="sponsor">
<a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
</div>
<div class="sponsor">
<a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Kaffeemaschinen reparatur" href="http://www.kaffeemaschinen-reparatur.de">Kaffeemaschinen reparatur</a><!-- 2012080100030 Temurbas atlas-multimedia-->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2012080100030 atlas-multimedia-->
</div>
</div>
</div>
</div>
<div class="eastbar">
<div class="g-plusone" id="gplusone"></div>
<script type="text/javascript">
window.___gcfg = {
lang: 'en-US'
};
(function() {
var po = document.createElement('script');
po.type = 'text/javascript'; po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var script = document.getElementsByTagName('script')[0];
script.parentNode.insertBefore(po, script);
})();
var gplusone = document.getElementById("gplusone");
gplusone.setAttribute("data-size","medium");
gplusone.setAttribute("data-count","false");
</script>
</div>
<div class="main">
<h1>Module histogram Methods</h1>
<p class="navigation-index">[<a href="histogram.html#GetImageHistogram">GetImageHistogram</a> &bull; <a href="histogram.html#IsHistogramImage">IsHistogramImage</a> &bull; <a href="histogram.html#IsPaletteImage">IsPaletteImage</a> &bull; <a href="histogram.html#MinMaxStretchImage">MinMaxStretchImage</a> &bull; <a href="histogram.html#GetNumberColors">GetNumberColors</a> &bull; <a href="histogram.html#UniqueImageColors">UniqueImageColors</a>]</p>
<h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="GetImageHistogram">GetImageHistogram</a></h2>
<div class="doc-section">
<p>GetImageHistogram() returns the unique colors in an image.</p>
<p>The format of the GetImageHistogram method is:</p>
<pre class="code">
size_t GetImageHistogram(const Image *image,
size_t *number_colors,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p>
<h5>image</h5>
<p>the image.</p>
<h5>file</h5>
<p>Write a histogram of the color distribution to this file handle.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="IsHistogramImage">IsHistogramImage</a></h2>
<div class="doc-section">
<p>IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.</p>
<p>The format of the IsHistogramImage method is:</p>
<pre class="code">
MagickBooleanType IsHistogramImage(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p>
<h5>image</h5>
<p>the image.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="IsPaletteImage">IsPaletteImage</a></h2>
<div class="doc-section">
<p>IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.</p>
<p>The format of the IsPaletteImage method is:</p>
<pre class="code">
MagickBooleanType IsPaletteImage(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p>
<h5>image</h5>
<p>the image.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="MinMaxStretchImage">MinMaxStretchImage</a></h2>
<div class="doc-section">
<p>MinMaxStretchImage() uses the exact minimum and maximum values found in each of the channels given, as the BlackPoint and WhitePoint to linearly stretch the colors (and histogram) of the image. The stretch points are also moved further inward by the adjustment values given.</p>
<p>If the adjustment values are both zero this function is equivalent to a perfect normalization (or autolevel) of the image.</p>
<p>Each channel is stretched independantally of each other (producing color distortion) unless the special 'SyncChannels' flag is also provided in the channels setting. If this flag is present the minimum and maximum point will be extracted from all the given channels, and those channels will be stretched by exactly the same amount (preventing color distortion).</p>
<p>In the special case that only ONE value is found in a channel of the image that value is not stretched, that value is left as is.</p>
<p>The 'SyncChannels' is turned on in the 'DefaultChannels' setting by default.</p>
<p>The format of the MinMaxStretchImage method is:</p>
<pre class="code">
MagickBooleanType MinMaxStretchImage(Image *image,
const ChannelType channel, const double black_adjust,
const double white_adjust)
</pre>
<p>A description of each parameter follows:</p>
<h5>image</h5>
<p>The image to auto-level</p>
<h5>channel</h5>
<p>The channels to auto-level. If the special 'SyncChannels' flag is set, all the given channels are stretched by the same amount.</p>
<h5>black_adjust, white_adjust</h5>
<p>Move the Black/White Point inward from the minimum and maximum points by this color value.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="GetNumberColors">GetNumberColors</a></h2>
<div class="doc-section">
<p>GetNumberColors() returns the number of unique colors in an image.</p>
<p>The format of the GetNumberColors method is:</p>
<pre class="code">
size_t GetNumberColors(const Image *image,FILE *file,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p>
<h5>image</h5>
<p>the image.</p>
<h5>file</h5>
<p>Write a histogram of the color distribution to this file handle.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="UniqueImageColors">UniqueImageColors</a></h2>
<div class="doc-section">
<p>UniqueImageColors() returns the unique colors of an image.</p>
<p>The format of the UniqueImageColors method is:</p>
<pre class="code">
Image *UniqueImageColors(const Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows.</p>
<h5>image</h5>
<p>the image.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
</div>
<div id="linkbar">
<span id="linkbar-west">&nbsp;</span>
<span id="linkbar-center">
<a href="../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east">&nbsp;</span>
</div>
<div class="footer">
<span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-17690367-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>