1 /*
   2  * Copyright (c) 2007, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation. Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package org.jemmy.image;
  26 
  27 
  28 import java.awt.Color;
  29 import java.awt.image.BufferedImage;
  30 import org.jemmy.image.pixel.AverageDistanceComparator;
  31 import org.jemmy.image.pixel.MaxDistanceComparator;
  32 
  33 
  34 /**
  35  * Compares two images naturally
  36  * (i.e. ignoring slight difference between pixel colors).
  37  *
  38  * @author KAM
  39  */
  40 public class NaturalImageComparator extends BufferedImageComparator {
  41 
  42     /**
  43      * Creates comparator with the default sensitivity value = 0.02
  44      * (around 5 in 0-255 color component value).
  45      * @see #NaturalImageComparator(double)
  46      */
  47     public NaturalImageComparator() {
  48         this(0.02);
  49     }
  50 
  51     /**
  52      * Creates comparator with the specified sensitivity value
  53      * @param sensitivity Maximum threshold for 3-D distance between colors
  54      * in 3-D sRGB color space for pixels to be considered equal.
  55      * Meaningful values are between 0 and approx 1.733. 0 means colors should
  56      * be equal to pass the comparison, 1.733 (which is more than square root
  57      * of 3) means that comparison will be passed even if the colors are
  58      * completely different. You could also use {@linkplain
  59      * #findSensitivity(java.awt.image.BufferedImage, java.awt.image.BufferedImage)
  60      * findSensitivity()} method to obtain necessary sensitivity value.
  61      */
  62     public NaturalImageComparator(double sensitivity) {
  63         super(new MaxDistanceComparator(sensitivity));
  64     }
  65     public void setSensitivity(double sensitivity) {
  66         ((MaxDistanceComparator)getRasterComparator()).setThreshold(sensitivity);
  67     }
  68     public double getSensitivity() {
  69         return ((MaxDistanceComparator)getRasterComparator()).getThreshold();
  70     }
  71 }