Package adams.flow.transformer

Class LocateObjects

  • All Implemented Interfaces:
    AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, ErrorHandler, InputConsumer, OutputProducer, ObjectPrefixHandler, Serializable, Comparable
    public class LocateObjects
extends AbstractArrayProvider
implements ObjectPrefixHandler
    Locates objects in an image and forwards an image per located object, cropped around the object.

    Input/output:
    - accepts:
       adams.data.image.AbstractImageContainer
       java.awt.image.BufferedImage
    - generates:
       adams.data.image.BufferedImageContainer


    -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: LocateObjects
 
    -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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -output-array <boolean> (property: outputArray)
    Outputs the images either one by one or as array.
    default: false
 
    -locator <adams.flow.transformer.locateobjects.AbstractObjectLocator> (property: locator)
    The algorithm for locating the objects.
    default: adams.flow.transformer.locateobjects.PassThrough
 
    -generate-report <boolean> (property: generateReport)
    If enabled, a report with all the locations is generated instead of separate 
    image objects.
    default: false
 
    -prefix <java.lang.String> (property: prefix)
    The report field prefix to use when generating a report.
    default: Object.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • BACKUP_QUEUE

        public static final String BACKUP_QUEUE
        the key for storing the current images in the backup.
        See Also:
        Constant Field Values

      • FIELD_X

        public static final String FIELD_X
        the key for storing the X position (top-left corner) in the report.
        See Also:
        Constant Field Values

      • FIELD_Y

        public static final String FIELD_Y
        the key for storing the Y position (top-left corner) in the report.
        See Also:
        Constant Field Values

      • FIELD_LOCATION

        public static final String FIELD_LOCATION
        the key for storing the quadrilateral location in the report.
        See Also:
        Constant Field Values

      • m_GenerateReport

        protected boolean m_GenerateReport
        whether to generate an annotated image rather than single image objects.

      • m_Prefix

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

    • Constructor Detail

      • LocateObjects

        public LocateObjects()

    • Method Detail

      • setLocator

        public void setLocator​(AbstractObjectLocator value)
        Sets the scheme for locating the objects.
        Parameters:
        value - the scheme

      • getLocator

        public AbstractObjectLocator getLocator()
        Returns the scheme to use for locating the objects.
        Returns:
        the scheme

      • locatorTipText

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

      • setGenerateReport

        public void setGenerateReport​(boolean value)
        Sets whether to generate an annotated image with a report of all positions instead of separate image objects.
        Parameters:
        value - true of to generate report

      • getGenerateReport

        public boolean getGenerateReport()
        Returns whether to generate an annotated image with a report of all positions instead of separate image objects.
        Returns:
        true if to generate report

      • generateReportTipText

        public String generateReportTipText()
        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 to use when generating a report.
        Specified by:
        setPrefix in interface ObjectPrefixHandler
        Parameters:
        value - the field prefix

      • getPrefix

        public String getPrefix()
        Returns the field prefix to use when generating a report.
        Specified by:
        getPrefix in interface ObjectPrefixHandler
        Returns:
        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.

      • 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

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message