Class Regions

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectPrefixHandler, Serializable

    public class Regions
    extends AbstractSubImagesGenerator
    Extracts the sub-images according to the region definitions.
    Additional report values:
    - Region for the region

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    -prefix <java.lang.String> (property: prefix)
        The report field prefix used in the report.
        default: Object.
     
    -partial <boolean> (property: partial)
        If enabled, partial hits are included as well.
        default: false
     
    -fix-invalid <boolean> (property: fixInvalid)
        If enabled, objects that fall partially outside the image boundaries get
        fixed (eg when allowing partial hits).
        default: false
     
    -region <adams.core.base.BaseRectangle> [-region ...] (property: regions)
        The regions to extract (x y w h, 0 or 1-based x/y).
        default:
     
    -one-based-coords <boolean> (property: oneBasedCoords)
        If enabled, the coordinates are consisdered starting at 1 rather than 0.
        default: true
     
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Regions

        protected BaseRectangle[] m_Regions
        the regions to use.
      • m_OneBasedCoords

        protected boolean m_OneBasedCoords
        whether the regions are 1-based or 0-based.
    • Constructor Detail

      • Regions

        public Regions()
    • Method Detail

      • setRegions

        public void setRegions​(BaseRectangle[] value)
        Sets the regions to extract (x y w h, 0 or 1-based x/y).
        Parameters:
        value - the regions
      • getRegions

        public BaseRectangle[] getRegions()
        Returns the regions to extract (x y w h, 0 or 1-based x/y).
        Returns:
        the regions
      • regionsTipText

        public String regionsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui
      • setOneBasedCoords

        public void setOneBasedCoords​(boolean value)
        Sets whether the coordinates start at 1 or 0.
        Parameters:
        value - true if 1-based coordinates
      • getOneBasedCoords

        public boolean getOneBasedCoords()
        Returns whether the coordinates start at 1 or 0.
        Returns:
        true if 1-based coordinates
      • oneBasedCoordsTipText

        public String oneBasedCoordsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui