Package adams.data.overlappingobjectremoval

Class MergeOverlaps

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.overlappingobjectremoval.AbstractOverlappingObjectRemoval

adams.data.overlappingobjectremoval.MergeOverlaps

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, OverlappingObjectRemoval, Serializable

public class MergeOverlaps
extends AbstractOverlappingObjectRemoval

Merges overlapping objects into single one.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ObjectOverlap	m_Algorithm	the object overlap calculation to use.
protected String	m_LabelKey	the label meta-data key - ignored if empty.
protected MergedScoreCalculation	m_MergedScoreCalculation	how to calculate the merged score.
protected String	m_ScoreKey	the score meta-data key - ignored if empty.

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
MergeOverlaps()

Method Summary

Modifier and Type	Method	Description
String	algorithmTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
ObjectOverlap	getAlgorithm()	Returns the algorithm for determining the overlapping objects.
String	getLabelKey()	Returns the (optional) key for a string label in the meta-data.
MergedScoreCalculation	getMergedScoreCalculation()	Returns how to calculate the score for the merged object.
String	getScoreKey()	Returns the (optional) key for a numeric prediction score in the meta-data.
String	globalInfo()	Returns a string describing the object.
String	labelKeyTipText()	Returns the tip text for this property.
String	mergedScoreCalculationTipText()	Returns the tip text for this property.
LocatedObjects	removeOverlaps(LocatedObjects objects, Map<LocatedObject,Map<LocatedObject,Double>> matches)	Removes overlapping image objects.
String	scoreKeyTipText()	Returns the tip text for this property.
void	setAlgorithm(ObjectOverlap value)	Sets the algorithm for determining the overlapping objects
void	setLabelKey(String value)	Sets the (optional) key for a string label in the meta-data.
void	setMergedScoreCalculation(MergedScoreCalculation value)	Sets how to calculate the score for the merged object.
void	setScoreKey(String value)	Sets the (optional) key for a numeric prediction score in the meta-data.

Methods inherited from class adams.data.overlappingobjectremoval.AbstractOverlappingObjectRemoval

remove

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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Algorithm

protected ObjectOverlap m_Algorithm

the object overlap calculation to use.

m_LabelKey

protected String m_LabelKey

the label meta-data key - ignored if empty.

m_ScoreKey

protected String m_ScoreKey

the score meta-data key - ignored if empty.

m_MergedScoreCalculation

protected MergedScoreCalculation m_MergedScoreCalculation

how to calculate the merged score.

Constructor Detail

MergeOverlaps

public MergeOverlaps()

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

setAlgorithm

public void setAlgorithm(ObjectOverlap value)

Sets the algorithm for determining the overlapping objects

Parameters:

value - the algorithm

getAlgorithm

public ObjectOverlap getAlgorithm()

Returns the algorithm for determining the overlapping objects.

Returns:

the algorithm

algorithmTipText

public String algorithmTipText()

Returns the tip text for this property.

Returns:

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

setLabelKey

public void setLabelKey(String value)

Sets the (optional) key for a string label in the meta-data. Only objects with matching labels get merged.

Parameters:

value - the key, ignored if empty

getLabelKey

public String getLabelKey()

Returns the (optional) key for a string label in the meta-data. Only objects with matching labels get merged.

Returns:

the key, ignored if empty

labelKeyTipText

public String labelKeyTipText()

Returns the tip text for this property.

Returns:

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

setScoreKey

public void setScoreKey(String value)

Sets the (optional) key for a numeric prediction score in the meta-data.

Parameters:

value - the key, ignored if empty

getScoreKey

public String getScoreKey()

Returns the (optional) key for a numeric prediction score in the meta-data.

Returns:

the key, ignored if empty

scoreKeyTipText

public String scoreKeyTipText()

Returns the tip text for this property.

Returns:

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

setMergedScoreCalculation

public void setMergedScoreCalculation(MergedScoreCalculation value)

Sets how to calculate the score for the merged object.

Parameters:

value - the type of calculation

getMergedScoreCalculation

public MergedScoreCalculation getMergedScoreCalculation()

Returns how to calculate the score for the merged object.

Returns:

the type of calculation

mergedScoreCalculationTipText

public String mergedScoreCalculationTipText()

Returns the tip text for this property.

Returns:

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

removeOverlaps

public LocatedObjects removeOverlaps(LocatedObjects objects,
                                     Map<LocatedObject,Map<LocatedObject,Double>> matches)

Removes overlapping image objects.

Specified by:

removeOverlaps in interface OverlappingObjectRemoval

Specified by:

removeOverlaps in class AbstractOverlappingObjectRemoval

Parameters:

objects - the objects to clean up

matches - the matches that were determined by an algorithm, used as basis for removal

Returns:

the updated objects