Package adams.flow.transformer

Class ImageObjectOverlap

  • 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 ImageObjectOverlap
extends AbstractTransformer
    Computes the overlap of objects with the specified report from storage.
    It stores the overlap percentage of the highest overlap found (overlap_highest) and the total number of overlaps greater than the specified minimum (overlap_count).
    If a label key (located object meta-data) has been supplied, then the label of the object with the highest overlap gets stored as well (overlap_label_highest) and whether the labels match (overlap_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: ImageObjectOverlap
 
    -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-overlap-ratio <double> (property: minOverlapRatio)
    The minimum ratio that an overlap 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 overlap gets stored in the report using
    overlap_label_highest, overlap_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:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StorageName

        protected StorageName m_StorageName
        the storage item.

      • m_Finder

        protected ObjectFinder m_Finder
        the object finder to use.

      • m_MinOverlapRatio

        protected double m_MinOverlapRatio
        the minimum overlap 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_AverageRatio

        protected boolean m_AverageRatio
        whether to use average overlap ratio instead of just this->other.

    • Constructor Detail

      • ImageObjectOverlap

        public ImageObjectOverlap()

    • Method Detail

      • 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.

      • setMinOverlapRatio

        public void setMinOverlapRatio​(double value)
        Sets the minimum overlap ratio to use.
        Parameters:
        value - the minimum ratio

      • getMinOverlapRatio

        public double getMinOverlapRatio()
        Returns the minimum overlap ratio to use.
        Returns:
        the minimum ratio

      • minOverlapRatioTipText

        public String minOverlapRatioTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • 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.

      • setAverageRatio

        public void setAverageRatio​(boolean value)
        Sets whether to use average overlap ratio instead.
        Parameters:
        value - true if to use average overlap ratio instead

      • getAverageRatio

        public boolean getAverageRatio()
        Returns whether to use average overlap ratio instead.
        Returns:
        true if to use average overlap ratio instead

      • averageRatioTipText

        public String averageRatioTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • 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 class AbstractActor
        Returns:
        null if everything is fine, otherwise error message