Package adams.data.overlappingobjectremoval

Class KeepHighestMetaDataValue

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.overlappingobjectremoval.AbstractOverlappingObjectRemoval

adams.data.overlappingobjectremoval.KeepHighestMetaDataValue

All Implemented Interfaces:

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

public class KeepHighestMetaDataValue
extends AbstractOverlappingObjectRemoval

Keeps object with the highest (numeric) meta-data value.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_ScoreKey	the score meta-data key.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	getScoreKey()	Returns the key for the score in the meta-data.
String	globalInfo()	Returns a string describing the object.
LocatedObjects	removeOverlaps(LocatedObjects objects, Map<LocatedObject,Map<LocatedObject,Double>> matches)	Removes overlapping image objects.
String	scoreKeyTipText()	Returns the tip text for this property.
void	setScoreKey(String value)	Sets the key for the 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_ScoreKey

protected String m_ScoreKey

the score meta-data key.

Constructor Detail

KeepHighestMetaDataValue

public KeepHighestMetaDataValue()

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

setScoreKey

public void setScoreKey(String value)

Sets the key for the score in the meta-data.

Parameters:

value - the key

getScoreKey

public String getScoreKey()

Returns the key for the score in the meta-data.

Returns:

the key

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.

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