com.tplan.robot.imagecomparison

Interface AdvancedImageComparisonModule

All Known Implementing Classes:

AbbyyOCR, GoogleVisionOCR, ImageDiffModule, ObjectSearchModule, SearchImageComparisonModule2, TesseractOCR, TesseractOCRImpl, TextRecognitionComparisonModule

public interface AdvancedImageComparisonModule

Advanced image comparison module methods.

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

Method Summary

Modifier and Type	Method and Description
float	getDefaultPassRate() Get the default pass rate value.
String	getPassRateName() Get alternative name for the default "pass rate".
boolean	usesPassRate() Indicate whether the module uses the pass rate as a parameter or not.

Method Detail

usesPassRate

boolean usesPassRate()

Indicate whether the module uses the pass rate as a parameter or not. This information is typically used by the GUI which disables or removes the password field.

Returns:

true if the module allows to specify a pass rate, false if not.

getPassRateName

String getPassRateName()

Get alternative name for the default "pass rate". This allows to update the GUI component label to be more descriptive, for example when the module calls the pass rate parameter in a different way such as "similarity", "comparison factor" or other.

Returns:

alternative pass rate name; null defaults to "pass rate".

getDefaultPassRate

float getDefaultPassRate()

Get the default pass rate value. It must be a float value between 0 and 1. This method gets called only if usesPassRate() returns true.

Returns:

default pass rate value;