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