Package adams.data.areaoverlap

Class BoundingBoxBased

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.areaoverlap.AbstractAreaOverlap

adams.data.areaoverlap.BoundingBoxBased

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, AreaOverlap, Serializable

public class BoundingBoxBased
extends AbstractAreaOverlap

Uses bounding boxes for the calculation.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_AREA_NEW
static String	KEY_AREA_OLD
static String	KEY_AREA_RATIO
protected AreaType	m_AreaType	how to calculate the area.
protected double	m_BoundingBoxFallbackRatio	the ratio used for determining whether to fall back from polygon on bbox.
protected boolean	m_Fallback	whether to fallback on bounding box.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
BoundingBoxBased()

Method Summary

Modifier and Type	Method	Description
String	areaTypeTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected LocatedObjects	doCalculate(Map<LocatedObject,Map<LocatedObject,Double>> matches, MessageCollection errors)	Computes the overlapping areas between the matches.
AreaType	getAreaType()	Returns what area to use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setAreaType(AreaType value)	Sets what area to use.

Methods inherited from class adams.data.areaoverlap.AbstractAreaOverlap

calculate, check

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

KEY_AREA_OLD

public static final String KEY_AREA_OLD

See Also:

Constant Field Values

KEY_AREA_NEW

public static final String KEY_AREA_NEW

See Also:

Constant Field Values

KEY_AREA_RATIO

public static final String KEY_AREA_RATIO

See Also:

Constant Field Values

m_AreaType

protected AreaType m_AreaType

how to calculate the area.

m_Fallback

protected boolean m_Fallback

whether to fallback on bounding box.

m_BoundingBoxFallbackRatio

protected double m_BoundingBoxFallbackRatio

the ratio used for determining whether to fall back from polygon on bbox.

Constructor Detail

BoundingBoxBased

public BoundingBoxBased()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setAreaType

public void setAreaType(AreaType value)

Sets what area to use.

Parameters:

value - the type

getAreaType

public AreaType getAreaType()

Returns what area to use.

Returns:

the type

areaTypeTipText

public String areaTypeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Returns:

null if no info available, otherwise short string

doCalculate

protected LocatedObjects doCalculate(Map<LocatedObject,Map<LocatedObject,Double>> matches,
                                     MessageCollection errors)

Computes the overlapping areas between the matches.

Specified by:

doCalculate in class AbstractAreaOverlap

Parameters:

matches - the computed matches

errors - for collecting errors

Returns:

the overlapping areas, null in case of error