2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % TTTTT H H RRRR EEEEE SSSSS H H OOO L DDDD %
7 % T H H R R E SS H H O O L D D %
8 % T HHHHH RRRR EEE SSS HHHHH O O L D D %
9 % T H H R R E SS H H O O L D D %
10 % T H H R R EEEEE SSSSS H H OOO LLLLL DDDD %
13 % MagickCore Image Threshold Methods %
20 % Copyright 1999-2012 ImageMagick Studio LLC, a non-profit organization %
21 % dedicated to making software imaging solutions freely available. %
23 % You may not use this file except in compliance with the License. You may %
24 % obtain a copy of the License at %
26 % http://www.imagemagick.org/script/license.php %
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. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
43 #include "MagickCore/studio.h"
44 #include "MagickCore/property.h"
45 #include "MagickCore/blob.h"
46 #include "MagickCore/cache-view.h"
47 #include "MagickCore/color.h"
48 #include "MagickCore/color-private.h"
49 #include "MagickCore/colormap.h"
50 #include "MagickCore/colorspace.h"
51 #include "MagickCore/colorspace-private.h"
52 #include "MagickCore/configure.h"
53 #include "MagickCore/constitute.h"
54 #include "MagickCore/decorate.h"
55 #include "MagickCore/draw.h"
56 #include "MagickCore/enhance.h"
57 #include "MagickCore/exception.h"
58 #include "MagickCore/exception-private.h"
59 #include "MagickCore/effect.h"
60 #include "MagickCore/fx.h"
61 #include "MagickCore/gem.h"
62 #include "MagickCore/geometry.h"
63 #include "MagickCore/image-private.h"
64 #include "MagickCore/list.h"
65 #include "MagickCore/log.h"
66 #include "MagickCore/memory_.h"
67 #include "MagickCore/monitor.h"
68 #include "MagickCore/monitor-private.h"
69 #include "MagickCore/montage.h"
70 #include "MagickCore/option.h"
71 #include "MagickCore/pixel-accessor.h"
72 #include "MagickCore/quantize.h"
73 #include "MagickCore/quantum.h"
74 #include "MagickCore/random_.h"
75 #include "MagickCore/random-private.h"
76 #include "MagickCore/resize.h"
77 #include "MagickCore/resource_.h"
78 #include "MagickCore/segment.h"
79 #include "MagickCore/shear.h"
80 #include "MagickCore/signature-private.h"
81 #include "MagickCore/string_.h"
82 #include "MagickCore/string-private.h"
83 #include "MagickCore/thread-private.h"
84 #include "MagickCore/threshold.h"
85 #include "MagickCore/token.h"
86 #include "MagickCore/transform.h"
87 #include "MagickCore/xml-tree.h"
88 #include "MagickCore/xml-tree-private.h"
93 #define ThresholdsFilename "thresholds.xml"
114 Forward declarations.
117 *GetThresholdMapFile(const char *,const char *,const char *,ExceptionInfo *);
120 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
124 % A d a p t i v e T h r e s h o l d I m a g e %
128 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
130 % AdaptiveThresholdImage() selects an individual threshold for each pixel
131 % based on the range of intensity values in its local neighborhood. This
132 % allows for thresholding of an image whose global intensity histogram
133 % doesn't contain distinctive peaks.
135 % The format of the AdaptiveThresholdImage method is:
137 % Image *AdaptiveThresholdImage(const Image *image,const size_t width,
138 % const size_t height,const double bias,ExceptionInfo *exception)
140 % A description of each parameter follows:
142 % o image: the image.
144 % o width: the width of the local neighborhood.
146 % o height: the height of the local neighborhood.
148 % o bias: the mean bias.
150 % o exception: return any errors or warnings in this structure.
153 MagickExport Image *AdaptiveThresholdImage(const Image *image,
154 const size_t width,const size_t height,const double bias,
155 ExceptionInfo *exception)
157 #define AdaptiveThresholdImageTag "AdaptiveThreshold/Image"
179 Initialize threshold image attributes.
181 assert(image != (Image *) NULL);
182 assert(image->signature == MagickSignature);
183 if (image->debug != MagickFalse)
184 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
185 assert(exception != (ExceptionInfo *) NULL);
186 assert(exception->signature == MagickSignature);
187 if ((width % 2) == 0)
188 ThrowImageException(OptionError,"KernelWidthMustBeAnOddNumber");
189 threshold_image=CloneImage(image,image->columns,image->rows,MagickTrue,
191 if (threshold_image == (Image *) NULL)
192 return((Image *) NULL);
193 status=SetImageStorageClass(threshold_image,DirectClass,exception);
194 if (status == MagickFalse)
196 threshold_image=DestroyImage(threshold_image);
197 return((Image *) NULL);
204 number_pixels=(MagickSizeType) width*height;
205 image_view=AcquireVirtualCacheView(image,exception);
206 threshold_view=AcquireAuthenticCacheView(threshold_image,exception);
207 #if defined(MAGICKCORE_OPENMP_SUPPORT)
208 #pragma omp parallel for schedule(static,4) shared(progress,status) \
209 dynamic_number_threads(image,image->columns,image->rows,1)
211 for (y=0; y < (ssize_t) image->rows; y++)
213 register const Quantum
225 if (status == MagickFalse)
227 p=GetCacheViewVirtualPixels(image_view,-((ssize_t) width/2L),y-(ssize_t)
228 (height/2L),image->columns+width,height,exception);
229 q=QueueCacheViewAuthenticPixels(threshold_view,0,y,threshold_image->columns,
231 if ((p == (const Quantum *) NULL) || (q == (Quantum *) NULL))
236 center=(ssize_t) GetPixelChannels(image)*(image->columns+width)*(height/2L)+
237 GetPixelChannels(image)*(width/2);
238 for (x=0; x < (ssize_t) image->columns; x++)
243 if (GetPixelMask(image,p) != 0)
245 p+=GetPixelChannels(image);
246 q+=GetPixelChannels(threshold_image);
249 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
262 register const Quantum
271 channel=GetPixelChannelMapChannel(image,i);
272 traits=GetPixelChannelMapTraits(image,channel);
273 threshold_traits=GetPixelChannelMapTraits(threshold_image,channel);
274 if ((traits == UndefinedPixelTrait) ||
275 (threshold_traits == UndefinedPixelTrait))
277 if ((threshold_traits & CopyPixelTrait) != 0)
279 SetPixelChannel(threshold_image,channel,p[center+i],q);
284 for (v=0; v < (ssize_t) height; v++)
286 for (u=0; u < (ssize_t) width; u++)
289 pixels+=GetPixelChannels(image);
291 pixels+=image->columns*GetPixelChannels(image);
293 mean=(MagickRealType) (pixel/number_pixels+bias);
294 SetPixelChannel(threshold_image,channel,(Quantum) ((MagickRealType)
295 p[center+i] <= mean ? 0 : QuantumRange),q);
297 p+=GetPixelChannels(image);
298 q+=GetPixelChannels(threshold_image);
300 if (SyncCacheViewAuthenticPixels(threshold_view,exception) == MagickFalse)
302 if (image->progress_monitor != (MagickProgressMonitor) NULL)
307 #if defined(MAGICKCORE_OPENMP_SUPPORT)
308 #pragma omp critical (MagickCore_AdaptiveThresholdImage)
310 proceed=SetImageProgress(image,AdaptiveThresholdImageTag,progress++,
312 if (proceed == MagickFalse)
316 threshold_image->type=image->type;
317 threshold_view=DestroyCacheView(threshold_view);
318 image_view=DestroyCacheView(image_view);
319 if (status == MagickFalse)
320 threshold_image=DestroyImage(threshold_image);
321 return(threshold_image);
325 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
329 % B i l e v e l I m a g e %
333 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
335 % BilevelImage() changes the value of individual pixels based on the
336 % intensity of each pixel channel. The result is a high-contrast image.
338 % More precisely each channel value of the image is 'thresholded' so that if
339 % it is equal to or less than the given value it is set to zero, while any
340 % value greater than that give is set to it maximum or QuantumRange.
342 % This function is what is used to implement the "-threshold" operator for
343 % the command line API.
345 % If the default channel setting is given the image is thresholded using just
346 % the gray 'intensity' of the image, rather than the individual channels.
348 % The format of the BilevelImage method is:
350 % MagickBooleanType BilevelImage(Image *image,const double threshold,
351 % ExceptionInfo *exception)
353 % A description of each parameter follows:
355 % o image: the image.
357 % o threshold: define the threshold values.
359 % o exception: return any errors or warnings in this structure.
361 % Aside: You can get the same results as operator using LevelImages()
362 % with the 'threshold' value for both the black_point and the white_point.
365 MagickExport MagickBooleanType BilevelImage(Image *image,const double threshold,
366 ExceptionInfo *exception)
368 #define ThresholdImageTag "Threshold/Image"
382 assert(image != (Image *) NULL);
383 assert(image->signature == MagickSignature);
384 if (image->debug != MagickFalse)
385 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
386 if (SetImageStorageClass(image,DirectClass,exception) == MagickFalse)
389 Bilevel threshold image.
393 image_view=AcquireAuthenticCacheView(image,exception);
394 #if defined(MAGICKCORE_OPENMP_SUPPORT)
395 #pragma omp parallel for schedule(static,8) shared(progress,status) \
396 dynamic_number_threads(image,image->columns,image->rows,1)
398 for (y=0; y < (ssize_t) image->rows; y++)
406 if (status == MagickFalse)
408 q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
409 if (q == (Quantum *) NULL)
414 for (x=0; x < (ssize_t) image->columns; x++)
419 if (GetPixelMask(image,q) != 0)
421 q+=GetPixelChannels(image);
424 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
432 channel=GetPixelChannelMapChannel(image,i);
433 traits=GetPixelChannelMapTraits(image,channel);
434 if ((traits & UpdatePixelTrait) == 0)
436 q[i]=(Quantum) ((MagickRealType) q[i] <= threshold ? 0 : QuantumRange);
438 q+=GetPixelChannels(image);
440 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
442 if (image->progress_monitor != (MagickProgressMonitor) NULL)
447 #if defined(MAGICKCORE_OPENMP_SUPPORT)
448 #pragma omp critical (MagickCore_BilevelImage)
450 proceed=SetImageProgress(image,ThresholdImageTag,progress++,
452 if (proceed == MagickFalse)
456 image_view=DestroyCacheView(image_view);
461 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
465 % B l a c k T h r e s h o l d I m a g e %
469 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
471 % BlackThresholdImage() is like ThresholdImage() but forces all pixels below
472 % the threshold into black while leaving all pixels at or above the threshold
475 % The format of the BlackThresholdImage method is:
477 % MagickBooleanType BlackThresholdImage(Image *image,
478 % const char *threshold,ExceptionInfo *exception)
480 % A description of each parameter follows:
482 % o image: the image.
484 % o threshold: define the threshold value.
486 % o exception: return any errors or warnings in this structure.
489 MagickExport MagickBooleanType BlackThresholdImage(Image *image,
490 const char *thresholds,ExceptionInfo *exception)
492 #define ThresholdImageTag "Threshold/Image"
515 assert(image != (Image *) NULL);
516 assert(image->signature == MagickSignature);
517 if (image->debug != MagickFalse)
518 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
519 if (thresholds == (const char *) NULL)
521 if (SetImageStorageClass(image,DirectClass,exception) == MagickFalse)
523 if (IsGrayColorspace(image->colorspace) != MagickFalse)
524 (void) TransformImageColorspace(image,sRGBColorspace,exception);
525 GetPixelInfo(image,&threshold);
526 flags=ParseGeometry(thresholds,&geometry_info);
527 threshold.red=geometry_info.rho;
528 threshold.green=geometry_info.rho;
529 threshold.blue=geometry_info.rho;
530 threshold.black=geometry_info.rho;
531 threshold.alpha=100.0;
532 if ((flags & SigmaValue) != 0)
533 threshold.green=geometry_info.sigma;
534 if ((flags & XiValue) != 0)
535 threshold.blue=geometry_info.xi;
536 if ((flags & PsiValue) != 0)
537 threshold.alpha=geometry_info.psi;
538 if (threshold.colorspace == CMYKColorspace)
540 if ((flags & PsiValue) != 0)
541 threshold.black=geometry_info.psi;
542 if ((flags & ChiValue) != 0)
543 threshold.alpha=geometry_info.chi;
545 if ((flags & PercentValue) != 0)
547 threshold.red*=(QuantumRange/100.0);
548 threshold.green*=(QuantumRange/100.0);
549 threshold.blue*=(QuantumRange/100.0);
550 threshold.black*=(QuantumRange/100.0);
551 threshold.alpha*=(QuantumRange/100.0);
554 White threshold image.
558 image_view=AcquireAuthenticCacheView(image,exception);
559 #if defined(MAGICKCORE_OPENMP_SUPPORT)
560 #pragma omp parallel for schedule(static,8) shared(progress,status) \
561 dynamic_number_threads(image,image->columns,image->rows,1)
563 for (y=0; y < (ssize_t) image->rows; y++)
571 if (status == MagickFalse)
573 q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
574 if (q == (Quantum *) NULL)
579 for (x=0; x < (ssize_t) image->columns; x++)
584 if (GetPixelMask(image,q) != 0)
586 q+=GetPixelChannels(image);
589 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
597 channel=GetPixelChannelMapChannel(image,i);
598 traits=GetPixelChannelMapTraits(image,channel);
599 if ((traits & UpdatePixelTrait) == 0)
601 if ((double) q[i] <= GetPixelInfoChannel(&threshold,channel))
604 q+=GetPixelChannels(image);
606 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
608 if (image->progress_monitor != (MagickProgressMonitor) NULL)
613 #if defined(MAGICKCORE_OPENMP_SUPPORT)
614 #pragma omp critical (MagickCore_BlackThresholdImage)
616 proceed=SetImageProgress(image,ThresholdImageTag,progress++,
618 if (proceed == MagickFalse)
622 image_view=DestroyCacheView(image_view);
627 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
631 % C l a m p I m a g e %
635 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
637 % ClampImage() restricts the color range from 0 to the quantum depth.
639 % The format of the ClampImage method is:
641 % MagickBooleanType ClampImage(Image *image,ExceptionInfo *exception)
643 % A description of each parameter follows:
645 % o image: the image.
647 % o exception: return any errors or warnings in this structure.
651 static inline Quantum ClampToUnsignedQuantum(const Quantum quantum)
653 #if defined(MAGICKCORE_HDRI_SUPPORT)
656 if (quantum >= QuantumRange)
657 return(QuantumRange);
664 MagickExport MagickBooleanType ClampImage(Image *image,ExceptionInfo *exception)
666 #define ClampImageTag "Clamp/Image"
680 assert(image != (Image *) NULL);
681 assert(image->signature == MagickSignature);
682 if (image->debug != MagickFalse)
683 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
684 if (image->storage_class == PseudoClass)
693 for (i=0; i < (ssize_t) image->colors; i++)
695 q->red=(double) ClampToUnsignedQuantum(ClampToQuantum(q->red));
696 q->green=(double) ClampToUnsignedQuantum(ClampToQuantum(q->green));
697 q->blue=(double) ClampToUnsignedQuantum(ClampToQuantum(q->blue));
698 q->alpha=(double) ClampToUnsignedQuantum(ClampToQuantum(q->alpha));
701 return(SyncImage(image,exception));
708 image_view=AcquireAuthenticCacheView(image,exception);
709 #if defined(MAGICKCORE_OPENMP_SUPPORT)
710 #pragma omp parallel for schedule(static,8) shared(progress,status) \
711 dynamic_number_threads(image,image->columns,image->rows,1)
713 for (y=0; y < (ssize_t) image->rows; y++)
721 if (status == MagickFalse)
723 q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
724 if (q == (Quantum *) NULL)
729 for (x=0; x < (ssize_t) image->columns; x++)
734 if (GetPixelMask(image,q) != 0)
736 q+=GetPixelChannels(image);
739 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
747 channel=GetPixelChannelMapChannel(image,i);
748 traits=GetPixelChannelMapTraits(image,channel);
749 if (traits == UndefinedPixelTrait)
751 q[i]=ClampToUnsignedQuantum(q[i]);
753 q+=GetPixelChannels(image);
755 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
757 if (image->progress_monitor != (MagickProgressMonitor) NULL)
762 #if defined(MAGICKCORE_OPENMP_SUPPORT)
763 #pragma omp critical (MagickCore_ClampImage)
765 proceed=SetImageProgress(image,ClampImageTag,progress++,image->rows);
766 if (proceed == MagickFalse)
770 image_view=DestroyCacheView(image_view);
775 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
779 % D e s t r o y T h r e s h o l d M a p %
783 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
785 % DestroyThresholdMap() de-allocate the given ThresholdMap
787 % The format of the ListThresholdMaps method is:
789 % ThresholdMap *DestroyThresholdMap(Threshold *map)
791 % A description of each parameter follows.
793 % o map: Pointer to the Threshold map to destroy
796 MagickExport ThresholdMap *DestroyThresholdMap(ThresholdMap *map)
798 assert(map != (ThresholdMap *) NULL);
799 if (map->map_id != (char *) NULL)
800 map->map_id=DestroyString(map->map_id);
801 if (map->description != (char *) NULL)
802 map->description=DestroyString(map->description);
803 if (map->levels != (ssize_t *) NULL)
804 map->levels=(ssize_t *) RelinquishMagickMemory(map->levels);
805 map=(ThresholdMap *) RelinquishMagickMemory(map);
810 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
814 % G e t T h r e s h o l d M a p %
818 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
820 % GetThresholdMap() loads and searches one or more threshold map files for the
821 % map matching the given name or alias.
823 % The format of the GetThresholdMap method is:
825 % ThresholdMap *GetThresholdMap(const char *map_id,
826 % ExceptionInfo *exception)
828 % A description of each parameter follows.
830 % o map_id: ID of the map to look for.
832 % o exception: return any errors or warnings in this structure.
835 MagickExport ThresholdMap *GetThresholdMap(const char *map_id,
836 ExceptionInfo *exception)
847 map=(ThresholdMap *)NULL;
848 options=GetConfigureOptions(ThresholdsFilename,exception);
849 while ((option=(const StringInfo *) GetNextValueInLinkedList(options)) !=
850 (const StringInfo *) NULL && (map == (ThresholdMap *) NULL))
851 map=GetThresholdMapFile((const char *) GetStringInfoDatum(option),
852 GetStringInfoPath(option),map_id,exception);
853 options=DestroyConfigureOptions(options);
858 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
862 + G e t T h r e s h o l d M a p F i l e %
866 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
868 % GetThresholdMapFile() look for a given threshold map name or alias in the
869 % given XML file data, and return the allocated the map when found.
871 % The format of the ListThresholdMaps method is:
873 % ThresholdMap *GetThresholdMap(const char *xml,const char *filename,
874 % const char *map_id,ExceptionInfo *exception)
876 % A description of each parameter follows.
878 % o xml: The threshold map list in XML format.
880 % o filename: The threshold map XML filename.
882 % o map_id: ID of the map to look for in XML list.
884 % o exception: return any errors or warnings in this structure.
887 static ThresholdMap *GetThresholdMapFile(const char *xml,
888 const char *filename,const char *map_id,ExceptionInfo *exception)
912 (void) LogMagickEvent(ConfigureEvent,GetMagickModule(),
913 "Loading threshold map file \"%s\" ...",filename);
914 map=(ThresholdMap *) NULL;
915 thresholds=NewXMLTree(xml,exception);
916 if (thresholds == (XMLTreeInfo *) NULL)
918 for (threshold=GetXMLTreeChild(thresholds,"threshold");
919 threshold != (XMLTreeInfo *) NULL;
920 threshold=GetNextXMLTreeTag(threshold))
922 attribute=GetXMLTreeAttribute(threshold,"map");
923 if ((attribute != (char *) NULL) && (LocaleCompare(map_id,attribute) == 0))
925 attribute=GetXMLTreeAttribute(threshold,"alias");
926 if ((attribute != (char *) NULL) && (LocaleCompare(map_id,attribute) == 0))
929 if (threshold == (XMLTreeInfo *) NULL)
931 description=GetXMLTreeChild(threshold,"description");
932 if (description == (XMLTreeInfo *) NULL)
934 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
935 "XmlMissingElement", "<description>, map \"%s\"",map_id);
936 thresholds=DestroyXMLTree(thresholds);
939 levels=GetXMLTreeChild(threshold,"levels");
940 if (levels == (XMLTreeInfo *) NULL)
942 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
943 "XmlMissingElement", "<levels>, map \"%s\"", map_id);
944 thresholds=DestroyXMLTree(thresholds);
947 map=(ThresholdMap *) AcquireMagickMemory(sizeof(ThresholdMap));
948 if (map == (ThresholdMap *) NULL)
949 ThrowFatalException(ResourceLimitFatalError,"UnableToAcquireThresholdMap");
950 map->map_id=(char *) NULL;
951 map->description=(char *) NULL;
952 map->levels=(ssize_t *) NULL;
953 attribute=GetXMLTreeAttribute(threshold,"map");
954 if (attribute != (char *) NULL)
955 map->map_id=ConstantString(attribute);
956 content=GetXMLTreeContent(description);
957 if (content != (char *) NULL)
958 map->description=ConstantString(content);
959 attribute=GetXMLTreeAttribute(levels,"width");
960 if (attribute == (char *) NULL)
962 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
963 "XmlMissingAttribute", "<levels width>, map \"%s\"",map_id);
964 thresholds=DestroyXMLTree(thresholds);
965 map=DestroyThresholdMap(map);
968 map->width=StringToUnsignedLong(attribute);
971 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
972 "XmlInvalidAttribute", "<levels width>, map \"%s\"",map_id);
973 thresholds=DestroyXMLTree(thresholds);
974 map=DestroyThresholdMap(map);
977 attribute=GetXMLTreeAttribute(levels,"height");
978 if (attribute == (char *) NULL)
980 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
981 "XmlMissingAttribute", "<levels height>, map \"%s\"",map_id);
982 thresholds=DestroyXMLTree(thresholds);
983 map=DestroyThresholdMap(map);
986 map->height=StringToUnsignedLong(attribute);
987 if (map->height == 0)
989 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
990 "XmlInvalidAttribute", "<levels height>, map \"%s\"",map_id);
991 thresholds=DestroyXMLTree(thresholds);
992 map=DestroyThresholdMap(map);
995 attribute=GetXMLTreeAttribute(levels,"divisor");
996 if (attribute == (char *) NULL)
998 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
999 "XmlMissingAttribute", "<levels divisor>, map \"%s\"",map_id);
1000 thresholds=DestroyXMLTree(thresholds);
1001 map=DestroyThresholdMap(map);
1004 map->divisor=(ssize_t) StringToLong(attribute);
1005 if (map->divisor < 2)
1007 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1008 "XmlInvalidAttribute", "<levels divisor>, map \"%s\"",map_id);
1009 thresholds=DestroyXMLTree(thresholds);
1010 map=DestroyThresholdMap(map);
1013 content=GetXMLTreeContent(levels);
1014 if (content == (char *) NULL)
1016 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1017 "XmlMissingContent", "<levels>, map \"%s\"",map_id);
1018 thresholds=DestroyXMLTree(thresholds);
1019 map=DestroyThresholdMap(map);
1022 map->levels=(ssize_t *) AcquireQuantumMemory((size_t) map->width,map->height*
1023 sizeof(*map->levels));
1024 if (map->levels == (ssize_t *) NULL)
1025 ThrowFatalException(ResourceLimitFatalError,"UnableToAcquireThresholdMap");
1026 for (i=0; i < (ssize_t) (map->width*map->height); i++)
1028 map->levels[i]=(ssize_t) strtol(content,&p,10);
1031 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1032 "XmlInvalidContent", "<level> too few values, map \"%s\"",map_id);
1033 thresholds=DestroyXMLTree(thresholds);
1034 map=DestroyThresholdMap(map);
1037 if ((map->levels[i] < 0) || (map->levels[i] > map->divisor))
1039 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1040 "XmlInvalidContent", "<level> %.20g out of range, map \"%s\"",
1041 (double) map->levels[i],map_id);
1042 thresholds=DestroyXMLTree(thresholds);
1043 map=DestroyThresholdMap(map);
1048 value=(double) strtol(content,&p,10);
1052 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1053 "XmlInvalidContent", "<level> too many values, map \"%s\"",map_id);
1054 thresholds=DestroyXMLTree(thresholds);
1055 map=DestroyThresholdMap(map);
1058 thresholds=DestroyXMLTree(thresholds);
1063 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1067 + L i s t T h r e s h o l d M a p F i l e %
1071 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1073 % ListThresholdMapFile() lists the threshold maps and their descriptions
1074 % in the given XML file data.
1076 % The format of the ListThresholdMaps method is:
1078 % MagickBooleanType ListThresholdMaps(FILE *file,const char*xml,
1079 % const char *filename,ExceptionInfo *exception)
1081 % A description of each parameter follows.
1083 % o file: An pointer to the output FILE.
1085 % o xml: The threshold map list in XML format.
1087 % o filename: The threshold map XML filename.
1089 % o exception: return any errors or warnings in this structure.
1092 MagickBooleanType ListThresholdMapFile(FILE *file,const char *xml,
1093 const char *filename,ExceptionInfo *exception)
1105 assert( xml != (char *)NULL );
1106 assert( file != (FILE *)NULL );
1107 (void) LogMagickEvent(ConfigureEvent,GetMagickModule(),
1108 "Loading threshold map file \"%s\" ...",filename);
1109 thresholds=NewXMLTree(xml,exception);
1110 if ( thresholds == (XMLTreeInfo *)NULL )
1111 return(MagickFalse);
1112 (void) FormatLocaleFile(file,"%-16s %-12s %s\n","Map","Alias","Description");
1113 (void) FormatLocaleFile(file,
1114 "----------------------------------------------------\n");
1115 threshold=GetXMLTreeChild(thresholds,"threshold");
1116 for ( ; threshold != (XMLTreeInfo *) NULL;
1117 threshold=GetNextXMLTreeTag(threshold))
1119 map=GetXMLTreeAttribute(threshold,"map");
1120 if (map == (char *) NULL)
1122 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1123 "XmlMissingAttribute", "<map>");
1124 thresholds=DestroyXMLTree(thresholds);
1125 return(MagickFalse);
1127 alias=GetXMLTreeAttribute(threshold,"alias");
1128 description=GetXMLTreeChild(threshold,"description");
1129 if (description == (XMLTreeInfo *) NULL)
1131 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1132 "XmlMissingElement", "<description>, map \"%s\"",map);
1133 thresholds=DestroyXMLTree(thresholds);
1134 return(MagickFalse);
1136 content=GetXMLTreeContent(description);
1137 if (content == (char *) NULL)
1139 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1140 "XmlMissingContent", "<description>, map \"%s\"", map);
1141 thresholds=DestroyXMLTree(thresholds);
1142 return(MagickFalse);
1144 (void) FormatLocaleFile(file,"%-16s %-12s %s\n",map,alias ? alias : "",
1147 thresholds=DestroyXMLTree(thresholds);
1152 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1156 % L i s t T h r e s h o l d M a p s %
1160 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1162 % ListThresholdMaps() lists the threshold maps and their descriptions
1163 % as defined by "threshold.xml" to a file.
1165 % The format of the ListThresholdMaps method is:
1167 % MagickBooleanType ListThresholdMaps(FILE *file,ExceptionInfo *exception)
1169 % A description of each parameter follows.
1171 % o file: An pointer to the output FILE.
1173 % o exception: return any errors or warnings in this structure.
1176 MagickExport MagickBooleanType ListThresholdMaps(FILE *file,
1177 ExceptionInfo *exception)
1189 if (file == (FILE *) NULL)
1191 options=GetConfigureOptions(ThresholdsFilename,exception);
1192 (void) FormatLocaleFile(file,
1193 "\n Threshold Maps for Ordered Dither Operations\n");
1194 while ((option=(const StringInfo *) GetNextValueInLinkedList(options)) !=
1195 (const StringInfo *) NULL)
1197 (void) FormatLocaleFile(file,"\nPATH: %s\n\n",GetStringInfoPath(option));
1198 status|=ListThresholdMapFile(file,(const char *) GetStringInfoDatum(option),
1199 GetStringInfoPath(option),exception);
1201 options=DestroyConfigureOptions(options);
1202 return(status != 0 ? MagickTrue : MagickFalse);
1206 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1210 % O r d e r e d P o s t e r i z e I m a g e %
1214 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1216 % OrderedPosterizeImage() will perform a ordered dither based on a number
1217 % of pre-defined dithering threshold maps, but over multiple intensity
1218 % levels, which can be different for different channels, according to the
1221 % The format of the OrderedPosterizeImage method is:
1223 % MagickBooleanType OrderedPosterizeImage(Image *image,
1224 % const char *threshold_map,ExceptionInfo *exception)
1226 % A description of each parameter follows:
1228 % o image: the image.
1230 % o threshold_map: A string containing the name of the threshold dither
1231 % map to use, followed by zero or more numbers representing the number
1232 % of color levels tho dither between.
1234 % Any level number less than 2 will be equivalent to 2, and means only
1235 % binary dithering will be applied to each color channel.
1237 % No numbers also means a 2 level (bitmap) dither will be applied to all
1238 % channels, while a single number is the number of levels applied to each
1239 % channel in sequence. More numbers will be applied in turn to each of
1240 % the color channels.
1242 % For example: "o3x3,6" will generate a 6 level posterization of the
1243 % image with a ordered 3x3 diffused pixel dither being applied between
1244 % each level. While checker,8,8,4 will produce a 332 colormaped image
1245 % with only a single checkerboard hash pattern (50% grey) between each
1246 % color level, to basically double the number of color levels with
1247 % a bare minimim of dithering.
1249 % o exception: return any errors or warnings in this structure.
1252 MagickExport MagickBooleanType OrderedPosterizeImage(Image *image,
1253 const char *threshold_map,ExceptionInfo *exception)
1255 #define DitherImageTag "Dither/Image"
1261 token[MaxTextExtent];
1273 levels[CompositePixelChannel];
1284 assert(image != (Image *) NULL);
1285 assert(image->signature == MagickSignature);
1286 if (image->debug != MagickFalse)
1287 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1288 assert(exception != (ExceptionInfo *) NULL);
1289 assert(exception->signature == MagickSignature);
1290 if (threshold_map == (const char *) NULL)
1292 p=(char *) threshold_map;
1293 while (((isspace((int) ((unsigned char) *p)) != 0) || (*p == ',')) &&
1297 while (((isspace((int) ((unsigned char) *p)) == 0) && (*p != ',')) &&
1300 if ((p-threshold_map) >= (MaxTextExtent-1))
1302 token[p-threshold_map]=(*p);
1305 token[p-threshold_map]='\0';
1306 map=GetThresholdMap(token,exception);
1307 if (map == (ThresholdMap *) NULL)
1309 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
1310 "InvalidArgument","%s : '%s'","ordered-dither",threshold_map);
1311 return(MagickFalse);
1313 for (i=0; i < MaxPixelChannels; i++)
1315 p=strchr((char *) threshold_map,',');
1316 if ((p != (char *) NULL) && (isdigit((int) ((unsigned char) *(++p))) != 0))
1317 for (i=0; (*p != '\0') && (i < MaxPixelChannels); i++)
1319 GetMagickToken(p,&p,token);
1321 GetMagickToken(p,&p,token);
1322 levels[i]=StringToDouble(token,(char **) NULL);
1324 for (i=0; i < MaxPixelChannels; i++)
1325 if (fabs(levels[i]) >= 1)
1327 if (SetImageStorageClass(image,DirectClass,exception) == MagickFalse)
1328 return(MagickFalse);
1331 image_view=AcquireAuthenticCacheView(image,exception);
1332 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1333 #pragma omp parallel for schedule(static,8) shared(progress,status) \
1334 dynamic_number_threads(image,image->columns,image->rows,1)
1336 for (y=0; y < (ssize_t) image->rows; y++)
1344 if (status == MagickFalse)
1346 q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
1347 if (q == (Quantum *) NULL)
1352 for (x=0; x < (ssize_t) image->columns; x++)
1361 if (GetPixelMask(image,q) != 0)
1363 q+=GetPixelChannels(image);
1366 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
1378 channel=GetPixelChannelMapChannel(image,i);
1379 traits=GetPixelChannelMapTraits(image,channel);
1380 if ((traits & UpdatePixelTrait) == 0)
1382 if (fabs(levels[n++]) < MagickEpsilon)
1384 threshold=(ssize_t) (QuantumScale*q[i]*(levels[n]*(map->divisor-1)+1));
1385 level=threshold/(map->divisor-1);
1386 threshold-=level*(map->divisor-1);
1387 q[i]=ClampToQuantum((double) (level+(threshold >=
1388 map->levels[(x % map->width)+map->width*(y % map->height)]))*
1389 QuantumRange/levels[n]);
1392 q+=GetPixelChannels(image);
1394 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
1396 if (image->progress_monitor != (MagickProgressMonitor) NULL)
1401 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1402 #pragma omp critical (MagickCore_OrderedPosterizeImage)
1404 proceed=SetImageProgress(image,DitherImageTag,progress++,image->rows);
1405 if (proceed == MagickFalse)
1409 image_view=DestroyCacheView(image_view);
1410 map=DestroyThresholdMap(map);
1415 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1419 % R a n d o m T h r e s h o l d I m a g e %
1423 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1425 % RandomThresholdImage() changes the value of individual pixels based on the
1426 % intensity of each pixel compared to a random threshold. The result is a
1427 % low-contrast, two color image.
1429 % The format of the RandomThresholdImage method is:
1431 % MagickBooleanType RandomThresholdImage(Image *image,
1432 % const char *thresholds,ExceptionInfo *exception)
1434 % A description of each parameter follows:
1436 % o image: the image.
1438 % o thresholds: a geometry string containing low,high thresholds. If the
1439 % string contains 2x2, 3x3, or 4x4, an ordered dither of order 2, 3, or 4
1440 % is performed instead.
1442 % o exception: return any errors or warnings in this structure.
1445 MagickExport MagickBooleanType RandomThresholdImage(Image *image,
1446 const char *thresholds,ExceptionInfo *exception)
1448 #define ThresholdImageTag "Threshold/Image"
1473 **restrict random_info;
1481 assert(image != (Image *) NULL);
1482 assert(image->signature == MagickSignature);
1483 if (image->debug != MagickFalse)
1484 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1485 assert(exception != (ExceptionInfo *) NULL);
1486 assert(exception->signature == MagickSignature);
1487 if (thresholds == (const char *) NULL)
1489 if (SetImageStorageClass(image,DirectClass,exception) == MagickFalse)
1490 return(MagickFalse);
1491 GetPixelInfo(image,&threshold);
1493 max_threshold=(MagickRealType) QuantumRange;
1494 flags=ParseGeometry(thresholds,&geometry_info);
1495 min_threshold=geometry_info.rho;
1496 max_threshold=geometry_info.sigma;
1497 if ((flags & SigmaValue) == 0)
1498 max_threshold=min_threshold;
1499 if (strchr(thresholds,'%') != (char *) NULL)
1501 max_threshold*=(MagickRealType) (0.01*QuantumRange);
1502 min_threshold*=(MagickRealType) (0.01*QuantumRange);
1505 Random threshold image.
1509 random_info=AcquireRandomInfoThreadSet();
1510 key=GetRandomSecretKey(random_info[0]);
1511 image_view=AcquireAuthenticCacheView(image,exception);
1512 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1513 #pragma omp parallel for schedule(static,8) shared(progress,status) \
1514 dynamic_number_threads(image,image->columns,image->rows,key == ~0UL)
1516 for (y=0; y < (ssize_t) image->rows; y++)
1519 id = GetOpenMPThreadId();
1527 if (status == MagickFalse)
1529 q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
1530 if (q == (Quantum *) NULL)
1535 for (x=0; x < (ssize_t) image->columns; x++)
1540 if (GetPixelMask(image,q) != 0)
1542 q+=GetPixelChannels(image);
1545 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
1556 channel=GetPixelChannelMapChannel(image,i);
1557 traits=GetPixelChannelMapTraits(image,channel);
1558 if ((traits & UpdatePixelTrait) == 0)
1560 if ((MagickRealType) q[i] < min_threshold)
1561 threshold=min_threshold;
1563 if ((MagickRealType) q[i] > max_threshold)
1564 threshold=max_threshold;
1566 threshold=(MagickRealType) (QuantumRange*
1567 GetPseudoRandomValue(random_info[id]));
1568 q[i]=(MagickRealType) q[i] <= threshold ? 0 : QuantumRange;
1570 q+=GetPixelChannels(image);
1572 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
1574 if (image->progress_monitor != (MagickProgressMonitor) NULL)
1579 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1580 #pragma omp critical (MagickCore_RandomThresholdImage)
1582 proceed=SetImageProgress(image,ThresholdImageTag,progress++,
1584 if (proceed == MagickFalse)
1588 image_view=DestroyCacheView(image_view);
1589 random_info=DestroyRandomInfoThreadSet(random_info);
1594 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1598 % W h i t e T h r e s h o l d I m a g e %
1602 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1604 % WhiteThresholdImage() is like ThresholdImage() but forces all pixels above
1605 % the threshold into white while leaving all pixels at or below the threshold
1608 % The format of the WhiteThresholdImage method is:
1610 % MagickBooleanType WhiteThresholdImage(Image *image,
1611 % const char *threshold,ExceptionInfo *exception)
1613 % A description of each parameter follows:
1615 % o image: the image.
1617 % o threshold: Define the threshold value.
1619 % o exception: return any errors or warnings in this structure.
1622 MagickExport MagickBooleanType WhiteThresholdImage(Image *image,
1623 const char *thresholds,ExceptionInfo *exception)
1625 #define ThresholdImageTag "Threshold/Image"
1648 assert(image != (Image *) NULL);
1649 assert(image->signature == MagickSignature);
1650 if (image->debug != MagickFalse)
1651 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1652 if (thresholds == (const char *) NULL)
1654 if (SetImageStorageClass(image,DirectClass,exception) == MagickFalse)
1655 return(MagickFalse);
1656 if (IsGrayColorspace(image->colorspace) != MagickFalse)
1657 (void) TransformImageColorspace(image,sRGBColorspace,exception);
1658 GetPixelInfo(image,&threshold);
1659 flags=ParseGeometry(thresholds,&geometry_info);
1660 threshold.red=geometry_info.rho;
1661 threshold.green=geometry_info.rho;
1662 threshold.blue=geometry_info.rho;
1663 threshold.black=geometry_info.rho;
1664 threshold.alpha=100.0;
1665 if ((flags & SigmaValue) != 0)
1666 threshold.green=geometry_info.sigma;
1667 if ((flags & XiValue) != 0)
1668 threshold.blue=geometry_info.xi;
1669 if ((flags & PsiValue) != 0)
1670 threshold.alpha=geometry_info.psi;
1671 if (threshold.colorspace == CMYKColorspace)
1673 if ((flags & PsiValue) != 0)
1674 threshold.black=geometry_info.psi;
1675 if ((flags & ChiValue) != 0)
1676 threshold.alpha=geometry_info.chi;
1678 if ((flags & PercentValue) != 0)
1680 threshold.red*=(QuantumRange/100.0);
1681 threshold.green*=(QuantumRange/100.0);
1682 threshold.blue*=(QuantumRange/100.0);
1683 threshold.black*=(QuantumRange/100.0);
1684 threshold.alpha*=(QuantumRange/100.0);
1687 White threshold image.
1691 image_view=AcquireAuthenticCacheView(image,exception);
1692 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1693 #pragma omp parallel for schedule(static,8) shared(progress,status) \
1694 dynamic_number_threads(image,image->columns,image->rows,1)
1696 for (y=0; y < (ssize_t) image->rows; y++)
1704 if (status == MagickFalse)
1706 q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
1707 if (q == (Quantum *) NULL)
1712 for (x=0; x < (ssize_t) image->columns; x++)
1717 if (GetPixelMask(image,q) != 0)
1719 q+=GetPixelChannels(image);
1722 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
1730 channel=GetPixelChannelMapChannel(image,i);
1731 traits=GetPixelChannelMapTraits(image,channel);
1732 if ((traits & UpdatePixelTrait) == 0)
1734 if ((double) q[i] > GetPixelInfoChannel(&threshold,channel))
1737 q+=GetPixelChannels(image);
1739 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
1741 if (image->progress_monitor != (MagickProgressMonitor) NULL)
1746 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1747 #pragma omp critical (MagickCore_WhiteThresholdImage)
1749 proceed=SetImageProgress(image,ThresholdImageTag,progress++,
1751 if (proceed == MagickFalse)
1755 image_view=DestroyCacheView(image_view);