diff options
Diffstat (limited to 'www/api/effect.html')
| -rw-r--r-- | www/api/effect.html | 748 |
1 files changed, 374 insertions, 374 deletions
diff --git a/www/api/effect.html b/www/api/effect.html index b2d1a7a..6f03d6a 100644 --- a/www/api/effect.html +++ b/www/api/effect.html @@ -1,12 +1,14 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<!DOCTYPE html> +<html lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" /> -<title>effect</title> -<link rel="stylesheet" href="../docutils-api.css" type="text/css" /> + <meta charset="utf-8"> + <meta content="en" name="language"> + <title>effect</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet"> + </head> + <body> <div class="banner"> @@ -19,6 +21,7 @@ </form> </div> + <div class="navmenu"> <ul> <li><a href="../index.html">Home</a></li> @@ -32,50 +35,48 @@ <li><a href="../reference.html">Reference</a></li> </ul> </div> + <div class="document" id="effect"> <h1 class="title">effect</h1> -<h2 class="subtitle" id="image-effects-methods">Image effects methods</h2> - +<p class="subtitle" id="image-effects-methods">Image effects methods</p> <div class="contents topic" id="contents"> <p class="topic-title">Contents</p> <ul class="simple"> -<li><a class="reference internal" href="#adaptivethresholdimage" id="id51">AdaptiveThresholdImage</a></li> -<li><a class="reference internal" href="#addnoiseimage" id="id52">AddNoiseImage</a></li> -<li><a class="reference internal" href="#addnoiseimagechannel" id="id53">AddNoiseImageChannel</a></li> -<li><a class="reference internal" href="#blackthresholdimage" id="id54">BlackThresholdImage</a></li> -<li><a class="reference internal" href="#blurimage" id="id55">BlurImage</a></li> -<li><a class="reference internal" href="#blurimagechannel" id="id56">BlurImageChannel</a></li> -<li><a class="reference internal" href="#channelthresholdimage" id="id57">ChannelThresholdImage</a></li> -<li><a class="reference internal" href="#convolveimage" id="id58">ConvolveImage</a></li> -<li><a class="reference internal" href="#despeckleimage" id="id59">DespeckleImage</a></li> -<li><a class="reference internal" href="#edgeimage" id="id60">EdgeImage</a></li> -<li><a class="reference internal" href="#embossimage" id="id61">EmbossImage</a></li> -<li><a class="reference internal" href="#enhanceimage" id="id62">EnhanceImage</a></li> -<li><a class="reference internal" href="#gaussianblurimage" id="id63">GaussianBlurImage</a></li> -<li><a class="reference internal" href="#gaussianblurimagechannel" id="id64">GaussianBlurImageChannel</a></li> -<li><a class="reference internal" href="#medianfilterimage" id="id65">MedianFilterImage</a></li> -<li><a class="reference internal" href="#motionblurimage" id="id66">MotionBlurImage</a></li> -<li><a class="reference internal" href="#randomchannelthresholdimage" id="id67">RandomChannelThresholdImage</a></li> -<li><a class="reference internal" href="#reducenoiseimage" id="id68">ReduceNoiseImage</a></li> -<li><a class="reference internal" href="#shadeimage" id="id69">ShadeImage</a></li> -<li><a class="reference internal" href="#sharpenimage" id="id70">SharpenImage</a></li> -<li><a class="reference internal" href="#sharpenimagechannel" id="id71">SharpenImageChannel</a></li> -<li><a class="reference internal" href="#spreadimage" id="id72">SpreadImage</a></li> -<li><a class="reference internal" href="#thresholdimage" id="id73">ThresholdImage</a></li> -<li><a class="reference internal" href="#unsharpmaskimage" id="id74">UnsharpMaskImage</a></li> -<li><a class="reference internal" href="#unsharpmaskimagechannel" id="id75">UnsharpMaskImageChannel</a></li> -<li><a class="reference internal" href="#whitethresholdimage" id="id76">WhiteThresholdImage</a></li> +<li><p><a class="reference internal" href="#adaptivethresholdimage" id="id51">AdaptiveThresholdImage</a></p></li> +<li><p><a class="reference internal" href="#addnoiseimage" id="id52">AddNoiseImage</a></p></li> +<li><p><a class="reference internal" href="#addnoiseimagechannel" id="id53">AddNoiseImageChannel</a></p></li> +<li><p><a class="reference internal" href="#blackthresholdimage" id="id54">BlackThresholdImage</a></p></li> +<li><p><a class="reference internal" href="#blurimage" id="id55">BlurImage</a></p></li> +<li><p><a class="reference internal" href="#blurimagechannel" id="id56">BlurImageChannel</a></p></li> +<li><p><a class="reference internal" href="#channelthresholdimage" id="id57">ChannelThresholdImage</a></p></li> +<li><p><a class="reference internal" href="#convolveimage" id="id58">ConvolveImage</a></p></li> +<li><p><a class="reference internal" href="#despeckleimage" id="id59">DespeckleImage</a></p></li> +<li><p><a class="reference internal" href="#edgeimage" id="id60">EdgeImage</a></p></li> +<li><p><a class="reference internal" href="#embossimage" id="id61">EmbossImage</a></p></li> +<li><p><a class="reference internal" href="#enhanceimage" id="id62">EnhanceImage</a></p></li> +<li><p><a class="reference internal" href="#gaussianblurimage" id="id63">GaussianBlurImage</a></p></li> +<li><p><a class="reference internal" href="#gaussianblurimagechannel" id="id64">GaussianBlurImageChannel</a></p></li> +<li><p><a class="reference internal" href="#medianfilterimage" id="id65">MedianFilterImage</a></p></li> +<li><p><a class="reference internal" href="#motionblurimage" id="id66">MotionBlurImage</a></p></li> +<li><p><a class="reference internal" href="#randomchannelthresholdimage" id="id67">RandomChannelThresholdImage</a></p></li> +<li><p><a class="reference internal" href="#reducenoiseimage" id="id68">ReduceNoiseImage</a></p></li> +<li><p><a class="reference internal" href="#shadeimage" id="id69">ShadeImage</a></p></li> +<li><p><a class="reference internal" href="#sharpenimage" id="id70">SharpenImage</a></p></li> +<li><p><a class="reference internal" href="#sharpenimagechannel" id="id71">SharpenImageChannel</a></p></li> +<li><p><a class="reference internal" href="#spreadimage" id="id72">SpreadImage</a></p></li> +<li><p><a class="reference internal" href="#thresholdimage" id="id73">ThresholdImage</a></p></li> +<li><p><a class="reference internal" href="#unsharpmaskimage" id="id74">UnsharpMaskImage</a></p></li> +<li><p><a class="reference internal" href="#unsharpmaskimagechannel" id="id75">UnsharpMaskImageChannel</a></p></li> +<li><p><a class="reference internal" href="#whitethresholdimage" id="id76">WhiteThresholdImage</a></p></li> </ul> </div> <div class="section" id="adaptivethresholdimage"> <h1><a class="toc-backref" href="#id51">AdaptiveThresholdImage</a></h1> <div class="section" id="synopsis"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *AdaptiveThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long width, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AdaptiveThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long width, const unsigned long height, const unsigned long unsigned long, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="description"> <h2>Description</h2> @@ -84,22 +85,25 @@ based on the range of intensity values in its local neighborhood. This allows for thresholding of an image whose global intensity histogram doesn't contain distinctive peaks.</p> <p>The format of the AdaptiveThresholdImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *AdaptiveThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long width, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AdaptiveThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned long width, const unsigned long height, const unsigned long unsigned long, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>width:</dt> -<dd>The width of the local neighborhood.</dd> +<dd><p>The width of the local neighborhood.</p> +</dd> <dt>height:</dt> -<dd>The height of the local neighborhood.</dd> +<dd><p>The height of the local neighborhood.</p> +</dd> <dt>offset:</dt> -<dd>The mean offset.</dd> +<dd><p>The mean offset.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -107,27 +111,26 @@ doesn't contain distinctive peaks.</p> <h1><a class="toc-backref" href="#id52">AddNoiseImage</a></h1> <div class="section" id="id1"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *AddNoiseImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#noisetype">NoiseType</a> noise_type, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AddNoiseImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#noisetype">NoiseType</a> noise_type, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id2"> <h2>Description</h2> <p>AddNoiseImage() adds random noise to the image.</p> <p>The format of the AddNoiseImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *AddNoiseImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#noisetype">NoiseType</a> noise_type, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AddNoiseImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#noisetype">NoiseType</a> noise_type, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>noise_type:</dt> -<dd>The type of noise: Uniform, Gaussian, Multiplicative, -Impulse, Laplacian, Poisson, or Random.</dd> +<dd><p>The type of noise: Uniform, Gaussian, Multiplicative, +Impulse, Laplacian, Poisson, or Random.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -135,29 +138,29 @@ Impulse, Laplacian, Poisson, or Random.</dd> <h1><a class="toc-backref" href="#id53">AddNoiseImageChannel</a></h1> <div class="section" id="id3"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *AddNoiseImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, - const <a class="reference external" href="../api/types.html#noisetype">NoiseType</a> noise_type, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AddNoiseImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, + const <a class="reference external" href="../api/types.html#noisetype">NoiseType</a> noise_type, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id4"> <h2>Description</h2> <p>AddNoiseImageChannel() adds random noise to one image channel.</p> <p>The format of the AddNoiseImageChannel method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *AddNoiseImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, - const <a class="reference external" href="../api/types.html#noisetype">NoiseType</a> noise_type, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *AddNoiseImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, + const <a class="reference external" href="../api/types.html#noisetype">NoiseType</a> noise_type, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>channel:</dt> -<dd>The image channel to apply noise to.</dd> +<dd><p>The image channel to apply noise to.</p> +</dd> <dt>noise_type:</dt> -<dd>The type of noise: Uniform, Gaussian, Multiplicative, -Impulse, Laplacian, Poisson, or Random.</dd> +<dd><p>The type of noise: Uniform, Gaussian, Multiplicative, +Impulse, Laplacian, Poisson, or Random.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -165,9 +168,7 @@ Impulse, Laplacian, Poisson, or Random.</dd> <h1><a class="toc-backref" href="#id54">BlackThresholdImage</a></h1> <div class="section" id="id5"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail BlackThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *thresholds ); -</pre> +<pre class="literal-block">MagickPassFail BlackThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *thresholds );</pre> </div> <div class="section" id="id6"> <h2>Description</h2> @@ -175,18 +176,18 @@ MagickPassFail BlackThresholdImage( <a class="reference external" href="../api/t values below a specified threshold are set to the minimum value (black) while the remaining pixels are unchanged.</p> <p>The format of the BlackThresholdImage method is:</p> -<pre class="literal-block"> -MagickPassFail BlackThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *thresholds ); -</pre> +<pre class="literal-block">MagickPassFail BlackThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *thresholds );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>thresholds:</dt> -<dd>Channel thresholds which are specified as a comma delimited +<dd><p>Channel thresholds which are specified as a comma delimited list containing the thresholds for red, green, blue, and opacity. If the list contains a percent symbol (%) then all values are treated as -a percentage of MaxRGB.</dd> +a percentage of MaxRGB.</p> +</dd> </dl> </div> </div> @@ -194,10 +195,8 @@ a percentage of MaxRGB.</dd> <h1><a class="toc-backref" href="#id55">BlurImage</a></h1> <div class="section" id="id7"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *BlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *BlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id8"> <h2>Description</h2> @@ -206,18 +205,19 @@ operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and BlurImage() selects a suitable radius for you.</p> <p>The format of the BlurImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *BlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *BlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>radius:</dt> -<dd>The radius of the Gaussian, in pixels, not counting the center -pixel.</dd> +<dd><p>The radius of the Gaussian, in pixels, not counting the center +pixel.</p> +</dd> <dt>sigma:</dt> -<dd>The standard deviation of the Gaussian, in pixels.</dd> +<dd><p>The standard deviation of the Gaussian, in pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -225,11 +225,9 @@ pixel.</dd> <h1><a class="toc-backref" href="#id56">BlurImageChannel</a></h1> <div class="section" id="id9"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *BlurImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *BlurImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id10"> <h2>Description</h2> @@ -239,21 +237,23 @@ deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and BlurImageChannel() selects a suitable radius for you.</p> <p>The format of the BlurImageChannel method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *BlurImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *BlurImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>channel:</dt> -<dd>The channel to blur.</dd> +<dd><p>The channel to blur.</p> +</dd> <dt>radius:</dt> -<dd>The radius of the Gaussian, in pixels, not counting the center -pixel.</dd> +<dd><p>The radius of the Gaussian, in pixels, not counting the center +pixel.</p> +</dd> <dt>sigma:</dt> -<dd>The standard deviation of the Gaussian, in pixels.</dd> +<dd><p>The standard deviation of the Gaussian, in pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -261,9 +261,7 @@ pixel.</dd> <h1><a class="toc-backref" href="#id57">ChannelThresholdImage</a></h1> <div class="section" id="id11"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail ChannelThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *threshold ); -</pre> +<pre class="literal-block">MagickPassFail ChannelThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *threshold );</pre> </div> <div class="section" id="id12"> <h2>Description</h2> @@ -274,15 +272,15 @@ disables thresholding for that channel. Append a percent symbol to have threshold values automatically scaled from a percentage to MaxRGB.</p> <p>Invoked by the '-threshold' option.</p> <p>The format of the ChannelThresholdImage method is:</p> -<pre class="literal-block"> -MagickPassFail ChannelThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *threshold ); -</pre> +<pre class="literal-block">MagickPassFail ChannelThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *threshold );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>threshold:</dt> -<dd>define the threshold values, <red>{<green>,<blue>,<opacity>}{%}.</dd> +<dd><p>define the threshold values, <red>{<green>,<blue>,<opacity>}{%}.</p> +</dd> </dl> </div> </div> @@ -290,28 +288,28 @@ MagickPassFail ChannelThresholdImage( <a class="reference external" href="../api <h1><a class="toc-backref" href="#id58">ConvolveImage</a></h1> <div class="section" id="id13"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ConvolveImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int order, - const double *kernel, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ConvolveImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int order, + const double *kernel, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id14"> <h2>Description</h2> <p>ConvolveImage() applies a custom convolution kernel to the image.</p> <p>The format of the ConvolveImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ConvolveImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int order, - const double *kernel, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ConvolveImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int order, + const double *kernel, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>order:</dt> -<dd>The number of columns and rows in the filter kernel.</dd> +<dd><p>The number of columns and rows in the filter kernel.</p> +</dd> <dt>kernel:</dt> -<dd>An array of double representing the convolution kernel.</dd> +<dd><p>An array of double representing the convolution kernel.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -319,24 +317,22 @@ MagickPassFail ChannelThresholdImage( <a class="reference external" href="../api <h1><a class="toc-backref" href="#id59">DespeckleImage</a></h1> <div class="section" id="id15"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *DespeckleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *DespeckleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id16"> <h2>Description</h2> <p>Despeckle() reduces the speckle noise in an image while preserving the edges of the original image.</p> <p>The format of the DespeckleImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *DespeckleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *DespeckleImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -344,10 +340,8 @@ edges of the original image.</p> <h1><a class="toc-backref" href="#id60">EdgeImage</a></h1> <div class="section" id="id17"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *EdgeImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *EdgeImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id18"> <h2>Description</h2> @@ -355,17 +349,18 @@ edges of the original image.</p> convolution filter. Use a radius of 0 and Edge() selects a suitable radius for you.</p> <p>The format of the EdgeImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *EdgeImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *EdgeImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>radius:</dt> -<dd>the radius of the pixel neighborhood.</dd> +<dd><p>the radius of the pixel neighborhood.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -373,10 +368,8 @@ radius for you.</p> <h1><a class="toc-backref" href="#id61">EmbossImage</a></h1> <div class="section" id="id19"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *EmbossImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *EmbossImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id20"> <h2>Description</h2> @@ -386,19 +379,21 @@ standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and Emboss() selects a suitable radius for you.</p> <p>The format of the EmbossImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *EmbossImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *EmbossImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>radius:</dt> -<dd>the radius of the pixel neighborhood.</dd> +<dd><p>the radius of the pixel neighborhood.</p> +</dd> <dt>sigma:</dt> -<dd>The standard deviation of the Gaussian, in pixels.</dd> +<dd><p>The standard deviation of the Gaussian, in pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -406,9 +401,7 @@ radius for you.</p> <h1><a class="toc-backref" href="#id62">EnhanceImage</a></h1> <div class="section" id="id21"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *EnhanceImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *EnhanceImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id22"> <h2>Description</h2> @@ -416,15 +409,15 @@ radius for you.</p> improves the quality of a noisy image. The opacity channel is preserved but is otherwise ignored.</p> <p>The format of the EnhanceImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *EnhanceImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *EnhanceImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -432,10 +425,8 @@ but is otherwise ignored.</p> <h1><a class="toc-backref" href="#id63">GaussianBlurImage</a></h1> <div class="section" id="id23"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *GaussianBlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GaussianBlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id24"> <h2>Description</h2> @@ -444,24 +435,27 @@ Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and GaussianBlurImage() selects a suitable radius for you</p> <p>The format of the GaussianBlurImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *GaussianBlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GaussianBlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>blur_image:</dt> -<dd>Method GaussianBlurImage returns a pointer to the image +<dd><p>Method GaussianBlurImage returns a pointer to the image after it is blur. A null image is returned if there is a memory -shortage.</dd> +shortage.</p> +</dd> <dt>image:</dt> -<dd>Image to blur.</dd> +<dd><p>Image to blur.</p> +</dd> <dt>radius:</dt> -<dd>the radius of the Gaussian, in pixels, not counting the center -pixel.</dd> +<dd><p>the radius of the Gaussian, in pixels, not counting the center +pixel.</p> +</dd> <dt>sigma:</dt> -<dd>the standard deviation of the Gaussian, in pixels.</dd> +<dd><p>the standard deviation of the Gaussian, in pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -469,11 +463,9 @@ pixel.</dd> <h1><a class="toc-backref" href="#id64">GaussianBlurImageChannel</a></h1> <div class="section" id="id25"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *GaussianBlurImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GaussianBlurImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id26"> <h2>Description</h2> @@ -483,27 +475,31 @@ with a Gaussian operator of the given radius and standard deviation Use a radius of 0 and GaussianBlurImage() selects a suitable radius for you.</p> <p>The format of the GaussianBlurImageChannel method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *GaussianBlurImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GaussianBlurImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>blur_image:</dt> -<dd>Method GaussianBlurImage returns a pointer to the image +<dd><p>Method GaussianBlurImage returns a pointer to the image after it is blur. A null image is returned if there is a memory -shortage.</dd> +shortage.</p> +</dd> <dt>image:</dt> -<dd>Image to blur.</dd> +<dd><p>Image to blur.</p> +</dd> <dt>channel:</dt> -<dd>Channel to blur in image.</dd> +<dd><p>Channel to blur in image.</p> +</dd> <dt>radius:</dt> -<dd>the radius of the Gaussian, in pixels, not counting the center -pixel.</dd> +<dd><p>the radius of the Gaussian, in pixels, not counting the center +pixel.</p> +</dd> <dt>sigma:</dt> -<dd>the standard deviation of the Gaussian, in pixels.</dd> +<dd><p>the standard deviation of the Gaussian, in pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -511,10 +507,8 @@ pixel.</dd> <h1><a class="toc-backref" href="#id65">MedianFilterImage</a></h1> <div class="section" id="id27"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *MedianFilterImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MedianFilterImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id28"> <h2>Description</h2> @@ -526,17 +520,18 @@ sort for selecting median color-channel values. For more on this algorithm see "Skip Lists: A probabilistic Alternative to Balanced Trees" by William Pugh in the June 1990 of Communications of the ACM.</p> <p>The format of the MedianFilterImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *MedianFilterImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MedianFilterImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>radius:</dt> -<dd>The radius of the pixel neighborhood.</dd> +<dd><p>The radius of the pixel neighborhood.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -544,10 +539,8 @@ Pugh in the June 1990 of Communications of the ACM.</p> <h1><a class="toc-backref" href="#id66">MotionBlurImage</a></h1> <div class="section" id="id29"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *MotionBlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - const double angle, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MotionBlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + const double angle, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id30"> <h2>Description</h2> @@ -559,22 +552,25 @@ Angle gives the angle of the blurring motion (direction object appears to be coming from).</p> <p>Andrew Protano contributed this effect.</p> <p>The format of the MotionBlurImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *MotionBlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - const double angle, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *MotionBlurImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + const double angle, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>radius:</dt> -<dd>The radius of the Gaussian, in pixels, not counting -the center pixel.</dd> +<dd><p>The radius of the Gaussian, in pixels, not counting +the center pixel.</p> +</dd> <dt>sigma:</dt> -<dd>The standard deviation of the Gaussian, in pixels.</dd> +<dd><p>The standard deviation of the Gaussian, in pixels.</p> +</dd> <dt>angle:</dt> -<dd>Apply the effect along this angle.</dd> +<dd><p>Apply the effect along this angle.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -582,11 +578,9 @@ the center pixel.</dd> <h1><a class="toc-backref" href="#id67">RandomChannelThresholdImage</a></h1> <div class="section" id="id31"> <h2>Synopsis</h2> -<pre class="literal-block"> -unsigned int RandomChannelThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *channel, +<pre class="literal-block">unsigned int RandomChannelThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *channel, const char *thresholds, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id32"> <h2>Description</h2> @@ -594,23 +588,25 @@ unsigned int RandomChannelThresholdImage( <a class="reference external" href=".. on the intensity of each pixel compared to a random threshold. The result is a low-contrast, two color image.</p> <p>The format of the RandomChannelThresholdImage method is:</p> -<pre class="literal-block"> -unsigned int RandomChannelThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *channel, +<pre class="literal-block">unsigned int RandomChannelThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *channel, const char *thresholds, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>channel:</dt> -<dd>The channel or channels to be thresholded.</dd> +<dd><p>The channel or channels to be thresholded.</p> +</dd> <dt>thresholds:</dt> -<dd>a geometry string containing LOWxHIGH thresholds. +<dd><p>a geometry string containing LOWxHIGH thresholds. If the string contains 2x2, 3x3, 4x4, 5x5, 6x6, or 7x7, then an ordered dither of order 2, 3, 4, 5, 6, or 7 will be performed -instead.</dd> +instead.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -618,10 +614,8 @@ instead.</dd> <h1><a class="toc-backref" href="#id68">ReduceNoiseImage</a></h1> <div class="section" id="id33"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ReduceNoiseImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ReduceNoiseImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id34"> <h2>Description</h2> @@ -630,17 +624,18 @@ edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. Use a radius of 0 and ReduceNoise() selects a suitable radius for you.</p> <p>The format of the ReduceNoiseImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ReduceNoiseImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ReduceNoiseImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>radius:</dt> -<dd>The radius of the pixel neighborhood.</dd> +<dd><p>The radius of the pixel neighborhood.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -648,10 +643,8 @@ of 0 and ReduceNoise() selects a suitable radius for you.</p> <h1><a class="toc-backref" href="#id69">ShadeImage</a></h1> <div class="section" id="id35"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ShadeImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int gray, double azimuth, - double elevation, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ShadeImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int gray, double azimuth, + double elevation, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id36"> <h2>Description</h2> @@ -660,19 +653,21 @@ three-dimensional effect. You control the positioning of the light with azimuth and elevation; azimuth is measured in degrees off the x axis and elevation is measured in pixels above the Z axis.</p> <p>The format of the ShadeImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *ShadeImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int gray, double azimuth, - double elevation, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *ShadeImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int gray, double azimuth, + double elevation, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>gray:</dt> -<dd>A value other than zero shades the intensity of each pixel.</dd> +<dd><p>A value other than zero shades the intensity of each pixel.</p> +</dd> <dt>azimuth, elevation:</dt> -<dd>Define the light source direction.</dd> +<dd><p>Define the light source direction.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -680,10 +675,8 @@ and elevation is measured in pixels above the Z axis.</p> <h1><a class="toc-backref" href="#id70">SharpenImage</a></h1> <div class="section" id="id37"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *SharpenImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SharpenImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id38"> <h2>Description</h2> @@ -692,20 +685,22 @@ Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and SharpenImage() selects a suitable radius for you.</p> <p>The format of the SharpenImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *SharpenImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SharpenImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>radius:</dt> -<dd>The radius of the Gaussian, in pixels, not counting the center -pixel.</dd> +<dd><p>The radius of the Gaussian, in pixels, not counting the center +pixel.</p> +</dd> <dt>sigma:</dt> -<dd>The standard deviation of the Laplacian, in pixels.</dd> +<dd><p>The standard deviation of the Laplacian, in pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -713,11 +708,9 @@ pixel.</dd> <h1><a class="toc-backref" href="#id71">SharpenImageChannel</a></h1> <div class="section" id="id39"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *SharpenImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SharpenImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id40"> <h2>Description</h2> @@ -727,23 +720,26 @@ deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and SharpenImageChannel() selects a suitable radius for you.</p> <p>The format of the SharpenImageChannel method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *SharpenImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SharpenImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, const double radius, const double sigma, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>channel:</dt> -<dd>The channel to sharpen.</dd> +<dd><p>The channel to sharpen.</p> +</dd> <dt>radius:</dt> -<dd>The radius of the Gaussian, in pixels, not counting the center -pixel.</dd> +<dd><p>The radius of the Gaussian, in pixels, not counting the center +pixel.</p> +</dd> <dt>sigma:</dt> -<dd>The standard deviation of the Laplacian, in pixels.</dd> +<dd><p>The standard deviation of the Laplacian, in pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -751,27 +747,27 @@ pixel.</dd> <h1><a class="toc-backref" href="#id72">SpreadImage</a></h1> <div class="section" id="id41"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *SpreadImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int radius, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SpreadImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int radius, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id42"> <h2>Description</h2> <p>SpreadImage() is a special effects method that randomly displaces each -pixel in a block defined by the radius parameter.</p> +pixel in a block defined by the radius parameter. Useful values are 1 +to than less than 100.</p> <p>The format of the SpreadImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *SpreadImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int radius, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *SpreadImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const unsigned int radius, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>radius:</dt> -<dd>Choose a random pixel in a neighborhood of this extent.</dd> +<dd><p>Choose a random pixel in a neighborhood of this extent.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -779,9 +775,7 @@ pixel in a block defined by the radius parameter.</p> <h1><a class="toc-backref" href="#id73">ThresholdImage</a></h1> <div class="section" id="id43"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail ThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const double threshold ); -</pre> +<pre class="literal-block">MagickPassFail ThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const double threshold );</pre> </div> <div class="section" id="id44"> <h2>Description</h2> @@ -791,15 +785,15 @@ greater than the threshold are set to the maximum quantum value, and values equal to or below the threshold are set to the minimum quantum value. The result is a high-contrast, two color image.</p> <p>The format of the ThresholdImage method is:</p> -<pre class="literal-block"> -MagickPassFail ThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const double threshold ); -</pre> +<pre class="literal-block">MagickPassFail ThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const double threshold );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>threshold:</dt> -<dd>Define the threshold value</dd> +<dd><p>Define the threshold value</p> +</dd> </dl> </div> </div> @@ -807,11 +801,9 @@ MagickPassFail ThresholdImage( <a class="reference external" href="../api/types. <h1><a class="toc-backref" href="#id74">UnsharpMaskImage</a></h1> <div class="section" id="id45"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *UnsharpMaskImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *UnsharpMaskImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, const double amount, const double threshold, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id46"> <h2>Description</h2> @@ -820,26 +812,30 @@ Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and UnsharpMaskImage() selects a suitable radius for you.</p> <p>The format of the UnsharpMaskImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *UnsharpMaskImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *UnsharpMaskImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const double radius, const double sigma, const double amount, const double threshold, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>radius:</dt> -<dd>The radius of the Gaussian, in pixels, not counting the center -pixel.</dd> +<dd><p>The radius of the Gaussian, in pixels, not counting the center +pixel.</p> +</dd> <dt>sigma:</dt> -<dd>The standard deviation of the Gaussian, in pixels.</dd> +<dd><p>The standard deviation of the Gaussian, in pixels.</p> +</dd> <dt>amount:</dt> -<dd>The percentage of the difference between the original and the -blur image that is added back into the original.</dd> +<dd><p>The percentage of the difference between the original and the +blur image that is added back into the original.</p> +</dd> <dt>threshold:</dt> -<dd>The threshold in pixels needed to apply the diffence amount.</dd> +<dd><p>The threshold in pixels needed to apply the diffence amount.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -847,11 +843,9 @@ blur image that is added back into the original.</dd> <h1><a class="toc-backref" href="#id75">UnsharpMaskImageChannel</a></h1> <div class="section" id="id47"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *UnsharpMaskImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *UnsharpMaskImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, const double radius, const double sigma, const double amount, - const double threshold, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + const double threshold, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id48"> <h2>Description</h2> @@ -861,28 +855,33 @@ deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and UnsharpMaskImage() selects a suitable radius for you.</p> <p>The format of the UnsharpMaskImageChannel method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *UnsharpMaskImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *UnsharpMaskImageChannel( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#channeltype">ChannelType</a> channel, const double radius, const double sigma, const double amount, - const double threshold, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + const double threshold, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>channel:</dt> -<dd>The channel to sharpen.</dd> +<dd><p>The channel to sharpen.</p> +</dd> <dt>radius:</dt> -<dd>The radius of the Gaussian, in pixels, not counting the center -pixel.</dd> +<dd><p>The radius of the Gaussian, in pixels, not counting the center +pixel.</p> +</dd> <dt>sigma:</dt> -<dd>The standard deviation of the Gaussian, in pixels.</dd> +<dd><p>The standard deviation of the Gaussian, in pixels.</p> +</dd> <dt>amount:</dt> -<dd>The percentage of the difference between the original and the -blur image that is added back into the original.</dd> +<dd><p>The percentage of the difference between the original and the +blur image that is added back into the original.</p> +</dd> <dt>threshold:</dt> -<dd>The threshold in pixels needed to apply the diffence amount.</dd> +<dd><p>The threshold in pixels needed to apply the diffence amount.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -890,9 +889,7 @@ blur image that is added back into the original.</dd> <h1><a class="toc-backref" href="#id76">WhiteThresholdImage</a></h1> <div class="section" id="id49"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail WhiteThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *thresholds ); -</pre> +<pre class="literal-block">MagickPassFail WhiteThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *thresholds );</pre> </div> <div class="section" id="id50"> <h2>Description</h2> @@ -900,26 +897,29 @@ MagickPassFail WhiteThresholdImage( <a class="reference external" href="../api/t values above a specified threshold are set to the maximum value (white) while the remaining pixels are unchanged.</p> <p>The format of the WhiteThresholdImage method is:</p> -<pre class="literal-block"> -MagickPassFail WhiteThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *thresholds ); -</pre> +<pre class="literal-block">MagickPassFail WhiteThresholdImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *thresholds );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>thresholds:</dt> -<dd>Channel thresholds which are specified as a comma delimited +<dd><p>Channel thresholds which are specified as a comma delimited list containing the thresholds for red, green, blue, and opacity. If the list contains a percent symbol (%) then all values are treated as -a percentage of MaxRGB.</dd> +a percentage of MaxRGB.</p> +</dd> </dl> </div> </div> </div> + <hr class="docutils"> <div class="document"> - <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2022<!--SPONSOR_LOGO--></p> + <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p> +</div> + </div> </body> </html> |