java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.objectoverlap.AbstractObjectOverlap
      - adams.data.objectoverlap.DiceCoefficient

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, BoundingBoxFallbackSupporter, LabelAwareObjectOverlap, ObjectOverlap, OptionalBoundingBoxFallbackSupporter, Serializable
```
public class DiceCoefficient
extends AbstractObjectOverlap
implements LabelAwareObjectOverlap, OptionalBoundingBoxFallbackSupporter
```
Computes the Dice coefficient between annotations and predictions.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DICE_COUNT`	the DICE count.
`static String`	`DICE_LABEL_HIGHEST`	the label of the highest DICE.
`static String`	`DICE_LABEL_HIGHEST_MATCH`	whether the labels of the highest DICE match.
`static String`	`DICE_PERCENTAGE_HIGHEST`	the highest DICE percentage.
`protected boolean`	`m_AdditionalObject`	whether to check for additional predicted objects not present in actual.
`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.
`protected GeometryType`	`m_Geometry`	the geometry to use.
`protected String`	`m_LabelKey`	the label meta-data key - ignored if empty.
`protected double`	`m_MinDice`	the minimum DICE ratio to use.
`protected boolean`	`m_UseOtherObject`	whether to use the other object in the output in case of an overlap.

Fields inherited from class adams.data.objectoverlap.AbstractObjectOverlap
m_CopyMetaData, m_ExcludeIdentical, m_MetaDataKeys

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.data.objectoverlap.ObjectOverlap
ADDITIONAL_OBJ, UNKNOWN_LABEL

Constructor Summary

Constructors
Constructor Description

DiceCoefficient()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`additionalObjectTipText()`	Returns the tip text for this property.
`String`	`boundingBoxFallbackRatioTipText()`	Returns the tip text for this property.
`protected double`	`calculateDice(LocatedObject thisObj, LocatedObject otherObj)`	Calculates the Dice for the two objects.
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected LocatedObjects`	`doCalculate(LocatedObjects annotations, LocatedObjects predictions, Map<LocatedObject,Map<LocatedObject,Double>> matches)`	Computes the overlapping objects between the annotations and the predictions.
`String`	`fallbackTipText()`	Returns the tip text for this property.
`String`	`geometryTipText()`	Returns the tip text for this property.
`boolean`	`getAdditionalObject()`	Returns whether to count additional predicted objects.
`double`	`getBoundingBoxFallbackRatio()`	Returns the ratio between shape area over bbox area.
`boolean`	`getFallback()`	Returns whether to fall back on the bounding box if no polygon available.
`GeometryType`	`getGeometry()`	Returns the geometry type to use for the calculations.
`String`	`getLabelKey()`	Returns the (optional) key for a string label in the meta-data; if supplied the value of the object with the highest overlap gets stored in the report using `DICE_LABEL_HIGHEST`, `DICE_LABEL_HIGHEST_MATCH` stores whether the labels match.
`double`	`getMinDice()`	Returns the minimum DICE ratio to use.
`String`	`getQuickInfo()`	Returns a quick info about the actor, which will be displayed in the GUI.
`boolean`	`getUseOtherObject()`	Returns whether to use/forward other object data.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`labelKeyTipText()`	Returns the tip text for this property.
`String`	`minDiceTipText()`	Returns the tip text for this property.
`void`	`setAdditionalObject(boolean value)`	Sets whether to count additional predicted objects.
`void`	`setBoundingBoxFallbackRatio(double value)`	Sets the ratio between shape area over bbox area.
`void`	`setFallback(boolean value)`	Sets whether to fall back on the bounding box if no polygon available.
`void`	`setGeometry(GeometryType value)`	Sets the geometry type to use for the calculations.
`void`	`setLabelKey(String value)`	Sets the (optional) key for a string label in the meta-data; if supplied the value of the object with the highest overlap gets stored in the report using `DICE_LABEL_HIGHEST`, `DICE_LABEL_HIGHEST_MATCH` stores whether the labels match.
`void`	`setMinDice(double value)`	Sets the minimum DICE ratio to use.
`void`	`setUseOtherObject(boolean value)`	Sets whether to use/forward other object data.
`com.github.fracpete.javautils.struct.Struct2<LocatedObjects,LocatedObjects>`	`splitOverlaps(LocatedObjects overlaps)`	Splits the overlapping objects into subsets of matching labels and mismatching ones.
`String`	`useOtherObjectTipText()`	Returns the tip text for this property.

Methods inherited from class adams.data.objectoverlap.AbstractObjectOverlap
addMatch, calculate, check, copyMetaData, copyMetaDataTipText, excludeIdenticalTipText, getCopyMetaData, getExcludeIdentical, getMetaDataKeys, initMatch, matches, metaDataKeysTipText, setCopyMetaData, setExcludeIdentical, setMetaDataKeys

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.data.objectoverlap.ObjectOverlap
calculate, matches

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

- Field Detail
  - DICE_PERCENTAGE_HIGHEST
```
public static final String DICE_PERCENTAGE_HIGHEST
```
    the highest DICE percentage.
    
    See Also:
    
    Constant Field Values
  - DICE_LABEL_HIGHEST
```
public static final String DICE_LABEL_HIGHEST
```
    the label of the highest DICE.
    
    See Also:
    
    Constant Field Values
  - DICE_LABEL_HIGHEST_MATCH
```
public static final String DICE_LABEL_HIGHEST_MATCH
```
    whether the labels of the highest DICE match.
    
    See Also:
    
    Constant Field Values
  - DICE_COUNT
```
public static final String DICE_COUNT
```
    the DICE count.
    
    See Also:
    
    Constant Field Values
  - m_MinDice
```
protected double m_MinDice
```
    the minimum DICE ratio to use.
  - m_LabelKey
```
protected String m_LabelKey
```
    the label meta-data key - ignored if empty.
  - m_UseOtherObject
```
protected boolean m_UseOtherObject
```
    whether to use the other object in the output in case of an overlap.
  - m_AdditionalObject
```
protected boolean m_AdditionalObject
```
    whether to check for additional predicted objects not present in actual.
  - m_Geometry
```
protected GeometryType m_Geometry
```
    the geometry to use.
  - 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
  - DiceCoefficient
```
public DiceCoefficient()
```
- 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 AbstractObjectOverlap
  - setMinDice
```
public void setMinDice(double value)
```
    Sets the minimum DICE ratio to use.
    
    Parameters:
    
    value - the minimum ratio
  - getMinDice
```
public double getMinDice()
```
    Returns the minimum DICE ratio to use.
    
    Returns:
    
    the minimum ratio
  - minDiceTipText
```
public String minDiceTipText()
```
    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; if supplied the value of the object with the highest overlap gets stored in the report using DICE_LABEL_HIGHEST, DICE_LABEL_HIGHEST_MATCH stores whether the labels match.
    
    Parameters:
    
    value - the key, ignored if empty
  - getLabelKey
```
public String getLabelKey()
```
    Returns the (optional) key for a string label in the meta-data; if supplied the value of the object with the highest overlap gets stored in the report using DICE_LABEL_HIGHEST, DICE_LABEL_HIGHEST_MATCH stores whether the labels match.
    
    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.
  - setUseOtherObject
```
public void setUseOtherObject(boolean value)
```
    Sets whether to use/forward other object data.
    
    Parameters:
    
    value - true if to use other object
  - getUseOtherObject
```
public boolean getUseOtherObject()
```
    Returns whether to use/forward other object data.
    
    Returns:
    
    true if to use other object
  - useOtherObjectTipText
```
public String useOtherObjectTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAdditionalObject
```
public void setAdditionalObject(boolean value)
```
    Sets whether to count additional predicted objects.
    
    Parameters:
    
    value - true if to count additional predicted objects
  - getAdditionalObject
```
public boolean getAdditionalObject()
```
    Returns whether to count additional predicted objects.
    
    Returns:
    
    true if to count additional predicted objects
  - additionalObjectTipText
```
public String additionalObjectTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setGeometry
```
public void setGeometry(GeometryType value)
```
    Sets the geometry type to use for the calculations.
    
    Parameters:
    
    value - the type
  - getGeometry
```
public GeometryType getGeometry()
```
    Returns the geometry type to use for the calculations.
    
    Returns:
    
    the type
  - geometryTipText
```
public String geometryTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setFallback
```
public void setFallback(boolean value)
```
    Sets whether to fall back on the bounding box if no polygon available.
    
    Specified by:
    
    setFallback in interface OptionalBoundingBoxFallbackSupporter
    
    Parameters:
    
    value - true if to use
  - getFallback
```
public boolean getFallback()
```
    Returns whether to fall back on the bounding box if no polygon available.
    
    Specified by:
    
    getFallback in interface OptionalBoundingBoxFallbackSupporter
    
    Returns:
    
    true if to use
  - fallbackTipText
```
public String fallbackTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    fallbackTipText in interface OptionalBoundingBoxFallbackSupporter
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setBoundingBoxFallbackRatio
```
public void setBoundingBoxFallbackRatio(double value)
```
    Sets the ratio between shape area over bbox area. If below the bbox is used instead of the polygon.
    
    Specified by:
    
    setBoundingBoxFallbackRatio in interface BoundingBoxFallbackSupporter
    
    Parameters:
    
    value - the ratio
  - getBoundingBoxFallbackRatio
```
public double getBoundingBoxFallbackRatio()
```
    Returns the ratio between shape area over bbox area. If below the bbox is used instead of the polygon.
    
    Specified by:
    
    getBoundingBoxFallbackRatio in interface BoundingBoxFallbackSupporter
    
    Returns:
    
    the ratio
  - boundingBoxFallbackRatioTipText
```
public String boundingBoxFallbackRatioTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    boundingBoxFallbackRatioTipText in interface BoundingBoxFallbackSupporter
    
    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 actor, which will be displayed in the GUI.
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Overrides:
    
    getQuickInfo in class AbstractObjectOverlap
    
    Returns:
    
    null if no info available, otherwise short string
  - calculateDice
```
protected double calculateDice(LocatedObject thisObj,
                               LocatedObject otherObj)
```
    Calculates the Dice for the two objects.
    
    Parameters:
    
    thisObj - first object
    
    otherObj - second object
    
    Returns:
    
    the Dice
  - doCalculate
```
protected LocatedObjects doCalculate(LocatedObjects annotations,
                                     LocatedObjects predictions,
                                     Map<LocatedObject,Map<LocatedObject,Double>> matches)
```
    Computes the overlapping objects between the annotations and the predictions.
    
    Specified by:
    
    doCalculate in class AbstractObjectOverlap
    
    Parameters:
    
    annotations - the annotations (ground truth)
    
    predictions - the predictions to compare with
    
    matches - for collecting the matches
    
    Returns:
    
    the overlapping objects
  - splitOverlaps
```
public com.github.fracpete.javautils.struct.Struct2<LocatedObjects,LocatedObjects> splitOverlaps(LocatedObjects overlaps)
```
    Splits the overlapping objects into subsets of matching labels and mismatching ones.
    
    Specified by:
    
    splitOverlaps in interface LabelAwareObjectOverlap
    
    Parameters:
    
    overlaps - all overlaps, to split
    
    Returns:
    
    split into matching/mismatching subsets

Class DiceCoefficient

Field Summary

Fields inherited from class adams.data.objectoverlap.AbstractObjectOverlap

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Fields inherited from interface adams.data.objectoverlap.ObjectOverlap

Constructor Summary

Method Summary

Methods inherited from class adams.data.objectoverlap.AbstractObjectOverlap

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.Destroyable

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.data.objectoverlap.ObjectOverlap

Methods inherited from interface adams.core.option.OptionHandler

Field Detail

DICE_PERCENTAGE_HIGHEST

DICE_LABEL_HIGHEST

DICE_LABEL_HIGHEST_MATCH

DICE_COUNT

m_MinDice

m_LabelKey

m_UseOtherObject

m_AdditionalObject

m_Geometry

m_Fallback

m_BoundingBoxFallbackRatio

Constructor Detail

DiceCoefficient

Method Detail

globalInfo

defineOptions

setMinDice

getMinDice

minDiceTipText

setLabelKey

getLabelKey

labelKeyTipText

setUseOtherObject

getUseOtherObject

useOtherObjectTipText

setAdditionalObject

getAdditionalObject

additionalObjectTipText

setGeometry

getGeometry

geometryTipText

setFallback

getFallback

fallbackTipText

setBoundingBoxFallbackRatio

getBoundingBoxFallbackRatio

boundingBoxFallbackRatioTipText

getQuickInfo

calculateDice

doCalculate

splitOverlaps