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