Package adams.data.objectfilter

Class Translate

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.objectfilter.AbstractObjectFilter

adams.data.objectfilter.Translate

All Implemented Interfaces:

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

public class Translate
extends AbstractObjectFilter

Translates the objects by the specified X and Y.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-x <int> (property: X)
    The translation on the X axis.
    default: 0
 

-y <int> (property: Y)
    The translation on the Y axis.
    default: 0
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_X	the translation for x.
protected int	m_Y	the translation for y.

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

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.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
int	getX()	Returns the translation on the X axis.
int	getY()	Returns the translation on the Y axis.
String	globalInfo()	Returns a string describing the object.
void	setX(int value)	Sets the translation on the X axis.
void	setY(int value)	Sets the translation on the Y axis.
String	XTipText()	Returns the tip text for this property.
String	YTipText()	Returns the tip teyt for this property.

Methods inherited from class adams.data.objectfilter.AbstractObjectFilter

check, filter, getFlowContext, 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_X

protected int m_X

the translation for x.

m_Y

protected int m_Y

the translation for y.

Constructor Detail

Translate

public Translate()

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

setX

public void setX(int value)

Sets the translation on the X axis.

Parameters:

value - the translation

getX

public int getX()

Returns the translation on the X axis.

Returns:

the translation

XTipText

public String XTipText()

Returns the tip text for this property.

Returns:

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

setY

public void setY(int value)

Sets the translation on the Y axis.

Parameters:

value - the translation

getY

public int getY()

Returns the translation on the Y axis.

Returns:

the translation

YTipText

public String YTipText()

Returns the tip teyt for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractObjectFilter

Returns:

null if no info available, otherwise short string

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