Package adams.flow.transformer

Class CountObjectsInRegion

  • 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 CountObjectsInRegion
extends AbstractTransformer
implements ObjectPrefixHandler
    Counts the objects in the report passing through that fall into the defined region.
    Partial hits can be counted as well, using their percentage in overlap as count.

    Input/output:
    - accepts:
       adams.data.report.Report
       adams.data.report.ReportHandler
    - generates:
       java.lang.Double


    -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: CountObjectsInRegion
 
    -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
 
    -top <int> (property: top)
    The y position of the top-left corner.
    default: 1
    minimum: 1
 
    -left <int> (property: left)
    The x position of the top-left corner.
    default: 1
    minimum: 1
 
    -height <int> (property: height)
    The height of the region.
    default: 1
    minimum: 1
 
    -width <int> (property: width)
    The width of the region.
    default: 1
    minimum: 1
 
    -partial-counts <boolean> (property: partialCounts)
    If enabled, partial hits are counted as well (using their fraction in overlap
    as count).
    default: false
 
    -one-based <boolean> (property: oneBased)
    If enabled, coordinates in the report are assumed to be 1-based instead
    of 0-based.
    default: false
 
    -prefix <java.lang.String> (property: prefix)
    The report field prefix used in the report.
    default: Object.
 
    -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 no check
    ).
    default:
 
    -type-find <adams.core.base.BaseRegExp> (property: typeFind)
    The regular expression to apply to the type, ignored if no check.
    default:
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Top

        protected int m_Top
        the y of the top-left corner.

      • m_Left

        protected int m_Left
        the x of the top-left corner.

      • m_Height

        protected int m_Height
        the height of the window.

      • m_Width

        protected int m_Width
        the width of the window.

      • m_PartialCounts

        protected boolean m_PartialCounts
        whether to include partial counts.

      • m_OneBased

        protected boolean m_OneBased
        whether report contains one-based coordinates.

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

    • Constructor Detail

      • CountObjectsInRegion

        public CountObjectsInRegion()

    • Method Detail

      • setTop

        public void setTop​(int value)
        Sets the y of the top-left corner.
        Parameters:
        value - the y

      • getTop

        public int getTop()
        Returns the y of the top-left corner.
        Returns:
        the y

      • topTipText

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

      • setLeft

        public void setLeft​(int value)
        Sets the x of the top-left corner.
        Parameters:
        value - the x

      • getLeft

        public int getLeft()
        Returns the x of the top-left corner.
        Returns:
        the x

      • leftTipText

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

      • setHeight

        public void setHeight​(int value)
        Sets the height of the crop rectangle.
        Parameters:
        value - the height, ignored if less than 1

      • getHeight

        public int getHeight()
        Returns the height of the region.
        Returns:
        the height

      • heightTipText

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

      • setWidth

        public void setWidth​(int value)
        Sets the width of the crop rectangle.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width of the region.
        Returns:
        the width

      • widthTipText

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

      • setPartialCounts

        public void setPartialCounts​(boolean value)
        Sets whether to include partial hits.
        Parameters:
        value - true if to include partial hits

      • getPartialCounts

        public boolean getPartialCounts()
        Returns whether to include partial hits.
        Returns:
        true if to count partial hits

      • partialCountsTipText

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

      • setOneBased

        public void setOneBased​(boolean value)
        Sets whether to assume 1-based coordinates in report.
        Parameters:
        value - true if to use 1-based coordinates

      • getOneBased

        public boolean getOneBased()
        Returns whether to assume 1-based coordinates in report.
        Returns:
        true if to use 1-based coordinates

      • oneBasedTipText

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

      • 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 no check).
        Parameters:
        value - the field suffix

      • getTypeSuffix

        public String getTypeSuffix()
        Returns the field suffix for the type used in the report (ignored if no check).
        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 no check.
        Parameters:
        value - the expression

      • getTypeFind

        public BaseRegExp getTypeFind()
        Returns the regular expression to apply to the type, ignored if no check.
        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.

      • 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