1 /*
2   Copyright 1999-2021 ImageMagick Studio LLC, a non-profit organization
3   dedicated to making software imaging solutions freely available.
4 
5   You may not use this file except in compliance with the License.  You may
6   obtain a copy of the License at
7 
8     https://imagemagick.org/script/license.php
9 
10   Unless required by applicable law or agreed to in writing, software
11   distributed under the License is distributed on an "AS IS" BASIS,
12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   See the License for the specific language governing permissions and
14   limitations under the License.
15 
16   MagickCore image compare methods.
17 */
18 #ifndef MAGICKCORE_COMPARE_H
19 #define MAGICKCORE_COMPARE_H
20 
21 #include "magick/image.h"
22 
23 #if defined(__cplusplus) || defined(c_plusplus)
24 extern "C" {
25 #endif
26 
27 typedef enum
28 {
29   UndefinedMetric,
30   AbsoluteErrorMetric,
31   MeanAbsoluteErrorMetric,
32   MeanErrorPerPixelMetric,
33   MeanSquaredErrorMetric,
34   PeakAbsoluteErrorMetric,
35   PeakSignalToNoiseRatioMetric,
36   RootMeanSquaredErrorMetric,
37   NormalizedCrossCorrelationErrorMetric,
38   FuzzErrorMetric,
39   UndefinedErrorMetric = 0,
40   PerceptualHashErrorMetric = 0xff
41 } MetricType;
42 
43 extern MagickExport double
44   *GetImageChannelDistortions(Image *,const Image *,const MetricType,
45     ExceptionInfo *);
46 
47 extern MagickExport Image
48   *CompareImageChannels(Image *,const Image *,const ChannelType,
49     const MetricType,double *,ExceptionInfo *),
50   *CompareImages(Image *,const Image *,const MetricType,double *,
51     ExceptionInfo *),
52   *SimilarityImage(Image *,const Image *,RectangleInfo *,double *,
53     ExceptionInfo *),
54   *SimilarityMetricImage(Image *,const Image *,const MetricType,
55     RectangleInfo *,double *,ExceptionInfo *);
56 
57 extern MagickExport MagickBooleanType
58   GetImageChannelDistortion(Image *,const Image *,const ChannelType,
59     const MetricType,double *,ExceptionInfo *),
60   GetImageDistortion(Image *,const Image *,const MetricType,double *,
61     ExceptionInfo *),
62   IsImagesEqual(Image *,const Image *);
63 
64 #if defined(__cplusplus) || defined(c_plusplus)
65 }
66 #endif
67 
68 #endif
69