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 
  24 package org.jemmy.image;
  25 
  26 
  27 import org.jemmy.image.pixel.AverageDistanceComparator;
  28 
  29 
  30 /**
  31  * Compares two images calculating average color distance between pixels and
  32  * comparing it to the threshold value. See {@linkplain NaturalImageComparator
  33  * NaturalImageComparator} for color comparison details.
  34  *
  35  * @author KAM
  36  */
  37 public class AverageDistanceImageComparator extends BufferedImageComparator {
  38 
  39     /**
  40      * Creates comparator with the default sensitivity value = 0.02
  41      * (around 5 in 0-255 color component value).
  42      */
  43     public AverageDistanceImageComparator() {
  44         this(0.02);
  45     }
  46 
  47     /**
  48      * Creates comparator with the specified sensitivity value
  49      * @param sensitivity Maximum threshold for average 3-D distance between
  50      * colors in 3-D sRGB color space for images to be considered equal.
  51      * Meaningful values lay between 0 and approx 1.733. 0 means colors should
  52      * be equal to pass the comparison, 1.733 (which is more than square root
  53      * of 3) means that comparison will be passed even if all the colors are
  54      * completely different.
  55      */
  56     public AverageDistanceImageComparator(double sensitivity) {
  57         super(new AverageDistanceComparator(sensitivity));
  58     }
  59 
  60     public void setSensitivity(double sensitivity) {
  61         ((AverageDistanceComparator)getRasterComparator()).setThreshold(sensitivity);
  62     }
  63     public double getSensitivity() {
  64         return ((AverageDistanceComparator)getRasterComparator()).getThreshold();
  65     }
  66 }