Package adams.data.image.transformer

Class GrayOrIndexedColorizer

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

All Implemented Interfaces:

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

public class GrayOrIndexedColorizer
extends AbstractBufferedImageTransformer
implements ImageColorizerWithColorProvider

Colorizes grayscale or indexed images using the specified color provider.
Other images types get converted to grayscale first.

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

-force-gray-scale <boolean> (property: forceGrayScale)
    If enabled, the image is forced into grayscale first (if not binary/indexed
    /grayscale), otherwise it is used as is.
    default: false
 

-color-provider <adams.gui.visualization.core.ColorProvider> (property: colorProvider)
    The color provider to use for coloring in the grayscale/indexed image.
    default: adams.gui.visualization.core.CustomColorProvider -color #ffff00 -color #0000ff -color #ff0000
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ColorProvider	m_ColorProvider	the color provider for generating the colors.
protected boolean	m_ForceGrayScale	whether to force gray scale or use the image as is.

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

Method Summary

Modifier and Type	Method	Description
String	colorProviderTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected BufferedImageContainer[]	doTransform(BufferedImageContainer img)	Performs the actual transforming of the image.
String	forceGrayScaleTipText()	Returns the tip text for this property.
ColorProvider	getColorProvider()	Returns the color provider to use.
protected ColorProvider	getDefaultColorProvider()	Returns the default color provider.
boolean	getForceGrayScale()	Returns whether to force gray scale (if not binary/indexed/grayscale) or use image as is.
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	setColorProvider(ColorProvider value)	Sets the color provider to use.
void	setForceGrayScale(boolean value)	Sets whether to force gray scale (if not binary/indexed/grayscale) or use image as is.

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, 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.CleanUpHandler

cleanUp

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.flow.core.FlowContextHandler

getFlowContext, setFlowContext

Methods inherited from interface adams.data.image.ImageTransformer

transform

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_ForceGrayScale

protected boolean m_ForceGrayScale

whether to force gray scale or use the image as is.

m_ColorProvider

protected ColorProvider m_ColorProvider

the color provider for generating the colors.

Constructor Detail

GrayOrIndexedColorizer

public GrayOrIndexedColorizer()

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

setForceGrayScale

public void setForceGrayScale(boolean value)

Sets whether to force gray scale (if not binary/indexed/grayscale) or use image as is.

Parameters:

value - true if to force

getForceGrayScale

public boolean getForceGrayScale()

Returns whether to force gray scale (if not binary/indexed/grayscale) or use image as is.

Returns:

true if to force

forceGrayScaleTipText

public String forceGrayScaleTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

getDefaultColorProvider

protected ColorProvider getDefaultColorProvider()

Returns the default color provider.

Returns:

the default

setColorProvider

public void setColorProvider(ColorProvider value)

Sets the color provider to use.

Specified by:

setColorProvider in interface ColorProviderHandler

Parameters:

value - the color provider

getColorProvider

public ColorProvider getColorProvider()

Returns the color provider to use.

Specified by:

getColorProvider in interface ColorProviderHandler

Returns:

the color provider

colorProviderTipText

public String colorProviderTipText()

Returns the tip text for this property.

Specified by:

colorProviderTipText in interface ColorProviderHandler

Returns:

tip text for this property suitable for displaying in the gui

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 AbstractImageTransformer<BufferedImageContainer>

Returns:

null if no info available, otherwise short string

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)