Class GetImageObjectIndices

  • All Implemented Interfaces:
    AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

    public class GetImageObjectIndices
    extends AbstractArrayProvider
    Uses the specified object finder to locate objects and forwards the indices.

    - accepts:
    - generates:

    -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: GetImageObjectIndices
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
        The annotations to attach to this actor.
    -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
        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
    -output-array <boolean> (property: outputArray)
        If enabled, the indices get output as array instead of one-by-one.
        default: false
    -finder <> (property: finder)
        The object finder to use for locating objects in the report.
    -sort <boolean> (property: sort)
        If enabled, the indices get sorted before output.
        default: true
    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_Sort

        protected boolean m_Sort
        whether to sort lists.
    • Constructor Detail

      • GetImageObjectIndices

        public GetImageObjectIndices()
    • Method Detail

      • setFinder

        public void setFinder​(ObjectFinder value)
        Sets the object finder to use.
        value - the finder
      • getFinder

        public ObjectFinder getFinder()
        Returns the object finder in use.
        the finder
      • finderTipText

        public String finderTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setSort

        public void setSort​(boolean value)
        Sets whether to sort the indices.
        value - true if to sort
      • getSort

        public boolean getSort()
        Returns whether to sort the indices.
        true if to sort
      • sortTipText

        public String sortTipText()
        Returns the tip text for this property.
        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.
        the Class of objects that can be processed
      • doExecute

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