<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>effect - Image effects methods</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:bfriesen@freddy.simplesystems.org" /> </head> <body style="background-color: white"> <P><a name="__index__"></a></P> <!-- INDEX BEGIN --> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li> <ul> <li><a href="#adaptivethresholdimage">AdaptiveThresholdImage</a></li> <li><a href="#addnoiseimage">AddNoiseImage</a></li> <li><a href="#blurimage">BlurImage</a></li> <li><a href="#channelthresholdimage">ChannelThresholdImage</a></li> <li><a href="#despeckleimage">DespeckleImage</a></li> <li><a href="#edgeimage">EdgeImage</a></li> <li><a href="#embossimage">EmbossImage</a></li> <li><a href="#enhanceimage">EnhanceImage</a></li> <li><a href="#gaussianblurimage">GaussianBlurImage</a></li> <li><a href="#medianfilterimage">MedianFilterImage</a></li> <li><a href="#motionblurimage">MotionBlurImage</a></li> <li><a href="#randomchannelthresholdimage">RandomChannelThresholdImage</a></li> <li><a href="#reducenoiseimage">ReduceNoiseImage</a></li> <li><a href="#shadeimage">ShadeImage</a></li> <li><a href="#sharpenimage">SharpenImage</a></li> <li><a href="#spreadimage">SpreadImage</a></li> <li><a href="#thresholdimage">ThresholdImage</a></li> <li><a href="#unsharpmaskimage">UnsharpMaskImage</a></li> </ul> </ul> <!-- INDEX END --> <hr /> <P> </P> <h1><a name="name">NAME</a></h1> <P>effect - Image effects methods</P> <P> </P> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <P>Image * <strong>AdaptiveThresholdImage</strong>( Image *image, const unsigned long width, const unsigned long height, const unsigned long unsigned long, ExceptionInfo *exception );</P> <P>Image * <strong>AddNoiseImage</strong>( const Image *image, const NoiseType noise_type, ExceptionInfo *exception );</P> <P>Image * <strong>BlurImage</strong>( const Image *image, const double radius, const double sigma, ExceptionInfo *exception );</P> <P>unsigned int <strong>ChannelThresholdImage</strong>( Image *image, const char *threshold );</P> <P>Image * <strong>DespeckleImage</strong>( const Image *image, ExceptionInfo *exception );</P> <P>Image * <strong>EdgeImage</strong>( const Image *image, const double radius, ExceptionInfo *exception );</P> <P>Image * <strong>EmbossImage</strong>( const Image *image, const double radius, const double sigma, ExceptionInfo *exception );</P> <P>Image * <strong>EnhanceImage</strong>( const Image *image, ExceptionInfo *exception );</P> <P>Image * <strong>GaussianBlurImage</strong>( const Image *image, const double radius, const double sigma, ExceptionInfo *exception );</P> <P>Image * <strong>MedianFilterImage</strong>( const Image *image, const double radius, ExceptionInfo *exception );</P> <P>Image * <strong>MotionBlurImage</strong>( const Image *image, const double radius, const double sigma, const double angle, ExceptionInfo *exception );</P> <P>unsigned int <strong>RandomChannelThresholdImage</strong>( Image *image, const char *channel, const char *thresholds, ExceptionInfo *exception );</P> <P>Image * <strong>ReduceNoiseImage</strong>( const Image *image, const double radius, ExceptionInfo *exception );</P> <P>Image * <strong>ShadeImage</strong>( const Image *image, const unsigned int gray, double azimuth, double elevation, ExceptionInfo *exception );</P> <P>Image * <strong>SharpenImage</strong>( const Image *image, const double radius, const double sigma, ExceptionInfo *exception );</P> <P>Image * <strong>SpreadImage</strong>( const Image *image, const unsigned int radius, ExceptionInfo *exception );</P> <P>unsigned int <strong>ThresholdImage</strong>( Image *image, const double threshold );</P> <P>Image * <strong>UnsharpMaskImage</strong>( const Image *image, const double radius, const double sigma, const double amount, const double threshold, ExceptionInfo *exception );</P> <P> </P> <hr /> <h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1> <P> </P> <h2><a name="adaptivethresholdimage">AdaptiveThresholdImage</a></h2> <blockquote>AdaptiveThresholdImage() selects an individual threshold for each pixel 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. </blockquote><P>The format of the AdaptiveThresholdImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *AdaptiveThresholdImage ( <A HREF="types.html#Image">Image</A> *image, const unsigned long width, const unsigned long height, const unsigned long unsigned long, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong><a name="item_o_image_3a">image:</a></strong> <DD> <P>The image.</P> </dd> </li> <dt><strong><a name="item_o_width_3a">width:</a></strong> <DD> <P>The width of the local neighborhood.</P> </dd> </li> <dt><strong><a name="item_o_height_3a">height:</a></strong> <DD> <P>The height of the local neighborhood.</P> </dd> </li> <dt><strong><a name="item_o_offset_3a">offset:</a></strong> <DD> <P>The mean offset.</P> </dd> </li> <dt><strong><a name="item_o_exception_3a">exception:</a></strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="addnoiseimage">AddNoiseImage</a></h2> <blockquote>AddNoiseImage() adds random noise to the image. </blockquote><P>The format of the AddNoiseImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *AddNoiseImage ( const <A HREF="types.html#Image">Image</A> *image, const <A HREF="types.html#NoiseType">NoiseType</A> noise_type, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong><a name="item_o_noise_type_3a">noise_type:</a></strong> <DD> <P>The type of noise: Uniform, Gaussian, Multiplicative, Impulse, Laplacian, or Poisson.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="blurimage">BlurImage</a></h2> <blockquote>BlurImage() blurs an image. We convolve the image with a 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 BlurImage ( ) selects a suitable radius for you. </blockquote><P>The format of the BlurImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *BlurImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, const double sigma, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong><a name="item_o_radius_3a">radius:</a></strong> <DD> <P>The radius of the Gaussian, in pixels, not counting the center pixel.</P> </dd> </li> <dt><strong><a name="item_o_sigma_3a">sigma:</a></strong> <DD> <P>The standard deviation of the Gaussian, in pixels.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="channelthresholdimage">ChannelThresholdImage</a></h2> <blockquote>ChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel channel. The result is a high-contrast image. </blockquote><P>The format of the ChannelThresholdImage method is:</P> <blockquote>unsigned int ChannelThresholdImage ( <A HREF="types.html#Image">Image</A> *image, const char *threshold ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong><a name="item_o_threshold_3a">threshold:</a></strong> <DD> <P>define the threshold values.</P> </dd> </li> </dl> <P> </P> <h2><a name="despeckleimage">DespeckleImage</a></h2> <P><code>Despeckle()</code> reduces the speckle noise in an image while perserving the edges of the original image.</P> <P>The format of the DespeckleImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *DespeckleImage ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="edgeimage">EdgeImage</a></h2> <blockquote>EdgeImage() finds edges in an image. Radius defines the radius of the convolution filter. Use a radius of 0 and Edge ( ) selects a suitable radius for you. </blockquote><P>The format of the EdgeImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *EdgeImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>the radius of the pixel neighborhood.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="embossimage">EmbossImage</a></h2> <blockquote>EmbossImage() returns a grayscale image with a three-dimensional effect. We convolve the image with a 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 Emboss ( ) selects a suitable radius for you. </blockquote><P>The format of the EmbossImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *EmbossImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, const double sigma, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>the radius of the pixel neighborhood.</P> </dd> </li> <dt><strong>sigma:</strong> <DD> <P>The standard deviation of the Gaussian, in pixels.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="enhanceimage">EnhanceImage</a></h2> <blockquote>EnhanceImage() applies a digital filter that improves the quality of a noisy image. </blockquote><P>The format of the EnhanceImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *EnhanceImage ( const <A HREF="types.html#Image">Image</A> *image, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="gaussianblurimage">GaussianBlurImage</a></h2> <blockquote>GaussianBlurImage() blurs an image. We convolve the image with a 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 </blockquote><P>The format of the BlurImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *GaussianBlurImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, const double sigma, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong><a name="item_o_blur_image_3a">blur_image:</a></strong> <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.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>the radius of the Gaussian, in pixels, not counting the center pixel.</P> </dd> </li> <dt><strong>sigma:</strong> <DD> <P>the standard deviation of the Gaussian, in pixels.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="medianfilterimage">MedianFilterImage</a></h2> <blockquote>MedianFilterImage() applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius. </blockquote><P>The algorithm was contributed by Mike Edmonds and implements an insertion 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> <blockquote><A HREF="types.html#Image">Image</A> *MedianFilterImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>The radius of the pixel neighborhood.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="motionblurimage">MotionBlurImage</a></h2> <blockquote>MotionBlurImage() simulates motion blur. We convolve the image with a 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 MotionBlurImage ( ) selects a suitable radius for you. Angle gives the angle of the blurring motion. </blockquote><P>Andrew Protano contributed this effect.</P> <P>The format of the MotionBlurImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *MotionBlurImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, const double sigma, const double angle, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>The radius of the Gaussian, in pixels, not counting the center pixel.</P> </dd> </li> <dt><strong>sigma:</strong> <DD> <P>The standard deviation of the Gaussian, in pixels.</P> </dd> </li> <dt><strong><a name="item_o_angle_3a">angle:</a></strong> <DD> <P>Apply the effect along this angle.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="randomchannelthresholdimage">RandomChannelThresholdImage</a></h2> <blockquote>RandomChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to a random threshold. The result is a low-contrast, two color image. </blockquote><P>The format of the RandomChannelThresholdImage method is:</P> <blockquote>unsigned int RandomChannelThresholdImage ( <A HREF="types.html#Image">Image</A> *image, const char *channel, const char *thresholds, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong><a name="item_o_channel_3a">channel:</a></strong> <DD> <P>The channel or channels to be thresholded.</P> </dd> </li> <dt><strong><a name="item_o_thresholds_3a">thresholds:</a></strong> <DD> <P>a geometry string containing LOWxHIGH thresholds. If the string contains 2x2, 3x3, or 4x4, then an ordered dither of order 2, 3, or 4 will be performed instead.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="reducenoiseimage">ReduceNoiseImage</a></h2> <blockquote>ReduceNoiseImage() smooths the contours of an image while still preserving 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. </blockquote><P>The format of the ReduceNoiseImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *ReduceNoiseImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>The radius of the pixel neighborhood.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="shadeimage">ShadeImage</a></h2> <blockquote>ShadeImage() shines a distant light on an image to create a 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. </blockquote><P>The format of the ShadeImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *ShadeImage ( const <A HREF="types.html#Image">Image</A> *image, const unsigned int gray, double azimuth, double elevation, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong><a name="item_o_gray_3a">gray:</a></strong> <DD> <P>A value other than zero shades the intensity of each pixel.</P> </dd> </li> <dt><strong><a name="item_o_azimuth_2c_elevation_3a">azimuth, elevation:</a></strong> <DD> <P>Define the light source direction.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="sharpenimage">SharpenImage</a></h2> <blockquote>SharpenImage() sharpens an image. We convolve the image with a 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. </blockquote><P>The format of the SharpenImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *SharpenImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, const double sigma, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>The radius of the Gaussian, in pixels, not counting the center pixel.</P> </dd> </li> <dt><strong>sigma:</strong> <DD> <P>The standard deviation of the Laplacian, in pixels.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="spreadimage">SpreadImage</a></h2> <blockquote>SpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter. </blockquote><P>The format of the SpreadImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *SpreadImage ( const <A HREF="types.html#Image">Image</A> *image, const unsigned int radius, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>Choose a random pixel in a neighborhood of this extent.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="thresholdimage">ThresholdImage</a></h2> <blockquote>ThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image. </blockquote><P>The format of the ThresholdImage method is:</P> <blockquote>unsigned int ThresholdImage ( <A HREF="types.html#Image">Image</A> *image, const double threshold ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>threshold:</strong> <DD> <P>Define the threshold value</P> </dd> </li> </dl> <P> </P> <h2><a name="unsharpmaskimage">UnsharpMaskImage</a></h2> <blockquote>UnsharpMaskImage() sharpens an image. We convolve the image with a 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. </blockquote><P>The format of the UnsharpMaskImage method is:</P> <blockquote><A HREF="types.html#Image">Image</A> *UnsharpMaskImage ( const <A HREF="types.html#Image">Image</A> *image, const double radius, const double sigma, const double amount, const double threshold, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>image:</strong> <DD> <P>The image.</P> </dd> </li> <dt><strong>radius:</strong> <DD> <P>The radius of the Gaussian, in pixels, not counting the center pixel.</P> </dd> </li> <dt><strong>sigma:</strong> <DD> <P>The standard deviation of the Gaussian, in pixels.</P> </dd> </li> <dt><strong><a name="item_o_amount_3a">amount:</a></strong> <DD> <P>The percentage of the difference between the original and the blur image that is added back into the original.</P> </dd> </li> <dt><strong>threshold:</strong> <DD> <P>The threshold in pixels needed to apply the diffence amount.</P> </dd> </li> <dt><strong>exception:</strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </dl> </body> </html>
