Package adams.flow.transformer

Class ImageObjectInfo

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, DataInfoActor, ErrorHandler, InputConsumer, OutputProducer, ObjectPrefixHandler, Serializable, Comparable
    public class ImageObjectInfo
extends AbstractTransformer
implements DataInfoActor, ObjectPrefixHandler
    Outputs the requested type of information for either the incoming adams.flow.transformer.locateobjects.LocatedObject or the specified image object in the report.

    Input/output:
    - accepts:
       adams.data.report.ReportHandler
       adams.data.report.Report
       adams.flow.transformer.locateobjects.LocatedObject
    - generates:
       java.lang.Integer


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ImageObjectInfo
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -prefix <java.lang.String> (property: prefix)
    The report field prefix used in the report.
    default: Object.
 
    -index <java.lang.String> (property: index)
    The index of the object to retrieve the information for.
    default:
 
    -type <X|Y|WIDTH|HEIGHT|META_DATA|RECTANGLE|BASE_RECTANGLE|INDEX_STRING|INDEX_INT|BITMAP|RECTANGLE_AREA|POLYGON_AREA> (property: type)
    The type of information to generate.
    default: X
 
    -perform-scaling <boolean> (property: performScaling)
    If enabled, the scale factors for X/Y get applied.
    default: false
 
    -scale-x <double> (property: scaleX)
    The scale factor for the X axis.
    default: 1.0
    minimum: 0.0
 
    -scale-y <double> (property: scaleY)
    The scale factor for the Y axis.
    default: 1.0
    minimum: 0.0
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Prefix

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

      • m_Index

        protected String m_Index
        the index to retrieve.

      • m_PerformScaling

        protected boolean m_PerformScaling
        whether to scale coordinates/areas.

      • m_ScaleX

        protected double m_ScaleX
        the scale factor for X.

      • m_ScaleY

        protected double m_ScaleY
        the scale factor for Y.

    • Constructor Detail

      • ImageObjectInfo

        public ImageObjectInfo()

    • Method Detail

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

      • setIndex

        public void setIndex​(String value)
        Sets the index of the object to get the information for.
        Parameters:
        value - the index

      • getIndex

        public String getIndex()
        Returns the index of the object to get the information for.
        Returns:
        the index

      • indexTipText

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

      • setType

        public void setType​(ImageObjectInfo.InfoType value)
        Sets the type of information to generate.
        Parameters:
        value - the type

      • typeTipText

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

      • setPerformScaling

        public void setPerformScaling​(boolean value)
        Sets whether to perform scaling.
        Parameters:
        value - true if to perform

      • getPerformScaling

        public boolean getPerformScaling()
        Returns whether to perform scaling.
        Returns:
        true if to perform

      • performScalingTipText

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

      • setScaleX

        public void setScaleX​(double value)
        Sets the scale factor for the X axis.
        Parameters:
        value - the scale factor

      • getScaleX

        public double getScaleX()
        Returns the scale factor for the X axis.
        Returns:
        the scale factor

      • scaleXTipText

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

      • setScaleY

        public void setScaleY​(double value)
        Sets the scale factor for the Y axis.
        Parameters:
        value - the scale factor

      • getScaleY

        public double getScaleY()
        Returns the scale factor for the Y axis.
        Returns:
        the scale factor

      • scaleYTipText

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