ObjectOverlap (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, OptionHandler, QuickInfoSupporter

All Known Subinterfaces:

LabelAwareObjectOverlap

All Known Implementing Classes:

AbstractObjectOverlap, AreaRatio, IntersectOverUnionRatio, Null
```
public interface ObjectOverlap
extends OptionHandler, QuickInfoSupporter
```
Interface for schemes that calculate image overlaps.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields
Modifier and Type Field Description

static String ADDITIONAL_OBJ
the additional objects boolean.

static String UNKNOWN_LABEL
the placeholder for unknown label.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`LocatedObjects`	`calculate(LocatedObjects annotations, LocatedObjects predictions)`	Computes the overlapping objects between the annotations and the predictions.
`Map<LocatedObject,Map<LocatedObject,Double>>`	`matches(LocatedObjects annotations, LocatedObjects predictions)`	Computes the overlapping objects between the annotations and the predictions and returns the matches.

Methods inherited from interface adams.core.Destroyable
destroy

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

Methods inherited from interface adams.core.QuickInfoSupporter
getQuickInfo

- Field Detail
  - ADDITIONAL_OBJ
```
static final String ADDITIONAL_OBJ
```
    the additional objects boolean.
    
    See Also:
    
    Constant Field Values
  - UNKNOWN_LABEL
```
static final String UNKNOWN_LABEL
```
    the placeholder for unknown label.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - calculate
```
LocatedObjects calculate(LocatedObjects annotations,
                         LocatedObjects predictions)
```
    Computes the overlapping objects between the annotations and the predictions.
    
    Parameters:
    
    annotations - the annotations (ground truth)
    
    predictions - the predictions to compare with
    
    Returns:
    
    the overlapping objects
  - matches
```
Map<LocatedObject,Map<LocatedObject,Double>> matches(LocatedObjects annotations,
                                                                 LocatedObjects predictions)
```
    Computes the overlapping objects between the annotations and the predictions and returns the matches.
    
    Parameters:
    
    annotations - the annotations (ground truth)
    
    predictions - the predictions to compare with
    
    Returns:
    
    the matches