Package adams.flow.transformer

Class MergeObjectLocations

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, ObjectPrefixHandler, Serializable, Comparable
    public class MergeObjectLocations
extends AbstractTransformer
implements ObjectPrefixHandler
    Merges the object locations in the report of the container passing through with the one obtained from storage.
    The 'overlap action' determines what to do if objects overlap.
    With the 'check type' you can still trigger a 'skip' if the type values of the two overlapping objects differ.
    For simply merging all objects, choose a minOverlapRatio of 0.0 and the OverlapAction of KEEP.

    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: MergeObjectLocations
 
    -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
 
    -prefix <java.lang.String> (property: prefix)
    The report field prefix used in the report.
    default: Object.
 
    -overlap-action <SKIP|KEEP> (property: overlapAction)
    The action to take when an object from this and the other report overlap.
    default: SKIP
 
    -no-overlap-action <SKIP|KEEP> (property: noOverlapAction)
    The action to take when an object has no overlaps at all.
    default: KEEP
 
    -check-type <boolean> (property: checkType)
    If enabled, the type of the objects gets checked as well.
    default: false
 
    -type-suffix <java.lang.String> (property: typeSuffix)
    The report field suffix for the type used in the report (ignored if empty
    ).
    default:
 
    -type-find <adams.core.base.BaseRegExp> (property: typeFind)
    The regular expression to apply to the type, ignored if empty.
    default:
    more: https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html
 
    -type-replace <java.lang.String> (property: typeReplace)
    The replacement string to use with the replacement regular expression.
    default: 
 
    -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
    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_Prefix

        protected String m_Prefix
        the prefix to use when generating a report.

      • m_CheckType

        protected boolean m_CheckType
        whether to check the type (if a suffix provided).

      • m_TypeSuffix

        protected String m_TypeSuffix
        the suffix for the type.

      • m_TypeFind

        protected BaseRegExp m_TypeFind
        the regular expression to apply to the type.

      • m_TypeReplace

        protected String m_TypeReplace
        the replacement for the type.

      • m_MinOverlapRatio

        protected double m_MinOverlapRatio
        the minimum overlap ratio to use.

    • Constructor Detail

      • MergeObjectLocations

        public MergeObjectLocations()

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

      • setPrefix

        public void setPrefix​(String value)
        Sets the field prefix used in the report.
        Specified by:
        setPrefix in interface ObjectPrefixHandler
        Parameters:
        value - the field prefix

      • prefixTipText

        public String prefixTipText()
        Returns the tip text for this property.
        Specified by:
        prefixTipText in interface ObjectPrefixHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOverlapAction

        public void setOverlapAction​(MergeObjectLocations.OverlapAction value)
        Sets the action to take when an object from this and the other report overlap.
        Parameters:
        value - the action

      • getOverlapAction

        public MergeObjectLocations.OverlapAction getOverlapAction()
        Returns the action to take when an object from this and the other report overlap.
        Returns:
        the action

      • overlapActionTipText

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

      • setNoOverlapAction

        public void setNoOverlapAction​(MergeObjectLocations.NoOverlapAction value)
        Sets the action to take when an object has no overlaps.
        Parameters:
        value - the action

      • noOverlapActionTipText

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

      • setCheckType

        public void setCheckType​(boolean value)
        Sets whether to check the type as well.
        Parameters:
        value - true if to check

      • getCheckType

        public boolean getCheckType()
        Returns the field suffix for the type used in the report (ignored if empty).
        Returns:
        true if to check

      • checkTypeTipText

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

      • setTypeSuffix

        public void setTypeSuffix​(String value)
        Sets the field suffix for the type used in the report (ignored if empty).
        Parameters:
        value - the field suffix

      • getTypeSuffix

        public String getTypeSuffix()
        Returns the field suffix for the type used in the report (ignored if empty).
        Returns:
        the field suffix

      • typeSuffixTipText

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

      • setTypeFind

        public void setTypeFind​(BaseRegExp value)
        Sets the regular expression to apply to the type, ignored if empty.
        Parameters:
        value - the expression

      • getTypeFind

        public BaseRegExp getTypeFind()
        Returns the regular expression to apply to the type, ignored if empty.
        Returns:
        the expression

      • typeFindTipText

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

      • setTypeReplace

        public void setTypeReplace​(String value)
        Sets the replacement string to use with the replacement regular expression.
        Parameters:
        value - the replacement

      • getTypeReplace

        public String getTypeReplace()
        Returns the replacement string to use with the replacement regular expression.
        Returns:
        the replacement

      • typeReplaceTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        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