Package adams.data.image.transformer

Class ReplaceColors

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.image.AbstractImageTransformer<BufferedImageContainer>

adams.data.image.transformer.AbstractBufferedImageTransformer

adams.data.image.transformer.ReplaceColors

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ImageTransformer<BufferedImageContainer>, FlowContextHandler, Serializable, Comparable

public class ReplaceColors
extends AbstractBufferedImageTransformer

Allows replacing one color with another.

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

-old-color <adams.core.base.BaseColor> [-old-color ...] (property: oldColors)
    The old colors to replace.
    default:
 

-new-color <adams.core.base.BaseColor> [-new-color ...] (property: newColors)
    The replacement colors.
    default:
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseColor[]	m_NewColors	the new colors.
protected BaseColor[]	m_OldColors	the old colors.

Fields inherited from class adams.data.image.AbstractImageTransformer

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected BufferedImageContainer[]	doTransform(BufferedImageContainer img)	Performs the actual transforming of the image.
BaseColor[]	getNewColors()	Returns the new colors.
BaseColor[]	getOldColors()	Returns the old colors to replace.
String	globalInfo()	Returns a string describing the object.
String	newColorsTipText()	Returns the tip text for this property.
String	oldColorsTipText()	Returns the tip text for this property.
void	setNewColors(BaseColor[] value)	Sets the new colors.
void	setOldColors(BaseColor[] value)	Sets the old colors to replace.

Methods inherited from class adams.data.image.transformer.AbstractBufferedImageTransformer

forCommandLine, forName, getTransformations

Methods inherited from class adams.data.image.AbstractImageTransformer

checkImage, cleanUp, compareTo, destroy, equals, getFlowContext, getQuickInfo, initialize, setFlowContext, shallowCopy, shallowCopy, transform

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_OldColors

protected BaseColor[] m_OldColors

the old colors.

m_NewColors

protected BaseColor[] m_NewColors

the new colors.

Constructor Detail

ReplaceColors

public ReplaceColors()

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

setOldColors

public void setOldColors(BaseColor[] value)

Sets the old colors to replace.

Parameters:

value - the colors

getOldColors

public BaseColor[] getOldColors()

Returns the old colors to replace.

Returns:

the colors

oldColorsTipText

public String oldColorsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setNewColors

public void setNewColors(BaseColor[] value)

Sets the new colors.

Parameters:

value - the colors

getNewColors

public BaseColor[] getNewColors()

Returns the new colors.

Returns:

the colors

newColorsTipText

public String newColorsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

doTransform

protected BufferedImageContainer[] doTransform(BufferedImageContainer img)

Performs the actual transforming of the image.

Specified by:

doTransform in class AbstractImageTransformer<BufferedImageContainer>

Parameters:

img - the image to transform (can be modified, since it is a copy)

Returns:

the generated image(s)