Package adams.data.objectfilter

Class ClipBoundingBoxes

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.objectfilter.AbstractObjectFilter

adams.data.objectfilter.ClipBoundingBoxes

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFilter, FlowContextHandler, Serializable

public class ClipBoundingBoxes
extends AbstractObjectFilter

Ensures that bounding boxes fall within the image boundaries.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Height	the image height to use.
protected int	m_Width	the image width to use.

Fields inherited from class adams.data.objectfilter.AbstractObjectFilter

m_FlowContext

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
ClipBoundingBoxes()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected LocatedObjects	doFilter(LocatedObjects objects)	Filters the image objects.
int	getHeight()	Returns the height of the image to use.
int	getWidth()	Returns the width of the image to use.
String	globalInfo()	Returns a string describing the object.
String	heightTipText()	Returns the tip text for this property.
void	setHeight(int value)	Sets the height of the image to use.
void	setWidth(int value)	Sets the width of the image to use.
String	widthTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.objectfilter.AbstractObjectFilter

check, filter, getFlowContext, getQuickInfo, requiresFlowContext, setFlowContext

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

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Width

protected int m_Width

the image width to use.

m_Height

protected int m_Height

the image height to use.

Constructor Detail

ClipBoundingBoxes

public ClipBoundingBoxes()

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 AbstractOptionHandler

setWidth

public void setWidth(int value)

Sets the width of the image to use.

Parameters:

value - the image width

getWidth

public int getWidth()

Returns the width of the image to use.

Returns:

the image 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.

setHeight

public void setHeight(int value)

Sets the height of the image to use.

Parameters:

value - the image height

getHeight

public int getHeight()

Returns the height of the image to use.

Returns:

the image 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.

doFilter

protected LocatedObjects doFilter(LocatedObjects objects)

Filters the image objects.

Specified by:

doFilter in class AbstractObjectFilter

Parameters:

objects - the located objects

Returns:

the updated list of objects