Package adams.flow.transformer

Class ImageObjectToVariables

  • 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 ImageObjectToVariables
extends AbstractTransformer
    Converts the parameters of an image object into variables.
    Meta-data can be turned into variables as well.

    Input/output:
    - accepts:
       adams.flow.transformer.locateobjects.LocatedObject
    - generates:
       adams.flow.transformer.locateobjects.LocatedObject


    -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: ImageObjectToVariables
 
    -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
 
    -variable-prefix <java.lang.String> (property: variablePrefix)
    The string to prefix the variable name with.
    default:
 
    -include-metadata <boolean> (property: includeMetaData)
    If enabled, the metadata gets turned into variables as well.
    default: false
 
    -metadata-variable-prefix <java.lang.String> (property: metaDataVariablePrefix)
    The string to prefix the variable name with for metadata values.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • ImageObjectToVariables

        public ImageObjectToVariables()

    • Method Detail

      • setVariablePrefix

        public void setVariablePrefix​(String value)
        Sets the prefix for the variables (prefix + name).
        Parameters:
        value - the prefix

      • getVariablePrefix

        public String getVariablePrefix()
        Returns the prefix for the variables (prefix + name).
        Returns:
        the prefix

      • variablePrefixTipText

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

      • setIncludeMetaData

        public void setIncludeMetaData​(boolean value)
        Sets whether to turn the metadata values into variables as well.
        Parameters:
        value - true if to include

      • getIncludeMetaData

        public boolean getIncludeMetaData()
        Returns whether to turn the metadata values into variables as well.
        Returns:
        true if to include

      • includeMetaDataTipText

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

      • setMetaDataVariablePrefix

        public void setMetaDataVariablePrefix​(String value)
        Sets the prefix for the metadata variables (prefix + name).
        Parameters:
        value - the prefix

      • getMetaDataVariablePrefix

        public String getMetaDataVariablePrefix()
        Returns the prefix for the metadata variables (prefix + name).
        Returns:
        the prefix

      • metaDataVariablePrefixTipText

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