blob: 55adfaea7a36062c5a255b8c1f356ab2a6c25fff [file] [log] [blame]
cristy701db312009-11-20 03:14:08 +00001/*
2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3% %
4% %
5% %
6% M M OOO RRRR PPPP H H OOO L OOO GGGG Y Y %
7% MM MM O O R R P P H H O O L O O G Y Y %
8% M M M O O RRRR PPPP HHHHH O O L O O G GGG Y %
9% M M O O R R P H H O O L O O G G Y %
10% M M OOO R R P H H OOO LLLLL OOO GGG Y %
11% %
12% %
13% MagickCore Morphology Methods %
14% %
15% Software Design %
16% Anthony Thyssen %
anthonyc94cdb02010-01-06 08:15:29 +000017% January 2010 %
cristy701db312009-11-20 03:14:08 +000018% %
19% %
cristy16af1cb2009-12-11 21:38:29 +000020% Copyright 1999-2010 ImageMagick Studio LLC, a non-profit organization %
cristy701db312009-11-20 03:14:08 +000021% dedicated to making software imaging solutions freely available. %
22% %
23% You may not use this file except in compliance with the License. You may %
24% obtain a copy of the License at %
25% %
26% http://www.imagemagick.org/script/license.php %
27% %
28% Unless required by applicable law or agreed to in writing, software %
29% distributed under the License is distributed on an "AS IS" BASIS, %
30% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31% See the License for the specific language governing permissions and %
32% limitations under the License. %
33% %
34%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
35%
anthony602ab9b2010-01-05 08:06:50 +000036% Morpology is the the application of various kernals, of any size and even
37% shape, to a image in various ways (typically binary, but not always).
cristy701db312009-11-20 03:14:08 +000038%
anthony602ab9b2010-01-05 08:06:50 +000039% Convolution (weighted sum or average) is just one specific type of
40% morphology. Just one that is very common for image bluring and sharpening
41% effects. Not only 2D Gaussian blurring, but also 2-pass 1D Blurring.
42%
43% This module provides not only a general morphology function, and the ability
44% to apply more advanced or iterative morphologies, but also functions for the
45% generation of many different types of kernel arrays from user supplied
46% arguments. Prehaps even the generation of a kernel from a small image.
cristy701db312009-11-20 03:14:08 +000047*/
48
49/*
50 Include declarations.
51*/
52#include "magick/studio.h"
anthony602ab9b2010-01-05 08:06:50 +000053#include "magick/artifact.h"
cristy701db312009-11-20 03:14:08 +000054#include "magick/cache-view.h"
55#include "magick/color-private.h"
56#include "magick/enhance.h"
57#include "magick/exception.h"
58#include "magick/exception-private.h"
anthony602ab9b2010-01-05 08:06:50 +000059#include "magick/gem.h"
cristy701db312009-11-20 03:14:08 +000060#include "magick/hashmap.h"
61#include "magick/image.h"
cristybba804b2010-01-05 15:39:59 +000062#include "magick/image-private.h"
cristy701db312009-11-20 03:14:08 +000063#include "magick/list.h"
anthony29188a82010-01-22 10:12:34 +000064#include "magick/magick.h"
cristy701db312009-11-20 03:14:08 +000065#include "magick/memory_.h"
66#include "magick/monitor-private.h"
67#include "magick/morphology.h"
anthony602ab9b2010-01-05 08:06:50 +000068#include "magick/option.h"
cristy701db312009-11-20 03:14:08 +000069#include "magick/pixel-private.h"
70#include "magick/prepress.h"
71#include "magick/quantize.h"
72#include "magick/registry.h"
73#include "magick/semaphore.h"
74#include "magick/splay-tree.h"
75#include "magick/statistic.h"
76#include "magick/string_.h"
anthony602ab9b2010-01-05 08:06:50 +000077#include "magick/string-private.h"
78#include "magick/token.h"
79
anthonyc94cdb02010-01-06 08:15:29 +000080
anthony602ab9b2010-01-05 08:06:50 +000081/*
anthonyc94cdb02010-01-06 08:15:29 +000082 * The following test is for special floating point numbers of value NaN (not
83 * a number), that may be used within a Kernel Definition. NaN's are defined
84 * as part of the IEEE standard for floating point number representation.
anthony602ab9b2010-01-05 08:06:50 +000085 *
anthonyc94cdb02010-01-06 08:15:29 +000086 * These are used a Kernel value of NaN means that that kernal position is not
87 * part of the normal convolution or morphology process, and thus allowing the
88 * use of 'shaped' kernels.
anthony602ab9b2010-01-05 08:06:50 +000089 *
anthonyc94cdb02010-01-06 08:15:29 +000090 * Special Properities Two NaN's are never equal, even if they are from the
91 * same variable That is the IsNaN() macro is only true if the value is NaN.
anthony602ab9b2010-01-05 08:06:50 +000092 */
93#define IsNan(a) ((a)!=(a))
94
anthony29188a82010-01-22 10:12:34 +000095/*
96 * Other global definitions used by module
97 */
98static inline double MagickMin(const double x,const double y)
99{
100 return( x < y ? x : y);
101}
102static inline double MagickMax(const double x,const double y)
103{
104 return( x > y ? x : y);
105}
106#define Minimize(assign,value) assign=MagickMin(assign,value)
107#define Maximize(assign,value) assign=MagickMax(assign,value)
108
anthonyc4c86e02010-01-27 09:30:32 +0000109/* Currently these are only internal to this module */
110static void
anthony4fd27e22010-02-07 08:17:18 +0000111 RotateKernelInfo(KernelInfo *, double),
112 ScaleKernelInfo(KernelInfo *, double);
113
114static KernelInfo
anthony930be612010-02-08 04:26:15 +0000115 *CloneKernelInfo(const KernelInfo *);
anthony83ba99b2010-01-24 08:48:15 +0000116
anthony602ab9b2010-01-05 08:06:50 +0000117
118/*
119%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
120% %
121% %
122% %
anthony83ba99b2010-01-24 08:48:15 +0000123% A c q u i r e K e r n e l I n f o %
anthony602ab9b2010-01-05 08:06:50 +0000124% %
125% %
126% %
127%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
128%
cristy2be15382010-01-21 02:38:03 +0000129% AcquireKernelInfo() takes the given string (generally supplied by the
anthony602ab9b2010-01-05 08:06:50 +0000130% user) and converts it into a Morphology/Convolution Kernel. This allows
131% users to specify a kernel from a number of pre-defined kernels, or to fully
132% specify their own kernel for a specific Convolution or Morphology
133% Operation.
134%
135% The kernel so generated can be any rectangular array of floating point
136% values (doubles) with the 'control point' or 'pixel being affected'
137% anywhere within that array of values.
138%
anthony83ba99b2010-01-24 08:48:15 +0000139% Previously IM was restricted to a square of odd size using the exact
140% center as origin, this is no longer the case, and any rectangular kernel
141% with any value being declared the origin. This in turn allows the use of
142% highly asymmetrical kernels.
anthony602ab9b2010-01-05 08:06:50 +0000143%
144% The floating point values in the kernel can also include a special value
anthony83ba99b2010-01-24 08:48:15 +0000145% known as 'nan' or 'not a number' to indicate that this value is not part
146% of the kernel array. This allows you to shaped the kernel within its
147% rectangular area. That is 'nan' values provide a 'mask' for the kernel
148% shape. However at least one non-nan value must be provided for correct
149% working of a kernel.
anthony602ab9b2010-01-05 08:06:50 +0000150%
anthony83ba99b2010-01-24 08:48:15 +0000151% The returned kernel should be free using the DestroyKernelInfo() when you
152% are finished with it.
anthony602ab9b2010-01-05 08:06:50 +0000153%
154% Input kernel defintion strings can consist of any of three types.
155%
anthony29188a82010-01-22 10:12:34 +0000156% "name:args"
157% Select from one of the built in kernels, using the name and
158% geometry arguments supplied. See AcquireKernelBuiltIn()
anthony602ab9b2010-01-05 08:06:50 +0000159%
160% "WxH[+X+Y]:num, num, num ..."
161% a kernal of size W by H, with W*H floating point numbers following.
162% the 'center' can be optionally be defined at +X+Y (such that +0+0
anthony29188a82010-01-22 10:12:34 +0000163% is top left corner). If not defined the pixel in the center, for
164% odd sizes, or to the immediate top or left of center for even sizes
165% is automatically selected.
anthony602ab9b2010-01-05 08:06:50 +0000166%
anthony29188a82010-01-22 10:12:34 +0000167% "num, num, num, num, ..."
168% list of floating point numbers defining an 'old style' odd sized
169% square kernel. At least 9 values should be provided for a 3x3
170% square kernel, 25 for a 5x5 square kernel, 49 for 7x7, etc.
171% Values can be space or comma separated. This is not recommended.
anthony602ab9b2010-01-05 08:06:50 +0000172%
anthony83ba99b2010-01-24 08:48:15 +0000173% Note that 'name' kernels will start with an alphabetic character while the
174% new kernel specification has a ':' character in its specification string.
175% If neither is the case, it is assumed an old style of a simple list of
176% numbers generating a odd-sized square kernel has been given.
anthony602ab9b2010-01-05 08:06:50 +0000177%
178% The format of the AcquireKernal method is:
179%
cristy2be15382010-01-21 02:38:03 +0000180% KernelInfo *AcquireKernelInfo(const char *kernel_string)
anthony602ab9b2010-01-05 08:06:50 +0000181%
182% A description of each parameter follows:
183%
184% o kernel_string: the Morphology/Convolution kernel wanted.
185%
186*/
187
cristy2be15382010-01-21 02:38:03 +0000188MagickExport KernelInfo *AcquireKernelInfo(const char *kernel_string)
anthony602ab9b2010-01-05 08:06:50 +0000189{
cristy2be15382010-01-21 02:38:03 +0000190 KernelInfo
anthony602ab9b2010-01-05 08:06:50 +0000191 *kernel;
192
193 char
194 token[MaxTextExtent];
195
cristy150989e2010-02-01 14:59:39 +0000196 register long
anthony602ab9b2010-01-05 08:06:50 +0000197 i;
198
199 const char
200 *p;
201
202 MagickStatusType
203 flags;
204
205 GeometryInfo
206 args;
207
anthony29188a82010-01-22 10:12:34 +0000208 double
209 nan = sqrt((double)-1.0); /* Special Value : Not A Number */
210
anthony602ab9b2010-01-05 08:06:50 +0000211 assert(kernel_string != (const char *) NULL);
212 SetGeometryInfo(&args);
213
214 /* does it start with an alpha - Return a builtin kernel */
215 GetMagickToken(kernel_string,&p,token);
216 if ( isalpha((int)token[0]) )
217 {
218 long
219 type;
220
anthony29188a82010-01-22 10:12:34 +0000221 type=ParseMagickOption(MagickKernelOptions,MagickFalse,token);
anthony602ab9b2010-01-05 08:06:50 +0000222 if ( type < 0 || type == UserDefinedKernel )
cristy2be15382010-01-21 02:38:03 +0000223 return((KernelInfo *)NULL);
anthony602ab9b2010-01-05 08:06:50 +0000224
225 while (((isspace((int) ((unsigned char) *p)) != 0) ||
226 (*p == ',') || (*p == ':' )) && (*p != '\0'))
227 p++;
228 flags = ParseGeometry(p, &args);
229
230 /* special handling of missing values in input string */
anthony4fd27e22010-02-07 08:17:18 +0000231 switch( type ) {
232 case RectangleKernel:
anthony602ab9b2010-01-05 08:06:50 +0000233 if ( (flags & WidthValue) == 0 ) /* if no width then */
234 args.rho = args.sigma; /* then width = height */
235 if ( args.rho < 1.0 ) /* if width too small */
236 args.rho = 3; /* then width = 3 */
237 if ( args.sigma < 1.0 ) /* if height too small */
238 args.sigma = args.rho; /* then height = width */
239 if ( (flags & XValue) == 0 ) /* center offset if not defined */
240 args.xi = (double)(((long)args.rho-1)/2);
241 if ( (flags & YValue) == 0 )
242 args.psi = (double)(((long)args.sigma-1)/2);
anthony4fd27e22010-02-07 08:17:18 +0000243 break;
244 case SquareKernel:
245 case DiamondKernel:
246 case DiskKernel:
247 case PlusKernel:
248 if ( (flags & HeightValue) == 0 ) /* if no scale */
249 args.sigma = 1.0; /* then scale = 1.0 */
250 break;
251 default:
252 break;
anthony602ab9b2010-01-05 08:06:50 +0000253 }
254
cristy2be15382010-01-21 02:38:03 +0000255 return(AcquireKernelBuiltIn((KernelInfoType)type, &args));
anthony602ab9b2010-01-05 08:06:50 +0000256 }
257
cristy2be15382010-01-21 02:38:03 +0000258 kernel=(KernelInfo *) AcquireMagickMemory(sizeof(*kernel));
259 if (kernel == (KernelInfo *)NULL)
anthony602ab9b2010-01-05 08:06:50 +0000260 return(kernel);
261 (void) ResetMagickMemory(kernel,0,sizeof(*kernel));
262 kernel->type = UserDefinedKernel;
cristyd43a46b2010-01-21 02:13:41 +0000263 kernel->signature = MagickSignature;
anthony602ab9b2010-01-05 08:06:50 +0000264
265 /* Has a ':' in argument - New user kernel specification */
266 p = strchr(kernel_string, ':');
267 if ( p != (char *) NULL)
268 {
anthony602ab9b2010-01-05 08:06:50 +0000269 /* ParseGeometry() needs the geometry separated! -- Arrgghh */
cristy150989e2010-02-01 14:59:39 +0000270 memcpy(token, kernel_string, (size_t) (p-kernel_string));
anthony602ab9b2010-01-05 08:06:50 +0000271 token[p-kernel_string] = '\0';
272 flags = ParseGeometry(token, &args);
anthony602ab9b2010-01-05 08:06:50 +0000273
anthony29188a82010-01-22 10:12:34 +0000274 /* Size handling and checks of geometry settings */
anthony602ab9b2010-01-05 08:06:50 +0000275 if ( (flags & WidthValue) == 0 ) /* if no width then */
276 args.rho = args.sigma; /* then width = height */
277 if ( args.rho < 1.0 ) /* if width too small */
278 args.rho = 1.0; /* then width = 1 */
279 if ( args.sigma < 1.0 ) /* if height too small */
280 args.sigma = args.rho; /* then height = width */
281 kernel->width = (unsigned long)args.rho;
282 kernel->height = (unsigned long)args.sigma;
283
284 /* Offset Handling and Checks */
285 if ( args.xi < 0.0 || args.psi < 0.0 )
anthony83ba99b2010-01-24 08:48:15 +0000286 return(DestroyKernelInfo(kernel));
cristyc99304f2010-02-01 15:26:27 +0000287 kernel->x = ((flags & XValue)!=0) ? (long)args.xi
cristy150989e2010-02-01 14:59:39 +0000288 : (long) (kernel->width-1)/2;
cristyc99304f2010-02-01 15:26:27 +0000289 kernel->y = ((flags & YValue)!=0) ? (long)args.psi
cristy150989e2010-02-01 14:59:39 +0000290 : (long) (kernel->height-1)/2;
cristyc99304f2010-02-01 15:26:27 +0000291 if ( kernel->x >= (long) kernel->width ||
292 kernel->y >= (long) kernel->height )
anthony83ba99b2010-01-24 08:48:15 +0000293 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000294
295 p++; /* advance beyond the ':' */
296 }
297 else
298 { /* ELSE - Old old kernel specification, forming odd-square kernel */
299 /* count up number of values given */
300 p=(const char *) kernel_string;
cristya699b172010-01-06 16:48:49 +0000301 while ((isspace((int) ((unsigned char) *p)) != 0) || (*p == '\''))
anthony29188a82010-01-22 10:12:34 +0000302 p++; /* ignore "'" chars for convolve filter usage - Cristy */
anthony602ab9b2010-01-05 08:06:50 +0000303 for (i=0; *p != '\0'; i++)
304 {
305 GetMagickToken(p,&p,token);
306 if (*token == ',')
307 GetMagickToken(p,&p,token);
308 }
309 /* set the size of the kernel - old sized square */
310 kernel->width = kernel->height= (unsigned long) sqrt((double) i+1.0);
cristyc99304f2010-02-01 15:26:27 +0000311 kernel->x = kernel->y = (long) (kernel->width-1)/2;
anthony602ab9b2010-01-05 08:06:50 +0000312 p=(const char *) kernel_string;
anthony29188a82010-01-22 10:12:34 +0000313 while ((isspace((int) ((unsigned char) *p)) != 0) || (*p == '\''))
314 p++; /* ignore "'" chars for convolve filter usage - Cristy */
anthony602ab9b2010-01-05 08:06:50 +0000315 }
316
317 /* Read in the kernel values from rest of input string argument */
318 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
319 kernel->height*sizeof(double));
320 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000321 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000322
cristyc99304f2010-02-01 15:26:27 +0000323 kernel->minimum = +MagickHuge;
324 kernel->maximum = -MagickHuge;
325 kernel->negative_range = kernel->positive_range = 0.0;
cristy150989e2010-02-01 14:59:39 +0000326 for (i=0; (i < (long) (kernel->width*kernel->height)) && (*p != '\0'); i++)
anthony602ab9b2010-01-05 08:06:50 +0000327 {
328 GetMagickToken(p,&p,token);
329 if (*token == ',')
330 GetMagickToken(p,&p,token);
anthony29188a82010-01-22 10:12:34 +0000331 if ( LocaleCompare("nan",token) == 0
332 || LocaleCompare("-",token) == 0 ) {
333 kernel->values[i] = nan; /* do not include this value in kernel */
334 }
335 else {
336 kernel->values[i] = StringToDouble(token);
337 ( kernel->values[i] < 0)
cristyc99304f2010-02-01 15:26:27 +0000338 ? ( kernel->negative_range += kernel->values[i] )
339 : ( kernel->positive_range += kernel->values[i] );
340 Minimize(kernel->minimum, kernel->values[i]);
341 Maximize(kernel->maximum, kernel->values[i]);
anthony29188a82010-01-22 10:12:34 +0000342 }
anthony602ab9b2010-01-05 08:06:50 +0000343 }
anthonycc6c8362010-01-25 04:14:01 +0000344 /* check that we recieved at least one real (non-nan) value! */
cristyc99304f2010-02-01 15:26:27 +0000345 if ( kernel->minimum == MagickHuge )
anthonycc6c8362010-01-25 04:14:01 +0000346 return(DestroyKernelInfo(kernel));
anthony29188a82010-01-22 10:12:34 +0000347
anthonycc6c8362010-01-25 04:14:01 +0000348 /* This should not be needed for a fully defined kernel
anthony29188a82010-01-22 10:12:34 +0000349 * Perhaps an error should be reported instead!
anthonycc6c8362010-01-25 04:14:01 +0000350 * Kept for backward compatibility.
anthony29188a82010-01-22 10:12:34 +0000351 */
cristy150989e2010-02-01 14:59:39 +0000352 if ( i < (long) (kernel->width*kernel->height) ) {
cristyc99304f2010-02-01 15:26:27 +0000353 Minimize(kernel->minimum, kernel->values[i]);
354 Maximize(kernel->maximum, kernel->values[i]);
cristy150989e2010-02-01 14:59:39 +0000355 for ( ; i < (long) (kernel->width*kernel->height); i++)
anthony29188a82010-01-22 10:12:34 +0000356 kernel->values[i]=0.0;
357 }
anthony602ab9b2010-01-05 08:06:50 +0000358
359 return(kernel);
360}
361
362/*
363%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
364% %
365% %
366% %
367% A c q u i r e K e r n e l B u i l t I n %
368% %
369% %
370% %
371%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
372%
373% AcquireKernelBuiltIn() returned one of the 'named' built-in types of
374% kernels used for special purposes such as gaussian blurring, skeleton
375% pruning, and edge distance determination.
376%
377% They take a KernelType, and a set of geometry style arguments, which were
378% typically decoded from a user supplied string, or from a more complex
379% Morphology Method that was requested.
380%
381% The format of the AcquireKernalBuiltIn method is:
382%
cristy2be15382010-01-21 02:38:03 +0000383% KernelInfo *AcquireKernelBuiltIn(const KernelInfoType type,
anthony602ab9b2010-01-05 08:06:50 +0000384% const GeometryInfo args)
385%
386% A description of each parameter follows:
387%
388% o type: the pre-defined type of kernel wanted
389%
390% o args: arguments defining or modifying the kernel
391%
392% Convolution Kernels
393%
anthony4fd27e22010-02-07 08:17:18 +0000394% Gaussian "{radius},{sigma}"
anthony602ab9b2010-01-05 08:06:50 +0000395% Generate a two-dimentional gaussian kernel, as used by -gaussian
396% A sigma is required, (with the 'x'), due to historical reasons.
397%
398% NOTE: that the 'radius' is optional, but if provided can limit (clip)
399% the final size of the resulting kernel to a square 2*radius+1 in size.
400% The radius should be at least 2 times that of the sigma value, or
401% sever clipping and aliasing may result. If not given or set to 0 the
402% radius will be determined so as to produce the best minimal error
403% result, which is usally much larger than is normally needed.
404%
anthony4fd27e22010-02-07 08:17:18 +0000405% Blur "{radius},{sigma},{angle}"
anthony602ab9b2010-01-05 08:06:50 +0000406% As per Gaussian, but generates a 1 dimensional or linear gaussian
407% blur, at the angle given (current restricted to orthogonal angles).
408% If a 'radius' is given the kernel is clipped to a width of 2*radius+1.
409%
410% NOTE that two such blurs perpendicular to each other is equivelent to
411% -blur and the previous gaussian, but is often 10 or more times faster.
412%
anthony4fd27e22010-02-07 08:17:18 +0000413% Comet "{width},{sigma},{angle}"
anthony602ab9b2010-01-05 08:06:50 +0000414% Blur in one direction only, mush like how a bright object leaves
415% a comet like trail. The Kernel is actually half a gaussian curve,
416% Adding two such blurs in oppiste directions produces a Linear Blur.
417%
418% NOTE: that the first argument is the width of the kernel and not the
419% radius of the kernel.
420%
421% # Still to be implemented...
422% #
anthony4fd27e22010-02-07 08:17:18 +0000423% # Sharpen "{radius},{sigma}
424% # Negated Gaussian (center zeroed and re-normalized),
425% # with a 2 unit positive peak. -- Check On line documentation
426% #
427% # Laplacian "{radius},{sigma}"
anthony602ab9b2010-01-05 08:06:50 +0000428% # Laplacian (a mexican hat like) Function
429% #
430% # LOG "{radius},{sigma1},{sigma2}
431% # Laplacian of Gaussian
432% #
433% # DOG "{radius},{sigma1},{sigma2}
anthony4fd27e22010-02-07 08:17:18 +0000434% # Difference of two Gaussians
435% #
436% # Filter2D
437% # Filter1D
438% # Set kernel values using a resize filter, and given scale (sigma)
439% # Cylindrical or Linear. Is this posible with an image?
440% #
anthony602ab9b2010-01-05 08:06:50 +0000441%
442% Boolean Kernels
443%
444% Rectangle "{geometry}"
445% Simply generate a rectangle of 1's with the size given. You can also
446% specify the location of the 'control point', otherwise the closest
447% pixel to the center of the rectangle is selected.
448%
449% Properly centered and odd sized rectangles work the best.
450%
anthony4fd27e22010-02-07 08:17:18 +0000451% Diamond "[{radius}[,{scale}]]"
anthony602ab9b2010-01-05 08:06:50 +0000452% Generate a diamond shaped kernal with given radius to the points.
453% Kernel size will again be radius*2+1 square and defaults to radius 1,
454% generating a 3x3 kernel that is slightly larger than a square.
455%
anthony4fd27e22010-02-07 08:17:18 +0000456% Square "[{radius}[,{scale}]]"
anthony602ab9b2010-01-05 08:06:50 +0000457% Generate a square shaped kernel of size radius*2+1, and defaulting
458% to a 3x3 (radius 1).
459%
460% Note that using a larger radius for the "Square" or the "Diamond"
461% is also equivelent to iterating the basic morphological method
462% that many times. However However iterating with the smaller radius 1
463% default is actually faster than using a larger kernel radius.
464%
anthony4fd27e22010-02-07 08:17:18 +0000465% Disk "[{radius}[,{scale}]]
anthony602ab9b2010-01-05 08:06:50 +0000466% Generate a binary disk of the radius given, radius may be a float.
467% Kernel size will be ceil(radius)*2+1 square.
468% NOTE: Here are some disk shapes of specific interest
469% "disk:1" => "diamond" or "cross:1"
470% "disk:1.5" => "square"
471% "disk:2" => "diamond:2"
anthony83ba99b2010-01-24 08:48:15 +0000472% "disk:2.5" => a general disk shape of radius 2
anthony602ab9b2010-01-05 08:06:50 +0000473% "disk:2.9" => "square:2"
anthony83ba99b2010-01-24 08:48:15 +0000474% "disk:3.5" => default - octagonal/disk shape of radius 3
anthony602ab9b2010-01-05 08:06:50 +0000475% "disk:4.2" => roughly octagonal shape of radius 4
anthony83ba99b2010-01-24 08:48:15 +0000476% "disk:4.3" => a general disk shape of radius 4
anthony602ab9b2010-01-05 08:06:50 +0000477% After this all the kernel shape becomes more and more circular.
478%
479% Because a "disk" is more circular when using a larger radius, using a
480% larger radius is preferred over iterating the morphological operation.
481%
anthony4fd27e22010-02-07 08:17:18 +0000482% Plus "[{radius}[,{scale}]]"
anthony602ab9b2010-01-05 08:06:50 +0000483% Generate a kernel in the shape of a 'plus' sign. The length of each
484% arm is also the radius, which defaults to 2.
485%
486% This kernel is not a good general morphological kernel, but is used
487% more for highlighting and marking any single pixels in an image using,
488% a "Dilate" or "Erode" method as appropriate.
anthonyc94cdb02010-01-06 08:15:29 +0000489%
anthony602ab9b2010-01-05 08:06:50 +0000490% NOTE: "plus:1" is equivelent to a "Diamond" kernel.
491%
492% Note that unlike other kernels iterating a plus does not produce the
493% same result as using a larger radius for the cross.
494%
495% Distance Measuring Kernels
496%
497% Chebyshev "[{radius}][x{scale}]" largest x or y distance (default r=1)
498% Manhatten "[{radius}][x{scale}]" square grid distance (default r=1)
anthonyc94cdb02010-01-06 08:15:29 +0000499% Euclidean "[{radius}][x{scale}]" direct distance (default r=1)
anthony602ab9b2010-01-05 08:06:50 +0000500%
501% Different types of distance measuring methods, which are used with the
502% a 'Distance' morphology method for generating a gradient based on
503% distance from an edge of a binary shape, though there is a technique
504% for handling a anti-aliased shape.
505%
anthonyc94cdb02010-01-06 08:15:29 +0000506% Chebyshev Distance (also known as Tchebychev Distance) is a value of
507% one to any neighbour, orthogonal or diagonal. One why of thinking of
508% it is the number of squares a 'King' or 'Queen' in chess needs to
509% traverse reach any other position on a chess board. It results in a
510% 'square' like distance function, but one where diagonals are closer
511% than expected.
anthony602ab9b2010-01-05 08:06:50 +0000512%
anthonyc94cdb02010-01-06 08:15:29 +0000513% Manhatten Distance (also known as Rectilinear Distance, or the Taxi
514% Cab metric), is the distance needed when you can only travel in
515% orthogonal (horizontal or vertical) only. It is the distance a 'Rook'
516% in chess would travel. It results in a diamond like distances, where
517% diagonals are further than expected.
anthony602ab9b2010-01-05 08:06:50 +0000518%
anthonyc94cdb02010-01-06 08:15:29 +0000519% Euclidean Distance is the 'direct' or 'as the crow flys distance.
520% However by default the kernel size only has a radius of 1, which
521% limits the distance to 'Knight' like moves, with only orthogonal and
522% diagonal measurements being correct. As such for the default kernel
523% you will get octagonal like distance function, which is reasonally
524% accurate.
525%
526% However if you use a larger radius such as "Euclidean:4" you will
527% get a much smoother distance gradient from the edge of the shape.
528% Of course a larger kernel is slower to use, and generally not needed.
529%
530% To allow the use of fractional distances that you get with diagonals
531% the actual distance is scaled by a fixed value which the user can
532% provide. This is not actually nessary for either ""Chebyshev" or
533% "Manhatten" distance kernels, but is done for all three distance
534% kernels. If no scale is provided it is set to a value of 100,
535% allowing for a maximum distance measurement of 655 pixels using a Q16
536% version of IM, from any edge. However for small images this can
537% result in quite a dark gradient.
538%
539% See the 'Distance' Morphological Method, for information of how it is
540% applied.
anthony602ab9b2010-01-05 08:06:50 +0000541%
anthony4fd27e22010-02-07 08:17:18 +0000542% # Hit-n-Miss Kernel-Lists -- Still to be implemented
543% #
544% # specifically for Pruning, Thinning, Thickening
545% #
anthony602ab9b2010-01-05 08:06:50 +0000546*/
547
cristy2be15382010-01-21 02:38:03 +0000548MagickExport KernelInfo *AcquireKernelBuiltIn(const KernelInfoType type,
anthony602ab9b2010-01-05 08:06:50 +0000549 const GeometryInfo *args)
550{
cristy2be15382010-01-21 02:38:03 +0000551 KernelInfo
anthony602ab9b2010-01-05 08:06:50 +0000552 *kernel;
553
cristy150989e2010-02-01 14:59:39 +0000554 register long
anthony602ab9b2010-01-05 08:06:50 +0000555 i;
556
557 register long
558 u,
559 v;
560
561 double
562 nan = sqrt((double)-1.0); /* Special Value : Not A Number */
563
cristy2be15382010-01-21 02:38:03 +0000564 kernel=(KernelInfo *) AcquireMagickMemory(sizeof(*kernel));
565 if (kernel == (KernelInfo *) NULL)
anthony602ab9b2010-01-05 08:06:50 +0000566 return(kernel);
567 (void) ResetMagickMemory(kernel,0,sizeof(*kernel));
cristyc99304f2010-02-01 15:26:27 +0000568 kernel->minimum = kernel->maximum = 0.0;
569 kernel->negative_range = kernel->positive_range = 0.0;
anthony602ab9b2010-01-05 08:06:50 +0000570 kernel->type = type;
cristyd43a46b2010-01-21 02:13:41 +0000571 kernel->signature = MagickSignature;
anthony602ab9b2010-01-05 08:06:50 +0000572
573 switch(type) {
574 /* Convolution Kernels */
575 case GaussianKernel:
576 { double
577 sigma = fabs(args->sigma);
578
579 sigma = (sigma <= MagickEpsilon) ? 1.0 : sigma;
580
581 kernel->width = kernel->height =
582 GetOptimalKernelWidth2D(args->rho,sigma);
cristyc99304f2010-02-01 15:26:27 +0000583 kernel->x = kernel->y = (long) (kernel->width-1)/2;
584 kernel->negative_range = kernel->positive_range = 0.0;
anthony602ab9b2010-01-05 08:06:50 +0000585 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
586 kernel->height*sizeof(double));
587 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000588 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000589
590 sigma = 2.0*sigma*sigma; /* simplify the expression */
cristyc99304f2010-02-01 15:26:27 +0000591 for ( i=0, v=-kernel->y; v <= (long)kernel->y; v++)
592 for ( u=-kernel->x; u <= (long)kernel->x; u++, i++)
593 kernel->positive_range += (
anthony602ab9b2010-01-05 08:06:50 +0000594 kernel->values[i] =
595 exp(-((double)(u*u+v*v))/sigma)
596 /* / (MagickPI*sigma) */ );
cristyc99304f2010-02-01 15:26:27 +0000597 kernel->minimum = 0;
598 kernel->maximum = kernel->values[
599 kernel->y*kernel->width+kernel->x ];
anthony602ab9b2010-01-05 08:06:50 +0000600
anthony4fd27e22010-02-07 08:17:18 +0000601 ScaleKernelInfo(kernel, 0.0); /* Normalize Kernel Values */
anthony602ab9b2010-01-05 08:06:50 +0000602
603 break;
604 }
605 case BlurKernel:
606 { double
607 sigma = fabs(args->sigma);
608
609 sigma = (sigma <= MagickEpsilon) ? 1.0 : sigma;
610
611 kernel->width = GetOptimalKernelWidth1D(args->rho,sigma);
cristyc99304f2010-02-01 15:26:27 +0000612 kernel->x = (long) (kernel->width-1)/2;
anthony602ab9b2010-01-05 08:06:50 +0000613 kernel->height = 1;
cristyc99304f2010-02-01 15:26:27 +0000614 kernel->y = 0;
615 kernel->negative_range = kernel->positive_range = 0.0;
anthony602ab9b2010-01-05 08:06:50 +0000616 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
617 kernel->height*sizeof(double));
618 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000619 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000620
621#if 1
622#define KernelRank 3
623 /* Formula derived from GetBlurKernel() in "effect.c" (plus bug fix).
624 ** It generates a gaussian 3 times the width, and compresses it into
625 ** the expected range. This produces a closer normalization of the
626 ** resulting kernel, especially for very low sigma values.
627 ** As such while wierd it is prefered.
628 **
629 ** I am told this method originally came from Photoshop.
630 */
631 sigma *= KernelRank; /* simplify expanded curve */
cristy150989e2010-02-01 14:59:39 +0000632 v = (long) (kernel->width*KernelRank-1)/2; /* start/end points to fit range */
anthony602ab9b2010-01-05 08:06:50 +0000633 (void) ResetMagickMemory(kernel->values,0, (size_t)
634 kernel->width*sizeof(double));
635 for ( u=-v; u <= v; u++) {
636 kernel->values[(u+v)/KernelRank] +=
637 exp(-((double)(u*u))/(2.0*sigma*sigma))
638 /* / (MagickSQ2PI*sigma/KernelRank) */ ;
639 }
cristy150989e2010-02-01 14:59:39 +0000640 for (i=0; i < (long) kernel->width; i++)
cristyc99304f2010-02-01 15:26:27 +0000641 kernel->positive_range += kernel->values[i];
anthony602ab9b2010-01-05 08:06:50 +0000642#else
cristyc99304f2010-02-01 15:26:27 +0000643 for ( i=0, u=-kernel->x; i < kernel->width; i++, u++)
644 kernel->positive_range += (
anthony602ab9b2010-01-05 08:06:50 +0000645 kernel->values[i] =
646 exp(-((double)(u*u))/(2.0*sigma*sigma))
647 /* / (MagickSQ2PI*sigma) */ );
648#endif
cristyc99304f2010-02-01 15:26:27 +0000649 kernel->minimum = 0;
650 kernel->maximum = kernel->values[ kernel->x ];
anthonycc6c8362010-01-25 04:14:01 +0000651 /* Note that neither methods above generate a normalized kernel,
652 ** though it gets close. The kernel may be 'clipped' by a user defined
653 ** radius, producing a smaller (darker) kernel. Also for very small
654 ** sigma's (> 0.1) the central value becomes larger than one, and thus
655 ** producing a very bright kernel.
anthony602ab9b2010-01-05 08:06:50 +0000656 */
anthonycc6c8362010-01-25 04:14:01 +0000657
anthony602ab9b2010-01-05 08:06:50 +0000658 /* Normalize the 1D Gaussian Kernel
659 **
660 ** Because of this the divisor in the above kernel generator is
anthonyc94cdb02010-01-06 08:15:29 +0000661 ** not needed, so is not done above.
anthony602ab9b2010-01-05 08:06:50 +0000662 */
anthony4fd27e22010-02-07 08:17:18 +0000663 ScaleKernelInfo(kernel, 0.0); /* Normalize Kernel Values */
anthonycc6c8362010-01-25 04:14:01 +0000664
anthony602ab9b2010-01-05 08:06:50 +0000665 /* rotate the kernel by given angle */
anthony4fd27e22010-02-07 08:17:18 +0000666 RotateKernelInfo(kernel, args->xi);
anthony602ab9b2010-01-05 08:06:50 +0000667 break;
668 }
669 case CometKernel:
670 { double
671 sigma = fabs(args->sigma);
672
673 sigma = (sigma <= MagickEpsilon) ? 1.0 : sigma;
674
675 if ( args->rho < 1.0 )
676 kernel->width = GetOptimalKernelWidth1D(args->rho,sigma);
677 else
678 kernel->width = (unsigned long)args->rho;
cristyc99304f2010-02-01 15:26:27 +0000679 kernel->x = kernel->y = 0;
anthony602ab9b2010-01-05 08:06:50 +0000680 kernel->height = 1;
cristyc99304f2010-02-01 15:26:27 +0000681 kernel->negative_range = kernel->positive_range = 0.0;
anthony602ab9b2010-01-05 08:06:50 +0000682 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
683 kernel->height*sizeof(double));
684 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000685 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000686
687 /* A comet blur is half a gaussian curve, so that the object is
688 ** blurred in one direction only. This may not be quite the right
689 ** curve so may change in the future. The function must be normalised.
690 */
691#if 1
692#define KernelRank 3
693 sigma *= KernelRank; /* simplify expanded curve */
cristy150989e2010-02-01 14:59:39 +0000694 v = (long) kernel->width*KernelRank; /* start/end points to fit range */
anthony602ab9b2010-01-05 08:06:50 +0000695 (void) ResetMagickMemory(kernel->values,0, (size_t)
696 kernel->width*sizeof(double));
697 for ( u=0; u < v; u++) {
698 kernel->values[u/KernelRank] +=
699 exp(-((double)(u*u))/(2.0*sigma*sigma))
700 /* / (MagickSQ2PI*sigma/KernelRank) */ ;
701 }
cristy150989e2010-02-01 14:59:39 +0000702 for (i=0; i < (long) kernel->width; i++)
cristyc99304f2010-02-01 15:26:27 +0000703 kernel->positive_range += kernel->values[i];
anthony602ab9b2010-01-05 08:06:50 +0000704#else
cristy150989e2010-02-01 14:59:39 +0000705 for ( i=0; i < (long) kernel->width; i++)
cristyc99304f2010-02-01 15:26:27 +0000706 kernel->positive_range += (
anthony602ab9b2010-01-05 08:06:50 +0000707 kernel->values[i] =
708 exp(-((double)(i*i))/(2.0*sigma*sigma))
709 /* / (MagickSQ2PI*sigma) */ );
710#endif
cristyc99304f2010-02-01 15:26:27 +0000711 kernel->minimum = 0;
712 kernel->maximum = kernel->values[0];
anthony602ab9b2010-01-05 08:06:50 +0000713
anthony4fd27e22010-02-07 08:17:18 +0000714 ScaleKernelInfo(kernel, 0.0); /* Normalize Kernel Values */
715 RotateKernelInfo(kernel, args->xi);
anthony602ab9b2010-01-05 08:06:50 +0000716 break;
717 }
718 /* Boolean Kernels */
719 case RectangleKernel:
720 case SquareKernel:
721 {
anthony4fd27e22010-02-07 08:17:18 +0000722 double scale;
anthony602ab9b2010-01-05 08:06:50 +0000723 if ( type == SquareKernel )
724 {
725 if (args->rho < 1.0)
anthonyc94cdb02010-01-06 08:15:29 +0000726 kernel->width = kernel->height = 3; /* default radius = 1 */
anthony602ab9b2010-01-05 08:06:50 +0000727 else
cristy150989e2010-02-01 14:59:39 +0000728 kernel->width = kernel->height = (unsigned long) (2*args->rho+1);
cristyc99304f2010-02-01 15:26:27 +0000729 kernel->x = kernel->y = (long) (kernel->width-1)/2;
anthony4fd27e22010-02-07 08:17:18 +0000730 scale = args->sigma;
anthony602ab9b2010-01-05 08:06:50 +0000731 }
732 else {
cristy2be15382010-01-21 02:38:03 +0000733 /* NOTE: user defaults set in "AcquireKernelInfo()" */
anthony602ab9b2010-01-05 08:06:50 +0000734 if ( args->rho < 1.0 || args->sigma < 1.0 )
anthony83ba99b2010-01-24 08:48:15 +0000735 return(DestroyKernelInfo(kernel)); /* invalid args given */
anthony602ab9b2010-01-05 08:06:50 +0000736 kernel->width = (unsigned long)args->rho;
737 kernel->height = (unsigned long)args->sigma;
738 if ( args->xi < 0.0 || args->xi > (double)kernel->width ||
739 args->psi < 0.0 || args->psi > (double)kernel->height )
anthony83ba99b2010-01-24 08:48:15 +0000740 return(DestroyKernelInfo(kernel)); /* invalid args given */
cristyc99304f2010-02-01 15:26:27 +0000741 kernel->x = (long) args->xi;
742 kernel->y = (long) args->psi;
anthony4fd27e22010-02-07 08:17:18 +0000743 scale = 1.0;
anthony602ab9b2010-01-05 08:06:50 +0000744 }
745 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
746 kernel->height*sizeof(double));
747 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000748 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000749
anthonycc6c8362010-01-25 04:14:01 +0000750 /* set all kernel values to 1.0 */
cristy150989e2010-02-01 14:59:39 +0000751 u=(long) kernel->width*kernel->height;
752 for ( i=0; i < u; i++)
anthony4fd27e22010-02-07 08:17:18 +0000753 kernel->values[i] = scale;
754 kernel->minimum = kernel->maximum = scale; /* a flat shape */
755 kernel->positive_range = scale*u;
anthonycc6c8362010-01-25 04:14:01 +0000756 break;
anthony602ab9b2010-01-05 08:06:50 +0000757 }
758 case DiamondKernel:
759 {
760 if (args->rho < 1.0)
anthonyc94cdb02010-01-06 08:15:29 +0000761 kernel->width = kernel->height = 3; /* default radius = 1 */
anthony602ab9b2010-01-05 08:06:50 +0000762 else
763 kernel->width = kernel->height = ((unsigned long)args->rho)*2+1;
cristyc99304f2010-02-01 15:26:27 +0000764 kernel->x = kernel->y = (long) (kernel->width-1)/2;
anthony602ab9b2010-01-05 08:06:50 +0000765
766 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
767 kernel->height*sizeof(double));
768 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000769 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000770
anthony4fd27e22010-02-07 08:17:18 +0000771 /* set all kernel values within diamond area to scale given */
cristyc99304f2010-02-01 15:26:27 +0000772 for ( i=0, v=-kernel->y; v <= (long)kernel->y; v++)
773 for ( u=-kernel->x; u <= (long)kernel->x; u++, i++)
774 if ((labs(u)+labs(v)) <= (long)kernel->x)
anthony4fd27e22010-02-07 08:17:18 +0000775 kernel->positive_range += kernel->values[i] = args->sigma;
anthony602ab9b2010-01-05 08:06:50 +0000776 else
777 kernel->values[i] = nan;
anthony4fd27e22010-02-07 08:17:18 +0000778 kernel->minimum = kernel->maximum = args->sigma; /* a flat shape */
anthony602ab9b2010-01-05 08:06:50 +0000779 break;
780 }
781 case DiskKernel:
782 {
783 long
784 limit;
785
786 limit = (long)(args->rho*args->rho);
anthony83ba99b2010-01-24 08:48:15 +0000787 if (args->rho < 0.1) /* default radius approx 3.5 */
788 kernel->width = kernel->height = 7L, limit = 10L;
anthony602ab9b2010-01-05 08:06:50 +0000789 else
790 kernel->width = kernel->height = ((unsigned long)args->rho)*2+1;
cristyc99304f2010-02-01 15:26:27 +0000791 kernel->x = kernel->y = (long) (kernel->width-1)/2;
anthony602ab9b2010-01-05 08:06:50 +0000792
793 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
794 kernel->height*sizeof(double));
795 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000796 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000797
anthonycc6c8362010-01-25 04:14:01 +0000798 /* set all kernel values within disk area to 1.0 */
cristyc99304f2010-02-01 15:26:27 +0000799 for ( i=0, v= -kernel->y; v <= (long)kernel->y; v++)
800 for ( u=-kernel->x; u <= (long)kernel->x; u++, i++)
anthony602ab9b2010-01-05 08:06:50 +0000801 if ((u*u+v*v) <= limit)
anthony4fd27e22010-02-07 08:17:18 +0000802 kernel->positive_range += kernel->values[i] = args->sigma;
anthony602ab9b2010-01-05 08:06:50 +0000803 else
804 kernel->values[i] = nan;
anthony4fd27e22010-02-07 08:17:18 +0000805 kernel->minimum = kernel->maximum = args->sigma; /* a flat shape */
anthony602ab9b2010-01-05 08:06:50 +0000806 break;
807 }
808 case PlusKernel:
809 {
810 if (args->rho < 1.0)
anthonyc94cdb02010-01-06 08:15:29 +0000811 kernel->width = kernel->height = 5; /* default radius 2 */
anthony602ab9b2010-01-05 08:06:50 +0000812 else
813 kernel->width = kernel->height = ((unsigned long)args->rho)*2+1;
cristyc99304f2010-02-01 15:26:27 +0000814 kernel->x = kernel->y = (long) (kernel->width-1)/2;
anthony602ab9b2010-01-05 08:06:50 +0000815
816 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
817 kernel->height*sizeof(double));
818 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000819 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000820
anthonycc6c8362010-01-25 04:14:01 +0000821 /* set all kernel values along axises to 1.0 */
cristyc99304f2010-02-01 15:26:27 +0000822 for ( i=0, v=-kernel->y; v <= (long)kernel->y; v++)
823 for ( u=-kernel->x; u <= (long)kernel->x; u++, i++)
anthony4fd27e22010-02-07 08:17:18 +0000824 kernel->values[i] = (u == 0 || v == 0) ? args->sigma : nan;
825 kernel->minimum = kernel->maximum = args->sigma; /* a flat shape */
826 kernel->positive_range = args->sigma*(kernel->width*2.0 - 1.0);
anthony602ab9b2010-01-05 08:06:50 +0000827 break;
828 }
829 /* Distance Measuring Kernels */
830 case ChebyshevKernel:
831 {
832 double
833 scale;
834
835 if (args->rho < 1.0)
anthonyc94cdb02010-01-06 08:15:29 +0000836 kernel->width = kernel->height = 3; /* default radius = 1 */
anthony602ab9b2010-01-05 08:06:50 +0000837 else
838 kernel->width = kernel->height = ((unsigned long)args->rho)*2+1;
cristyc99304f2010-02-01 15:26:27 +0000839 kernel->x = kernel->y = (long) (kernel->width-1)/2;
anthony602ab9b2010-01-05 08:06:50 +0000840
841 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
842 kernel->height*sizeof(double));
843 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000844 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000845
846 scale = (args->sigma < 1.0) ? 100.0 : args->sigma;
cristyc99304f2010-02-01 15:26:27 +0000847 for ( i=0, v=-kernel->y; v <= (long)kernel->y; v++)
848 for ( u=-kernel->x; u <= (long)kernel->x; u++, i++)
849 kernel->positive_range += ( kernel->values[i] =
anthony602ab9b2010-01-05 08:06:50 +0000850 scale*((labs(u)>labs(v)) ? labs(u) : labs(v)) );
cristyc99304f2010-02-01 15:26:27 +0000851 kernel->maximum = kernel->values[0];
anthony602ab9b2010-01-05 08:06:50 +0000852 break;
853 }
854 case ManhattenKernel:
855 {
856 double
857 scale;
858
859 if (args->rho < 1.0)
anthonyc94cdb02010-01-06 08:15:29 +0000860 kernel->width = kernel->height = 3; /* default radius = 1 */
anthony602ab9b2010-01-05 08:06:50 +0000861 else
862 kernel->width = kernel->height = ((unsigned long)args->rho)*2+1;
cristyc99304f2010-02-01 15:26:27 +0000863 kernel->x = kernel->y = (long) (kernel->width-1)/2;
anthony602ab9b2010-01-05 08:06:50 +0000864
865 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
866 kernel->height*sizeof(double));
867 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000868 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000869
870 scale = (args->sigma < 1.0) ? 100.0 : args->sigma;
cristyc99304f2010-02-01 15:26:27 +0000871 for ( i=0, v=-kernel->y; v <= (long)kernel->y; v++)
872 for ( u=-kernel->x; u <= (long)kernel->x; u++, i++)
873 kernel->positive_range += ( kernel->values[i] =
anthony602ab9b2010-01-05 08:06:50 +0000874 scale*(labs(u)+labs(v)) );
cristyc99304f2010-02-01 15:26:27 +0000875 kernel->maximum = kernel->values[0];
anthony602ab9b2010-01-05 08:06:50 +0000876 break;
877 }
878 case EuclideanKernel:
879 {
880 double
881 scale;
882
883 if (args->rho < 1.0)
anthonyc94cdb02010-01-06 08:15:29 +0000884 kernel->width = kernel->height = 3; /* default radius = 1 */
anthony602ab9b2010-01-05 08:06:50 +0000885 else
886 kernel->width = kernel->height = ((unsigned long)args->rho)*2+1;
cristyc99304f2010-02-01 15:26:27 +0000887 kernel->x = kernel->y = (long) (kernel->width-1)/2;
anthony602ab9b2010-01-05 08:06:50 +0000888
889 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
890 kernel->height*sizeof(double));
891 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000892 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000893
894 scale = (args->sigma < 1.0) ? 100.0 : args->sigma;
cristyc99304f2010-02-01 15:26:27 +0000895 for ( i=0, v=-kernel->y; v <= (long)kernel->y; v++)
896 for ( u=-kernel->x; u <= (long)kernel->x; u++, i++)
897 kernel->positive_range += ( kernel->values[i] =
anthony602ab9b2010-01-05 08:06:50 +0000898 scale*sqrt((double)(u*u+v*v)) );
cristyc99304f2010-02-01 15:26:27 +0000899 kernel->maximum = kernel->values[0];
anthony602ab9b2010-01-05 08:06:50 +0000900 break;
901 }
902 /* Undefined Kernels */
903 case LaplacianKernel:
904 case LOGKernel:
905 case DOGKernel:
cristy150989e2010-02-01 14:59:39 +0000906 perror("Kernel Type has not been defined yet");
anthony602ab9b2010-01-05 08:06:50 +0000907 /* FALL THRU */
908 default:
909 /* Generate a No-Op minimal kernel - 1x1 pixel */
910 kernel->values=(double *)AcquireQuantumMemory((size_t)1,sizeof(double));
911 if (kernel->values == (double *) NULL)
anthony83ba99b2010-01-24 08:48:15 +0000912 return(DestroyKernelInfo(kernel));
anthony602ab9b2010-01-05 08:06:50 +0000913 kernel->width = kernel->height = 1;
cristyc99304f2010-02-01 15:26:27 +0000914 kernel->x = kernel->x = 0;
anthony602ab9b2010-01-05 08:06:50 +0000915 kernel->type = UndefinedKernel;
cristyc99304f2010-02-01 15:26:27 +0000916 kernel->maximum =
917 kernel->positive_range =
anthonyc94cdb02010-01-06 08:15:29 +0000918 kernel->values[0] = 1.0; /* a flat single-point no-op kernel! */
anthony602ab9b2010-01-05 08:06:50 +0000919 break;
920 }
921
922 return(kernel);
923}
anthonyc94cdb02010-01-06 08:15:29 +0000924
anthony602ab9b2010-01-05 08:06:50 +0000925/*
926%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
927% %
928% %
929% %
anthony4fd27e22010-02-07 08:17:18 +0000930+ C l o n e K e r n e l I n f o %
931% %
932% %
933% %
934%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
935%
936% CloneKernelInfo() creates a new clone of the given Kernel so that its can
937% be modified without effecting the original. The cloned kernel should be
938% destroyed using DestoryKernelInfo() when no longer needed.
939%
940% The format of the DestroyKernelInfo method is:
941%
anthony930be612010-02-08 04:26:15 +0000942% KernelInfo *CloneKernelInfo(const KernelInfo *kernel)
anthony4fd27e22010-02-07 08:17:18 +0000943%
944% A description of each parameter follows:
945%
946% o kernel: the Morphology/Convolution kernel to be cloned
947%
948*/
949
anthony930be612010-02-08 04:26:15 +0000950static KernelInfo *CloneKernelInfo(const KernelInfo *kernel)
anthony4fd27e22010-02-07 08:17:18 +0000951{
952 register long
953 i;
954
955 KernelInfo *
956 new;
957
958 assert(kernel != (KernelInfo *) NULL);
959
960 new=(KernelInfo *) AcquireMagickMemory(sizeof(*kernel));
961 if (new == (KernelInfo *) NULL)
962 return(new);
963 *new = *kernel; /* copy values in structure */
964
965 new->values=(double *) AcquireQuantumMemory(kernel->width,
966 kernel->height*sizeof(double));
967 if (new->values == (double *) NULL)
968 return(DestroyKernelInfo(new));
969
970 for (i=0; i < (long) (kernel->width*kernel->height); i++)
971 new->values[i] = kernel->values[i];
972
973 return(new);
974}
975
976/*
977%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
978% %
979% %
980% %
anthony83ba99b2010-01-24 08:48:15 +0000981% D e s t r o y K e r n e l I n f o %
anthony602ab9b2010-01-05 08:06:50 +0000982% %
983% %
984% %
985%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
986%
anthony83ba99b2010-01-24 08:48:15 +0000987% DestroyKernelInfo() frees the memory used by a Convolution/Morphology
988% kernel.
anthony602ab9b2010-01-05 08:06:50 +0000989%
anthony83ba99b2010-01-24 08:48:15 +0000990% The format of the DestroyKernelInfo method is:
anthony602ab9b2010-01-05 08:06:50 +0000991%
anthony83ba99b2010-01-24 08:48:15 +0000992% KernelInfo *DestroyKernelInfo(KernelInfo *kernel)
anthony602ab9b2010-01-05 08:06:50 +0000993%
994% A description of each parameter follows:
995%
996% o kernel: the Morphology/Convolution kernel to be destroyed
997%
998*/
999
anthony83ba99b2010-01-24 08:48:15 +00001000MagickExport KernelInfo *DestroyKernelInfo(KernelInfo *kernel)
anthony602ab9b2010-01-05 08:06:50 +00001001{
cristy2be15382010-01-21 02:38:03 +00001002 assert(kernel != (KernelInfo *) NULL);
anthony4fd27e22010-02-07 08:17:18 +00001003
1004 kernel->values=(double *) AcquireQuantumMemory(kernel->width,
1005 kernel->height*sizeof(double));
anthony602ab9b2010-01-05 08:06:50 +00001006 kernel->values=(double *)RelinquishMagickMemory(kernel->values);
cristy2be15382010-01-21 02:38:03 +00001007 kernel=(KernelInfo *) RelinquishMagickMemory(kernel);
anthony602ab9b2010-01-05 08:06:50 +00001008 return(kernel);
1009}
anthonyc94cdb02010-01-06 08:15:29 +00001010
1011/*
1012%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1013% %
1014% %
1015% %
anthony29188a82010-01-22 10:12:34 +00001016% M o r p h o l o g y I m a g e C h a n n e l %
anthony602ab9b2010-01-05 08:06:50 +00001017% %
1018% %
1019% %
1020%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1021%
anthony29188a82010-01-22 10:12:34 +00001022% MorphologyImageChannel() applies a user supplied kernel to the image
1023% according to the given mophology method.
anthony602ab9b2010-01-05 08:06:50 +00001024%
1025% The given kernel is assumed to have been pre-scaled appropriatally, usally
1026% by the kernel generator.
1027%
1028% The format of the MorphologyImage method is:
1029%
anthony29188a82010-01-22 10:12:34 +00001030% Image *MorphologyImage(const Image *image, MorphologyMethod method,
1031% const long iterations, KernelInfo *kernel, ExceptionInfo *exception)
1032% Image *MorphologyImageChannel(const Image *image, const ChannelType
1033% channel, MorphologyMethod method, const long iterations, KernelInfo
1034% *kernel, ExceptionInfo *exception)
anthony602ab9b2010-01-05 08:06:50 +00001035%
1036% A description of each parameter follows:
1037%
1038% o image: the image.
1039%
1040% o method: the morphology method to be applied.
1041%
1042% o iterations: apply the operation this many times (or no change).
1043% A value of -1 means loop until no change found.
1044% How this is applied may depend on the morphology method.
1045% Typically this is a value of 1.
1046%
1047% o channel: the channel type.
1048%
1049% o kernel: An array of double representing the morphology kernel.
anthony29188a82010-01-22 10:12:34 +00001050% Warning: kernel may be normalized for the Convolve method.
anthony602ab9b2010-01-05 08:06:50 +00001051%
1052% o exception: return any errors or warnings in this structure.
1053%
1054%
1055% TODO: bias and auto-scale handling of the kernel for convolution
1056% The given kernel is assumed to have been pre-scaled appropriatally, usally
1057% by the kernel generator.
1058%
1059*/
1060
anthony930be612010-02-08 04:26:15 +00001061
anthony602ab9b2010-01-05 08:06:50 +00001062/* Internal function
anthony930be612010-02-08 04:26:15 +00001063 * Apply the Low-Level Morphology Method using the given Kernel
1064 * Returning the number of pixels that changed.
1065 * Two pre-created images must be provided, no image is created.
anthony602ab9b2010-01-05 08:06:50 +00001066 */
1067static unsigned long MorphologyApply(const Image *image, Image
1068 *result_image, const MorphologyMethod method, const ChannelType channel,
cristy2be15382010-01-21 02:38:03 +00001069 const KernelInfo *kernel, ExceptionInfo *exception)
anthony602ab9b2010-01-05 08:06:50 +00001070{
cristy2be15382010-01-21 02:38:03 +00001071#define MorphologyTag "Morphology/Image"
anthony602ab9b2010-01-05 08:06:50 +00001072
1073 long
cristy150989e2010-02-01 14:59:39 +00001074 progress,
anthony29188a82010-01-22 10:12:34 +00001075 y, offx, offy,
anthony602ab9b2010-01-05 08:06:50 +00001076 changed;
1077
1078 MagickBooleanType
1079 status;
1080
1081 MagickPixelPacket
1082 bias;
1083
1084 CacheView
1085 *p_view,
1086 *q_view;
1087
anthony4fd27e22010-02-07 08:17:18 +00001088 /* Only the most basic morphology is actually performed by this routine */
anthony4fd27e22010-02-07 08:17:18 +00001089
anthony602ab9b2010-01-05 08:06:50 +00001090 /*
anthony4fd27e22010-02-07 08:17:18 +00001091 Apply Basic Morphology to Image.
anthony602ab9b2010-01-05 08:06:50 +00001092 */
1093 status=MagickTrue;
1094 changed=0;
1095 progress=0;
1096
1097 GetMagickPixelPacket(image,&bias);
1098 SetMagickPixelPacketBias(image,&bias);
anthonycc6c8362010-01-25 04:14:01 +00001099 /* Future: handle auto-bias from user, based on kernel input */
anthony602ab9b2010-01-05 08:06:50 +00001100
1101 p_view=AcquireCacheView(image);
1102 q_view=AcquireCacheView(result_image);
anthony29188a82010-01-22 10:12:34 +00001103
anthonycc6c8362010-01-25 04:14:01 +00001104 /* Some methods (including convolve) needs use a reflected kernel.
1105 * Adjust 'origin' offsets for this reflected kernel.
anthony29188a82010-01-22 10:12:34 +00001106 */
cristyc99304f2010-02-01 15:26:27 +00001107 offx = kernel->x;
1108 offy = kernel->y;
anthony29188a82010-01-22 10:12:34 +00001109 switch(method) {
1110 case ErodeMorphology:
1111 case ErodeIntensityMorphology:
1112 /* kernel is not reflected */
1113 break;
anthony930be612010-02-08 04:26:15 +00001114 case ConvolveMorphology:
1115 case DilateMorphology:
1116 case DilateIntensityMorphology:
1117 case DistanceMorphology:
anthony29188a82010-01-22 10:12:34 +00001118 /* kernel needs to be reflected */
cristy150989e2010-02-01 14:59:39 +00001119 offx = (long) kernel->width-offx-1;
1120 offy = (long) kernel->height-offy-1;
anthony29188a82010-01-22 10:12:34 +00001121 break;
anthony930be612010-02-08 04:26:15 +00001122 default:
1123 perror("Not a low level Morpholgy Method");
1124 break;
anthony29188a82010-01-22 10:12:34 +00001125 }
1126
anthony602ab9b2010-01-05 08:06:50 +00001127#if defined(MAGICKCORE_OPENMP_SUPPORT)
1128 #pragma omp parallel for schedule(dynamic,4) shared(progress,status)
1129#endif
cristy150989e2010-02-01 14:59:39 +00001130 for (y=0; y < (long) image->rows; y++)
anthony602ab9b2010-01-05 08:06:50 +00001131 {
1132 MagickBooleanType
1133 sync;
1134
1135 register const PixelPacket
1136 *restrict p;
1137
1138 register const IndexPacket
1139 *restrict p_indexes;
1140
1141 register PixelPacket
1142 *restrict q;
1143
1144 register IndexPacket
1145 *restrict q_indexes;
1146
cristy150989e2010-02-01 14:59:39 +00001147 register long
anthony602ab9b2010-01-05 08:06:50 +00001148 x;
1149
anthony29188a82010-01-22 10:12:34 +00001150 unsigned long
anthony602ab9b2010-01-05 08:06:50 +00001151 r;
1152
1153 if (status == MagickFalse)
1154 continue;
anthony29188a82010-01-22 10:12:34 +00001155 p=GetCacheViewVirtualPixels(p_view, -offx, y-offy,
1156 image->columns+kernel->width, kernel->height, exception);
anthony602ab9b2010-01-05 08:06:50 +00001157 q=GetCacheViewAuthenticPixels(q_view,0,y,result_image->columns,1,
1158 exception);
1159 if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL))
1160 {
1161 status=MagickFalse;
1162 continue;
1163 }
1164 p_indexes=GetCacheViewVirtualIndexQueue(p_view);
1165 q_indexes=GetCacheViewAuthenticIndexQueue(q_view);
anthony29188a82010-01-22 10:12:34 +00001166 r = (image->columns+kernel->width)*offy+offx; /* constant */
1167
cristy150989e2010-02-01 14:59:39 +00001168 for (x=0; x < (long) image->columns; x++)
anthony602ab9b2010-01-05 08:06:50 +00001169 {
cristy150989e2010-02-01 14:59:39 +00001170 long
anthony602ab9b2010-01-05 08:06:50 +00001171 v;
1172
cristy150989e2010-02-01 14:59:39 +00001173 register long
anthony602ab9b2010-01-05 08:06:50 +00001174 u;
1175
1176 register const double
1177 *restrict k;
1178
1179 register const PixelPacket
1180 *restrict k_pixels;
1181
1182 register const IndexPacket
1183 *restrict k_indexes;
1184
1185 MagickPixelPacket
1186 result;
1187
anthony29188a82010-01-22 10:12:34 +00001188 /* Copy input to ouput image for unused channels
anthony83ba99b2010-01-24 08:48:15 +00001189 * This removes need for 'cloning' a new image every iteration
anthony29188a82010-01-22 10:12:34 +00001190 */
anthony602ab9b2010-01-05 08:06:50 +00001191 *q = p[r];
1192 if (image->colorspace == CMYKColorspace)
1193 q_indexes[x] = p_indexes[r];
1194
cristy150989e2010-02-01 14:59:39 +00001195 result.index=(MagickRealType) 0; /* stop compiler warnings */
anthony602ab9b2010-01-05 08:06:50 +00001196 switch (method) {
1197 case ConvolveMorphology:
anthony930be612010-02-08 04:26:15 +00001198 /* Set the user defined bias of the weighted average output
1199 **
1200 ** FUTURE: provide some way for internal functions to disable
1201 ** user defined bias and scaling effects.
1202 */
anthony602ab9b2010-01-05 08:06:50 +00001203 result=bias;
anthony930be612010-02-08 04:26:15 +00001204 break;
anthony83ba99b2010-01-24 08:48:15 +00001205 case DilateMorphology:
anthony29188a82010-01-22 10:12:34 +00001206 result.red =
1207 result.green =
1208 result.blue =
1209 result.opacity =
1210 result.index = -MagickHuge;
1211 break;
1212 case ErodeMorphology:
1213 result.red =
1214 result.green =
1215 result.blue =
1216 result.opacity =
1217 result.index = +MagickHuge;
1218 break;
anthony4fd27e22010-02-07 08:17:18 +00001219 case DilateIntensityMorphology:
1220 case ErodeIntensityMorphology:
1221 result.red = 0.0; /* flag indicating first match found */
1222 break;
anthony602ab9b2010-01-05 08:06:50 +00001223 default:
anthony29188a82010-01-22 10:12:34 +00001224 /* Otherwise just start with the original pixel value */
cristy150989e2010-02-01 14:59:39 +00001225 result.red = (MagickRealType) p[r].red;
1226 result.green = (MagickRealType) p[r].green;
1227 result.blue = (MagickRealType) p[r].blue;
1228 result.opacity = QuantumRange - (MagickRealType) p[r].opacity;
anthony602ab9b2010-01-05 08:06:50 +00001229 if ( image->colorspace == CMYKColorspace)
cristy150989e2010-02-01 14:59:39 +00001230 result.index = (MagickRealType) p_indexes[r];
anthony602ab9b2010-01-05 08:06:50 +00001231 break;
1232 }
1233
1234 switch ( method ) {
1235 case ConvolveMorphology:
anthony930be612010-02-08 04:26:15 +00001236 /* Weighted Average of pixels using reflected kernel
1237 **
1238 ** NOTE for correct working of this operation for asymetrical
1239 ** kernels, the kernel needs to be applied in its reflected form.
1240 ** That is its values needs to be reversed.
1241 **
1242 ** Correlation is actually the same as this but without reflecting
1243 ** the kernel, and thus 'lower-level' that Convolution. However
1244 ** as Convolution is the more common method used, and it does not
1245 ** really cost us much in terms of processing to use a reflected
1246 ** kernel it is Convolution that is implemented.
1247 **
1248 ** Correlation will have its kernel reflected before calling
1249 ** this function to do a Convolve.
1250 **
1251 ** For more details of Correlation vs Convolution see
1252 ** http://www.cs.umd.edu/~djacobs/CMSC426/Convolution.pdf
1253 */
anthony602ab9b2010-01-05 08:06:50 +00001254 if (((channel & OpacityChannel) == 0) ||
1255 (image->matte == MagickFalse))
1256 {
anthony930be612010-02-08 04:26:15 +00001257 /* Convolution without transparency effects */
anthony29188a82010-01-22 10:12:34 +00001258 k = &kernel->values[ kernel->width*kernel->height-1 ];
anthony602ab9b2010-01-05 08:06:50 +00001259 k_pixels = p;
1260 k_indexes = p_indexes;
cristy150989e2010-02-01 14:59:39 +00001261 for (v=0; v < (long) kernel->height; v++) {
1262 for (u=0; u < (long) kernel->width; u++, k--) {
anthony602ab9b2010-01-05 08:06:50 +00001263 if ( IsNan(*k) ) continue;
1264 result.red += (*k)*k_pixels[u].red;
1265 result.green += (*k)*k_pixels[u].green;
1266 result.blue += (*k)*k_pixels[u].blue;
anthony83ba99b2010-01-24 08:48:15 +00001267 /* result.opacity += not involved here */
anthony602ab9b2010-01-05 08:06:50 +00001268 if ( image->colorspace == CMYKColorspace)
1269 result.index += (*k)*k_indexes[u];
1270 }
1271 k_pixels += image->columns+kernel->width;
1272 k_indexes += image->columns+kernel->width;
1273 }
anthony602ab9b2010-01-05 08:06:50 +00001274 }
1275 else
1276 { /* Kernel & Alpha weighted Convolution */
1277 MagickRealType
1278 alpha, /* alpha value * kernel weighting */
1279 gamma; /* weighting divisor */
1280
1281 gamma=0.0;
anthony29188a82010-01-22 10:12:34 +00001282 k = &kernel->values[ kernel->width*kernel->height-1 ];
anthony602ab9b2010-01-05 08:06:50 +00001283 k_pixels = p;
1284 k_indexes = p_indexes;
cristy150989e2010-02-01 14:59:39 +00001285 for (v=0; v < (long) kernel->height; v++) {
1286 for (u=0; u < (long) kernel->width; u++, k--) {
anthony602ab9b2010-01-05 08:06:50 +00001287 if ( IsNan(*k) ) continue;
1288 alpha=(*k)*(QuantumScale*(QuantumRange-
1289 k_pixels[u].opacity));
1290 gamma += alpha;
1291 result.red += alpha*k_pixels[u].red;
1292 result.green += alpha*k_pixels[u].green;
1293 result.blue += alpha*k_pixels[u].blue;
anthony83ba99b2010-01-24 08:48:15 +00001294 result.opacity += (*k)*(QuantumRange-k_pixels[u].opacity);
anthony602ab9b2010-01-05 08:06:50 +00001295 if ( image->colorspace == CMYKColorspace)
1296 result.index += alpha*k_indexes[u];
1297 }
1298 k_pixels += image->columns+kernel->width;
1299 k_indexes += image->columns+kernel->width;
1300 }
1301 gamma=1.0/(fabs((double) gamma) <= MagickEpsilon ? 1.0 : gamma);
anthony83ba99b2010-01-24 08:48:15 +00001302 result.red *= gamma;
1303 result.green *= gamma;
1304 result.blue *= gamma;
1305 result.opacity *= gamma;
1306 result.index *= gamma;
anthony602ab9b2010-01-05 08:06:50 +00001307 }
1308 break;
1309
anthony4fd27e22010-02-07 08:17:18 +00001310 case ErodeMorphology:
anthony930be612010-02-08 04:26:15 +00001311 /* Minimize Value within kernel neighbourhood
1312 **
1313 ** NOTE that the kernel is not reflected for this operation!
1314 **
1315 ** NOTE: in normal Greyscale Morphology, the kernel value should
1316 ** be added to the real value, this is currently not done, due to
1317 ** the nature of the boolean kernels being used.
1318 */
anthony4fd27e22010-02-07 08:17:18 +00001319 k = kernel->values;
1320 k_pixels = p;
1321 k_indexes = p_indexes;
1322 for (v=0; v < (long) kernel->height; v++) {
1323 for (u=0; u < (long) kernel->width; u++, k++) {
1324 if ( IsNan(*k) || (*k) < 0.5 ) continue;
1325 Minimize(result.red, (double) k_pixels[u].red);
1326 Minimize(result.green, (double) k_pixels[u].green);
1327 Minimize(result.blue, (double) k_pixels[u].blue);
1328 Minimize(result.opacity, QuantumRange-(double) k_pixels[u].opacity);
1329 if ( image->colorspace == CMYKColorspace)
1330 Minimize(result.index, (double) k_indexes[u]);
1331 }
1332 k_pixels += image->columns+kernel->width;
1333 k_indexes += image->columns+kernel->width;
1334 }
1335 break;
1336
anthony83ba99b2010-01-24 08:48:15 +00001337 case DilateMorphology:
anthony930be612010-02-08 04:26:15 +00001338 /* Maximize Value within kernel neighbourhood
1339 **
1340 ** NOTE for correct working of this operation for asymetrical
1341 ** kernels, the kernel needs to be applied in its reflected form.
1342 ** That is its values needs to be reversed.
1343 **
1344 ** NOTE: in normal Greyscale Morphology, the kernel value should
1345 ** be added to the real value, this is currently not done, due to
1346 ** the nature of the boolean kernels being used.
1347 **
1348 */
anthony29188a82010-01-22 10:12:34 +00001349 k = &kernel->values[ kernel->width*kernel->height-1 ];
anthony602ab9b2010-01-05 08:06:50 +00001350 k_pixels = p;
1351 k_indexes = p_indexes;
cristy150989e2010-02-01 14:59:39 +00001352 for (v=0; v < (long) kernel->height; v++) {
1353 for (u=0; u < (long) kernel->width; u++, k--) {
anthony602ab9b2010-01-05 08:06:50 +00001354 if ( IsNan(*k) || (*k) < 0.5 ) continue;
cristy150989e2010-02-01 14:59:39 +00001355 Maximize(result.red, (double) k_pixels[u].red);
1356 Maximize(result.green, (double) k_pixels[u].green);
1357 Maximize(result.blue, (double) k_pixels[u].blue);
1358 Maximize(result.opacity, QuantumRange-(double) k_pixels[u].opacity);
anthony602ab9b2010-01-05 08:06:50 +00001359 if ( image->colorspace == CMYKColorspace)
cristy150989e2010-02-01 14:59:39 +00001360 Maximize(result.index, (double) k_indexes[u]);
anthony602ab9b2010-01-05 08:06:50 +00001361 }
1362 k_pixels += image->columns+kernel->width;
1363 k_indexes += image->columns+kernel->width;
1364 }
anthony602ab9b2010-01-05 08:06:50 +00001365 break;
1366
anthony4fd27e22010-02-07 08:17:18 +00001367 case ErodeIntensityMorphology:
anthony930be612010-02-08 04:26:15 +00001368 /* Select Pixel with Minimum Intensity within kernel neighbourhood
1369 **
1370 ** WARNING: the intensity test fails for CMYK and does not
1371 ** take into account the moderating effect of teh alpha channel
1372 ** on the intensity.
1373 **
1374 ** NOTE that the kernel is not reflected for this operation!
1375 */
anthony602ab9b2010-01-05 08:06:50 +00001376 k = kernel->values;
1377 k_pixels = p;
1378 k_indexes = p_indexes;
cristy150989e2010-02-01 14:59:39 +00001379 for (v=0; v < (long) kernel->height; v++) {
1380 for (u=0; u < (long) kernel->width; u++, k++) {
anthony602ab9b2010-01-05 08:06:50 +00001381 if ( IsNan(*k) || (*k) < 0.5 ) continue;
anthony4fd27e22010-02-07 08:17:18 +00001382 if ( result.red == 0.0 ||
1383 PixelIntensity(&(k_pixels[u])) < PixelIntensity(q) ) {
1384 /* copy the whole pixel - no channel selection */
1385 *q = k_pixels[u];
1386 if ( result.red > 0.0 ) changed++;
1387 result.red = 1.0;
1388 }
anthony602ab9b2010-01-05 08:06:50 +00001389 }
1390 k_pixels += image->columns+kernel->width;
1391 k_indexes += image->columns+kernel->width;
1392 }
anthony602ab9b2010-01-05 08:06:50 +00001393 break;
1394
anthony83ba99b2010-01-24 08:48:15 +00001395 case DilateIntensityMorphology:
anthony930be612010-02-08 04:26:15 +00001396 /* Select Pixel with Maximum Intensity within kernel neighbourhood
1397 **
1398 ** WARNING: the intensity test fails for CMYK and does not
1399 ** take into account the moderating effect of teh alpha channel
1400 ** on the intensity.
1401 **
1402 ** NOTE for correct working of this operation for asymetrical
1403 ** kernels, the kernel needs to be applied in its reflected form.
1404 ** That is its values needs to be reversed.
1405 */
anthony29188a82010-01-22 10:12:34 +00001406 k = &kernel->values[ kernel->width*kernel->height-1 ];
anthony602ab9b2010-01-05 08:06:50 +00001407 k_pixels = p;
1408 k_indexes = p_indexes;
cristy150989e2010-02-01 14:59:39 +00001409 for (v=0; v < (long) kernel->height; v++) {
1410 for (u=0; u < (long) kernel->width; u++, k--) {
anthony29188a82010-01-22 10:12:34 +00001411 if ( IsNan(*k) || (*k) < 0.5 ) continue; /* boolean kernel */
1412 if ( result.red == 0.0 ||
1413 PixelIntensity(&(k_pixels[u])) > PixelIntensity(q) ) {
1414 /* copy the whole pixel - no channel selection */
1415 *q = k_pixels[u];
1416 if ( result.red > 0.0 ) changed++;
1417 result.red = 1.0;
1418 }
anthony602ab9b2010-01-05 08:06:50 +00001419 }
1420 k_pixels += image->columns+kernel->width;
1421 k_indexes += image->columns+kernel->width;
1422 }
anthony602ab9b2010-01-05 08:06:50 +00001423 break;
1424
anthony602ab9b2010-01-05 08:06:50 +00001425 case DistanceMorphology:
anthony930be612010-02-08 04:26:15 +00001426 /* Add kernel Value and select the minimum value found.
1427 ** The result is a iterative distance from edge of image shape.
1428 **
1429 ** All Distance Kernels are symetrical, but that may not always
1430 ** be the case. For example how about a distance from left edges?
1431 ** To work correctly with asymetrical kernels the reflected kernel
1432 ** needs to be applied.
1433 */
anthony602ab9b2010-01-05 08:06:50 +00001434#if 0
anthony930be612010-02-08 04:26:15 +00001435 /* No need to do distance morphology if original value is zero
1436 ** Unfortunatally I have not been able to get this right
1437 ** when channel selection also becomes involved. -- Arrgghhh
1438 */
1439 if ( ((channel & RedChannel) == 0 && p[r].red == 0)
1440 || ((channel & GreenChannel) == 0 && p[r].green == 0)
1441 || ((channel & BlueChannel) == 0 && p[r].blue == 0)
1442 || ((channel & OpacityChannel) == 0 && p[r].opacity == 0)
1443 || (( (channel & IndexChannel) == 0
1444 || image->colorspace != CMYKColorspace
1445 ) && p_indexes[x] ==0 )
1446 )
1447 break;
anthony602ab9b2010-01-05 08:06:50 +00001448#endif
anthony29188a82010-01-22 10:12:34 +00001449 k = &kernel->values[ kernel->width*kernel->height-1 ];
anthony602ab9b2010-01-05 08:06:50 +00001450 k_pixels = p;
1451 k_indexes = p_indexes;
cristy150989e2010-02-01 14:59:39 +00001452 for (v=0; v < (long) kernel->height; v++) {
1453 for (u=0; u < (long) kernel->width; u++, k--) {
anthony602ab9b2010-01-05 08:06:50 +00001454 if ( IsNan(*k) ) continue;
1455 Minimize(result.red, (*k)+k_pixels[u].red);
1456 Minimize(result.green, (*k)+k_pixels[u].green);
1457 Minimize(result.blue, (*k)+k_pixels[u].blue);
1458 Minimize(result.opacity, (*k)+QuantumRange-k_pixels[u].opacity);
1459 if ( image->colorspace == CMYKColorspace)
1460 Minimize(result.index, (*k)+k_indexes[u]);
1461 }
1462 k_pixels += image->columns+kernel->width;
1463 k_indexes += image->columns+kernel->width;
1464 }
anthony602ab9b2010-01-05 08:06:50 +00001465 break;
1466
1467 case UndefinedMorphology:
1468 default:
1469 break; /* Do nothing */
anthony83ba99b2010-01-24 08:48:15 +00001470 }
1471 switch ( method ) {
1472 case UndefinedMorphology:
1473 case DilateIntensityMorphology:
1474 case ErodeIntensityMorphology:
anthony930be612010-02-08 04:26:15 +00001475 break; /* full pixel was directly assigned - not a channel method */
anthony83ba99b2010-01-24 08:48:15 +00001476 default:
1477 /* Assign the results */
1478 if ((channel & RedChannel) != 0)
1479 q->red = ClampToQuantum(result.red);
1480 if ((channel & GreenChannel) != 0)
1481 q->green = ClampToQuantum(result.green);
1482 if ((channel & BlueChannel) != 0)
1483 q->blue = ClampToQuantum(result.blue);
1484 if ((channel & OpacityChannel) != 0
1485 && image->matte == MagickTrue )
1486 q->opacity = ClampToQuantum(QuantumRange-result.opacity);
1487 if ((channel & IndexChannel) != 0
1488 && image->colorspace == CMYKColorspace)
1489 q_indexes[x] = ClampToQuantum(result.index);
1490 break;
1491 }
1492 if ( ( p[r].red != q->red )
1493 || ( p[r].green != q->green )
1494 || ( p[r].blue != q->blue )
1495 || ( p[r].opacity != q->opacity )
1496 || ( image->colorspace == CMYKColorspace &&
1497 p_indexes[r] != q_indexes[x] ) )
1498 changed++; /* The pixel had some value changed! */
anthony602ab9b2010-01-05 08:06:50 +00001499 p++;
1500 q++;
anthony83ba99b2010-01-24 08:48:15 +00001501 } /* x */
anthony602ab9b2010-01-05 08:06:50 +00001502 sync=SyncCacheViewAuthenticPixels(q_view,exception);
1503 if (sync == MagickFalse)
1504 status=MagickFalse;
1505 if (image->progress_monitor != (MagickProgressMonitor) NULL)
1506 {
1507 MagickBooleanType
1508 proceed;
1509
1510#if defined(MAGICKCORE_OPENMP_SUPPORT)
1511 #pragma omp critical (MagickCore_MorphologyImage)
1512#endif
1513 proceed=SetImageProgress(image,MorphologyTag,progress++,image->rows);
1514 if (proceed == MagickFalse)
1515 status=MagickFalse;
1516 }
anthony83ba99b2010-01-24 08:48:15 +00001517 } /* y */
anthony602ab9b2010-01-05 08:06:50 +00001518 result_image->type=image->type;
1519 q_view=DestroyCacheView(q_view);
1520 p_view=DestroyCacheView(p_view);
cristy150989e2010-02-01 14:59:39 +00001521 return(status ? (unsigned long) changed : 0);
anthony602ab9b2010-01-05 08:06:50 +00001522}
1523
anthony4fd27e22010-02-07 08:17:18 +00001524
1525MagickExport Image *MorphologyImage(const Image *image, const MorphologyMethod
anthony930be612010-02-08 04:26:15 +00001526 method, const long iterations,const KernelInfo *kernel, ExceptionInfo
1527 *exception)
cristy2be15382010-01-21 02:38:03 +00001528{
1529 Image
1530 *morphology_image;
1531
1532 morphology_image=MorphologyImageChannel(image,DefaultChannels,method,
1533 iterations,kernel,exception);
1534 return(morphology_image);
1535}
1536
anthony4fd27e22010-02-07 08:17:18 +00001537
anthony930be612010-02-08 04:26:15 +00001538MagickExport Image *MorphologyImageChannel(const Image *image, const
1539 ChannelType channel, const MorphologyMethod method, const long
1540 iterations, const KernelInfo *kernel, ExceptionInfo *exception)
1541
anthony602ab9b2010-01-05 08:06:50 +00001542{
cristy150989e2010-02-01 14:59:39 +00001543 long
1544 count;
anthony602ab9b2010-01-05 08:06:50 +00001545
1546 Image
1547 *new_image,
anthony4fd27e22010-02-07 08:17:18 +00001548 *old_image,
1549 *grad_image;
anthony602ab9b2010-01-05 08:06:50 +00001550
anthonycc6c8362010-01-25 04:14:01 +00001551 const char
1552 *artifact;
1553
cristy150989e2010-02-01 14:59:39 +00001554 unsigned long
1555 changed,
1556 limit;
1557
anthony4fd27e22010-02-07 08:17:18 +00001558 KernelInfo
1559 *curr_kernel;
1560
1561 MorphologyMethod
1562 curr_method;
1563
anthony602ab9b2010-01-05 08:06:50 +00001564 assert(image != (Image *) NULL);
1565 assert(image->signature == MagickSignature);
anthony4fd27e22010-02-07 08:17:18 +00001566 assert(kernel != (KernelInfo *) NULL);
1567 assert(kernel->signature == MagickSignature);
anthony602ab9b2010-01-05 08:06:50 +00001568 assert(exception != (ExceptionInfo *) NULL);
1569 assert(exception->signature == MagickSignature);
1570
anthony602ab9b2010-01-05 08:06:50 +00001571 if ( iterations == 0 )
1572 return((Image *)NULL); /* null operation - nothing to do! */
1573
1574 /* kernel must be valid at this point
1575 * (except maybe for posible future morphology methods like "Prune"
1576 */
cristy2be15382010-01-21 02:38:03 +00001577 assert(kernel != (KernelInfo *)NULL);
anthony602ab9b2010-01-05 08:06:50 +00001578
anthony4fd27e22010-02-07 08:17:18 +00001579 count = 0; /* interation count */
1580 changed = 1; /* if compound method assume image was changed */
anthony930be612010-02-08 04:26:15 +00001581 curr_kernel = (KernelInfo *)kernel; /* allow kernel and method */
1582 curr_method = method; /* to be changed as nessary */
anthony4fd27e22010-02-07 08:17:18 +00001583
cristy150989e2010-02-01 14:59:39 +00001584 limit = (unsigned long) iterations;
anthony602ab9b2010-01-05 08:06:50 +00001585 if ( iterations < 0 )
1586 limit = image->columns > image->rows ? image->columns : image->rows;
1587
anthony4fd27e22010-02-07 08:17:18 +00001588 /* Third-level morphology methods */
1589 switch( curr_method ) {
1590 case EdgeMorphology:
1591 grad_image = MorphologyImageChannel(image, channel,
1592 DilateMorphology, iterations, curr_kernel, exception);
1593 /* FALL-THRU */
1594 case EdgeInMorphology:
1595 curr_method = ErodeMorphology;
anthony602ab9b2010-01-05 08:06:50 +00001596 break;
anthony4fd27e22010-02-07 08:17:18 +00001597 case EdgeOutMorphology:
1598 curr_method = DilateMorphology;
anthony602ab9b2010-01-05 08:06:50 +00001599 break;
anthony4fd27e22010-02-07 08:17:18 +00001600 case TopHatMorphology:
1601 curr_method = OpenMorphology;
1602 break;
1603 case BottomHatMorphology:
1604 curr_method = CloseMorphology;
1605 break;
1606 default:
anthony930be612010-02-08 04:26:15 +00001607 break; /* not a third-level method */
anthony4fd27e22010-02-07 08:17:18 +00001608 }
1609
1610 /* Second-level morphology methods */
1611 switch( curr_method ) {
anthony930be612010-02-08 04:26:15 +00001612 case OpenMorphology:
1613 /* Open is a Erode then a Dilate without reflection */
anthony4fd27e22010-02-07 08:17:18 +00001614 new_image = MorphologyImageChannel(image, channel,
1615 ErodeMorphology, iterations, curr_kernel, exception);
anthony602ab9b2010-01-05 08:06:50 +00001616 if (new_image == (Image *) NULL)
1617 return((Image *) NULL);
anthony4fd27e22010-02-07 08:17:18 +00001618 curr_method = DilateMorphology;
1619 break;
anthony602ab9b2010-01-05 08:06:50 +00001620 case OpenIntensityMorphology:
anthony4fd27e22010-02-07 08:17:18 +00001621 new_image = MorphologyImageChannel(image, channel,
1622 ErodeIntensityMorphology, iterations, curr_kernel, exception);
anthony602ab9b2010-01-05 08:06:50 +00001623 if (new_image == (Image *) NULL)
1624 return((Image *) NULL);
anthony4fd27e22010-02-07 08:17:18 +00001625 curr_method = DilateIntensityMorphology;
1626 break;
anthony930be612010-02-08 04:26:15 +00001627
1628 case CloseMorphology:
1629 /* Close is a Dilate then Erode using reflected kernel */
1630 /* A reflected kernel is needed for a Close */
1631 if ( curr_kernel == kernel )
1632 curr_kernel = CloneKernelInfo(kernel);
1633 RotateKernelInfo(curr_kernel,180);
1634 new_image = MorphologyImageChannel(image, channel,
1635 DilateMorphology, iterations, curr_kernel, exception);
1636 if (new_image == (Image *) NULL)
1637 return((Image *) NULL);
1638 curr_method = ErodeMorphology;
1639 break;
anthony4fd27e22010-02-07 08:17:18 +00001640 case CloseIntensityMorphology:
anthony930be612010-02-08 04:26:15 +00001641 /* A reflected kernel is needed for a Close */
1642 if ( curr_kernel == kernel )
1643 curr_kernel = CloneKernelInfo(kernel);
anthony4fd27e22010-02-07 08:17:18 +00001644 RotateKernelInfo(curr_kernel,180);
1645 new_image = MorphologyImageChannel(image, channel,
1646 DilateIntensityMorphology, iterations, curr_kernel, exception);
1647 if (new_image == (Image *) NULL)
1648 return((Image *) NULL);
1649 curr_method = ErodeIntensityMorphology;
anthony602ab9b2010-01-05 08:06:50 +00001650 break;
1651
anthony930be612010-02-08 04:26:15 +00001652 case CorrelateMorphology:
1653 /* A Correlation is actually a Convolution with a reflected kernel.
1654 ** However a Convolution is a weighted sum with a reflected kernel.
1655 ** It may seem stange to convert a Correlation into a Convolution
1656 ** as the Correleation is the simplier method, but Convolution is
1657 ** much more commonly used, and it makes sense to implement it directly
1658 ** so as to avoid the need to duplicate the kernel when it is not
1659 ** required (which is typically the default).
1660 */
1661 if ( curr_kernel == kernel )
1662 curr_kernel = CloneKernelInfo(kernel);
1663 RotateKernelInfo(curr_kernel,180);
1664 curr_method = ConvolveMorphology;
1665 /* FALL-THRU into Correlate (weigthed sum without reflection) */
1666
anthonyc94cdb02010-01-06 08:15:29 +00001667 case ConvolveMorphology:
anthony4fd27e22010-02-07 08:17:18 +00001668 /* Scale or Normalize kernel, according to user wishes
anthony930be612010-02-08 04:26:15 +00001669 ** before using it for the Convolve/Correlate method.
1670 **
1671 ** FUTURE: provide some way for internal functions to disable
1672 ** user bias and scaling effects.
anthonycc6c8362010-01-25 04:14:01 +00001673 */
1674 artifact = GetImageArtifact(image,"convolve:scale");
anthony4fd27e22010-02-07 08:17:18 +00001675 if ( artifact != (char *)NULL ) {
anthony930be612010-02-08 04:26:15 +00001676 if ( curr_kernel == kernel )
1677 curr_kernel = CloneKernelInfo(kernel);
anthony4fd27e22010-02-07 08:17:18 +00001678 ScaleKernelInfo(curr_kernel, StringToDouble(artifact) );
1679 }
anthony930be612010-02-08 04:26:15 +00001680 /* FALL-THRU to do the first, and typically the only iteration */
anthony4fd27e22010-02-07 08:17:18 +00001681
anthony602ab9b2010-01-05 08:06:50 +00001682 default:
anthony930be612010-02-08 04:26:15 +00001683 /* Do a single iteration using the Low-Level Morphology method!
1684 ** This ensures a "new_image" has been generated, but allows us to skip
1685 ** the creation of 'old_image' if no more iterations are needed.
1686 **
1687 ** The "curr_method" should also be set to a low-level method that is
1688 ** understood by the MorphologyApply() internal function.
anthony602ab9b2010-01-05 08:06:50 +00001689 */
1690 new_image=CloneImage(image,0,0,MagickTrue,exception);
1691 if (new_image == (Image *) NULL)
1692 return((Image *) NULL);
1693 if (SetImageStorageClass(new_image,DirectClass) == MagickFalse)
1694 {
1695 InheritException(exception,&new_image->exception);
1696 new_image=DestroyImage(new_image);
1697 return((Image *) NULL);
1698 }
anthony4fd27e22010-02-07 08:17:18 +00001699 changed = MorphologyApply(image,new_image,curr_method,channel,curr_kernel,
anthony602ab9b2010-01-05 08:06:50 +00001700 exception);
1701 count++;
1702 if ( GetImageArtifact(image,"verbose") != (const char *) NULL )
cristy150989e2010-02-01 14:59:39 +00001703 fprintf(stderr, "Morphology %s:%ld => Changed %lu\n",
anthony4fd27e22010-02-07 08:17:18 +00001704 MagickOptionToMnemonic(MagickMorphologyOptions, curr_method),
anthony602ab9b2010-01-05 08:06:50 +00001705 count, changed);
anthony930be612010-02-08 04:26:15 +00001706 break;
anthony602ab9b2010-01-05 08:06:50 +00001707 }
1708
anthony930be612010-02-08 04:26:15 +00001709 /* At this point the "curr_method" should not only be set to a low-level
1710 ** method that is understood by the MorphologyApply() internal function,
1711 ** but "new_image" should now be defined, as the image to apply the
1712 ** "curr_method" to.
1713 */
1714
1715 /* Repeat the low-level morphology until count or no change reached */
cristy150989e2010-02-01 14:59:39 +00001716 if ( count < (long) limit && changed > 0 ) {
anthony602ab9b2010-01-05 08:06:50 +00001717 old_image = CloneImage(new_image,0,0,MagickTrue,exception);
1718 if (old_image == (Image *) NULL)
1719 return(DestroyImage(new_image));
1720 if (SetImageStorageClass(old_image,DirectClass) == MagickFalse)
1721 {
1722 InheritException(exception,&old_image->exception);
1723 old_image=DestroyImage(old_image);
1724 return(DestroyImage(new_image));
1725 }
cristy150989e2010-02-01 14:59:39 +00001726 while( count < (long) limit && changed != 0 )
anthony602ab9b2010-01-05 08:06:50 +00001727 {
1728 Image *tmp = old_image;
1729 old_image = new_image;
1730 new_image = tmp;
anthony4fd27e22010-02-07 08:17:18 +00001731 changed = MorphologyApply(old_image,new_image,curr_method,channel,
1732 curr_kernel, exception);
anthony602ab9b2010-01-05 08:06:50 +00001733 count++;
1734 if ( GetImageArtifact(image,"verbose") != (const char *) NULL )
cristy150989e2010-02-01 14:59:39 +00001735 fprintf(stderr, "Morphology %s:%ld => Changed %lu\n",
anthony4fd27e22010-02-07 08:17:18 +00001736 MagickOptionToMnemonic(MagickMorphologyOptions, curr_method),
anthony602ab9b2010-01-05 08:06:50 +00001737 count, changed);
1738 }
cristy150989e2010-02-01 14:59:39 +00001739 old_image=DestroyImage(old_image);
anthony602ab9b2010-01-05 08:06:50 +00001740 }
anthony930be612010-02-08 04:26:15 +00001741
1742 /* We are finished with kernel - destroy it if we made a clone */
anthony4fd27e22010-02-07 08:17:18 +00001743 if ( curr_kernel != kernel )
1744 curr_kernel=DestroyKernelInfo(curr_kernel);
1745
anthony930be612010-02-08 04:26:15 +00001746 /* Third-level Subtractive methods post-processing */
anthony4fd27e22010-02-07 08:17:18 +00001747 switch( method ) {
1748 case EdgeOutMorphology:
1749 case EdgeInMorphology:
1750 case TopHatMorphology:
1751 case BottomHatMorphology:
anthony930be612010-02-08 04:26:15 +00001752 /* Get Difference relative to the original image */
1753 CompositeImageChannel(new_image, channel, DifferenceCompositeOp,
anthony4fd27e22010-02-07 08:17:18 +00001754 image, 0, 0);
1755 break;
anthony930be612010-02-08 04:26:15 +00001756 case EdgeMorphology: /* subtract the Erode from a Dilate */
1757 CompositeImageChannel(new_image, channel, DifferenceCompositeOp,
anthony4fd27e22010-02-07 08:17:18 +00001758 grad_image, 0, 0);
1759 grad_image=DestroyImage(grad_image);
1760 break;
1761 default:
1762 break;
1763 }
anthony602ab9b2010-01-05 08:06:50 +00001764
1765 return(new_image);
1766}
anthony83ba99b2010-01-24 08:48:15 +00001767
1768/*
1769%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1770% %
1771% %
1772% %
anthony4fd27e22010-02-07 08:17:18 +00001773+ R o t a t e K e r n e l I n f o %
anthony83ba99b2010-01-24 08:48:15 +00001774% %
1775% %
1776% %
1777%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1778%
anthony4fd27e22010-02-07 08:17:18 +00001779% RotateKernelInfo() rotates the kernel by the angle given. Currently it is
anthony83ba99b2010-01-24 08:48:15 +00001780% restricted to 90 degree angles, but this may be improved in the future.
1781%
anthony4fd27e22010-02-07 08:17:18 +00001782% The format of the RotateKernelInfo method is:
anthony83ba99b2010-01-24 08:48:15 +00001783%
anthony4fd27e22010-02-07 08:17:18 +00001784% void RotateKernelInfo(KernelInfo *kernel, double angle)
anthony83ba99b2010-01-24 08:48:15 +00001785%
1786% A description of each parameter follows:
1787%
1788% o kernel: the Morphology/Convolution kernel
1789%
1790% o angle: angle to rotate in degrees
1791%
anthonyc4c86e02010-01-27 09:30:32 +00001792% This function is only internel to this module, as it is not finalized,
1793% especially with regard to non-orthogonal angles, and rotation of larger
1794% 2D kernels.
anthony83ba99b2010-01-24 08:48:15 +00001795*/
anthony4fd27e22010-02-07 08:17:18 +00001796static void RotateKernelInfo(KernelInfo *kernel, double angle)
anthony83ba99b2010-01-24 08:48:15 +00001797{
1798 /* WARNING: Currently assumes the kernel (rightly) is horizontally symetrical
1799 **
1800 ** TODO: expand beyond simple 90 degree rotates, flips and flops
1801 */
1802
1803 /* Modulus the angle */
1804 angle = fmod(angle, 360.0);
1805 if ( angle < 0 )
1806 angle += 360.0;
1807
1808 if ( 315.0 < angle || angle <= 45.0 )
1809 return; /* no change! - At least at this time */
1810
1811 switch (kernel->type) {
1812 /* These built-in kernels are cylindrical kernels, rotating is useless */
1813 case GaussianKernel:
1814 case LaplacianKernel:
1815 case LOGKernel:
1816 case DOGKernel:
1817 case DiskKernel:
1818 case ChebyshevKernel:
1819 case ManhattenKernel:
1820 case EuclideanKernel:
1821 return;
1822
1823 /* These may be rotatable at non-90 angles in the future */
1824 /* but simply rotating them in multiples of 90 degrees is useless */
1825 case SquareKernel:
1826 case DiamondKernel:
1827 case PlusKernel:
1828 return;
1829
1830 /* These only allows a +/-90 degree rotation (by transpose) */
1831 /* A 180 degree rotation is useless */
1832 case BlurKernel:
1833 case RectangleKernel:
1834 if ( 135.0 < angle && angle <= 225.0 )
1835 return;
1836 if ( 225.0 < angle && angle <= 315.0 )
1837 angle -= 180;
1838 break;
1839
1840 /* these are freely rotatable in 90 degree units */
1841 case CometKernel:
1842 case UndefinedKernel:
1843 case UserDefinedKernel:
1844 break;
1845 }
1846 if ( 135.0 < angle && angle <= 225.0 )
1847 {
1848 /* For a 180 degree rotation - also know as a reflection */
1849 /* This is actually a very very common operation! */
1850 /* Basically all that is needed is a reversal of the kernel data! */
1851 unsigned long
1852 i,j;
1853 register double
1854 *k,t;
1855
1856 k=kernel->values;
1857 for ( i=0, j=kernel->width*kernel->height-1; i<j; i++, j--)
1858 t=k[i], k[i]=k[j], k[j]=t;
1859
anthony930be612010-02-08 04:26:15 +00001860 kernel->x = (long) kernel->width - kernel->x - 1;
1861 kernel->y = (long) kernel->height - kernel->y - 1;
anthony83ba99b2010-01-24 08:48:15 +00001862 angle = fmod(angle+180.0, 360.0);
1863 }
1864 if ( 45.0 < angle && angle <= 135.0 )
1865 { /* Do a transpose and a flop, of the image, which results in a 90
1866 * degree rotation using two mirror operations.
1867 *
1868 * WARNING: this assumes the original image was a 1 dimentional image
1869 * but currently that is the only built-ins it is applied to.
1870 */
cristy150989e2010-02-01 14:59:39 +00001871 long
anthony83ba99b2010-01-24 08:48:15 +00001872 t;
cristy150989e2010-02-01 14:59:39 +00001873 t = (long) kernel->width;
anthony83ba99b2010-01-24 08:48:15 +00001874 kernel->width = kernel->height;
cristy150989e2010-02-01 14:59:39 +00001875 kernel->height = (unsigned long) t;
cristyc99304f2010-02-01 15:26:27 +00001876 t = kernel->x;
1877 kernel->x = kernel->y;
1878 kernel->y = t;
anthony83ba99b2010-01-24 08:48:15 +00001879 angle = fmod(450.0 - angle, 360.0);
1880 }
1881 /* At this point angle should be between -45 (315) and +45 degrees
1882 * In the future some form of non-orthogonal angled rotates could be
1883 * performed here, posibily with a linear kernel restriction.
1884 */
1885
1886#if 0
1887 Not currently in use!
1888 { /* Do a flop, this assumes kernel is horizontally symetrical.
1889 * Each row of the kernel needs to be reversed!
1890 */
1891 unsigned long
1892 y;
cristy150989e2010-02-01 14:59:39 +00001893 register long
anthony83ba99b2010-01-24 08:48:15 +00001894 x,r;
1895 register double
1896 *k,t;
1897
1898 for ( y=0, k=kernel->values; y < kernel->height; y++, k+=kernel->width)
1899 for ( x=0, r=kernel->width-1; x<kernel->width/2; x++, r--)
1900 t=k[x], k[x]=k[r], k[r]=t;
1901
cristyc99304f2010-02-01 15:26:27 +00001902 kernel->x = kernel->width - kernel->x - 1;
anthony83ba99b2010-01-24 08:48:15 +00001903 angle = fmod(angle+180.0, 360.0);
1904 }
1905#endif
1906 return;
1907}
1908
1909/*
1910%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1911% %
1912% %
1913% %
anthony4fd27e22010-02-07 08:17:18 +00001914+ S c a l e K e r n e l I n f o %
anthonycc6c8362010-01-25 04:14:01 +00001915% %
1916% %
1917% %
1918%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1919%
anthony4fd27e22010-02-07 08:17:18 +00001920% ScaleKernelInfo() scales the kernel by the given amount. Scaling by value
1921% of zero will result in a normalization of the kernel.
anthonycc6c8362010-01-25 04:14:01 +00001922%
1923% For positive kernels normalization scales the kernel so the addition os all
1924% values is 1.0. While for kernels where values add to zero it is scaled
1925% so that the convolution output range covers 1.0. In such 'zero kernels'
1926% it is generally recomended that the user also provides a 50% bias to the
1927% output results.
1928%
1929% Correct normalization assumes the 'range_*' attributes of the kernel
1930% structure have been correctly set during the kernel creation.
1931%
anthony4fd27e22010-02-07 08:17:18 +00001932% The format of the ScaleKernelInfo method is:
anthonycc6c8362010-01-25 04:14:01 +00001933%
anthony4fd27e22010-02-07 08:17:18 +00001934% void ScaleKernelInfo(KernelInfo *kernel)
anthonycc6c8362010-01-25 04:14:01 +00001935%
1936% A description of each parameter follows:
1937%
1938% o kernel: the Morphology/Convolution kernel
1939%
1940% o scale: multiple all values by this, if zero normalize instead.
1941%
anthonyc4c86e02010-01-27 09:30:32 +00001942% This function is internal to this module only at this time, but can be
1943% exported to other modules if needed.
anthonycc6c8362010-01-25 04:14:01 +00001944*/
anthony4fd27e22010-02-07 08:17:18 +00001945static void ScaleKernelInfo(KernelInfo *kernel, double scale)
anthonycc6c8362010-01-25 04:14:01 +00001946{
cristy150989e2010-02-01 14:59:39 +00001947 register long
anthonycc6c8362010-01-25 04:14:01 +00001948 i;
1949
1950 if ( fabs(scale) < MagickEpsilon ) {
cristyc99304f2010-02-01 15:26:27 +00001951 if ( fabs(kernel->positive_range + kernel->negative_range) < MagickEpsilon )
1952 scale = 1/(kernel->positive_range - kernel->negative_range); /* zero kernels */
anthonycc6c8362010-01-25 04:14:01 +00001953 else
cristyc99304f2010-02-01 15:26:27 +00001954 scale = 1/(kernel->positive_range + kernel->negative_range); /* non-zero kernel */
anthonycc6c8362010-01-25 04:14:01 +00001955 }
1956
cristy150989e2010-02-01 14:59:39 +00001957 for (i=0; i < (long) (kernel->width*kernel->height); i++)
anthonycc6c8362010-01-25 04:14:01 +00001958 if ( ! IsNan(kernel->values[i]) )
1959 kernel->values[i] *= scale;
1960
cristyc99304f2010-02-01 15:26:27 +00001961 kernel->positive_range *= scale; /* convolution output range */
1962 kernel->negative_range *= scale;
1963 kernel->maximum *= scale; /* maximum and minimum values in kernel */
1964 kernel->minimum *= scale;
anthonycc6c8362010-01-25 04:14:01 +00001965
1966 return;
1967}
1968
1969/*
1970%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1971% %
1972% %
1973% %
anthony4fd27e22010-02-07 08:17:18 +00001974+ S h o w K e r n e l I n f o %
anthony83ba99b2010-01-24 08:48:15 +00001975% %
1976% %
1977% %
1978%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1979%
anthony4fd27e22010-02-07 08:17:18 +00001980% ShowKernelInfo() outputs the details of the given kernel defination to
1981% standard error, generally due to a users 'showkernel' option request.
anthony83ba99b2010-01-24 08:48:15 +00001982%
1983% The format of the ShowKernel method is:
1984%
anthony4fd27e22010-02-07 08:17:18 +00001985% void ShowKernelInfo(KernelInfo *kernel)
anthony83ba99b2010-01-24 08:48:15 +00001986%
1987% A description of each parameter follows:
1988%
1989% o kernel: the Morphology/Convolution kernel
1990%
anthonyc4c86e02010-01-27 09:30:32 +00001991% This function is internal to this module only at this time. That may change
1992% in the future.
anthony83ba99b2010-01-24 08:48:15 +00001993*/
anthony4fd27e22010-02-07 08:17:18 +00001994MagickExport void ShowKernelInfo(KernelInfo *kernel)
anthony83ba99b2010-01-24 08:48:15 +00001995{
cristy150989e2010-02-01 14:59:39 +00001996 long
anthony83ba99b2010-01-24 08:48:15 +00001997 i, u, v;
1998
1999 fprintf(stderr,
anthonycc6c8362010-01-25 04:14:01 +00002000 "Kernel \"%s\" of size %lux%lu%+ld%+ld with values from %.*lg to %.*lg\n",
anthony83ba99b2010-01-24 08:48:15 +00002001 MagickOptionToMnemonic(MagickKernelOptions, kernel->type),
2002 kernel->width, kernel->height,
cristyc99304f2010-02-01 15:26:27 +00002003 kernel->x, kernel->y,
2004 GetMagickPrecision(), kernel->minimum,
2005 GetMagickPrecision(), kernel->maximum);
anthonycc6c8362010-01-25 04:14:01 +00002006 fprintf(stderr, "Forming convolution output range from %.*lg to %.*lg%s\n",
cristyc99304f2010-02-01 15:26:27 +00002007 GetMagickPrecision(), kernel->negative_range,
2008 GetMagickPrecision(), kernel->positive_range,
anthonycc6c8362010-01-25 04:14:01 +00002009 /*kernel->normalized == MagickTrue ? " (normalized)" : */ "" );
cristy150989e2010-02-01 14:59:39 +00002010 for (i=v=0; v < (long) kernel->height; v++) {
anthony83ba99b2010-01-24 08:48:15 +00002011 fprintf(stderr,"%2ld:",v);
cristy150989e2010-02-01 14:59:39 +00002012 for (u=0; u < (long) kernel->width; u++, i++)
anthony83ba99b2010-01-24 08:48:15 +00002013 if ( IsNan(kernel->values[i]) )
2014 fprintf(stderr," %*s", GetMagickPrecision()+2, "nan");
2015 else
2016 fprintf(stderr," %*.*lg", GetMagickPrecision()+2,
2017 GetMagickPrecision(), kernel->values[i]);
2018 fprintf(stderr,"\n");
2019 }
2020}
anthonycc6c8362010-01-25 04:14:01 +00002021
2022/*
2023%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2024% %
2025% %
2026% %
anthony4fd27e22010-02-07 08:17:18 +00002027+ Z e r o K e r n e l N a n s %
anthonycc6c8362010-01-25 04:14:01 +00002028% %
2029% %
2030% %
2031%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2032%
2033% ZeroKernelNans() replaces any special 'nan' value that may be present in
2034% the kernel with a zero value. This is typically done when the kernel will
2035% be used in special hardware (GPU) convolution processors, to simply
2036% matters.
2037%
2038% The format of the ZeroKernelNans method is:
2039%
2040% voidZeroKernelNans (KernelInfo *kernel)
2041%
2042% A description of each parameter follows:
2043%
2044% o kernel: the Morphology/Convolution kernel
2045%
2046% FUTURE: return the information in a string for API usage.
2047*/
anthonyc4c86e02010-01-27 09:30:32 +00002048MagickExport void ZeroKernelNans(KernelInfo *kernel)
anthonycc6c8362010-01-25 04:14:01 +00002049{
cristy150989e2010-02-01 14:59:39 +00002050 register long
anthonycc6c8362010-01-25 04:14:01 +00002051 i;
2052
cristy150989e2010-02-01 14:59:39 +00002053 for (i=0; i < (long) (kernel->width*kernel->height); i++)
anthonycc6c8362010-01-25 04:14:01 +00002054 if ( IsNan(kernel->values[i]) )
2055 kernel->values[i] = 0.0;
2056
2057 return;
2058}