com.tplan.robot.imagecomparison.search

Class BgTransparencyFilter

java.lang.Object

java.awt.image.ImageFilter

java.awt.image.RGBImageFilter

com.tplan.robot.imagecomparison.search.BgTransparencyFilter

All Implemented Interfaces:

ImageConsumer, Cloneable

public class BgTransparencyFilter
extends RGBImageFilter

RGB background transparency filter.

T-Plan Robot Enterprise, (C) 2009-2025 T-Plan Limited. All rights reserved.

Field Summary

Fields inherited from interface java.awt.image.ImageConsumer

COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT

Constructor Summary

Constructors

Constructor and Description
BgTransparencyFilter()
BgTransparencyFilter(Color c)

Method Summary

Modifier and Type	Method and Description
int	filterRGB(int x, int y, int rgb) Filter the given pixel to find out whether it is a good candidate for transparency or not.
int	getAlphaLimit()
static Color	getBestBgColor(int[] pixels, Rectangle geometry) Identify the best candidate for a background color.
Color	getColor()
int[]	getCounters()
int	getLowerAlpha()
int	getMinAlphaForComparablePixels(int requiredComparablePixels)
static int	getMinAlphaForComparablePixels(int requiredComparablePixels, int[] counters)
int	getNumberOfComparablePixels()
int	getNumberOfOpaquePixels()
Rectangle	getRectangle()
int	getUpperAlpha()
boolean	isEnablePartialTransparency()
boolean	isEnableStatistics()
boolean	isStatisticsOnly()
void	setAlphaLimit(int alphaLimit)
void	setColor(Color color)
void	setEnablePartialTransparency(boolean enablePartialTransparency)
void	setEnableStatistics(boolean enableStatistics)
void	setRectangle(Rectangle rectangle)
void	setStatisticsOnly(boolean statisticsOnly)

Methods inherited from class java.awt.image.RGBImageFilter

filterIndexColorModel, filterRGBPixels, setColorModel, setPixels, setPixels, substituteColorModel

Methods inherited from class java.awt.image.ImageFilter

clone, getFilterInstance, imageComplete, resendTopDownLeftRight, setDimensions, setHints, setProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BgTransparencyFilter

public BgTransparencyFilter(Color c)

BgTransparencyFilter

public BgTransparencyFilter()

Method Detail

getBestBgColor

public static Color getBestBgColor(int[] pixels,
                                   Rectangle geometry)

Identify the best candidate for a background color.

Parameters:

pixels - image pixels.

geometry - image geometry (dimensions)

Returns:

best background color.

setColor

public void setColor(Color color)

getColor

public Color getColor()

filterRGB

public final int filterRGB(int x,
                           int y,
                           int rgb)

Filter the given pixel to find out whether it is a good candidate for transparency or not. This method implements the RGBImageFilter interface.

Specified by:

filterRGB in class RGBImageFilter

Parameters:

x - pixel x-coordinate.

y - pixel y-coordinate.

rgb - pixel RGB or RGBA.

Returns:

new value of the pixel.

getNumberOfOpaquePixels

public int getNumberOfOpaquePixels()

Returns:

the numberOfNonAlphaPixels

getNumberOfComparablePixels

public int getNumberOfComparablePixels()

getMinAlphaForComparablePixels

public int getMinAlphaForComparablePixels(int requiredComparablePixels)

getMinAlphaForComparablePixels

public static int getMinAlphaForComparablePixels(int requiredComparablePixels,
                                                 int[] counters)

getAlphaLimit

public int getAlphaLimit()

Returns:

the cutOffRatio

setAlphaLimit

public void setAlphaLimit(int alphaLimit)

isEnablePartialTransparency

public boolean isEnablePartialTransparency()

Returns:

the enablePartialTransparency

setEnablePartialTransparency

public void setEnablePartialTransparency(boolean enablePartialTransparency)

Parameters:

enablePartialTransparency - the enablePartialTransparency to set

isEnableStatistics

public boolean isEnableStatistics()

Returns:

the enableStatistics

setEnableStatistics

public void setEnableStatistics(boolean enableStatistics)

Parameters:

enableStatistics - the enableStatistics to set

getUpperAlpha

public int getUpperAlpha()

getLowerAlpha

public int getLowerAlpha()

getCounters

public int[] getCounters()

getRectangle

public Rectangle getRectangle()

Returns:

the rectangle

setRectangle

public void setRectangle(Rectangle rectangle)

Parameters:

rectangle - the rectangle to set

isStatisticsOnly

public boolean isStatisticsOnly()

Returns:

the statisticsOnly

setStatisticsOnly

public void setStatisticsOnly(boolean statisticsOnly)

Parameters:

statisticsOnly - the statisticsOnly to set