Package adams.flow.transformer

Class DeleteOverlappingImageObjects

  • 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 DeleteOverlappingImageObjects
extends AbstractTransformer
    Cleans up overlapping objects, e.g., multiple predicted bounding boxes per object.

    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: DeleteOverlappingImageObjects
 
    -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
 
    -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
 
    -removal-strategy <REMOVE_SMALLER_OBJECT|REMOVE_LARGER_OBJECT|REMOVE_BOTH> (property: removalStrategy)
    The strategy for removing overlapping objects.
    default: REMOVE_SMALLER_OBJECT
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Finder

        protected ObjectFinder m_Finder
        the object finder to use.

      • m_MinOverlapRatio

        protected double m_MinOverlapRatio
        the minimum overlap ratio to use.

      • m_DuplicateIndices

        protected boolean m_DuplicateIndices
        whether to check for duplicate object indices or not.

    • Constructor Detail

      • DeleteOverlappingImageObjects

        public DeleteOverlappingImageObjects()

    • Method Detail

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

      • removalStrategyTipText

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

      • setDuplicateIndices

        public void setDuplicateIndices​(boolean value)
        Sets the boolean duplicate indices.
        Parameters:
        value - duplicate indices

      • getDuplicateIndices

        public boolean getDuplicateIndices()
        Returns the boolean duplicate indices.
        Returns:
        duplicate indices

      • duplicateIndicesTipText

        public String duplicateIndicesTipText()
        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