Package adams.flow.transformer
Class IntersectOverUnion
-
- All Implemented Interfaces:
AdditionalInformationHandler
,CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter<Actor>
,SizeOfHandler
,Stoppable
,StoppableWithFeedback
,VariablesInspectionHandler
,VariableChangeListener
,Actor
,ErrorHandler
,InputConsumer
,OutputProducer
,Serializable
,Comparable
public class IntersectOverUnion extends AbstractTransformer
Computes the Intersect Over Union (IOU) of objects with the specified report from storage.
It stores the highest IOU found (iou_highest) and the total number of iou greater than the specified minimum (iou_count).
If a label key (located object meta-data) has been supplied, then the label of the object with the highest iou gets stored as well (iou_label_highest) and whether the labels match (iou_label_highest_match)
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-name <java.lang.String> (property: name) The name of the actor. default: IntersectOverUnion
-annotation <adams.core.base.BaseAnnotation> (property: annotations) The annotations to attach to this actor. default:
-skip <boolean> (property: skip) If set to true, transformation is skipped and the input token is just forwarded as it is. default: false
-stop-flow-on-error <boolean> (property: stopFlowOnError) If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors. default: false
-silent <boolean> (property: silent) If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well. default: false
-storage-name <adams.flow.control.StorageName> (property: storageName) The name of the storage item to merge with (Report or ReportHandler). default: storage
-finder <adams.data.objectfinder.ObjectFinder> (property: finder) The object finder for locating the objects of interest. default: adams.data.objectfinder.AllFinder
-min-iou-ratio <double> (property: minIntersectOverUnionRatio) The minimum ratio that an iou must have before being considered an actual overlap. default: 0.0 minimum: 0.0 maximum: 1.0
-label-key <java.lang.String> (property: labelKey) The (optional) key for a string label in the meta-data; if supplied the value of the object with the highest iou gets stored in the report using iou_label_highest, iou_label_highest_match stores whether the labels match. default:
-use-other-object <boolean> (property: useOtherObject) If enabled, the object data from the other report is used/forwarded in case of an overlap. default: false
-additional-object <boolean> (property: additionalObject) If enabled, the additional predicted objects not present in actual objects will be checked. default: false
- Author:
- Hisham (habdelqa at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
m_AdditionalObject
whether to check for additional predicted objects not present in actual.protected ObjectFinder
m_Finder
the object finder to use.protected String
m_LabelKey
the label meta-data key - ignored if empty.protected double
m_MinIntersectOverUnionRatio
the minimum iou ratio to use.protected StorageName
m_StorageName
the storage item.protected boolean
m_UseOtherObject
whether to use the other object in the output in case of an overlap.-
Fields inherited from class adams.flow.transformer.AbstractTransformer
BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken
-
Fields inherited from class adams.flow.core.AbstractActor
m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated
-
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.flow.core.Actor
FILE_EXTENSION, FILE_EXTENSION_GZ
-
-
Constructor Summary
Constructors Constructor Description IntersectOverUnion()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class[]
accepts()
Returns the class that the consumer accepts.String
additionalObjectTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.protected String
doExecute()
Executes the flow item.String
finderTipText()
Returns the tip text for this property.Class[]
generates()
Returns the class of objects that it generates.boolean
getAdditionalObject()
Returns whether to count additional predicted objects.ObjectFinder
getFinder()
Returns object finder for locating the objects.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 usingIntersectOverUnionRatio.IOU_LABEL_HIGHEST
,IntersectOverUnionRatio.IOU_LABEL_HIGHEST_MATCH
stores whether the labels match.double
getMinIntersectOverUnionRatio()
Returns the minimum iou ratio to use.String
getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.StorageName
getStorageName()
Returns the name of the storage item to merge with (Report or ReportHandler).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
minIntersectOverUnionRatioTipText()
Returns the tip text for this property.void
setAdditionalObject(boolean value)
Sets whether to count additional predicted objects.void
setFinder(ObjectFinder value)
Sets the object finder for locating the objects.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 usingIntersectOverUnionRatio.IOU_LABEL_HIGHEST
,IntersectOverUnionRatio.IOU_LABEL_HIGHEST_MATCH
stores whether the labels match.void
setMinIntersectOverUnionRatio(double value)
Sets the minimum iou ratio to use.void
setStorageName(StorageName value)
Sets the name of the storage item to merge with (Report or ReportHandler).void
setUseOtherObject(boolean value)
Sets whether to use/forward other object data.String
storageNameTipText()
Returns the tip text for this property.String
useOtherObjectTipText()
Returns the tip text for this property.-
Methods inherited from class adams.flow.transformer.AbstractTransformer
backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp
-
Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, pruneBackup, reset, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.flow.core.Actor
cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged
-
Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel
-
Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager
-
Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions
-
-
-
-
Field Detail
-
m_StorageName
protected StorageName m_StorageName
the storage item.
-
m_Finder
protected ObjectFinder m_Finder
the object finder to use.
-
m_MinIntersectOverUnionRatio
protected double m_MinIntersectOverUnionRatio
the minimum iou 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.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractActor
-
setStorageName
public void setStorageName(StorageName value)
Sets the name of the storage item to merge with (Report or ReportHandler).- Parameters:
value
- the name
-
getStorageName
public StorageName getStorageName()
Returns the name of the storage item to merge with (Report or ReportHandler).- Returns:
- the name
-
storageNameTipText
public String storageNameTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setFinder
public void setFinder(ObjectFinder value)
Sets the object finder for locating the objects.- Parameters:
value
- the finder
-
getFinder
public ObjectFinder getFinder()
Returns object finder for locating the objects.- Returns:
- the finder
-
finderTipText
public String finderTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setMinIntersectOverUnionRatio
public void setMinIntersectOverUnionRatio(double value)
Sets the minimum iou ratio to use.- Parameters:
value
- the minimum ratio
-
getMinIntersectOverUnionRatio
public double getMinIntersectOverUnionRatio()
Returns the minimum iou ratio to use.- Returns:
- the minimum ratio
-
minIntersectOverUnionRatioTipText
public String minIntersectOverUnionRatioTipText()
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 usingIntersectOverUnionRatio.IOU_LABEL_HIGHEST
,IntersectOverUnionRatio.IOU_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 usingIntersectOverUnionRatio.IOU_LABEL_HIGHEST
,IntersectOverUnionRatio.IOU_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.
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceActor
- Specified by:
getQuickInfo
in interfaceQuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractActor
- Returns:
- null if no info available, otherwise short string
-
accepts
public Class[] accepts()
Returns the class that the consumer accepts.- Returns:
- the Class of objects that can be processed
-
generates
public Class[] generates()
Returns the class of objects that it generates.- Returns:
- the Class of the generated tokens
-
doExecute
protected String doExecute()
Executes the flow item.- Specified by:
doExecute
in classAbstractActor
- Returns:
- null if everything is fine, otherwise error message
-
-