Package adams.data.image.transformer.subimages

Class Objects

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.image.transformer.subimages.AbstractSubImagesGenerator

adams.data.image.transformer.subimages.Objects

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectPrefixHandler, Serializable

public class Objects
extends AbstractSubImagesGenerator

Extracts sub-images defined by the objects that the object finder locates.

-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
 

-finder <adams.data.objectfinder.ObjectFinder> (property: finder)
    The object finder to use.
    default: adams.data.objectfinder.AllFinder
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ObjectFinder	m_Finder	the object finder to use.

Fields inherited from class adams.data.image.transformer.subimages.AbstractSubImagesGenerator

m_FixInvalid, m_Partial, m_Prefix

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
Objects()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected List<BufferedImageContainer>	doProcess(BufferedImageContainer image)	Performs the actual generation of the subimages.
String	finderTipText()	Returns the tip text for this property.
ObjectFinder	getFinder()	Returns the finder to use for locating the objects.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setFinder(ObjectFinder value)	Sets the finder to use for locating the objects.

Methods inherited from class adams.data.image.transformer.subimages.AbstractSubImagesGenerator

check, fixInvalidTipText, getFixInvalid, getPartial, getPrefix, partialTipText, prefixTipText, process, setFixInvalid, setPartial, setPrefix, transferObjects, transferObjects

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Finder

protected ObjectFinder m_Finder

the object finder to use.

Constructor Detail

Objects

public Objects()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractSubImagesGenerator

setFinder

public void setFinder(ObjectFinder value)

Sets the finder to use for locating the objects.

Parameters:

value - the finder

getFinder

public ObjectFinder getFinder()

Returns the finder to use for locating the objects.

Returns:

the finder

finderTipText

public String finderTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractSubImagesGenerator

Returns:

null if no info available, otherwise short string

doProcess

protected List<BufferedImageContainer> doProcess(BufferedImageContainer image)

Performs the actual generation of the subimages.

Specified by:

doProcess in class AbstractSubImagesGenerator

Parameters:

image - the image to process

Returns:

the list of subimages generated